LibreOffice Module svl (master) 1
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
SfxBoolItem Class Reference

#include <eitem.hxx>

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

Public Member Functions

 SfxBoolItem (sal_uInt16 const nWhich=0, bool const bValue=false)
 
bool GetValue () const
 
void SetValue (bool const bTheValue)
 
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 void dumpAsXml (xmlTextWriterPtr pWriter) const override
 
virtual bool QueryValue (css::uno::Any &rVal, sal_uInt8=0) const override
 
virtual bool PutValue (const css::uno::Any &rVal, sal_uInt8) override
 
virtual SfxBoolItemClone (SfxItemPool *=nullptr) const override
 
virtual OUString GetValueTextByVal (bool bTheValue) 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 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 ()
 

Private Attributes

bool m_bValue
 

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 67 of file eitem.hxx.

Constructor & Destructor Documentation

◆ SfxBoolItem()

SfxBoolItem::SfxBoolItem ( sal_uInt16 const  nWhich = 0,
bool const  bValue = false 
)
inlineexplicit

Definition at line 75 of file eitem.hxx.

Referenced by Clone(), and CreateDefault().

Member Function Documentation

◆ Clone()

SfxBoolItem * SfxBoolItem::Clone ( SfxItemPool = nullptr) const
overridevirtual

Implements SfxPoolItem.

Definition at line 137 of file cenumitm.cxx.

References SfxBoolItem().

◆ CreateDefault()

SfxPoolItem * SfxBoolItem::CreateDefault ( )
static

Definition at line 86 of file cenumitm.cxx.

References SfxBoolItem().

◆ dumpAsXml()

void SfxBoolItem::dumpAsXml ( xmlTextWriterPtr  pWriter) const
overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 108 of file cenumitm.cxx.

References SfxPoolItem::dumpAsXml(), GetValueTextByVal(), and m_bValue.

◆ GetPresentation()

bool SfxBoolItem::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 99 of file cenumitm.cxx.

References GetValueTextByVal(), and m_bValue.

◆ GetValue()

bool SfxBoolItem::GetValue ( ) const
inline

Definition at line 80 of file eitem.hxx.

Referenced by legacy::SfxBool::Store().

◆ GetValueTextByVal()

OUString SfxBoolItem::GetValueTextByVal ( bool  bTheValue) const
virtual

Definition at line 143 of file cenumitm.cxx.

Referenced by dumpAsXml(), and GetPresentation().

◆ operator==()

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

Implements SfxPoolItem.

Definition at line 92 of file cenumitm.cxx.

References m_bValue.

◆ PutValue()

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

Reimplemented from SfxPoolItem.

Definition at line 124 of file cenumitm.cxx.

References m_bValue, and SAL_WARN.

◆ QueryValue()

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

Reimplemented from SfxPoolItem.

Definition at line 117 of file cenumitm.cxx.

References m_bValue.

◆ SetValue()

void SfxBoolItem::SetValue ( bool const  bTheValue)
inline

Definition at line 82 of file eitem.hxx.

Referenced by legacy::SfxBool::Create().

Member Data Documentation

◆ m_bValue

bool SfxBoolItem::m_bValue
private

Definition at line 70 of file eitem.hxx.

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


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