offapi/com/sun/star/ui/ItemStyle.idl

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