Interface XPropertyControl

Devguide

unpublished

interface XPropertyControl

Usage Restrictions: not published
Description: defines the interface for a single control in an ObjectInspector
Since: OOo 2.0.3

Methods' Summary
isModified	determines whether the control content is currently modified
notifyModifiedValue	notifies the context in which the control lives of the current control value, if this value is currently modified

Attributes' Summary
ControlType	denotes the type of the control, as one of the PropertyControlType constants
Value	denotes the current content of the control.
ValueType	denotes the value type of the control.
ControlContext	specifies the context of the control within the ObjectInspector.
ControlWindow	denotes the window which is the real UI representation of the property control.

boolean
isModified();

Description: determines whether the control content is currently modified; An XPropertyControl internally manages a flag indicating whether its content is modified. This flag is reset to false every time our ControlContext is notified of our current value. Also, the control implementation must set this flag to true if and only if the user changed the control content.
See also: notifyModifiedValue, ControlContext, XPropertyControlContext::valueChanged

void
notifyModifiedValue();

Description: notifies the context in which the control lives of the current control value, if this value is currently modified
See also: isModified, ControlContext, XPropertyControlListener::valueChanged

[ readonly ] short ControlType; Description denotes the type of the control, as one of the PropertyControlType constants

any Value set raises (::com::sun::star::beans::IllegalTypeException); Description denotes the current content of the control. At every point in time, this value is either void, or of the type described by ValueType. Throws com::sun::star::beans::IllegalTypeException if an attempt is made to set a value which is not void and whose type does not equal ValueType.

[ readonly ] type ValueType; Description denotes the value type of the control. See also Value

XPropertyControlContext ControlContext; Description specifies the context of the control within the ObjectInspector. The property control should actively notify its state changes to the context. In particular, changes in the focus and the value of the control must be notified.