#include <macitem.hxx>

Inheritance diagram for SvxMacroItem:

Collaboration diagram for SvxMacroItem:

Public Member Functions
	SvxMacroItem (const sal_uInt16 nId)

virtual bool	operator== (const SfxPoolItem &) const override

virtual bool	GetPresentation (SfxItemPresentation ePres, MapUnit eCoreMetric, MapUnit ePresMetric, OUString &rText, const IntlWrapper &) const override
	This virtual method allows to get a textual representation of the value for the SfxPoolItem subclasses. More...

virtual SvxMacroItem *	Clone (SfxItemPool *pPool=nullptr) const override

const SvxMacroTableDtor &	GetMacroTable () const

void	SetMacroTable (const SvxMacroTableDtor &rTbl)

const SvxMacro &	GetMacro (SvMacroItemId nEvent) const

bool	HasMacro (SvMacroItemId nEvent) const

void	SetMacro (SvMacroItemId nEvent, const SvxMacro &)

Public Member Functions inherited from SfxPoolItem
void	AddRef (sal_uInt32 n=1) const

virtual	~SfxPoolItem ()

void	SetWhich (sal_uInt16 nId)

sal_uInt16	Which () const

template<class T >
T &	StaticWhichCast (TypedWhichId< T > nId)

template<class T >
const T &	StaticWhichCast (TypedWhichId< T > nId) const

template<class T >
T *	DynamicWhichCast (TypedWhichId< T > nId)

template<class T >
const T *	DynamicWhichCast (TypedWhichId< T > nId) const

virtual bool	operator== (const SfxPoolItem &) const =0

bool	operator!= (const SfxPoolItem &rItem) const

virtual bool	operator< (const SfxPoolItem &) const

virtual bool	IsSortable () const

virtual bool	HasLookup () const

virtual lookup_iterator	Lookup (lookup_iterator, lookup_iterator end) const

virtual bool	GetPresentation (SfxItemPresentation ePresentation, MapUnit eCoreMetric, MapUnit ePresentationMetric, OUString &rText, const IntlWrapper &rIntlWrapper) const
	This virtual method allows to get a textual representation of the value for the SfxPoolItem subclasses. More...

virtual void	ScaleMetrics (tools::Long lMult, tools::Long lDiv)

virtual bool	HasMetrics () const

virtual bool	QueryValue (css::uno::Any &rVal, sal_uInt8 nMemberId=0) const

virtual bool	PutValue (const css::uno::Any &rVal, sal_uInt8 nMemberId)

virtual SfxPoolItem *	Clone (SfxItemPool *pPool=nullptr) const =0

std::unique_ptr< SfxPoolItem >	CloneSetWhich (sal_uInt16 nNewWhich) const

template<class T >
std::unique_ptr< T >	CloneSetWhich (TypedWhichId< T > nId) const

sal_uInt32	GetRefCount () const

SfxItemKind	GetKind () const

virtual void	dumpAsXml (xmlTextWriterPtr pWriter) const

virtual boost::property_tree::ptree	dumpAsJSON () const

virtual bool	IsVoidItem () const
	Only SfxVoidItem shall and must return true for this. More...

Private Member Functions
	SvxMacroItem (const SvxMacroItem &)=default

Private Attributes
SvxMacroTableDtor	aMacroTable

Additional Inherited Members
Public Types inherited from SfxPoolItem
typedef std::vector< SfxPoolItem * >::const_iterator	lookup_iterator

Protected Member Functions inherited from SfxPoolItem
	SfxPoolItem (sal_uInt16 nWhich=0)

	SfxPoolItem (const SfxPoolItem &rCopy)

Detailed Description

Definition at line 110 of file macitem.hxx.

Constructor & Destructor Documentation

◆ SvxMacroItem() [1/2]

SvxMacroItem::SvxMacroItem ( const sal_uInt16 nId )

inlineexplicit

Definition at line 137 of file macitem.hxx.

References nId.

Referenced by Clone().

◆ SvxMacroItem() [2/2]

SvxMacroItem::SvxMacroItem ( const SvxMacroItem & )

privatedefault

Member Function Documentation

◆ Clone()

SvxMacroItem * SvxMacroItem::Clone ( SfxItemPool * pPool = nullptr ) const

overridevirtual

Implements SfxPoolItem.

Definition at line 201 of file macitem.cxx.

References SvxMacroItem().

◆ GetMacro()

const SvxMacro & SvxMacroItem::GetMacro ( SvMacroItemId nEvent ) const

inline

Definition at line 145 of file macitem.hxx.

References aMacroTable, and SvxMacroTableDtor::Get().

◆ GetMacroTable()

const SvxMacroTableDtor & SvxMacroItem::GetMacroTable ( ) const

inline

Definition at line 124 of file macitem.hxx.

◆ GetPresentation()

bool SvxMacroItem::GetPresentation	(	SfxItemPresentation	ePresentation,
		MapUnit	eCoreMetric,
		MapUnit	ePresentationMetric,
		OUString &	rText,
		const IntlWrapper &	rIntlWrapper
	)		const

overridevirtual

This virtual method allows to get a textual representation of the value for the SfxPoolItem subclasses.

Returns: true if it has a valid string representation

It should be overridden by all UI-relevant SfxPoolItem subclasses.

Because the unit of measure of the value in the SfxItemPool is only queryable via

See also: SfxItemPool::GetMetric(sal_uInt16) const (and not via the SfxPoolItem instance or subclass, the own unit of measure is passed to 'eCoreMetric'.

The corresponding unit of measure is passed as 'ePresentationMetric'.

Returns: SfxItemPresentation SfxItemPresentation::Nameless A textual representation (if applicable with a unit of measure) could be created, but it doesn't contain any semantic meaning

SfxItemPresentation::Complete A complete textual representation could be created with semantic meaning (if applicable with unit of measure)

Example:

pSvxFontItem->GetPresentation( SFX_PRESENTATION_NAMELESS, ... ) "12pt" with return SfxItemPresentation::Nameless

pSvxColorItem->GetPresentation( SFX_PRESENTATION_COMPLETE, ... ) "red" with return SfxItemPresentation::Nameless Because the SvxColorItem does not know which color it represents it cannot provide a name, which is communicated by the return value

pSvxBorderItem->GetPresentation( SFX_PRESENTATION_COMPLETE, ... ) "1cm top border, 2cm left border, 0.2cm bottom border, ..."

!! SvxMacroTableDtor& rTbl = (SvxMacroTableDtor&)GetMacroTable(); SvxMacro* pMac = rTbl.First();

while ( pMac ) { rText += pMac->GetLibName(); rText += cpDelim; rText += pMac->GetMacName(); pMac = rTbl.Next(); if ( pMac ) rText += cpDelim; }

Reimplemented from SfxPoolItem.

Definition at line 206 of file macitem.cxx.

◆ HasMacro()

bool SvxMacroItem::HasMacro ( SvMacroItemId nEvent ) const

inline

Definition at line 141 of file macitem.hxx.

References aMacroTable, and SvxMacroTableDtor::IsKeyValid().

◆ operator==()

bool SvxMacroItem::operator== ( const SfxPoolItem & rAttr ) const

overridevirtual

Implements SfxPoolItem.

Definition at line 191 of file macitem.cxx.

References aMacroTable.

◆ SetMacro()

void SvxMacroItem::SetMacro	(	SvMacroItemId	nEvent,
		const SvxMacro &	rMacro
	)

Definition at line 234 of file macitem.cxx.

References aMacroTable, and SvxMacroTableDtor::Insert().

◆ SetMacroTable()

void SvxMacroItem::SetMacroTable ( const SvxMacroTableDtor & rTbl )

inline

Definition at line 125 of file macitem.hxx.

Member Data Documentation

◆ aMacroTable

SvxMacroTableDtor SvxMacroItem::aMacroTable

private

Definition at line 132 of file macitem.hxx.

Referenced by GetMacro(), HasMacro(), operator==(), and SetMacro().

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SvxMacroItem() [1/2]

◆ SvxMacroItem() [2/2]

Member Function Documentation

◆ Clone()

◆ GetMacro()

◆ GetMacroTable()

◆ GetPresentation()

◆ HasMacro()

◆ operator==()

◆ SetMacro()

◆ SetMacroTable()

Member Data Documentation

◆ aMacroTable