LibreOffice
LibreOffice 5.0 SDK API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Exported Interfaces | List of all members
XMLFormsPropertyHandler Service Reference

implements a property handler for use with an com::sun::star::inspection::ObjectInspector which provides properties related to binding form control models to XForm bindings. More...

import "XMLFormsPropertyHandler.idl";

Inheritance diagram for XMLFormsPropertyHandler:
XPropertyHandler XComponent XInterface

Exported Interfaces

interface com::sun::star::inspection::XPropertyHandler
 
- Exported Interfaces inherited from XPropertyHandler
interface com::sun::star::lang::XComponent
 used for controlling resources acquired by the handler More...
 

Additional Inherited Members

- 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::Property
getSupportedProperties ()
 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...
 

Detailed Description

implements a property handler for use with an com::sun::star::inspection::ObjectInspector which provides properties related to binding form control models to XForm bindings.

The handler introduces new properties to choose an com::sun::star::xforms::XModel and a com::sun::star::xforms::Binding within this model. Additionally, it introduces properties which reflect the different facets of the binding (e.g. com::sun::star::xforms::Binding::BindingExpression), so they can be changed directly in the com::sun::star::inspection::ObjectInspector as if they were a property of the form component which is being inspected.

The handler expects a value named "ContextDocument" in the context in which it is created. That is, the com::sun::star::uno::XComponentContext used for creating the CellBindingPropertyHandler is examined for a value with this name. If the object in this value denotes a XML form document (indicated by supporting the com::sun::star::xforms::XFormsSupplier interface), this document is used to do XML binding related work.

See Also
com::sun::star::inspection::XPropertyHandler
com::sun::star::form::binding::BindableControlModel
com::sun::star::form::binding::ValueBinding
com::sun::star::xforms::Binding
com::sun::star::uno::XComponentContext::getValueByName

Exported Interfaces


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