LibreOffice
LibreOffice 6.4 SDK API Reference
Public Attributes | List of all members
ItemDescriptor Service Reference

describes a user interface item that is part of a user interface element. More...

import"ItemDescriptor.idl";

Public Attributes

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

Detailed Description

describes a user interface item that is part of a user interface element.

Common examples for such elements are:

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

Member Data Documentation

◆ CommandURL

string CommandURL
property

contains the command URL which specifies which action should be accomplished.

◆ HelpURL

string HelpURL
property

contains the a URL that points to a help text.

◆ IsVisible

boolean IsVisible
optionalproperty

specifies if this item is visible or not.

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

◆ ItemDescriptorContainer

com::sun::star::container::XIndexAccess ItemDescriptorContainer
optionalproperty

specifies an optional sub container.

This property is valid for menus only. It can be used to define sub menus.

◆ Label

string Label
property

the text of the user interface item.

◆ Offset

short Offset
optionalproperty

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.

◆ Style

short Style
optionalproperty

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.

◆ Type

short Type
property

specifies which type this item descriptor belongs to.

See constant definition ItemType.

◆ Width

short Width
optionalproperty

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.


The documentation for this service was generated from the following file: