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 :: ui ::

unpublished constants group ItemStyle
Usage Restrictions
not published
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:

  • ALIGN_LEFT
  • ALIGN_CENTER
  • ALIGN_RIGHT
Drawing:
  • DRAW_OUT3D
  • DRAW_IN3D
  • DRAW_FLAT

Since
OOo 2.0

Constants
ALIGN_LEFT specifies how the output of the item is aligned in the bounding box of the user interface element.  
ALIGN_CENTER specifies how the output of the item is aligned in the bounding box of the user interface element.  
ALIGN_RIGHT specifies how the output of the item is aligned in the bounding box of the user interface element.  
DRAW_OUT3D specifies how the implementation should draw the item.  
DRAW_IN3D specifies how the implementation should draw the item.  
DRAW_FLAT specifies how the implementation should draw the item.  
OWNER_DRAW specifies whether or not a item is displayed using an external function.  
AUTO_SIZE specifies whether or not the size of the item is set automatically by the parent user interface element.  
RADIO_CHECK determines whether the item unchecks neighbor entries which have also this style set.  
ICON specifies if an icon is placed on left side of the text, like an entry in a taskbar.  
DROP_DOWN specifies that the item supports a dropdown menu or toolbar for additional functions.  
REPEAT indicates that the item continues to execute the command while you click and hold the mouse button.  
DROPDOWN_ONLY indicates that the item only supports a dropdown menu or toolbar for additional functions. There is no function on the button itself.  
TEXT indicates if icon, text or text+icon is displayed for the item.  
Constants' Details
ALIGN_LEFT
const short ALIGN_LEFT = 1;
Description
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_CENTER
const short ALIGN_CENTER = 2;
Description
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_RIGHT
const short ALIGN_RIGHT = 3;
Description
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.

DRAW_OUT3D
const short DRAW_OUT3D = 4;
Description
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.

DRAW_IN3D
const short DRAW_IN3D = 8;
Description
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_FLAT
const short DRAW_FLAT = 12;
Description
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.

OWNER_DRAW
const short OWNER_DRAW = 16;
Description
specifies whether or not a item is displayed using an external function.

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

AUTO_SIZE
const short AUTO_SIZE = 32;
Description
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.

RADIO_CHECK
const short RADIO_CHECK = 64;
Description
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.

ICON
const short ICON = 128;
Description
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 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 )

DROP_DOWN
const short DROP_DOWN = 256;
Description
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.

REPEAT
const short REPEAT = 512;
Description
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.

DROPDOWN_ONLY
const short DROPDOWN_ONLY = 1024;
Description
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.

TEXT
const short TEXT = 2048;
Description
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 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 )

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.