#include <itemset.hxx>

Inheritance diagram for SfxItemSet:

Collaboration diagram for SfxItemSet:

Public Member Functions
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< SfxItemSet >	Clone (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 SfxPoolItem &	Get (sal_uInt16 nWhich, bool bSrchInParent=true) const

template<class T >
const T &	Get (TypedWhichId< T > nWhich, bool bSrchInParent=true) const

const SfxPoolItem *	GetItem (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 SfxPoolItem *	Put (const SfxPoolItem &rItem, sal_uInt16 nWhich)

const SfxPoolItem *	Put (std::unique_ptr< SfxPoolItem > xItem, sal_uInt16 nWhich)

const SfxPoolItem *	Put (const SfxPoolItem &rItem)

const SfxPoolItem *	Put (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)

SfxItemPool *	GetPool () const

const WhichRangesContainer &	GetRanges () 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 SfxItemSet *	GetParent () const

bool	operator== (const SfxItemSet &) const

bool	Equals (const SfxItemSet &, bool bComparePool) const
	Compare possibly ignoring SfxItemPool pointer. More...

void	dumpAsXml (xmlTextWriterPtr pWriter) const

Static Public Member Functions
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
enum class	SfxAllItemSetFlag { Flag }
	special constructor for SfxAllItemSet More...

Protected Member Functions
virtual void	Changed (const SfxPoolItem &rOld, const SfxPoolItem &rNew)
	Notification callback. More...

void	PutDirect (const SfxPoolItem &rItem)

virtual const SfxPoolItem *	PutImpl (const SfxPoolItem &, sal_uInt16 nWhich, bool bPassingOwnership)

	SfxItemSet (SfxItemPool &, SfxAllItemSetFlag)

	SfxItemSet (SfxItemPool &, WhichRangesContainer &&ranges, SfxPoolItem const **ppItems)
	special constructor for SfxItemSetFixed More...

Private Member Functions
SVL_DLLPRIVATE void	RecreateRanges_Impl (const WhichRangesContainer &pNewRanges)

const SfxItemSet &	operator= (const SfxItemSet &)=delete

sal_uInt16	ClearSingleItemImpl (sal_uInt16 nWhich, std::optional< sal_uInt16 > oItemOffsetHint)

sal_uInt16	ClearAllItemsImpl ()

SfxItemState	GetItemStateImpl (sal_uInt16 nWhich, bool bSrchInParent, const SfxPoolItem **ppItem, std::optional< sal_uInt16 > oItemsOffsetHint) const

Private Attributes
SfxItemPool *	m_pPool
	pool that stores the items More...

const SfxItemSet *	m_pParent
	derivation More...

SfxPoolItem const **	m_ppItems
	pointer to array of items, we allocate and free this unless m_bItemsFixed==true More...

WhichRangesContainer	m_pWhichRanges
	array of Which Ranges More...

sal_uInt16	m_nCount
	number of items More...

bool	m_bItemsFixed
	true if this is a SfxItemSetFixed object More...

Friends
class	SfxItemIter

class	SfxWhichIter

class	SfxItemPoolCache

class	SfxAllItemSet

Detailed Description

Definition at line 36 of file itemset.hxx.

Member Enumeration Documentation

◆ SfxAllItemSetFlag

enum class SfxItemSet::SfxAllItemSetFlag

strongprotected

special constructor for SfxAllItemSet

Enumerator
Flag

Definition at line 69 of file itemset.hxx.

Constructor & Destructor Documentation

◆ SfxItemSet() [1/8]

SfxItemSet::SfxItemSet	(	SfxItemPool &	rPool,
		SfxAllItemSetFlag
	)

protected

Definition at line 57 of file itemset.cxx.

References m_nCount.

Referenced by Clone(), and CloneAsValue().

◆ SfxItemSet() [2/8]

SfxItemSet::SfxItemSet	(	SfxItemPool &	rPool,
		WhichRangesContainer &&	ranges,
		SfxPoolItem const **	ppItems
	)

protected

special constructor for SfxItemSetFixed

Definition at line 67 of file itemset.cxx.

References m_nCount, m_pWhichRanges, WhichRangesContainer::size(), and svl::detail::validRanges2().

◆ SfxItemSet() [3/8]

SfxItemSet::SfxItemSet ( const SfxItemSet & rASet )

Definition at line 92 of file itemset.cxx.

References SfxPoolItem::AddRef(), SfxPoolItem::Clone(), svl::detail::CountRanges(), WhichRangesContainer::empty(), IsInvalidItem(), SfxItemPool::IsItemPoolable(), IsStaticDefaultItem(), m_nCount, m_ppItems, m_pPool, m_pWhichRanges, n, SfxItemPool::Put(), and svl::detail::validRanges2().

◆ SfxItemSet() [4/8]

SfxItemSet::SfxItemSet ( SfxItemSet && rASet )

noexcept

Definition at line 132 of file itemset.cxx.

References svl::detail::CountRanges(), m_nCount, and svl::detail::validRanges2().

◆ SfxItemSet() [5/8]

SfxItemSet::SfxItemSet ( SfxItemPool & rPool )

Ctor for a SfxItemSet with exactly the Which Ranges, which are known to the supplied SfxItemPool.

For Sfx programmers: an SfxItemSet constructed in this way cannot contain any Items with SlotIds as Which values.

Don't create ItemSets with full range before FreezeIdRanges()!

Definition at line 47 of file itemset.cxx.

◆ SfxItemSet() [6/8]

SfxItemSet::SfxItemSet	(	SfxItemPool &	pool,
		WhichRangesContainer	ranges
	)

Definition at line 80 of file itemset.cxx.

◆ SfxItemSet() [7/8]

SfxItemSet::SfxItemSet	(	SfxItemPool &	rPool,
		sal_uInt16	nWhichStart,
		sal_uInt16	nWhichEnd
	)

inline

Definition at line 80 of file itemset.hxx.

◆ SfxItemSet() [8/8]

template<sal_uInt16... WIDs>

SfxItemSet::SfxItemSet	(	SfxItemPool &	pool,
		svl::Items_t< WIDs... >	wids
	)

inline

Definition at line 84 of file itemset.hxx.

◆ ~SfxItemSet()

SfxItemSet::~SfxItemSet ( )

virtual

Definition at line 156 of file itemset.cxx.

References Count(), WhichRangesContainer::empty(), IsDefaultItem(), IsInvalidItem(), m_bItemsFixed, m_ppItems, m_pPool, m_pWhichRanges, nCount, SfxPoolItem::ReleaseRef(), SfxItemPool::Remove(), WhichRangesContainer::reset(), and TotalCount().

Member Function Documentation

◆ Changed()

void SfxItemSet::Changed	(	const SfxPoolItem &	rOld,
		const SfxPoolItem &	rNew
	)

protectedvirtual

Notification callback.

Definition at line 847 of file itemset.cxx.

Referenced by ClearAllItemsImpl(), ClearSingleItemImpl(), Differentiate(), Intersect(), and PutImpl().

◆ ClearAllItemsImpl()

sal_uInt16 SfxItemSet::ClearAllItemsImpl ( )

private

Definition at line 254 of file itemset.cxx.

References Changed(), Get(), SfxItemPool::GetDefaultItem(), IsInvalidItem(), SfxItemPool::IsWhich(), m_nCount, SfxPoolItem::m_nWhich, m_pParent, m_ppItems, m_pPool, m_pWhichRanges, and SfxItemPool::Remove().

Referenced by ClearItem().

◆ ClearInvalidItems()

void SfxItemSet::ClearInvalidItems ( )

Definition at line 300 of file itemset.cxx.

References IsInvalidItem(), m_nCount, m_ppItems, and m_pWhichRanges.

◆ ClearItem()

sal_uInt16 SfxItemSet::ClearItem ( sal_uInt16 nWhich = 0 )

Delete single Items or all Items (nWhich == 0)

Definition at line 190 of file itemset.cxx.

References ClearAllItemsImpl(), ClearSingleItemImpl(), and Count().

Referenced by Intersect(), Put(), PutExtended(), and Set().

◆ ClearSingleItemImpl()

sal_uInt16 SfxItemSet::ClearSingleItemImpl	(	sal_uInt16	nWhich,
		std::optional< sal_uInt16 >	oItemOffsetHint
	)

private

Definition at line 200 of file itemset.cxx.

References Changed(), Get(), SfxItemPool::GetDefaultItem(), IsInvalidItem(), SfxItemPool::IsWhich(), m_nCount, m_pParent, m_ppItems, m_pPool, m_pWhichRanges, SfxItemPool::Remove(), and SfxPoolItem::Which().

Referenced by ClearItem().

◆ Clone()

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

virtual

Reimplemented in SfxAllItemSet.

Definition at line 1273 of file itemset.cxx.

References SfxWhichIter::FirstWhich(), GetItemState(), m_pPool, m_pWhichRanges, SfxWhichIter::NextWhich(), SET, SfxItemSet(), and SfxPoolItem::Which().

◆ CloneAsValue()

SfxItemSet 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.

Definition at line 1298 of file itemset.cxx.

References SfxWhichIter::FirstWhich(), GetItemState(), m_pPool, m_pWhichRanges, SfxWhichIter::NextWhich(), Put(), SET, SfxItemSet(), and SfxPoolItem::Which().

◆ Count()

sal_uInt16 SfxItemSet::Count ( ) const

inline

Definition at line 95 of file itemset.hxx.

References m_nCount.

Referenced by ClearItem(), Differentiate(), Equals(), Get(), Intersect(), Put(), SfxItemIter::SfxItemIter(), StylePoolImpl::StylePoolImpl(), and ~SfxItemSet().

◆ Differentiate()

void SfxItemSet::Differentiate ( const SfxItemSet & rSet )

Definition at line 914 of file itemset.cxx.

References Changed(), SfxWhichIter::ClearItem(), Count(), SfxWhichIter::FirstWhich(), Get(), SfxItemPool::GetDefaultItem(), GetItemState(), IsInvalidItem(), SfxItemPool::IsWhich(), m_nCount, m_pParent, m_ppItems, m_pPool, m_pWhichRanges, SfxWhichIter::NextWhich(), SfxItemPool::Remove(), rSet, SET, TotalCount(), and SfxPoolItem::Which().

◆ DisableItem()

void SfxItemSet::DisableItem ( sal_uInt16 nWhich )

Disable Item Using a VoidItem with Which value 0.

Definition at line 1421 of file itemset.cxx.

References Put().

◆ dumpAsXml()

void SfxItemSet::dumpAsXml ( xmlTextWriterPtr pWriter ) const

Definition at line 1367 of file itemset.cxx.

References SfxItemIter::GetCurItem(), IsInvalidItem(), and SfxItemIter::NextItem().

◆ Equals()

bool SfxItemSet::Equals	(	const SfxItemSet &	rCmp,
		bool	bComparePool
	)		const

Compare possibly ignoring SfxItemPool pointer.

This can be used to compare the content of two SfxItemSet even if they don't share the same pool. EditTextObject::Equals(...,false) uses this which is needed in ScGlobal::EETextObjEqual() for ScPageHFItem::operator==()

Parameters

bComparePool if <FALSE> ignore SfxItemPool pointer, if <TRUE> compare also SfxItemPool pointer (identical to operator==())

Definition at line 1205 of file itemset.cxx.

References Count(), SfxWhichIter::FirstWhich(), GetItemState(), i, IsInvalidItem(), SfxItemPool::IsItemPoolable(), m_pParent, m_ppItems, m_pPool, m_pWhichRanges, SfxWhichIter::NextWhich(), nPos, WhichRangesContainer::size(), and TotalCount().

Referenced by operator==().

◆ Get() [1/2]

const SfxPoolItem & SfxItemSet::Get	(	sal_uInt16	nWhich,
		bool	bSrchInParent = `true`
	)		const

((SfxAllItemSet *)this)->aDefault.SetWhich(nWhich); return aDefault;

Definition at line 795 of file itemset.cxx.

References Count(), SfxItemPool::GetDefaultItem(), IsInvalidItem(), SfxPoolItem::IsVoidItem(), m_pParent, m_ppItems, m_pPool, m_pWhichRanges, SAL_INFO, and SfxPoolItem::Which().

Referenced by SfxItemPoolCache::ApplyTo(), ClearAllItemsImpl(), ClearSingleItemImpl(), Differentiate(), Get(), Intersect(), and PutImpl().

◆ Get() [2/2]

template<class T >

const T & SfxItemSet::Get	(	TypedWhichId< T >	nWhich,
		bool	bSrchInParent = `true`
	)		const

inline

Definition at line 100 of file itemset.hxx.

References Get().

◆ GetItem() [1/5]

template<class T >

static const T * SfxItemSet::GetItem	(	const SfxItemSet *	pItemSet,
		sal_uInt16	nWhich,
		bool	bSearchInParent
	)

inlinestatic

Templatized static version of GetItem() to directly return the correct type if the SfxItemSet is available.

Definition at line 129 of file itemset.hxx.

References GetItem().

◆ GetItem() [2/5]

template<class T >

static const T * SfxItemSet::GetItem	(	const SfxItemSet *	pItemSet,
		TypedWhichId< T >	nWhich,
		bool	bSearchInParent
	)

inlinestatic

Definition at line 137 of file itemset.hxx.

◆ GetItem() [3/5]

const SfxPoolItem * SfxItemSet::GetItem	(	sal_uInt16	nWhich,
		bool	bSearchInParent = `true`
	)		const

This method eases accessing single Items in the SfxItemSet.

Parameters

nId	SlotId or the Item's WhichId
bSearchInParent	also search in parent ItemSets

Returns: 0 if the ItemSet does not contain an Item with the Id 'nWhich'

Definition at line 779 of file itemset.cxx.

References DEFAULT, SfxItemPool::GetDefaultItem(), GetItemState(), GetPool(), SfxItemPool::GetWhich(), SfxItemPool::IsWhich(), m_pPool, and nId.

Referenced by GetItem().

◆ GetItem() [4/5]

template<class T >

const T * SfxItemSet::GetItem	(	sal_uInt16	nWhich,
		bool	bSearchInParent = `true`
	)		const

inline

Templatized version of GetItem() to directly return the correct type.

Definition at line 114 of file itemset.hxx.

References GetItem().

◆ GetItem() [5/5]

template<class T >

const T * SfxItemSet::GetItem	(	TypedWhichId< T >	nWhich,
		bool	bSearchInParent = `true`
	)		const

inline

Definition at line 122 of file itemset.hxx.

◆ GetItemIfSet()

template<class T >

const T * SfxItemSet::GetItemIfSet	(	TypedWhichId< T >	nWhich,
		bool	bSrchInParent = `true`
	)		const

inline

Templatized version of GetItemState() to directly return the correct type.

Definition at line 157 of file itemset.hxx.

References GetItemState(), and SET.

◆ GetItems_Impl()

SfxPoolItem const ** SfxItemSet::GetItems_Impl ( ) const

inline

Definition at line 55 of file itemset.hxx.

References m_ppItems.

◆ GetItemState() [1/2]

SfxItemState SfxItemSet::GetItemState	(	sal_uInt16	nWhich,
		bool	bSrchInParent = `true`,
		const SfxPoolItem **	ppItem = `nullptr`
	)		const

Definition at line 321 of file itemset.cxx.

References GetItemStateImpl().

Referenced by Clone(), CloneAsValue(), Differentiate(), Equals(), GetItem(), GetItemIfSet(), GetItemState(), SfxItemPropertySet::getPropertyState(), HasItem(), Intersect(), MergeRange(), and RecreateRanges_Impl().

◆ GetItemState() [2/2]

template<class T >

SfxItemState SfxItemSet::GetItemState	(	TypedWhichId< T >	nWhich,
		bool	bSrchInParent = `true`,
		const T **	ppItem = `nullptr`
	)		const

inline

Definition at line 150 of file itemset.hxx.

References GetItemState().

◆ GetItemStateImpl()

SfxItemState SfxItemSet::GetItemStateImpl	(	sal_uInt16	nWhich,
		bool	bSrchInParent,
		const SfxPoolItem **	ppItem,
		std::optional< sal_uInt16 >	oItemsOffsetHint
	)		const

private

Definition at line 328 of file itemset.cxx.

References DEFAULT, DISABLED, DONTCARE, IsInvalidItem(), m_pParent, m_ppItems, m_pWhichRanges, SET, and UNKNOWN.

Referenced by SfxItemIter::GetItemState(), SfxWhichIter::GetItemState(), and GetItemState().

◆ GetParent()

const SfxItemSet * SfxItemSet::GetParent ( ) const

inline

Definition at line 207 of file itemset.hxx.

References m_pParent.

Referenced by StylePoolImpl::insertItemSet().

◆ GetPool()

SfxItemPool * SfxItemSet::GetPool ( ) const

inline

Definition at line 202 of file itemset.hxx.

References m_pPool.

Referenced by SfxItemPoolCache::ApplyTo(), GetItem(), StylePoolImpl::insertItemSet(), MergeValues(), and PutExtended().

◆ GetRanges()

const WhichRangesContainer & SfxItemSet::GetRanges ( ) const

inline

Definition at line 203 of file itemset.hxx.

References m_pWhichRanges.

◆ GetWhichByPos()

sal_uInt16 SfxItemSet::GetWhichByPos ( sal_uInt16 nPos ) const

Definition at line 1186 of file itemset.cxx.

References m_pWhichRanges, n, and nPos.

◆ HasItem() [1/2]

bool SfxItemSet::HasItem	(	sal_uInt16	nWhich,
		const SfxPoolItem **	ppItem = `nullptr`
	)		const

Definition at line 392 of file itemset.cxx.

References GetItemState(), and SET.

Referenced by HasItem().

◆ HasItem() [2/2]

template<class T >

bool SfxItemSet::HasItem	(	TypedWhichId< T >	nWhich,
		const T **	ppItem = `nullptr`
	)		const

inline

Definition at line 168 of file itemset.hxx.

References HasItem().

◆ Intersect()

void SfxItemSet::Intersect ( const SfxItemSet & rSet )

Only retain the Items that are also present in rSet (nevermind their value).

Definition at line 860 of file itemset.cxx.

References Changed(), SfxWhichIter::ClearItem(), ClearItem(), Count(), SfxWhichIter::FirstWhich(), Get(), SfxItemPool::GetDefaultItem(), GetItemState(), IsInvalidItem(), SfxItemPool::IsWhich(), m_nCount, m_pParent, m_ppItems, m_pPool, m_pWhichRanges, SfxWhichIter::NextWhich(), SfxItemPool::Remove(), rSet, TotalCount(), UNKNOWN, and SfxPoolItem::Which().

◆ InvalidateAllItems()

void SfxItemSet::InvalidateAllItems ( )

Definition at line 314 of file itemset.cxx.

References m_nCount, m_ppItems, and TotalCount().

◆ InvalidateItem()

void SfxItemSet::InvalidateItem ( sal_uInt16 nWhich )

Definition at line 1157 of file itemset.cxx.

References INVALID_POOL_ITEM, IsInvalidItem(), m_nCount, m_ppItems, m_pPool, m_pWhichRanges, and SfxItemPool::Remove().

Referenced by MergeValues(), Put(), and PutExtended().

◆ MergeRange()

void SfxItemSet::MergeRange	(	sal_uInt16	nFrom,
		sal_uInt16	nTo
	)

Expands the ranges of settable items by 'nFrom' to 'nTo'.

Keeps state of items which are new ranges too.

Definition at line 610 of file itemset.cxx.

References DEFAULT, GetItemState(), m_pWhichRanges, WhichRangesContainer::MergeRange(), RecreateRanges_Impl(), and SET.

Referenced by SfxAllItemSet::PutImpl().

◆ MergeValue()

void SfxItemSet::MergeValue	(	const SfxPoolItem &	rItem,
		bool	bOverwriteDefaults = `false`
	)

Definition at line 1140 of file itemset.cxx.

References m_nCount, m_ppItems, m_pPool, m_pWhichRanges, MergeItem_Impl(), and SfxPoolItem::Which().

Referenced by MergeValues().

◆ MergeValues()

void SfxItemSet::MergeValues ( const SfxItemSet & rSet )

Definition at line 1103 of file itemset.cxx.

References SfxItemPool::GetDefaultItem(), SfxWhichIter::GetItemState(), GetPool(), InvalidateItem(), IsInvalidItem(), m_nCount, m_ppItems, m_pPool, m_pWhichRanges, MergeItem_Impl(), MergeValue(), SfxWhichIter::NextWhich(), rSet, and TotalCount().

◆ operator=()

const SfxItemSet & SfxItemSet::operator= ( const SfxItemSet & )

privatedelete

◆ operator==()

bool SfxItemSet::operator== ( const SfxItemSet & rCmp ) const

Definition at line 1200 of file itemset.cxx.

References Equals().

◆ Put() [1/5]

bool SfxItemSet::Put	(	const SfxItemSet &	rSet,
		bool	bInvalidAsDefault = `true`
	)

Definition at line 500 of file itemset.cxx.

References ClearItem(), Count(), InvalidateItem(), IsInvalidItem(), m_ppItems, m_pWhichRanges, Put(), and rSet.

◆ Put() [2/5]

const SfxPoolItem * SfxItemSet::Put ( const SfxPoolItem & rItem )

inline

Definition at line 185 of file itemset.hxx.

References Put(), and SfxPoolItem::Which().

◆ Put() [3/5]

const SfxPoolItem * SfxItemSet::Put	(	const SfxPoolItem &	rItem,
		sal_uInt16	nWhich
	)

inline

Definition at line 181 of file itemset.hxx.

References SfxAllItemSet::PutImpl().

Referenced by CloneAsValue(), DisableItem(), Put(), PutExtended(), and Set().

◆ Put() [4/5]

const SfxPoolItem * SfxItemSet::Put ( std::unique_ptr< SfxPoolItem > xItem )

inline

Definition at line 187 of file itemset.hxx.

References Put(), and SfxPoolItem::Which().

◆ Put() [5/5]

const SfxPoolItem * SfxItemSet::Put	(	std::unique_ptr< SfxPoolItem >	xItem,
		sal_uInt16	nWhich
	)

inline

Definition at line 183 of file itemset.hxx.

References SfxAllItemSet::PutImpl().

◆ PutDirect()

void SfxItemSet::PutDirect ( const SfxPoolItem & rItem )

protected

Definition at line 1327 of file itemset.cxx.

References SfxPoolItem::AddRef(), SfxItemPool::CheckItemInPool(), IsPoolDefaultItem(), IsStaticDefaultItem(), m_nCount, m_ppItems, m_pPool, m_pWhichRanges, SfxItemPool::Put(), SfxItemPool::Remove(), and SfxPoolItem::Which().

◆ PutExtended()

void SfxItemSet::PutExtended	(	const SfxItemSet &	rSet,
		SfxItemState	eDontCareAs,
		SfxItemState	eDefaultAs
	)

This method takes the Items from the 'rSet' and adds to '*this'.

Which ranges in '*this' that are non-existent in 'rSet' will not be altered. The Which range of '*this' is also not changed.

Items set in 'rSet' are also set in '*this'. Default (0 pointer) and Invalid (-1 pointer) Items are processed according to their parameter 'eDontCareAs' and 'eDefaultAs':

SfxItemState::SET: Hard set to the default of the Pool SfxItemState::DEFAULT: Deleted (0 pointer) SfxItemState::DONTCARE: Invalid (-1 pointer)

NB: All other values for 'eDontCareAs' and 'eDefaultAs' are invalid

Definition at line 543 of file itemset.cxx.

References ClearItem(), DEFAULT, DONTCARE, SfxItemPool::GetDefaultItem(), GetPool(), InvalidateItem(), IsInvalidItem(), m_ppItems, m_pWhichRanges, Put(), rSet, and SET.

◆ PutImpl()

const SfxPoolItem * SfxItemSet::PutImpl	(	const SfxPoolItem &	rItem,
		sal_uInt16	nWhich,
		bool	bPassingOwnership
	)

protectedvirtual

Reimplemented in SfxAllItemSet.

Definition at line 400 of file itemset.cxx.

References Changed(), SfxPoolItem::Clone(), Get(), SfxItemPool::GetDefaultItem(), IsInvalidItem(), SfxItemPool::IsItemPoolable(), SfxItemPool::IsWhich(), m_nCount, m_pParent, m_ppItems, m_pPool, m_pWhichRanges, SfxItemPool::PutImpl(), SfxItemPool::Remove(), SAL_WARN_IF, and SfxPoolItem::Which().

Referenced by SfxAllItemSet::PutImpl().

◆ RecreateRanges_Impl()

void SfxItemSet::RecreateRanges_Impl ( const WhichRangesContainer & pNewRanges )

private

Definition at line 647 of file itemset.cxx.

References SfxPoolItem::AddRef(), svl::detail::CountRanges(), DISABLED, DONTCARE, GetItemState(), INVALID_POOL_ITEM, IsInvalidItem(), m_bItemsFixed, m_nCount, m_ppItems, m_pPool, n, SfxItemPool::Remove(), SET, TotalCount(), and SfxPoolItem::Which().

Referenced by MergeRange(), and SetRanges().

◆ Set()

bool SfxItemSet::Set	(	const SfxItemSet &	rSet,
		bool	bDeep = `true`
	)

The SfxItemSet takes over exactly those SfxPoolItems that are set in rSet and are in their own Which range.

All others are removed. The SfxItemPool is retained, such that SfxPoolItems that have been taken over, are moved from the rSet's SfxItemPool to the SfxItemPool of *this.

SfxPoolItems in rSet, for which holds 'IsInvalidItem() == true' are taken over as invalid items.

Returns: bool true SfxPoolItems have been taken over

false No SfxPoolItems have been taken over, because e.g. the Which ranges of SfxItemSets are not intersecting or the intersection does not contain SfxPoolItems that are set in rSet

Definition at line 727 of file itemset.cxx.

References ClearItem(), SfxWhichIter::FirstWhich(), SfxWhichIter::GetItemState(), m_nCount, SfxWhichIter::NextWhich(), Put(), rSet, SET, and SfxPoolItem::Which().

◆ SetParent()

void SfxItemSet::SetParent ( const SfxItemSet * pNew )

inline

Definition at line 235 of file itemset.hxx.

References m_pParent.

◆ SetRanges() [1/2]

void SfxItemSet::SetRanges ( const WhichRangesContainer & pNewRanges )

Modifies the ranges of settable items.

Keeps state of items which are new ranges too.

Definition at line 627 of file itemset.cxx.

References m_pWhichRanges, RecreateRanges_Impl(), and svl::detail::validRanges2().

◆ SetRanges() [2/2]

void SfxItemSet::SetRanges ( WhichRangesContainer && pNewRanges )

Definition at line 637 of file itemset.cxx.

References m_pWhichRanges, RecreateRanges_Impl(), and svl::detail::validRanges2().

◆ TotalCount()

sal_uInt16 SfxItemSet::TotalCount ( ) const

Definition at line 851 of file itemset.cxx.

References svl::detail::CountRanges(), and m_pWhichRanges.

Referenced by Differentiate(), Equals(), Intersect(), InvalidateAllItems(), MergeValues(), RecreateRanges_Impl(), SfxItemIter::SfxItemIter(), and ~SfxItemSet().

Friends And Related Function Documentation

◆ SfxAllItemSet

friend class SfxAllItemSet

friend

Definition at line 49 of file itemset.hxx.

Referenced by SfxAllItemSet::Clone().

◆ SfxItemIter

friend class SfxItemIter

friend

Definition at line 38 of file itemset.hxx.

◆ SfxItemPoolCache

friend class SfxItemPoolCache

friend

Definition at line 48 of file itemset.hxx.

◆ SfxWhichIter

friend class SfxWhichIter

friend

Definition at line 39 of file itemset.hxx.

Member Data Documentation

◆ m_bItemsFixed

bool SfxItemSet::m_bItemsFixed

private

true if this is a SfxItemSetFixed object

Definition at line 46 of file itemset.hxx.

Referenced by RecreateRanges_Impl(), and ~SfxItemSet().

◆ m_nCount

sal_uInt16 SfxItemSet::m_nCount

private

number of items

Definition at line 45 of file itemset.hxx.

Referenced by ClearAllItemsImpl(), ClearInvalidItems(), ClearSingleItemImpl(), Count(), Differentiate(), SfxItemIter::GetCurItem(), Intersect(), InvalidateAllItems(), InvalidateItem(), MergeValue(), MergeValues(), PutDirect(), PutImpl(), RecreateRanges_Impl(), Set(), and SfxItemIter::SfxItemIter().

◆ m_pParent

const SfxItemSet* SfxItemSet::m_pParent

private

derivation

Definition at line 42 of file itemset.hxx.

Referenced by ClearAllItemsImpl(), ClearSingleItemImpl(), Differentiate(), Equals(), Get(), GetItemStateImpl(), GetParent(), Intersect(), PutImpl(), and SetParent().

◆ m_ppItems

SfxPoolItem const** SfxItemSet::m_ppItems

private

pointer to array of items, we allocate and free this unless m_bItemsFixed==true

Definition at line 43 of file itemset.hxx.

Referenced by ClearAllItemsImpl(), ClearInvalidItems(), SfxItemIter::ClearItem(), ClearSingleItemImpl(), Differentiate(), Equals(), Get(), SfxItemIter::GetCurItem(), GetItems_Impl(), SfxItemIter::GetItemState(), GetItemStateImpl(), SfxItemIter::ImplNextItem(), Intersect(), InvalidateAllItems(), InvalidateItem(), MergeValue(), MergeValues(), Put(), PutDirect(), PutExtended(), PutImpl(), RecreateRanges_Impl(), SfxItemIter::SfxItemIter(), SfxItemSet(), and ~SfxItemSet().

◆ m_pPool

SfxItemPool* SfxItemSet::m_pPool

private

pool that stores the items

Definition at line 41 of file itemset.hxx.

Referenced by ClearAllItemsImpl(), ClearSingleItemImpl(), Clone(), SfxAllItemSet::Clone(), CloneAsValue(), Differentiate(), Equals(), Get(), GetItem(), GetPool(), Intersect(), InvalidateItem(), MergeValue(), MergeValues(), PutDirect(), PutImpl(), RecreateRanges_Impl(), SfxItemSet(), and ~SfxItemSet().

◆ m_pWhichRanges

WhichRangesContainer SfxItemSet::m_pWhichRanges

private

array of Which Ranges

Definition at line 44 of file itemset.hxx.

Referenced by ClearAllItemsImpl(), ClearInvalidItems(), ClearSingleItemImpl(), Clone(), CloneAsValue(), Differentiate(), Equals(), SfxWhichIter::FirstWhich(), Get(), SfxWhichIter::GetCurWhich(), GetItemStateImpl(), GetRanges(), GetWhichByPos(), Intersect(), InvalidateItem(), MergeRange(), MergeValue(), MergeValues(), SfxWhichIter::NextWhich(), Put(), PutDirect(), PutExtended(), PutImpl(), SetRanges(), SfxItemSet(), TotalCount(), and ~SfxItemSet().

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

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ SfxAllItemSetFlag

Constructor & Destructor Documentation

◆ SfxItemSet() [1/8]

◆ SfxItemSet() [2/8]

◆ SfxItemSet() [3/8]

◆ SfxItemSet() [4/8]

◆ SfxItemSet() [5/8]

◆ SfxItemSet() [6/8]

◆ SfxItemSet() [7/8]

◆ SfxItemSet() [8/8]

◆ ~SfxItemSet()

Member Function Documentation

◆ Changed()

◆ ClearAllItemsImpl()

◆ ClearInvalidItems()

◆ ClearItem()

◆ ClearSingleItemImpl()

◆ Clone()

◆ CloneAsValue()

◆ Count()

◆ Differentiate()

◆ DisableItem()

◆ dumpAsXml()

◆ Equals()

◆ Get() [1/2]

◆ Get() [2/2]

◆ GetItem() [1/5]

◆ GetItem() [2/5]

◆ GetItem() [3/5]

◆ GetItem() [4/5]

◆ GetItem() [5/5]

◆ GetItemIfSet()

◆ GetItems_Impl()

◆ GetItemState() [1/2]

◆ GetItemState() [2/2]

◆ GetItemStateImpl()

◆ GetParent()

◆ GetPool()

◆ GetRanges()

◆ GetWhichByPos()

◆ HasItem() [1/2]

◆ HasItem() [2/2]

◆ Intersect()

◆ InvalidateAllItems()

◆ InvalidateItem()

◆ MergeRange()

◆ MergeValue()

◆ MergeValues()

◆ operator=()

◆ operator==()

◆ Put() [1/5]

◆ Put() [2/5]

◆ Put() [3/5]

◆ Put() [4/5]

◆ Put() [5/5]

◆ PutDirect()

◆ PutExtended()

◆ PutImpl()

◆ RecreateRanges_Impl()

◆ Set()

◆ SetParent()

◆ SetRanges() [1/2]

◆ SetRanges() [2/2]

◆ TotalCount()

Friends And Related Function Documentation

◆ SfxAllItemSet

◆ SfxItemIter

◆ SfxItemPoolCache

◆ SfxWhichIter

Member Data Documentation

◆ m_bItemsFixed