PropertyHierarchy Service Reference

provides access to and information about properties and subproperties of an implementation. More...

import"PropertyHierarchy.idl";

Inheritance diagram for PropertyHierarchy:

Exported Interfaces
interface	com::sun::star::beans::XPropertySet
	provides access to and information about the immediate properties of an implementation. More...
interface	com::sun::star::beans::XMultiPropertySet
	provides access to and information about the immediate properties of an implementation. More...
interface	com::sun::star::beans::XHierarchicalPropertySet
	provides access to and information about the whole hierarchy of properties and subproperties of an implementation. More...
interface	com::sun::star::beans::XMultiHierarchicalPropertySet
	provides access to and information about the whole hierarchy of properties and subproperties of an implementation. More...

Additional Inherited Members
Public Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo	getPropertySetInfo ()
void	setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
	sets the value of the property with the specified name. More...
any	getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
void	addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	adds an XPropertyChangeListener to the specified property. More...
void	removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	removes an XPropertyChangeListener from the listener list. More...
void	addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	adds an XVetoableChangeListener to the specified property with the name PropertyName. More...
void	removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	removes an XVetoableChangeListener from the listener list. More...
Public Member Functions inherited from XInterface
any	queryInterface ([in] type aType)
	queries for a new interface to an existing UNO object. More...
void	acquire ()
	increases the reference counter by one. More...
void	release ()
	decreases the reference counter by one. More...
Public Member Functions inherited from XMultiPropertySet
com::sun::star::beans::XPropertySetInfo	getPropertySetInfo ()
void	setPropertyValues ([in] sequence< string > aPropertyNames, [in] sequence< any > aValues) raises ( com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
	sets the values to the properties with the specified names. More...
sequence< any >	getPropertyValues ([in] sequence< string > aPropertyNames)
void	addPropertiesChangeListener ([in] sequence< string > aPropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener xListener)
	adds an XPropertiesChangeListener to the specified property with the specified names. More...
void	removePropertiesChangeListener ([in] com::sun::star::beans::XPropertiesChangeListener xListener)
	removes an XPropertiesChangeListener from the listener list. More...
void	firePropertiesChangeEvent ([in] sequence< string > aPropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener xListener)
	fires a sequence of PropertyChangeEvents to the specified listener. More...
Public Member Functions inherited from XHierarchicalPropertySet
com::sun::star::beans::XHierarchicalPropertySetInfo	getHierarchicalPropertySetInfo ()
	retrieve information about the hierarchy of properties More...
void	setHierarchicalPropertyValue ([in] string aHierarchicalPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
	sets the value of the property with the specified nested name. More...
any	getHierarchicalPropertyValue ([in] string aHierarchicalPropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
Public Member Functions inherited from XMultiHierarchicalPropertySet
com::sun::star::beans::XHierarchicalPropertySetInfo	getHierarchicalPropertySetInfo ()
	retrieve information about the hierarchy of properties More...
void	setHierarchicalPropertyValues ([in] sequence< string > aHierarchicalPropertyNames, [in] sequence< any > Values) raises ( com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
	sets the values of the properties with the specified nested names. More...
sequence< any >	getHierarchicalPropertyValues ([in] sequence< string > aPropertyNames) raises ( com::sun::star::lang::IllegalArgumentException , com::sun::star::lang::WrappedTargetException )

Detailed Description

provides access to and information about properties and subproperties of an implementation.

Properties in a property set may be full-fledged objects that have properties themselves (and so on recursively), thereby forming a hierarchy of properties. This service describes such a hierarchy, and allows direct access even to subproperties.

See also

com::sun::star::beans::XProperty Properties of an implementation that are objects themselves will often implement com::sun::star::beans::XProperty to allow direct access to information about the object. If such objects have properties of their own, they should fully implement PropertyHierarchy again.

Exported Interfaces

com::sun::star::beans::XHierarchicalPropertySet

interface com::sun::star::beans::XHierarchicalPropertySet

provides access to and information about the whole hierarchy of properties and subproperties of an implementation.

com::sun::star::beans::XMultiHierarchicalPropertySet

interface com::sun::star::beans::XMultiHierarchicalPropertySet

provides access to and information about the whole hierarchy of properties and subproperties of an implementation.

This interface allows retrieving or setting multiple properties at once. Accesses are guaranteed to occur as single atomic operations even if multiple threads are accessing the object simultaneously.

com::sun::star::beans::XMultiPropertySet

interface com::sun::star::beans::XMultiPropertySet

provides access to and information about the immediate properties of an implementation.

This interface allows retrieving or setting multiple properties at once. Accesses are guaranteed to occur as single atomic operations even if multiple threads are accessing the object simultaneously.

com::sun::star::beans::XPropertySet

interface com::sun::star::beans::XPropertySet

provides access to and information about the immediate properties of an implementation.

---

The documentation for this service was generated from the following file:

• com/sun/star/configuration/PropertyHierarchy.idl