LibreOffice Module svl (master) 1
Public Member Functions | Private Member Functions | List of all members
SfxAllItemSet Class Referencefinal

#include <itemset.hxx>

Inheritance diagram for SfxAllItemSet:
[legend]
Collaboration diagram for SfxAllItemSet:
[legend]

Public Member Functions

 SfxAllItemSet (SfxItemPool &rPool)
 
 SfxAllItemSet (const SfxItemSet &)
 
 SfxAllItemSet (const SfxAllItemSet &)
 Explicitly define this ctor to avoid auto-generation by the compiler. More...
 
virtual std::unique_ptr< SfxItemSetClone (bool bItems=true, SfxItemPool *pToPool=nullptr) const override
 
- Public Member Functions inherited from SfxItemSet
SfxPoolItem const ** GetItems_Impl () const
 
 SfxItemSet (const SfxItemSet &)
 
 SfxItemSet (SfxItemSet &&) noexcept
 
 SfxItemSet (SfxItemPool &)
 Ctor for a SfxItemSet with exactly the Which Ranges, which are known to the supplied SfxItemPool. More...
 
 SfxItemSet (SfxItemPool &, WhichRangesContainer ranges)
 
 SfxItemSet (SfxItemPool &rPool, sal_uInt16 nWhichStart, sal_uInt16 nWhichEnd)
 
template<sal_uInt16... WIDs>
 SfxItemSet (SfxItemPool &pool, svl::Items_t< WIDs... > wids)
 
virtual ~SfxItemSet ()
 
virtual std::unique_ptr< SfxItemSetClone (bool bItems=true, SfxItemPool *pToPool=nullptr) const
 
SfxItemSet CloneAsValue (bool bItems=true, SfxItemPool *pToPool=nullptr) const
 note that this only works if you know for sure that you are dealing with an SfxItemSet and not one of it's subclasses. More...
 
sal_uInt16 Count () const
 
sal_uInt16 TotalCount () const
 
const SfxPoolItemGet (sal_uInt16 nWhich, bool bSrchInParent=true) const
 
template<class T >
const T & Get (TypedWhichId< T > nWhich, bool bSrchInParent=true) const
 
const SfxPoolItemGetItem (sal_uInt16 nWhich, bool bSearchInParent=true) const
 This method eases accessing single Items in the SfxItemSet. More...
 
template<class T >
const T * GetItem (sal_uInt16 nWhich, bool bSearchInParent=true) const
 Templatized version of GetItem() to directly return the correct type. More...
 
template<class T >
const T * GetItem (TypedWhichId< T > nWhich, bool bSearchInParent=true) const
 
sal_uInt16 GetWhichByPos (sal_uInt16 nPos) const
 
SfxItemState GetItemState (sal_uInt16 nWhich, bool bSrchInParent=true, const SfxPoolItem **ppItem=nullptr) const
 
template<class T >
SfxItemState GetItemState (TypedWhichId< T > nWhich, bool bSrchInParent=true, const T **ppItem=nullptr) const
 
template<class T >
const T * GetItemIfSet (TypedWhichId< T > nWhich, bool bSrchInParent=true) const
 Templatized version of GetItemState() to directly return the correct type. More...
 
bool HasItem (sal_uInt16 nWhich, const SfxPoolItem **ppItem=nullptr) const
 
template<class T >
bool HasItem (TypedWhichId< T > nWhich, const T **ppItem=nullptr) const
 
void DisableItem (sal_uInt16 nWhich)
 Disable Item Using a VoidItem with Which value 0. More...
 
void InvalidateItem (sal_uInt16 nWhich)
 
sal_uInt16 ClearItem (sal_uInt16 nWhich=0)
 Delete single Items or all Items (nWhich == 0) More...
 
void ClearInvalidItems ()
 
void InvalidateAllItems ()
 
void SetParent (const SfxItemSet *pNew)
 
const SfxPoolItemPut (const SfxPoolItem &rItem, sal_uInt16 nWhich)
 
const SfxPoolItemPut (std::unique_ptr< SfxPoolItem > xItem, sal_uInt16 nWhich)
 
const SfxPoolItemPut (const SfxPoolItem &rItem)
 
const SfxPoolItemPut (std::unique_ptr< SfxPoolItem > xItem)
 
bool Put (const SfxItemSet &, bool bInvalidAsDefault=true)
 
void PutExtended (const SfxItemSet &, SfxItemState eDontCareAs, SfxItemState eDefaultAs)
 This method takes the Items from the 'rSet' and adds to '*this'. More...
 
bool Set (const SfxItemSet &, bool bDeep=true)
 The SfxItemSet takes over exactly those SfxPoolItems that are set in rSet and are in their own Which range. More...
 
void Intersect (const SfxItemSet &rSet)
 Only retain the Items that are also present in rSet (nevermind their value). More...
 
void MergeValues (const SfxItemSet &rSet)
 
void Differentiate (const SfxItemSet &rSet)
 
void MergeValue (const SfxPoolItem &rItem, bool bOverwriteDefaults=false)
 
SfxItemPoolGetPool () const
 
const WhichRangesContainerGetRanges () const
 
void SetRanges (const WhichRangesContainer &)
 Modifies the ranges of settable items. More...
 
void SetRanges (WhichRangesContainer &&)
 
void MergeRange (sal_uInt16 nFrom, sal_uInt16 nTo)
 Expands the ranges of settable items by 'nFrom' to 'nTo'. More...
 
const SfxItemSetGetParent () const
 
bool operator== (const SfxItemSet &) const
 
bool Equals (const SfxItemSet &, bool bComparePool) const
 Compare possibly ignoring SfxItemPool pointer. More...
 
void dumpAsXml (xmlTextWriterPtr pWriter) const
 

Private Member Functions

virtual const SfxPoolItemPutImpl (const SfxPoolItem &, sal_uInt16 nWhich, bool bPassingOwnership) override
 Putting with automatic extension of the WhichId with the ID of the Item. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from SfxItemSet
template<class T >
static const T * GetItem (const SfxItemSet *pItemSet, sal_uInt16 nWhich, bool bSearchInParent)
 Templatized static version of GetItem() to directly return the correct type if the SfxItemSet is available. More...
 
template<class T >
static const T * GetItem (const SfxItemSet *pItemSet, TypedWhichId< T > nWhich, bool bSearchInParent)
 
- Protected Types inherited from SfxItemSet
enum class  SfxAllItemSetFlag { Flag }
 special constructor for SfxAllItemSet More...
 
- Protected Member Functions inherited from SfxItemSet
virtual void Changed (const SfxPoolItem &rOld, const SfxPoolItem &rNew)
 Notification callback. More...
 
void PutDirect (const SfxPoolItem &rItem)
 
virtual const SfxPoolItemPutImpl (const SfxPoolItem &, sal_uInt16 nWhich, bool bPassingOwnership)
 
 SfxItemSet (SfxItemPool &, SfxAllItemSetFlag)
 
 SfxItemSet (SfxItemPool &, WhichRangesContainer &&ranges, SfxPoolItem const **ppItems)
 special constructor for SfxItemSetFixed More...
 

Detailed Description

Definition at line 240 of file itemset.hxx.

Constructor & Destructor Documentation

◆ SfxAllItemSet() [1/3]

SfxAllItemSet::SfxAllItemSet ( SfxItemPool rPool)

Definition at line 1389 of file itemset.cxx.

◆ SfxAllItemSet() [2/3]

SfxAllItemSet::SfxAllItemSet ( const SfxItemSet rCopy)

Definition at line 1394 of file itemset.cxx.

◆ SfxAllItemSet() [3/3]

SfxAllItemSet::SfxAllItemSet ( const SfxAllItemSet rCopy)

Explicitly define this ctor to avoid auto-generation by the compiler.

The compiler does not take the ctor with the 'const SfxItemSet&'!

Definition at line 1403 of file itemset.cxx.

Member Function Documentation

◆ Clone()

std::unique_ptr< SfxItemSet > SfxAllItemSet::Clone ( bool  bItems = true,
SfxItemPool pToPool = nullptr 
) const
overridevirtual

Reimplemented from SfxItemSet.

Definition at line 1426 of file itemset.cxx.

References SfxItemSet::m_pPool, and SfxItemSet::SfxAllItemSet.

◆ PutImpl()

const SfxPoolItem * SfxAllItemSet::PutImpl ( const SfxPoolItem rItem,
sal_uInt16  nWhich,
bool  bPassingOwnership 
)
overrideprivatevirtual

Putting with automatic extension of the WhichId with the ID of the Item.

Reimplemented from SfxItemSet.

Definition at line 1411 of file itemset.cxx.

References SfxItemSet::MergeRange(), and SfxItemSet::PutImpl().

Referenced by SfxItemSet::Put(), and SfxItemPool::Put().


The documentation for this class was generated from the following files: