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

Grab bag item provides a string-any map for keys with untyped values. More...

#include <grabbagitem.hxx>

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

Public Member Functions

 SfxGrabBagItem ()
 
 SfxGrabBagItem (sal_uInt16 nWhich)
 
 ~SfxGrabBagItem () override
 
 SfxGrabBagItem (SfxGrabBagItem const &)=default
 
 SfxGrabBagItem (SfxGrabBagItem &&)=default
 
SfxGrabBagItemoperator= (SfxGrabBagItem const &)=delete
 
SfxGrabBagItemoperator= (SfxGrabBagItem &&)=delete
 
const std::map< OUString, css::uno::Any > & GetGrabBag () const
 
std::map< OUString, css::uno::Any > & GetGrabBag ()
 
bool operator== (const SfxPoolItem &rItem) const override
 
SfxGrabBagItemClone (SfxItemPool *pPool=nullptr) const override
 
bool PutValue (const css::uno::Any &rVal, sal_uInt8 nMemberId) override
 
bool QueryValue (css::uno::Any &rVal, sal_uInt8 nMemberId=0) const 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...
 

Private Attributes

std::map< OUString, css::uno::Any > m_aMap
 

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

Grab bag item provides a string-any map for keys with untyped values.

Definition at line 19 of file grabbagitem.hxx.

Constructor & Destructor Documentation

◆ SfxGrabBagItem() [1/4]

SfxGrabBagItem::SfxGrabBagItem ( )
default

Referenced by Clone().

◆ SfxGrabBagItem() [2/4]

SfxGrabBagItem::SfxGrabBagItem ( sal_uInt16  nWhich)

Definition at line 21 of file grabbagitem.cxx.

◆ ~SfxGrabBagItem()

SfxGrabBagItem::~SfxGrabBagItem ( )
overridedefault

◆ SfxGrabBagItem() [3/4]

SfxGrabBagItem::SfxGrabBagItem ( SfxGrabBagItem const &  )
default

◆ SfxGrabBagItem() [4/4]

SfxGrabBagItem::SfxGrabBagItem ( SfxGrabBagItem &&  )
default

Member Function Documentation

◆ Clone()

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

Implements SfxPoolItem.

Definition at line 34 of file grabbagitem.cxx.

References SfxGrabBagItem().

◆ GetGrabBag() [1/2]

std::map< OUString, css::uno::Any > & SfxGrabBagItem::GetGrabBag ( )
inline

Definition at line 36 of file grabbagitem.hxx.

◆ GetGrabBag() [2/2]

const std::map< OUString, css::uno::Any > & SfxGrabBagItem::GetGrabBag ( ) const
inline

Definition at line 34 of file grabbagitem.hxx.

◆ operator=() [1/2]

SfxGrabBagItem & SfxGrabBagItem::operator= ( SfxGrabBagItem &&  )
delete

◆ operator=() [2/2]

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

◆ operator==()

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

Implements SfxPoolItem.

Definition at line 28 of file grabbagitem.cxx.

References m_aMap, and SfxPoolItem::operator==().

◆ PutValue()

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

Reimplemented from SfxPoolItem.

Definition at line 39 of file grabbagitem.cxx.

References m_aMap, and SAL_WARN.

◆ QueryValue()

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

Reimplemented from SfxPoolItem.

Definition at line 56 of file grabbagitem.cxx.

References i, and m_aMap.

Member Data Documentation

◆ m_aMap

std::map<OUString, css::uno::Any> SfxGrabBagItem::m_aMap
private

Definition at line 22 of file grabbagitem.hxx.

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


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