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

#include <poolitem.hxx>

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

Public Member Functions

 SfxVoidItem (sal_uInt16 nWhich)
 
virtual ~SfxVoidItem () override
 
 SfxVoidItem (SfxVoidItem const &)=default
 
 SfxVoidItem (SfxVoidItem &&)=default
 
SfxVoidItemoperator= (SfxVoidItem const &)=delete
 
SfxVoidItemoperator= (SfxVoidItem &&)=delete
 
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 void dumpAsXml (xmlTextWriterPtr pWriter) const override
 
virtual SfxVoidItemClone (SfxItemPool *pPool=nullptr) const override
 
virtual bool IsVoidItem () const override
 Always returns true as this is an SfxVoidItem. More...
 
- 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 SfxPoolItemClone (SfxItemPool *pPool=nullptr) const =0
 
std::unique_ptr< SfxPoolItemCloneSetWhich (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...
 

Static Public Member Functions

static SfxPoolItemCreateDefault ()
 

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 294 of file poolitem.hxx.

Constructor & Destructor Documentation

◆ SfxVoidItem() [1/3]

SfxVoidItem::SfxVoidItem ( sal_uInt16  nWhich)
explicit

Definition at line 568 of file poolitem.cxx.

◆ ~SfxVoidItem()

SfxVoidItem::~SfxVoidItem ( )
overridevirtual

Definition at line 616 of file poolitem.cxx.

◆ SfxVoidItem() [2/3]

SfxVoidItem::SfxVoidItem ( SfxVoidItem const &  )
default

◆ SfxVoidItem() [3/3]

SfxVoidItem::SfxVoidItem ( SfxVoidItem &&  )
default

Member Function Documentation

◆ Clone()

SfxVoidItem * SfxVoidItem::Clone ( SfxItemPool pPool = nullptr) const
overridevirtual

Implements SfxPoolItem.

Definition at line 596 of file poolitem.cxx.

References SfxPoolItem::SfxVoidItem.

◆ CreateDefault()

SfxPoolItem * SfxVoidItem::CreateDefault ( )
static

Definition at line 566 of file poolitem.cxx.

References SfxPoolItem::SfxVoidItem.

◆ dumpAsXml()

void SfxVoidItem::dumpAsXml ( xmlTextWriterPtr  pWriter) const
overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 588 of file poolitem.cxx.

References SfxPoolItem::Which().

◆ GetPresentation()

bool SfxVoidItem::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 580 of file poolitem.cxx.

◆ IsVoidItem()

bool SfxVoidItem::IsVoidItem ( ) const
overridevirtual

Always returns true as this is an SfxVoidItem.

Reimplemented from SfxPoolItem.

Definition at line 598 of file poolitem.cxx.

◆ operator=() [1/2]

SfxVoidItem & SfxVoidItem::operator= ( SfxVoidItem &&  )
delete

References Clone().

◆ operator=() [2/2]

SfxVoidItem & SfxVoidItem::operator= ( SfxVoidItem const &  )
delete

◆ operator==()

bool SfxVoidItem::operator== ( const SfxPoolItem rCmp) const
overridevirtual

Implements SfxPoolItem.

Definition at line 573 of file poolitem.cxx.


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