Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

struct LineDescriptor
Description
describes the appearance of a line representing a single property in an ObjectInspector. Such a line consists of
  • a label with a human-readable name for the property
  • a control which is used for user interaction - i.e. it displays the current property value, and allows the user entering a new one.
  • (optional) one or two buttons which, when clicked, can start a more complex, interactive property value input. For instance, if you have a property whose value is a path in the file system, such a button could be used to let the user browse for a path with a usual file picker.
Since
OOo 2.0.3
See also
XPropertyHandler::describePropertyLine, PropertyLineElement

Elements' Summary
DisplayName denotes the human-readable display name used to present a property to the user  
Control denotes the control which should be used to represent the property at the UI.  
HelpURL specifies the URL to the help topic to be associated with the property  
HasPrimaryButton detetrmines whether a button exists which can be used for a more complex, interactive property value input.  
PrimaryButtonId describes a unique id to associate with the primary button  
PrimaryButtonImageURL describes the URL of an image to display on the primary button, if any.  
PrimaryButtonImage describes a graphics to display at the primary button, if any.  
HasSecondaryButton detetrmines whether a secondary button exists which can be used for a more complex, interactive property value input.  
SecondaryButtonId describes a unique id to associate with the primary button  
SecondaryButtonImageURL describes the URL of an image to display on the secondary button, if any.  
SecondaryButtonImage describes a graphics to display at the secondary button, if any.  
IndentLevel describes the indent level for the property  
Category describes the category into which the property should be sorted by the ObjectInspector.  
Elements' Details
DisplayName
string DisplayName;
Description
denotes the human-readable display name used to present a property to the user
Control
XPropertyControl Control;
Description
denotes the control which should be used to represent the property at the UI.
See also
XPropertyControlFactory
HelpURL
string HelpURL;
Description
specifies the URL to the help topic to be associated with the property
HasPrimaryButton
boolean HasPrimaryButton;
Description
detetrmines whether a button exists which can be used for a more complex, interactive property value input.

If no image for the primary button is specified, but a primary button is present, the three dots will be displayed on the button.

See also
XPropertyHandler::onInteractivePropertySelection, HasSecondaryButton, PrimaryButtonImageURL, PrimaryButtonImage
PrimaryButtonId
string PrimaryButtonId;
Description
describes a unique id to associate with the primary button

In OpenOffice.org, UI elements sometimes require a so-called UniqueID, which can be used to uniquely (within the whole application) identify this UI element. For instance, automating the OpenOffice.org UI via a dedicated separate application ("TestTool") requires such IDs.

If a primary button exists for a property's UI representation (HasPrimaryButton), it gets the ID specified herein.

PrimaryButtonImageURL
string PrimaryButtonImageURL;
Description
describes the URL of an image to display on the primary button, if any.

This URL will be used to obtain an actual ::com::sun::star::graphic::XGraphic object from an ::com::sun::star::graphic::GraphicProvider.

The property will be ignored if HasPrimaryButton is false.

If you need to specify a graphic which does not have an URL, but is available as ::com::sun::star::graphic::XGraphic only, then you must leave PrimaryButtonImageURL empty, and use the PrimaryButtonImage property.

See also
PrimaryButtonImage
PrimaryButtonImage
::com::sun::star::graphic::XGraphic PrimaryButtonImage;
Description
describes a graphics to display at the primary button, if any.

The property will be ignored if HasPrimaryButton is false, or if PrimaryButtonImageURL is a non-empty string.

See also
HasPrimaryButton, PrimaryButtonImageURL
HasSecondaryButton
boolean HasSecondaryButton;
Description
detetrmines whether a secondary button exists which can be used for a more complex, interactive property value input.

A secondary button subordinated to the primary button. If no primary button exists (HasPrimaryButton), this member is ignored.

See also
XPropertyHandler::onInteractivePropertySelection, HasSecondaryButton
SecondaryButtonId
string SecondaryButtonId;
Description
describes a unique id to associate with the primary button

If a secondary button exists for a property's UI representation (HasSecondaryButton), it gets the ID specified herein.

See also
PrimaryButtonId
SecondaryButtonImageURL
string SecondaryButtonImageURL;
Description
describes the URL of an image to display on the secondary button, if any.

This URL will be used to obtain an actual ::com::sun::star::graphic::XGraphic object from an ::com::sun::star::graphic::GraphicProvider.

The property will be ignored if HasSecondaryButton is false.

If you need to specify a graphic which does not have an URL, but is available as ::com::sun::star::graphic::XGraphic only, then you must leave SecondaryButtonImageURL empty, and use the SecondaryButtonImage property.

See also
SecondaryButtonImage
SecondaryButtonImage
::com::sun::star::graphic::XGraphic SecondaryButtonImage;
Description
describes a graphics to display at the secondary button, if any.

The property will be ignored if HasSecondaryButton is false, or if SecondaryButtonImageURL is a non-empty string.

See also
HasSecondaryButton, SecondaryButtonImageURL
IndentLevel
short IndentLevel;
Description
describes the indent level for the property

If a given property semantically depends on another one, the indent level can be used to visually represent this fact. For this, the dependent property's indent level would be one larger than the indent level of the other property.

Normally, XPropertyHandlers will set this to 0 when describing the UI for a normal property.

Category
string Category;
Description
describes the category into which the property should be sorted by the ObjectInspector.

An ObjectInspector can visually group properties which semantically belong together (for instance using tab pages). The decision which properties actually belong together is made using this Category attribute.

For your implementation of XPropertyHandler, it's recommended that you document the programmatic names used for property categories. This way, your handler might be re-used in different contexts, where only the XObjectInspectorModel needs to provide consistent UI names for the categories.

See also
XObjectInspectorModel::describeCategories
Top of Page

Apache Software Foundation

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

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