Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

:: com :: sun :: star :: inspection ::

interface XPropertyControl
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.  
Methods' Details
isModified
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
notifyModifiedValue
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
Attributes' Details
ControlType
[ readonly ] short ControlType;
Description
denotes the type of the control, as one of the PropertyControlType constants
Value
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.
ValueType
[ readonly ] type ValueType;
Description
denotes the value type of the control.
See also
Value
ControlContext
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.

ControlWindow
[ readonly ] ::com::sun::star::awt::XWindow ControlWindow;
Description
denotes the window which is the real UI representation of the property control.

The ObjectInspector will automatically position and size this control as needed, care for its Z-order, and so on.

This Window must not be NULL, else the whole control is not usable.
Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

The ASF

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The ASF logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.