#include <visitem.hxx>

Inheritance diagram for SfxVisibilityItem:

Collaboration diagram for SfxVisibilityItem:

Public Member Functions
	SfxVisibilityItem (sal_uInt16 which, bool bVisible)

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

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

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

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

virtual SfxVisibilityItem *	Clone (SfxItemPool *=nullptr) const override

bool	GetValue () const

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 Attributes
css::frame::status::Visibility	m_nValue

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 27 of file visitem.hxx.

Constructor & Destructor Documentation

◆ SfxVisibilityItem()

SfxVisibilityItem::SfxVisibilityItem	(	sal_uInt16	which,
		bool	bVisible
	)

inlineexplicit

Definition at line 33 of file visitem.hxx.

References bVisible.

Referenced by Clone().

Member Function Documentation

◆ Clone()

SfxVisibilityItem * SfxVisibilityItem::Clone ( SfxItemPool * = nullptr ) const

overridevirtual

Implements SfxPoolItem.

Definition at line 66 of file visitem.cxx.

References SfxVisibilityItem().

◆ GetPresentation()

bool SfxVisibilityItem::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, ..."

Reimplemented from SfxPoolItem.

Definition at line 38 of file visitem.cxx.

References m_nValue, and u.

◆ GetValue()

bool SfxVisibilityItem::GetValue ( ) const

inline

Definition at line 54 of file visitem.hxx.

◆ operator==()

bool SfxVisibilityItem::operator== ( const SfxPoolItem & rItem ) const

overridevirtual

Implements SfxPoolItem.

Definition at line 30 of file visitem.cxx.

References m_nValue.

◆ PutValue()

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

overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 56 of file visitem.cxx.

References m_nValue.

◆ QueryValue()

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

overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 49 of file visitem.cxx.

References m_nValue.

Member Data Documentation

◆ m_nValue

css::frame::status::Visibility SfxVisibilityItem::m_nValue

private

Definition at line 29 of file visitem.hxx.

Referenced by GetPresentation(), operator==(), PutValue(), and QueryValue().

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SfxVisibilityItem()

Member Function Documentation

◆ Clone()

◆ GetPresentation()

◆ GetValue()

◆ operator==()

◆ PutValue()

◆ QueryValue()

Member Data Documentation

◆ m_nValue