LibreOffice Module svl (master) 1
Public Member Functions | Protected Member Functions | List of all members
SfxEnumItemInterface Class Referenceabstract

#include <cenumitm.hxx>

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

Public Member Functions

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=0) const override
 
virtual bool PutValue (const css::uno::Any &rVal, sal_uInt8) override
 
virtual sal_uInt16 GetValueCount () const =0
 
virtual sal_uInt16 GetEnumValue () const =0
 
virtual void SetEnumValue (sal_uInt16 nValue)=0
 
virtual bool HasBoolValue () const
 
virtual bool GetBoolValue () const
 
virtual void SetBoolValue (bool bValue)
 
- 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...
 

Protected Member Functions

 SfxEnumItemInterface (sal_uInt16 which)
 
 SfxEnumItemInterface (const SfxEnumItemInterface &)=default
 
- Protected Member Functions inherited from SfxPoolItem
 SfxPoolItem (sal_uInt16 nWhich=0)
 
 SfxPoolItem (const SfxPoolItem &rCopy)
 

Additional Inherited Members

- Public Types inherited from SfxPoolItem
typedef std::vector< SfxPoolItem * >::const_iterator lookup_iterator
 

Detailed Description

Definition at line 26 of file cenumitm.hxx.

Constructor & Destructor Documentation

◆ SfxEnumItemInterface() [1/2]

SfxEnumItemInterface::SfxEnumItemInterface ( sal_uInt16  which)
inlineexplicitprotected

Definition at line 29 of file cenumitm.hxx.

◆ SfxEnumItemInterface() [2/2]

SfxEnumItemInterface::SfxEnumItemInterface ( const SfxEnumItemInterface )
protecteddefault

Member Function Documentation

◆ GetBoolValue()

bool SfxEnumItemInterface::GetBoolValue ( ) const
virtual

Definition at line 77 of file cenumitm.cxx.

◆ GetEnumValue()

virtual sal_uInt16 SfxEnumItemInterface::GetEnumValue ( ) const
pure virtual

Implemented in SfxEnumItem< EnumT >.

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

◆ GetPresentation()

bool SfxEnumItemInterface::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 39 of file cenumitm.cxx.

References GetEnumValue().

◆ GetValueCount()

virtual sal_uInt16 SfxEnumItemInterface::GetValueCount ( ) const
pure virtual

◆ HasBoolValue()

bool SfxEnumItemInterface::HasBoolValue ( ) const
virtual

Definition at line 71 of file cenumitm.cxx.

◆ operator==()

bool SfxEnumItemInterface::operator== ( const SfxPoolItem rItem) const
overridevirtual

Implements SfxPoolItem.

Reimplemented in SfxEnumItem< EnumT >.

Definition at line 30 of file cenumitm.cxx.

References GetEnumValue(), SAL_WARN_IF, and SfxPoolItem::Which().

Referenced by SfxEnumItem< EnumT >::operator==().

◆ PutValue()

bool SfxEnumItemInterface::PutValue ( const css::uno::Any &  rVal,
sal_uInt8   
)
overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 56 of file cenumitm.cxx.

References SAL_WARN, and SetEnumValue().

◆ QueryValue()

bool SfxEnumItemInterface::QueryValue ( css::uno::Any &  rVal,
sal_uInt8  = 0 
) const
overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 48 of file cenumitm.cxx.

References GetEnumValue().

◆ SetBoolValue()

void SfxEnumItemInterface::SetBoolValue ( bool  bValue)
virtual

Definition at line 83 of file cenumitm.cxx.

◆ SetEnumValue()

virtual void SfxEnumItemInterface::SetEnumValue ( sal_uInt16  nValue)
pure virtual

Implemented in SfxEnumItem< EnumT >.

Referenced by PutValue().


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