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

#include <ptitem.hxx>

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

Public Member Functions

 SfxPointItem ()
 
 SfxPointItem (sal_uInt16 nWhich, const Point &rVal)
 
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 bool operator== (const SfxPoolItem &) const override
 
virtual SfxPointItemClone (SfxItemPool *pPool=nullptr) const override
 
const PointGetValue () const
 
void SetValue (const Point &rNewVal)
 
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
 
- 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

Point aVal
 

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 29 of file ptitem.hxx.

Constructor & Destructor Documentation

◆ SfxPointItem() [1/2]

SfxPointItem::SfxPointItem ( )

Definition at line 37 of file ptitem.cxx.

Referenced by Clone(), and CreateDefault().

◆ SfxPointItem() [2/2]

SfxPointItem::SfxPointItem ( sal_uInt16  nWhich,
const Point rVal 
)

Definition at line 42 of file ptitem.cxx.

Member Function Documentation

◆ Clone()

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

Implements SfxPoolItem.

Definition at line 69 of file ptitem.cxx.

References SfxPointItem().

◆ CreateDefault()

SfxPoolItem * SfxPointItem::CreateDefault ( )
static

Definition at line 34 of file ptitem.cxx.

References SfxPointItem().

◆ GetPresentation()

bool SfxPointItem::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 49 of file ptitem.cxx.

References aVal, Point::X(), and Point::Y().

◆ GetValue()

const Point & SfxPointItem::GetValue ( ) const
inline

Definition at line 48 of file ptitem.hxx.

◆ operator==()

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

Implements SfxPoolItem.

Definition at line 63 of file ptitem.cxx.

References aVal.

◆ PutValue()

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

Reimplemented from SfxPoolItem.

Definition at line 97 of file ptitem.cxx.

References aVal, CONVERT_TWIPS, MID_X, MID_Y, o3tl::mm100, Point::setX(), Point::setY(), and o3tl::toTwips().

◆ QueryValue()

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

Reimplemented from SfxPoolItem.

Definition at line 74 of file ptitem.cxx.

References aVal, CONVERT_TWIPS, convertTwipToMm100(), MID_X, MID_Y, Point::X(), and Point::Y().

◆ SetValue()

void SfxPointItem::SetValue ( const Point rNewVal)
inline

Definition at line 49 of file ptitem.hxx.

References DBG_ASSERT, and SfxPoolItem::GetRefCount().

Member Data Documentation

◆ aVal

Point SfxPointItem::aVal
private

Definition at line 31 of file ptitem.hxx.

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


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