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

#include <slstitm.hxx>

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

Public Member Functions

 SfxStringListItem ()
 
 SfxStringListItem (sal_uInt16 nWhich, const std::vector< OUString > *pList=nullptr)
 
virtual ~SfxStringListItem () override
 
 SfxStringListItem (SfxStringListItem const &)=default
 
 SfxStringListItem (SfxStringListItem &&)=default
 
SfxStringListItemoperator= (SfxStringListItem const &)=delete
 
SfxStringListItemoperator= (SfxStringListItem &&)=delete
 
std::vector< OUString > & GetList ()
 
const std::vector< OUString > & GetList () const
 
void SetString (const OUString &)
 
OUString GetString ()
 
void SetStringList (const css::uno::Sequence< OUString > &rList)
 
void GetStringList (css::uno::Sequence< OUString > &rList) const
 
virtual bool operator== (const SfxPoolItem &) const override
 
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 SfxStringListItemClone (SfxItemPool *pPool=nullptr) const override
 
virtual bool PutValue (const css::uno::Any &rVal, sal_uInt8 nMemberId) override
 
virtual 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...
 

Static Public Member Functions

static SfxPoolItemCreateDefault ()
 

Private Attributes

std::shared_ptr< std::vector< OUString > > mpList
 

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 30 of file slstitm.hxx.

Constructor & Destructor Documentation

◆ SfxStringListItem() [1/4]

SfxStringListItem::SfxStringListItem ( )

Definition at line 32 of file slstitm.cxx.

Referenced by Clone(), and CreateDefault().

◆ SfxStringListItem() [2/4]

SfxStringListItem::SfxStringListItem ( sal_uInt16  nWhich,
const std::vector< OUString > *  pList = nullptr 
)

!! && pList->Count()

Definition at line 37 of file slstitm.cxx.

References mpList.

◆ ~SfxStringListItem()

SfxStringListItem::~SfxStringListItem ( )
overridevirtual

Definition at line 49 of file slstitm.cxx.

◆ SfxStringListItem() [3/4]

SfxStringListItem::SfxStringListItem ( SfxStringListItem const &  )
default

◆ SfxStringListItem() [4/4]

SfxStringListItem::SfxStringListItem ( SfxStringListItem &&  )
default

Member Function Documentation

◆ Clone()

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

Implements SfxPoolItem.

Definition at line 90 of file slstitm.cxx.

References SfxStringListItem().

◆ CreateDefault()

SfxPoolItem * SfxStringListItem::CreateDefault ( )
static

Definition at line 30 of file slstitm.cxx.

References SfxStringListItem().

◆ GetList() [1/2]

std::vector< OUString > & SfxStringListItem::GetList ( )

Definition at line 54 of file slstitm.cxx.

References mpList.

Referenced by GetList().

◆ GetList() [2/2]

const std::vector< OUString > & SfxStringListItem::GetList ( ) const

Definition at line 61 of file slstitm.cxx.

References GetList().

◆ GetPresentation()

bool SfxStringListItem::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 77 of file slstitm.cxx.

◆ GetString()

OUString SfxStringListItem::GetString ( )

Definition at line 106 of file slstitm.cxx.

References aStr, end, mpList, and SAL_NEWLINE_STRING.

◆ GetStringList()

void SfxStringListItem::GetStringList ( css::uno::Sequence< OUString > &  rList) const

Definition at line 132 of file slstitm.cxx.

References i, mpList, and nCount.

Referenced by QueryValue().

◆ operator=() [1/2]

SfxStringListItem & SfxStringListItem::operator= ( SfxStringListItem &&  )
delete

References GetList(), GetString(), and SetString().

◆ operator=() [2/2]

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

◆ operator==()

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

Implements SfxPoolItem.

Definition at line 67 of file slstitm.cxx.

References mpList.

◆ PutValue()

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

Reimplemented from SfxPoolItem.

Definition at line 143 of file slstitm.cxx.

References SetStringList().

◆ QueryValue()

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

Reimplemented from SfxPoolItem.

Definition at line 157 of file slstitm.cxx.

References aStringList, and GetStringList().

◆ SetString()

void SfxStringListItem::SetString ( const OUString &  rStr)

Definition at line 95 of file slstitm.cxx.

References aStr, convertLineEnd(), LINEEND_CR, and mpList.

◆ SetStringList()

void SfxStringListItem::SetStringList ( const css::uno::Sequence< OUString > &  rList)

Definition at line 126 of file slstitm.cxx.

References mpList.

Referenced by PutValue().

Member Data Documentation

◆ mpList

std::shared_ptr<std::vector<OUString> > SfxStringListItem::mpList
private

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