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

#include <intitem.hxx>

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

Public Member Functions

 SfxInt16Item (sal_uInt16 which=0, sal_Int16 nTheValue=0)
 
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 boost::property_tree::ptree dumpAsJSON () const override
 
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 SfxInt16ItemClone (SfxItemPool *=nullptr) const override
 
sal_Int16 GetValue () const
 
void SetValue (sal_Int16 nTheValue)
 
- 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

sal_Int16 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 40 of file intitem.hxx.

Constructor & Destructor Documentation

◆ SfxInt16Item()

SfxInt16Item::SfxInt16Item ( sal_uInt16  which = 0,
sal_Int16  nTheValue = 0 
)
inlineexplicit

Definition at line 47 of file intitem.hxx.

Referenced by Clone(), and CreateDefault().

Member Function Documentation

◆ Clone()

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

Implements SfxPoolItem.

Reimplemented in SfxImageItem.

Definition at line 91 of file intitem.cxx.

References SfxInt16Item().

◆ CreateDefault()

SfxPoolItem * SfxInt16Item::CreateDefault ( )
static

Definition at line 37 of file intitem.cxx.

References SfxInt16Item().

◆ dumpAsJSON()

boost::property_tree::ptree SfxInt16Item::dumpAsJSON ( ) const
overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 61 of file intitem.cxx.

References SfxPoolItem::dumpAsJSON(), and GetValue().

◆ GetPresentation()

bool SfxInt16Item::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 51 of file intitem.cxx.

References m_nValue.

◆ GetValue()

sal_Int16 SfxInt16Item::GetValue ( ) const
inline

Definition at line 69 of file intitem.hxx.

References CntByteItem::m_nValue.

Referenced by dumpAsJSON(), and SfxImageItem::QueryValue().

◆ operator==()

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

Implements SfxPoolItem.

Reimplemented in SfxImageItem.

Definition at line 43 of file intitem.cxx.

References m_nValue.

◆ PutValue()

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

Reimplemented from SfxPoolItem.

Reimplemented in SfxImageItem.

Definition at line 78 of file intitem.cxx.

References m_nValue, and nValue.

◆ QueryValue()

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

Reimplemented from SfxPoolItem.

Reimplemented in SfxImageItem.

Definition at line 70 of file intitem.cxx.

References m_nValue, and nValue.

◆ SetValue()

void SfxInt16Item::SetValue ( sal_Int16  nTheValue)
inline

Definition at line 74 of file intitem.hxx.

References DBG_ASSERT, SfxPoolItem::GetRefCount(), and m_nValue.

Referenced by SfxImageItem::PutValue().

Member Data Documentation

◆ m_nValue

sal_Int16 SfxInt16Item::m_nValue
private

Definition at line 42 of file intitem.hxx.

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


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