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.
|
HasSecondaryButton |
detetrmines whether a secondary 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
|
SecondaryButtonId |
describes a unique id to associate with the primary button
|
PrimaryButtonImage |
describes a graphics to display at the primary button, if any.
|
SecondaryButtonImage |
describes a graphics to display at the primary 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
|
HelpURL
string HelpURL;
- Description
- specifies the URL to the help topic to be associated with the property
|
|
HasPrimaryButton
|
HasSecondaryButton
|
PrimaryButtonId
long 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.
|
|
SecondaryButtonId
long 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
|
|
PrimaryButtonImage
::com::sun::star::graphic::XGraphic PrimaryButtonImage;
- Description
- describes a graphics to display at the primary button, if any.
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
- HasPrimaryButton
|
|
SecondaryButtonImage
::com::sun::star::graphic::XGraphic SecondaryButtonImage;
- Description
- describes a graphics to display at the primary button, if any.
If no image for the secondary button is specified, but a secondary button is present,
the three dots will be displayed on the button.
- See also
- HasSecondaryButton
|
|
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, XPropertyHandler s 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
|
|
Copyright © 2003 Sun Microsystems, Inc.