LibreOffice
LibreOffice 24.2 SDK API Reference
Variables
com::sun::star::ui::ItemStyle Constant Group Reference

specifies styles which influence the appearance and the behavior of an user interface item. More...

Variables

const short ALIGN_LEFT = 1
 specifies how the output of the item is aligned in the bounding box of the user interface element. More...
 
const short ALIGN_CENTER = 2
 specifies how the output of the item is aligned in the bounding box of the user interface element. More...
 
const short ALIGN_RIGHT = 3
 specifies how the output of the item is aligned in the bounding box of the user interface element. More...
 
const short DRAW_OUT3D = 4
 specifies how the implementation should draw the item. More...
 
const short DRAW_IN3D = 8
 specifies how the implementation should draw the item. More...
 
const short DRAW_FLAT = 12
 specifies how the implementation should draw the item. More...
 
const short OWNER_DRAW = 16
 specifies whether or not an item is displayed using an external function. More...
 
const short AUTO_SIZE = 32
 specifies whether or not the size of the item is set automatically by the parent user interface element. More...
 
const short RADIO_CHECK = 64
 determines whether the item unchecks neighbor entries which have also this style set. More...
 
const short ICON = 128
 specifies if an icon is placed on left side of the text, like an entry in a taskbar. More...
 
const short DROP_DOWN = 256
 specifies that the item supports a dropdown menu or toolbar for additional functions. More...
 
const short REPEAT = 512
 indicates that the item continues to execute the command while you click and hold the mouse button. More...
 
const short DROPDOWN_ONLY = 1024
 indicates that the item only supports a dropdown menu or toolbar for additional functions. More...
 
const short TEXT = 2048
 indicates if icon, text or text+icon is displayed for the item. More...
 
const short MANDATORY = 4096
 marks always visible element which can not be removed when statusbar width is not sufficient. More...
 

Detailed Description

specifies styles which influence the appearance and the behavior of an user interface item.

These styles are only valid if the item describes a toolbar or statusbar item. The style values can be combined with the OR operator. Styles which are not valid for an item will be ignored by the implementation.
There are two styles where only one value is valid: Alignment:

Drawing:

Since
OOo 2.0

Variable Documentation

◆ ALIGN_CENTER

const short ALIGN_CENTER = 2

specifies how the output of the item is aligned in the bounding box of the user interface element.

This style is only valid for an item which describes a statusbar item. Draw item with a centered aligned output.

◆ ALIGN_LEFT

const short ALIGN_LEFT = 1

specifies how the output of the item is aligned in the bounding box of the user interface element.

This style is only valid for an item which describes a statusbar item. Draw item with a left aligned output.

◆ ALIGN_RIGHT

const short ALIGN_RIGHT = 3

specifies how the output of the item is aligned in the bounding box of the user interface element.

This style is only valid for an item which describes a statusbar item. Draw item with a right aligned output.

◆ AUTO_SIZE

const short AUTO_SIZE = 32

specifies whether or not the size of the item is set automatically by the parent user interface element.

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

◆ DRAW_FLAT

const short DRAW_FLAT = 12

specifies how the implementation should draw the item.

This style is only valid for an item which describes a statusbar item. Draw item without an 3D effect.

◆ DRAW_IN3D

const short DRAW_IN3D = 8

specifies how the implementation should draw the item.

This style is only valid for an item which describes a statusbar item. Draw item with an impressed 3D effect.

◆ DRAW_OUT3D

const short DRAW_OUT3D = 4

specifies how the implementation should draw the item.

This style is only valid for an item which describes a statusbar item. Draw item with an embossed 3D effect.

◆ DROP_DOWN

const short DROP_DOWN = 256

specifies that the item supports a dropdown menu or toolbar for additional functions.

This style is only valid if the item describes a toolbar item.

◆ DROPDOWN_ONLY

const short DROPDOWN_ONLY = 1024

indicates that the item only supports a dropdown menu or toolbar for additional functions.

There is no function on the button itself.

This style is only valid if the item describes a toolbar item.

◆ ICON

const short ICON = 128

specifies if an icon is placed on left side of the text, like an entry in a taskbar.

This style is only valid if the item describes a toolbar item and visible if style of the toolbar is set to symboltext.

This style can also be used for custom toolbars and menus, in a custom toolbar an item's Style setting can used to override the toolbar container setting, the style can be bitwise OR-ed with com::sun::star::ui::ItemStyle::TEXT to define text, text+icon or icon only is to be displayed. Similarly for menu items, an items Style can override the application setting to display either text or icon (note: for menu an icon only setting interpreted as icon+text)

◆ MANDATORY

const short MANDATORY = 4096

marks always visible element which can not be removed when statusbar width is not sufficient.

Since
LibreOffice 6.1

◆ OWNER_DRAW

const short OWNER_DRAW = 16

specifies whether or not an item is displayed using an external function.

This style is only valid if the item describes a statusbar item.

◆ RADIO_CHECK

const short RADIO_CHECK = 64

determines whether the item unchecks neighbor entries which have also this style set.

This style is only valid if the item describes a toolbar item.

◆ REPEAT

const short REPEAT = 512

indicates that the item continues to execute the command while you click and hold the mouse button.

This style is only valid if the item describes a toolbar item.

◆ TEXT

const short TEXT = 2048

indicates if icon, text or text+icon is displayed for the item.

This style can be used for custom toolbars and menus, in a custom toolbar an item's Style setting can used to override the toolbar container setting, the style can be bitwise OR-ed with com::sun::star::ui::ItemStyle::ICON to define text, text+icon or icon only is to be displayed. Similarly for menu items, an items Style can override the application setting to display either text or icon (note: for menu an icon only setting interpreted as icon+text)