Methods of Class OPropertyArrayHelper

Class

Index

Help

Methods of Class OPropertyArrayHelper

OPropertyArrayHelper

OPropertyArrayHelper(

::com::sun::star::beans::Property *	pProps,
sal_Int32	nElements,
sal_Bool	bSorted = sal_True ) throw();

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	NO

Summary

Create an object which supports the common property interfaces.

Parameters

pProps	array of properties The array pProps should be sorted.
nElements	is the number of properties in the pProps structure.
bSorted	indicates that the elements are sorted.

OPropertyArrayHelper

OPropertyArrayHelper(

const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::Property > &	aProps,
sal_Bool	bSorted = sal_True ) throw();

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	NO

Summary

Create an object which supports the common property interfaces.

Parameters

aProps	sequence of properties which are supported by this helper. The sequence aProps should be sorted.
bSorted	indicates that the elements are sorted.

getCount

sal_Int32 getCount() throw();

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	NO

Summary: Return the number of properties.

fillPropertyMembersByHandle

virtual sal_Bool fillPropertyMembersByHandle(

::rtl::OUString *	pPropName,
sal_Int16 *	pAttributes,
sal_Int32	nHandle );

virtual	abstract	const	volatile	template	static	inline	C-linkage
YES	NO	NO	NO	NO	NO	NO	NO

Summary

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

Parameters

nHandle

the 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 is only an indexed acces to the property array.
                   Otherwise it is a linear search through the array.

pPropName

is an out parameter filled with property name of the property with the
                       handle nHandle. May be NULL.

rAttributes

is an out parameter filled with attributes of the property with the
                       handle nHandle. May be NULL.

Return

True, if the handle exist, otherwise false.

getProperties

virtual ::com::sun::star::uno::Sequence< ::com::sun::star::beans::Property > getProperties(

void

);

virtual	abstract	const	volatile	template	static	inline	C-linkage
YES	NO	NO	NO	NO	NO	NO	NO

Summary: Return the sequence of properties. The sequence is sorted by name.

getPropertyByName

virtual ::com::sun::star::beans::Property getPropertyByName(

const ::rtl::OUString &	rPropertyName )
	throw( ::com::sun::star::beans::UnknownPropertyException );

virtual	abstract	const	volatile	template	static	inline	C-linkage
YES	NO	NO	NO	NO	NO	NO	NO

Summary

Return the property with the name rPropertyName.

Parameters

rPropertyName

the name of the property.

hasPropertyByName

virtual sal_Bool hasPropertyByName(

const ::rtl::OUString &

rPropertyName );

virtual	abstract	const	volatile	template	static	inline	C-linkage
YES	NO	NO	NO	NO	NO	NO	NO

Summary

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

Parameters

rPropertyName

the name of the property.

getHandleByName

virtual sal_Int32 getHandleByName(

const ::rtl::OUString &

rPropertyName );

virtual	abstract	const	volatile	template	static	inline	C-linkage
YES	NO	NO	NO	NO	NO	NO	NO

Summary

Return the handle of the property with the name rPropertyName. If the property does not exist -1 is returned.

Parameters

rPropertyName

the name of the property.

fillHandles

virtual sal_Int32 fillHandles(

sal_Int32 *	pHandles,
const ::com::sun::star::uno::Sequence< ::rtl::OUString > &	rPropNames );

virtual	abstract	const	volatile	template	static	inline	C-linkage
YES	NO	NO	NO	NO	NO	NO	NO

Summary: Fill the array with the handles of the properties.
Return: the handles of the names from the pHandles array. -1 indicates an unknown property name.

init

void init(

sal_Bool

bSorted ) throw();

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	NO

Top of Page