LibreOffice
LibreOffice 24.2 SDK API Reference
List of all members
GenericPropertyHandler Service Reference

implements a general-purpose XPropertyHandler More...

import"GenericPropertyHandler.idl";

Inheritance diagram for GenericPropertyHandler:
XPropertyHandler XComponent XInterface

Additional Inherited Members

- Exported Interfaces inherited from XPropertyHandler
interface com::sun::star::lang::XComponent
 used for controlling resources acquired by the handler More...
 
- Public Member Functions inherited from XPropertyHandler
void inspect ([in] com::sun::star::uno::XInterface Component) raises ( com::sun::star::lang::NullPointerException )
 binds the property handler to a new component More...
 
any getPropertyValue ([in] string PropertyName) raises (::com::sun::star::beans::UnknownPropertyException)
 retrieves the current value of a property More...
 
void setPropertyValue ([in] string PropertyName, [in] any Value) raises (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::beans::PropertyVetoException)
 sets the value of a property More...
 
com::sun::star::beans::PropertyState getPropertyState ([in] string PropertyName) raises (::com::sun::star::beans::UnknownPropertyException)
 returns the state of a property More...
 
LineDescriptor describePropertyLine ([in] string PropertyName, [in] XPropertyControlFactory ControlFactory) raises (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::NullPointerException)
 describes the UI to be used to represent the property More...
 
any convertToPropertyValue ([in] string PropertyName, [in] any ControlValue) raises (::com::sun::star::beans::UnknownPropertyException)
 converts a given control-compatible value to a property value More...
 
any convertToControlValue ([in] string PropertyName, [in] any PropertyValue, [in] type ControlValueType) raises (::com::sun::star::beans::UnknownPropertyException)
 converts a given property value to a control-compatible value More...
 
void addPropertyChangeListener ([in] com::sun::star::beans::XPropertyChangeListener Listener) raises ( com::sun::star::lang::NullPointerException )
 registers a listener for notification about property value changes More...
 
void removePropertyChangeListener ([in] com::sun::star::beans::XPropertyChangeListener Listener)
 revokes a listener for notification about property value changes More...
 
sequence< com::sun::star::beans::PropertygetSupportedProperties ()
 returns the properties which the handler can handle More...
 
sequence< string > getSupersededProperties ()
 returns the properties which are to be superseded by this handler More...
 
sequence< string > getActuatingProperties ()
 retrieve the actuating properties which this handler is interested in More...
 
boolean isComposable ([in] string PropertyName) raises (::com::sun::star::beans::UnknownPropertyException)
 determines whether a given property, which the handler is responsible for, is composable. More...
 
::com::sun::star::inspection::InteractiveSelectionResult onInteractivePropertySelection ([in] string PropertyName, [in] boolean Primary, [out] any outData, [in] XObjectInspectorUI InspectorUI) raises (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::NullPointerException)
 called when a browse button belonging to a property UI representation has been clicked More...
 
void actuatingPropertyChanged ([in] string ActuatingPropertyName, [in] any NewValue, [in] any OldValue, [in] XObjectInspectorUI InspectorUI, [in] boolean FirstTimeInit) raises (::com::sun::star::lang::NullPointerException)
 updates the UI of dependent properties when the value of a certain actuating property changed More...
 
boolean suspend ([in] boolean Suspend)
 suspends the handler More...
 
- Public Member Functions inherited from XComponent
void dispose ()
 The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More...
 
void addEventListener ([in] XEventListener xListener)
 adds an event listener to the object. More...
 
void removeEventListener ([in] XEventListener aListener)
 removes an event listener 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...
 

Detailed Description

implements a general-purpose XPropertyHandler

The property handler implemented by this service will do an introspection on the provided components, and expose the properties obtained via XIntrospectionAccess::getProperties.

The handler will automatically determine the best type of property control to represent a certain property, depending on the property type. This includes, for example, list box controls to represent enumeration properties.

See also
XPropertyHandler
scom::sun::star::beans::XIntrospectionAccess
XPropertyControl
Since
OOo 2.0.3

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