Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

:: com :: sun :: star :: inspection ::
unpublished | interface XObjectInspectorUI |
Usage Restrictions not published Description grants access to certain aspects of the user interface of an object inspector This interface is used as callback for XPropertyHandlers. As a consequence, methods operating on the UI for a property, and taking the name of this property, are tolerant against properties which do not exist. For instance, if a property handler tries to disable the UI for property `Foo`, but another handler has superseded this property, then the ObjectInspector will not have any UI for it. In this case, the call to `enablePropertyUI( "Foo" )` will simply be ignored. Since OOo 2.0.3

Methods' Summary
enablePropertyUI | enables or disables all components belonging to the UI representation of a property
enablePropertyUIElements | enables or disables the single elements which can be part of the UI representation of a property
rebuildPropertyUI | completely rebuilds the UI for the given property.
showPropertyUI | shows the UI for a given property
hidePropertyUI | hides the UI for a given property
showCategory | shows or hides all properties belonging to a given category
getPropertyControl | retrieves the control currently used to display a given property
registerControlObserver | registers an observer for all property controls
revokeControlObserver | revokes a previously registered control observer
setHelpSectionText | sets the text of the help section, if the object inspector contains one.

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
void
showCategory( | [in] string | Category,
| [in] boolean | Show );
Description shows or hides all properties belonging to a given category See also LineDescriptor::Category, XObjectInspectorModel::describeCategories
getPropertyControl
XPropertyControl
getPropertyControl( | [in] string | PropertyName );
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
void
registerControlObserver( | [in] XPropertyControlObserver | Observer );
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
void
revokeControlObserver( | [in] XPropertyControlObserver | Observer );
Description revokes a previously registered control observer Since OOo 2.2 See also registerControlObserver
setHelpSectionText
void
setHelpSectionText( | [in] string | HelpText )
raises( | ::com::sun::star::lang::NoSupportException );
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

Top of Page

Copyright © 2000, 2014 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.