UDK 3.2.7 C/C++ API Reference
Public Member Functions | Static Public Member Functions
cppu::IPropertyArrayHelper Class Reference

This interface is used by the OPropertyHelper, to access the property description. More...

#include <propshlp.hxx>

Inheritance diagram for cppu::IPropertyArrayHelper:
cppu::OPropertyArrayHelper

List of all members.

Public Member Functions

virtual ~IPropertyArrayHelper ()
 Following the rule, the first virtual method implies a virtual destructor.
virtual sal_Bool fillPropertyMembersByHandle (::rtl::OUString *pPropName, sal_Int16 *pAttributes, sal_Int32 nHandle)=0
 Return the property members Name and Attribute from the handle nHandle.
virtual
::com::sun::star::uno::Sequence
< ::com::sun::star::beans::Property > 
getProperties (void)=0
 Return the sequence of properties.
virtual
::com::sun::star::beans::Property 
getPropertyByName (const ::rtl::OUString &rPropertyName)=0 throw (::com::sun::star::beans::UnknownPropertyException)
 Return the property with the name rPropertyName.
virtual sal_Bool hasPropertyByName (const ::rtl::OUString &rPropertyName)=0
 Return true if the property with the name rPropertyName exist, otherwise false.
virtual sal_Int32 getHandleByName (const ::rtl::OUString &rPropertyName)=0
 Return the handle of the property with the name rPropertyName.
virtual sal_Int32 fillHandles (sal_Int32 *pHandles, const ::com::sun::star::uno::Sequence< ::rtl::OUString > &rPropNames)=0
 Fill the array with the handles of the properties.

Static Public Member Functions

static void * operator new (size_t nSize) throw ()
static void operator delete (void *pMem) throw ()
static void * operator new (size_t, void *pMem) throw ()
static void operator delete (void *, void *) throw ()

Detailed Description

This interface is used by the OPropertyHelper, to access the property description.


Constructor & Destructor Documentation

virtual cppu::IPropertyArrayHelper::~IPropertyArrayHelper ( ) [virtual]

Following the rule, the first virtual method implies a virtual destructor.


Member Function Documentation

virtual sal_Int32 cppu::IPropertyArrayHelper::fillHandles ( sal_Int32 *  pHandles,
const ::com::sun::star::uno::Sequence< ::rtl::OUString > &  rPropNames 
) [pure virtual]

Fill the array with the handles of the properties.

Returns:
the handles of the names from the pHandles array. -1 indicates an unknown property name.

Implemented in cppu::OPropertyArrayHelper.

virtual sal_Bool cppu::IPropertyArrayHelper::fillPropertyMembersByHandle ( ::rtl::OUString pPropName,
sal_Int16 *  pAttributes,
sal_Int32  nHandle 
) [pure virtual]

Return the property members Name and Attribute from the handle nHandle.

Parameters:
nHandlethe handle of a property. If the values of the handles are sorted in the same way as the names and the highest handle value is getCount() -1, than it must be an indexed acces to the property array.
pPropNameis an out parameter filled with property name of the property with the handle nHandle. May be NULL.
pAttributesis an out parameter filled with attributes of the property with the handle nHandle. May be NULL.
Returns:
True, if the handle exist, otherwise false.

Implemented in cppu::OPropertyArrayHelper.

virtual sal_Int32 cppu::IPropertyArrayHelper::getHandleByName ( const ::rtl::OUString rPropertyName) [pure virtual]

Return the handle of the property with the name rPropertyName.

If the property does not exist -1 is returned.

Parameters:
rPropertyNamethe name of the property.

Implemented in cppu::OPropertyArrayHelper.

virtual ::com::sun::star::uno::Sequence< ::com::sun::star::beans::Property > cppu::IPropertyArrayHelper::getProperties ( void  ) [pure virtual]

Return the sequence of properties.

The sequence is sorted by name.

Implemented in cppu::OPropertyArrayHelper.

virtual ::com::sun::star::beans::Property cppu::IPropertyArrayHelper::getPropertyByName ( const ::rtl::OUString rPropertyName) throw (::com::sun::star::beans::UnknownPropertyException) [pure virtual]

Return the property with the name rPropertyName.

Parameters:
rPropertyNamethe name of the property.
Exceptions:
UnknownPropertyExceptionthrown if the property name is unknown.

Implemented in cppu::OPropertyArrayHelper.

virtual sal_Bool cppu::IPropertyArrayHelper::hasPropertyByName ( const ::rtl::OUString rPropertyName) [pure virtual]

Return true if the property with the name rPropertyName exist, otherwise false.

Parameters:
rPropertyNamethe name of the property.

Implemented in cppu::OPropertyArrayHelper.

static void cppu::IPropertyArrayHelper::operator delete ( void *  ,
void *   
) throw () [inline, static]
static void cppu::IPropertyArrayHelper::operator delete ( void *  pMem) throw () [inline, static]
static void* cppu::IPropertyArrayHelper::operator new ( size_t  nSize) throw () [inline, static]
static void* cppu::IPropertyArrayHelper::operator new ( size_t  ,
void *  pMem 
) throw () [inline, static]

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines