Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Services' Summary Interfaces' Summary Properties' Summary Services' Details Interfaces' Details Properties' Details

:: com :: sun :: star :: ui ::

unpublished service ItemDescriptor
Usage Restrictions
not published
Description
describes a user interface item that is part of a user interface element.

Common examples for such elements are:

  • menus
  • tool bars
  • status bars
No assumption is made about any graphical representation: You could have a menu or a toolbox working with the same item descriptor.

Since
OOo 2.0
Properties' Summary
short
Type		 specifies which type this item descriptor belongs to. 
string
Label		 the text of the user interface item.  
string
CommandURL		 contains the command URL which specifies which action should be accomplished.  
string
HelpURL		 contains the a URL that points to a help text.  
short
Style		 [ OPTIONAL ]
different styles which influence the appearance of the item and its behavior.  
short
Offset		 [ OPTIONAL ]
specifies the pixel distance by which the text of the item is shifted on the x-axis.  
::com::sun::star::container::XIndexAccess
ItemDescriptorContainer		 [ OPTIONAL ]
specifies an optional sub container.  
boolean
IsVisible		 [ OPTIONAL ]
specifies if this item is visible or not.  
short
Width		 [ OPTIONAL ]
specifies a pixel width for this item inside the user interface element.  
Properties' Details
Type
short Type;
Description
specifies which type this item descriptor belongs to.

See constant definition ItemType.
Label
string Label;
Description
the text of the user interface item.
CommandURL
string CommandURL;
Description
contains the command URL which specifies which action should be accomplished.
HelpURL
string HelpURL;
Description
contains the a URL that points to a help text.
Style
short Style;
Usage Restrictions
optional
Description
different styles which influence the appearance of the item and its behavior.

This property is only valid if the item describes a toolbar or statusbar item. See ItemStyle for more information about possible styles.
Offset
short Offset;
Usage Restrictions
optional
Description
specifies the pixel distance by which the text of the item is shifted on the x-axis.

This property is only valid if the item describes a statusbar item.
ItemDescriptorContainer
::com::sun::star::container::XIndexAccess ItemDescriptorContainer;
Usage Restrictions
optional
Description
specifies an optional sub container.

This property is valid for menus only. It can be used to define sub menus.
IsVisible
boolean IsVisible;
Usage Restrictions
optional
Description
specifies if this item is visible or not.

This property is only valid if the item describes a toolbar or statusbar item.
Width
short Width;
Usage Restrictions
optional
Description
specifies a pixel width for this item inside the user interface element.

This property is only valid if the item describes a toolbar or statusbar item.

 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.