Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.10

API

SDK

Tips ‘n’ Tricks

Miscellaneous


:: cppu ::

class OPropertyArrayHelper


Base Classes
IPropertyArrayHelper (public)
  |  
  +--OPropertyArrayHelper
Known Derived Classes
None.

virtual abstract interface template
YES NO NO NO
Summary
You can use this helper class to map a XPropertySet-Interface to a XFast- or a XMultiPropertySet interface.
File
propshlp.hxx

Public Members

Methods


OPropertyArrayHelper( ::com::sun::star::beans::Property * pProps, sal_Int32 nElements, sal_Bool bSorted = sal_True ) throw( );
Create an object which supports the common property interfaces.

OPropertyArrayHelper( const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::Property > & aProps, sal_Bool bSorted = sal_True ) throw( );
Create an object which supports the common property interfaces.
sal_Int32
getCount( ) const throw( );
Return the number of properties.
virtual sal_Bool
fillPropertyMembersByHandle( ::rtl::OUString * pPropName, sal_Int16 * pAttributes, sal_Int32 nHandle );
Return the property members Name and Attribute from the handle nHandle.
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::beans::Property >
getProperties( void );
Return the sequence of properties. The sequence is sorted by name.
virtual ::com::sun::star::beans::Property
getPropertyByName( const ::rtl::OUString & rPropertyName ) throw( ::com::sun::star::beans::UnknownPropertyException );
Return the property with the name rPropertyName.
virtual sal_Bool
hasPropertyByName( const ::rtl::OUString & rPropertyName );
Return true if the property with the name rPropertyName exist, otherwise false.
virtual sal_Int32
getHandleByName( const ::rtl::OUString & rPropertyName );
Return the handle of the property with the name rPropertyName. If the property does not exist -1 is returned.
virtual sal_Int32
fillHandles( sal_Int32 * pHandles, const ::com::sun::star::uno::Sequence< ::rtl::OUString > & rPropNames );
Fill the array with the handles of the properties.

Protected Members

Data

void * m_pReserved; reserved for future use. do not use.

Private Members

Methods

void
init( sal_Bool bSorted ) throw( );

Data

::com::sun::star::uno::Sequence< ::com::sun::star::beans::Property > aInfos; The sequence generstet from the pProperties array.
sal_Bool bRightOrdered; True, If the values of the handles are sorted in the same way as the names and the highest handle value is getCount() -1, otherwise false.

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.