LibreOffice
LibreOffice 24.2 SDK API Reference
|
describes a controller which can be used to browse and modify properties of form controls. More...
import"PropertyBrowserController.idl";
Exported Interfaces | |
interface | com::sun::star::frame::XController |
ensures the basic functionality for a controller. More... | |
interface | com::sun::star::beans::XPropertySet |
allows to access the properties of the object More... | |
interface | com::sun::star::beans::XFastPropertySet |
allows to access the properties via indices More... | |
interface | com::sun::star::beans::XMultiPropertySet |
allows to access more than one property of the object at the same time More... | |
Public Attributes | |
com::sun::star::beans::XPropertySet | IntrospectedObject |
contains the object to inspect. More... | |
string | CurrentPage |
controls the actually visible page. More... | |
Additional Inherited Members | |
Public Member Functions inherited from XController | |
void | attachFrame ([in] XFrame Frame) |
is called to attach the controller with its managing frame. More... | |
boolean | attachModel ([in] XModel Model) |
is called to attach the controller to a new model. More... | |
boolean | suspend ([in] boolean Suspend) |
is called to prepare the controller for closing the view More... | |
any | getViewData () |
provides access to current view status More... | |
void | restoreViewData ([in] any Data) |
restores the view status using the data gotten from a previous call to XController::getViewData(). More... | |
XModel | getModel () |
provides access to currently attached model More... | |
XFrame | getFrame () |
provides access to owner frame of this controller 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... | |
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 XFastPropertySet | |
void | setFastPropertyValue ([in] long nHandle, [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 to the property with the specified name. More... | |
any | getFastPropertyValue ([in] long nHandle) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
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... | |
describes a controller which can be used to browse and modify properties of form controls.
The controller can be plugged into a com::sun::star::frame::XFrame, and will provide a visual component for inspecting control properties. This means it allows to interactively control several aspects of a FormControlModel or DataAwareControlModel, such as it's data binding, it's layout, and it's event binding
For using a PropertyBrowserController, you need to
Note that nowadays, this service is only a legacy wrapper using the com::sun::star::inspection::ObjectInspector and the com::sun::star::form::inspection::DefaultFormComponentInspectorModel services, and knitting them together.
interface com::sun::star::beans::XFastPropertySet |
allows to access the properties via indices
interface com::sun::star::beans::XMultiPropertySet |
allows to access more than one property of the object at the same time
interface com::sun::star::beans::XPropertySet |
allows to access the properties of the object
interface com::sun::star::frame::XController |
ensures the basic functionality for a controller.
With supporting this interface, the component is able to operate in (and provide content for) a com::sun::star::frame::XFrame.
|
property |
controls the actually visible page.
The aspects of a DataAwareControlModel which can be browsed and modified using this controller can be separated into 3 groups: common aspects, data-awareness related aspects, and bound events.
The appearance of the visual component created by the controller is that 3 tab pages, one for each group, are displayed (of course if the control does not support any aspects of a given group, the group is omitted).
With this property, it can be controller which page is currently active.
Valid values are (this list may be extended in the future):
|
property |
contains the object to inspect.
Changing this property from outside causes the controller to update its view with the data of the new object