1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27 28#ifndef __com_sun_star_ui_ItemStyle_idl__ 29#define __com_sun_star_ui_ItemStyle_idl__ 30 31//============================================================================= 32 33module com { module sun { module star { module ui { 34 35/** 36 specifies styles which influence the appearance and the behavior of an 37 user interface item. 38 39 <p> 40 These styles are only valid if the item describes a toolbar or statusbar item. 41 The style values can be combined with the OR operator. Styles which are not valid 42 for an item will be ignored by the implementation.<br/> 43 There are two styles where 44 only one value is valid: 45 Alignment: 46 <ul> 47 <li>ALIGN_LEFT</li> 48 <li>ALIGN_CENTER</li> 49 <li>ALIGN_RIGHT</li> 50 </ul> 51 Drawing: 52 <ul> 53 <li>DRAW_OUT3D</li> 54 <li>DRAW_IN3D</li> 55 <li>DRAW_FLAT</li> 56 </ul> 57 </p> 58 59 @since OOo 2.0 60*/ 61constants ItemStyle 62{ 63 //------------------------------------------------------------------------- 64 /** specifies how the output of the item is aligned in the bounding box of 65 the user interface element. 66 <p>This style is only valid for an item which describes a statusbar item. 67 Draw item with a left aligned output.</p> 68 */ 69 const short ALIGN_LEFT = 1; 70 71 /** specifies how the output of the item is aligned in the bounding box of 72 the user interface element. 73 <p>This style is only valid for an item which describes a statusbar item. 74 Draw item with a centered aligned output.</p> 75 */ 76 const short ALIGN_CENTER = 2; 77 78 /** specifies how the output of the item is aligned in the bounding box of 79 the user interface element. 80 <p>This style is only valid for an item which describes a statusbar item. 81 Draw item with a right aligned output.</p> 82 */ 83 const short ALIGN_RIGHT = 3; 84 85 //------------------------------------------------------------------------- 86 /** specifies how the implementation should draw the item. 87 <p>This style is only valid for an item which describes a statusbar item. 88 Draw item with an embossed 3D effect.</p> 89 */ 90 const short DRAW_OUT3D = 4; 91 92 /** specifies how the implementation should draw the item. 93 <p>This style is only valid for an item which describes a statusbar item. 94 Draw item with an impressed 3D effect.</p> 95 */ 96 const short DRAW_IN3D = 8; 97 98 /** specifies how the implementation should draw the item. 99 <p>This style is only valid for an item which describes a statusbar item. 100 Draw item without an 3D effect.</p> 101 */ 102 const short DRAW_FLAT = 12; 103 104 //------------------------------------------------------------------------- 105 /** specifies whether or not a item is displayed using an external function. 106 <p>This style is only valid if the item describes a statusbar item.</p> 107 */ 108 const short OWNER_DRAW = 16; 109 110 //------------------------------------------------------------------------- 111 /** specifies whether or not the size of the item is set automatically by 112 the parent user interface element. 113 <p>This style is only valid if the item describes a toolbar or statusbar item.</p> 114 */ 115 const short AUTO_SIZE = 32; 116 117 //------------------------------------------------------------------------- 118 /** determines whether the item unchecks neighbor entries which have also this style set. 119 <p>This style is only valid if the item describes a toolbar item.</p> 120 */ 121 const short RADIO_CHECK = 64; 122 123 //------------------------------------------------------------------------- 124 /** specifies if an icon is placed on left side of the text, like an entry in a taskbar. 125 <p>This style is only valid if the item describes a toolbar item and visible if 126 style of the toolbar is set to symboltext.</p> 127 <p> 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 <member scope="::com::sun::star::ui::ItemStyle">TEXT</member> 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 ) </p> 128 */ 129 const short ICON = 128; 130 131 //------------------------------------------------------------------------- 132 /** specifies that the item supports a dropdown menu or toolbar for additional functions. 133 <p>This style is only valid if the item describes a toolbar item.</p> 134 */ 135 const short DROP_DOWN = 256; 136 137 //------------------------------------------------------------------------- 138 /** indicates that the item continues to execute the command while you click and hold 139 the mouse button. 140 <p>This style is only valid if the item describes a toolbar item.</p> 141 */ 142 const short REPEAT = 512; 143 144 //------------------------------------------------------------------------- 145 /** indicates that the item only supports a dropdown menu or toolbar for 146 additional functions. There is no function on the button itself. 147 <p>This style is only valid if the item describes a toolbar item.</p> 148 */ 149 const short DROPDOWN_ONLY = 1024; 150 /** indicates if icon, text or text+icon is displayed for the item. 151 <p> 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 <member scope="com::sun::star::ui::ItemStyle">ICON</member> 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 ) </p> 152 */ 153 const short TEXT = 2048; 154}; 155 156}; }; }; }; 157 158#endif 159