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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com {  module sun {  module star {  module ui {
  22
  23 /**
  24     specifies styles which influence the appearance and the behavior of an
  25     user interface item.
  26
  27     <p>
  28     These styles are only valid if the item describes a toolbar or statusbar item.
  29     The style values can be combined with the OR operator. Styles which are not valid
  30     for an item will be ignored by the implementation.<br/>
  31     There are two styles where
  32     only one value is valid:
  33     Alignment:
  34     <ul>
  35         <li>ALIGN_LEFT</li>
  36         <li>ALIGN_CENTER</li>
  37         <li>ALIGN_RIGHT</li>
  38     </ul>
  39     Drawing:
  40     <ul>
  41         <li>DRAW_OUT3D</li>
  42         <li>DRAW_IN3D</li>
  43         <li>DRAW_FLAT</li>
  44     </ul>
  45     </p>
  46
  47     @since OOo 2.0
  48 */
  49 constants ItemStyle
  50 {
  51     /** specifies how the output of the item is aligned in the bounding box of
  52         the user interface element.
  53         <p>This style is only valid for an item which describes a statusbar item.
  54         Draw item with a left aligned output.</p>
  55     */
  56     const short ALIGN_LEFT   = 1;
  57
  58     /** specifies how the output of the item is aligned in the bounding box of
  59         the user interface element.
  60         <p>This style is only valid for an item which describes a statusbar item.
  61         Draw item with a centered aligned output.</p>
  62     */
  63     const short ALIGN_CENTER = 2;
  64
  65     /** specifies how the output of the item is aligned in the bounding box of
  66         the user interface element.
  67         <p>This style is only valid for an item which describes a statusbar item.
  68         Draw item with a right aligned output.</p>
  69     */
  70     const short ALIGN_RIGHT  = 3;
  71
  72     /** specifies how the implementation should draw the item.
  73         <p>This style is only valid for an item which describes a statusbar item.
  74         Draw item with an embossed 3D effect.</p>
  75     */
  76     const short DRAW_OUT3D   = 4;
  77
  78     /** specifies how the implementation should draw the item.
  79         <p>This style is only valid for an item which describes a statusbar item.
  80         Draw item with an impressed 3D effect.</p>
  81     */
  82     const short DRAW_IN3D    = 8;
  83
  84     /** specifies how the implementation should draw the item.
  85         <p>This style is only valid for an item which describes a statusbar item.
  86         Draw item without an 3D effect.</p>
  87     */
  88     const short DRAW_FLAT    = 12;
  89
  90     /** specifies whether or not an item is displayed using an external function.
  91         <p>This style is only valid if the item describes a statusbar item.</p>
  92     */
  93     const short OWNER_DRAW    = 16;
  94
  95     /** specifies whether or not the size of the item is set automatically by
  96         the parent user interface element.
  97         <p>This style is only valid if the item describes a toolbar or statusbar item.</p>
  98     */
  99     const short AUTO_SIZE     = 32;
 100
 101     /**  determines whether the item unchecks neighbor entries which have also this style set.
 102          <p>This style is only valid if the item describes a toolbar item.</p>
 103     */
 104     const short RADIO_CHECK   = 64;
 105
 106     /** specifies if an icon is placed on left side of the text, like an entry in a taskbar.
 107         <p>This style is only valid if the item describes a toolbar item and visible if
 108         style of the toolbar is set to symboltext.</p>
 109
 110         <p>This style can also be used for custom toolbars and menus, in a
 111         custom toolbar an item's Style setting can used to override the
 112         toolbar container setting, the style can be bitwise OR-ed with
 113         ::com::sun::star::ui::ItemStyle::TEXT to define text,
 114         text+icon or icon only is to be displayed. Similarly for menu items,
 115         an items Style can override the application setting to display either
 116         text or icon (note: for menu an icon only setting interpreted as
 117         icon+text)</p>
 118     */
 119     const short ICON          = 128;
 120
 121     /** specifies that the item supports a dropdown menu or toolbar for additional functions.
 122         <p>This style is only valid if the item describes a toolbar item.</p>
 123     */
 124     const short DROP_DOWN     = 256;
 125
 126     /** indicates that the item continues to execute the command while you click and hold
 127         the mouse button.
 128         <p>This style is only valid if the item describes a toolbar item.</p>
 129     */
 130     const short REPEAT        = 512;
 131
 132     /** indicates that the item only supports a dropdown menu or toolbar for
 133         additional functions. There is no function on the button itself.
 134         <p>This style is only valid if the item describes a toolbar item.</p>
 135     */
 136     const short DROPDOWN_ONLY = 1024;
 137     /** indicates if icon, text or text+icon is displayed for the item.
 138
 139         <p>This style can be used for custom toolbars and menus, in a custom
 140         toolbar an item's Style setting can used to override the toolbar
 141         container setting, the style can be bitwise OR-ed with
 142         com::sun::star::ui::ItemStyle::ICON to define text,
 143         text+icon or icon only is to be displayed. Similarly for menu items,
 144         an items Style can override the application setting to display either
 145         text or icon (note: for menu an icon only setting interpreted as
 146         icon+text)</p>
 147     */
 148     const short TEXT = 2048;
 149
 150     /** marks always visible element which can not be removed when statusbar
 151         width is not sufficient.
 152
 153         @since LibreOffice 6.1
 154     */
 155     const short MANDATORY = 4096;
 156 };
 157
 158 }; }; }; };
 159
 160 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */