Methods' Details |
enablePropertyUI
void |
enablePropertyUI( |
[in] string |
PropertyName, |
| [in] boolean |
Enable ); |
- Description
- enables or disables all components belonging to the UI representation of a property
This is usually used by an XPropertyHandler if it handles properties,
where one does only make sense if another one has a certain value.
- Parameter PropertyName
- denotes the name of the property whose UI is to be enabled or disabled.
- Parameter Enable
- true if and only if the UI should be disabled, false otherwise.
|
|
enablePropertyUIElements
void |
enablePropertyUIElements( |
[in] string |
PropertyName, |
| [in] short |
Elements, |
| [in] boolean |
Enable ); |
- Description
- enables or disables the single elements which can be part of the UI representation of a property
Note that the complete UI for the property must be enabled in order for these settings to
be evaluated. That is, enablePropertyUIElements does not have any effect if
somebody previously disabled the complete UI for this property with enablePropertyUI.
- Parameter PropertyName
- the name of the property whose user interface elements are to be enabled or disabled
- Parameter Elements
- a combination of PropertyLineElement flags specifying which elements are to be
enabled or disabled.
Note that if you don't set a particular bit here (say, PropertyLineElement::PrimaryButton),
this does mean that this element's state is not affected by the call - it does
not mean that it is disabled.
- Parameter Enable
- true if the elements denoted by _nElements should be enabled, false if
they should be disabled.
|
|
rebuildPropertyUI
void |
rebuildPropertyUI( |
[in] string |
PropertyName ); |
- Description
- completely rebuilds the UI for the given property.
This method might be used by an XPropertyHandler if it wants to change the type
of control (see PropertyControlType) used to display a certain property.
The object inspector will then call describePropertyLine again, and update its UI accordingly.
Note that the property whose UI should be rebuilt must not necessarily be (though usually is)
in the responsibility of the handler which calls this method. The object inspector will look up the
handler with the responsibility for PropertyName and call its
XPropertyHandler::describePropertyLine
- Parameter PropertyName
- the name of the property whose UI is to be completely rebuilt.
|
|
showPropertyUI
void |
showPropertyUI( |
[in] string |
PropertyName ); |
- Description
- shows the UI for a given property
- Parameter PropertyName
- the name of the property whose UI is to be shown
|
|
hidePropertyUI
void |
hidePropertyUI( |
[in] string |
PropertyName ); |
- Description
- hides the UI for a given property
- Parameter PropertyName
- the name of the property whose UI is to be hidden
|
|
showCategory
|
getPropertyControl
- Description
- retrieves the control currently used to display a given property
- Parameter PropertyName
- the name of the property whose control should be retrieved
- Returns
- the XPropertyControl representing the given property, or NULL
if there is no such property control.
|
|
registerControlObserver
- Description
- registers an observer for all property controls
The given XPropertyControlObserver will be notified of all changes
in all property controls.
- Since
- OOo 2.2
- See also
- revokeControlObserver
|
|
revokeControlObserver
|
setHelpSectionText
- Description
- sets the text of the help section, if the object inspector contains
one.
- Throws
- NoSupportException
if the XObjectInspectorModel::HasHelpSection property
requires the help section to be unavailable.
- Since
- OOo 2.2
|
|
Copyright © 2012, 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.