LibreOffice Module comphelper (master) 1
Public Member Functions | Private Attributes | List of all members
comphelper::PropertySetInfo Class Referencefinal

this class implements a XPropertySetInfo that is initialized with arrays of PropertyMapEntry. More...

#include <propertysetinfo.hxx>

Inheritance diagram for comphelper::PropertySetInfo:
[legend]
Collaboration diagram for comphelper::PropertySetInfo:
[legend]

Public Member Functions

 PropertySetInfo () noexcept
 
 PropertySetInfo (o3tl::span< const PropertyMapEntry > pMap) noexcept
 
virtual ~PropertySetInfo () noexcept override
 
const PropertyMapgetPropertyMap () const noexcept
 returns a stl map with all PropertyMapEntry pointer. More...
 
void add (o3tl::span< PropertyMapEntry const > pMap) noexcept
 adds an array of PropertyMapEntry to this instance. More...
 
void remove (const OUString &aName) noexcept
 removes an already added PropertyMapEntry which string in mpName equals to aName More...
 
virtual css::uno::Sequence< css::beans::Property > SAL_CALL getProperties () override
 
virtual css::beans::Property SAL_CALL getPropertyByName (const OUString &aName) override
 
virtual sal_Bool SAL_CALL hasPropertyByName (const OUString &Name) override
 

Private Attributes

PropertyMap maPropertyMap
 
css::uno::Sequence< css::beans::Property > maProperties
 Cache the value we return in getProperties because it is expensive to construct. More...
 

Detailed Description

this class implements a XPropertySetInfo that is initialized with arrays of PropertyMapEntry.

It is used by the class PropertySetHelper.

Definition at line 88 of file propertysetinfo.hxx.

Constructor & Destructor Documentation

◆ PropertySetInfo() [1/2]

comphelper::PropertySetInfo::PropertySetInfo ( )
noexcept

◆ PropertySetInfo() [2/2]

comphelper::PropertySetInfo::PropertySetInfo ( o3tl::span< const PropertyMapEntry pMap)
noexcept

◆ ~PropertySetInfo()

virtual comphelper::PropertySetInfo::~PropertySetInfo ( )
overridevirtualnoexcept

Member Function Documentation

◆ add()

void PropertySetInfo::add ( o3tl::span< PropertyMapEntry const >  pMap)
noexcept

adds an array of PropertyMapEntry to this instance.

The end is marked with a PropertyMapEntry where mpName equals NULL

Definition at line 54 of file propertysetinfo.cxx.

References maProperties.

◆ getProperties()

virtual css::uno::Sequence< css::beans::Property > SAL_CALL comphelper::PropertySetInfo::getProperties ( )
overridevirtual

◆ getPropertyByName()

virtual css::beans::Property SAL_CALL comphelper::PropertySetInfo::getPropertyByName ( const OUString &  aName)
overridevirtual

◆ getPropertyMap()

const PropertyMap & comphelper::PropertySetInfo::getPropertyMap ( ) const
inlinenoexcept

returns a stl map with all PropertyMapEntry pointer.

The key is the property name.

Definition at line 99 of file propertysetinfo.hxx.

◆ hasPropertyByName()

virtual sal_Bool SAL_CALL comphelper::PropertySetInfo::hasPropertyByName ( const OUString &  Name)
overridevirtual

◆ remove()

void PropertySetInfo::remove ( const OUString &  aName)
noexcept

removes an already added PropertyMapEntry which string in mpName equals to aName

Definition at line 72 of file propertysetinfo.cxx.

References aName, and maProperties.

Member Data Documentation

◆ maProperties

css::uno::Sequence< css::beans::Property > comphelper::PropertySetInfo::maProperties
private

Cache the value we return in getProperties because it is expensive to construct.

Definition at line 116 of file propertysetinfo.hxx.

◆ maPropertyMap

PropertyMap comphelper::PropertySetInfo::maPropertyMap
private

Definition at line 114 of file propertysetinfo.hxx.


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