include/vcl/vclenum.hxx

   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 #ifndef INCLUDED_VCL_VCLENUM_HXX
  21 #define INCLUDED_VCL_VCLENUM_HXX
  22
  23 #include <sal/types.h>
  24 #include <o3tl/typed_flags_set.hxx>
  25
  26 enum class SelectionMode { NONE, Single, Range, Multiple };
  27
  28 enum class TimeFieldFormat : sal_Int32 { F_NONE, F_SEC, F_SEC_CS };
  29
  30 enum class MenuItemType { DONTKNOW, STRING, IMAGE, STRINGIMAGE, SEPARATOR };
  31
  32 enum class MenuItemBits : sal_Int16
  33 {
  34     NONE                = 0x0000,
  35     CHECKABLE           = 0x0001,
  36     RADIOCHECK          = 0x0002,
  37     AUTOCHECK           = 0x0004,
  38     HELP                = 0x0010,
  39     POPUPSELECT         = 0x0020,
  40     // These have been said to be a preliminary (sic) solution since 2007
  41     NOSELECT            = 0x0040,
  42     ICON                = 0x0080,
  43     TEXT                = 0x0100,
  44 };
  45 namespace o3tl
  46 {
  47     template<> struct typed_flags<MenuItemBits> : is_typed_flags<MenuItemBits, 0x1f7> {};
  48 }
  49
  50 enum class ToolBoxItemBits
  51 {
  52     NONE                = 0x0000,
  53     CHECKABLE           = 0x0001,
  54     RADIOCHECK          = 0x0002,
  55     AUTOCHECK           = 0x0004,
  56     LEFT                = 0x0008,
  57     AUTOSIZE            = 0x0010,
  58     DROPDOWN            = 0x0020,
  59     REPEAT              = 0x0040,
  60     DROPDOWNONLY        = 0x00a0, // 0x0080 | DROPDOWN
  61     TEXT_ONLY           = 0x0100,
  62     ICON_ONLY           = 0x0200
  63 };
  64 namespace o3tl
  65 {
  66     template<> struct typed_flags<ToolBoxItemBits> : is_typed_flags<ToolBoxItemBits, 0x3ff> {};
  67 }
  68
  69 enum class ToolBoxItemType { DONTKNOW, BUTTON, SPACE, SEPARATOR, BREAK };
  70
  71 enum class ButtonType { SYMBOLONLY, TEXT, SYMBOLTEXT };
  72
  73 enum class SymbolType : sal_uInt16
  74 {
  75     DONTKNOW         = 0,
  76     IMAGE            = 1,
  77     ARROW_UP         = 2,
  78     ARROW_DOWN       = 3,
  79     ARROW_LEFT       = 4,
  80     ARROW_RIGHT      = 5,
  81     SPIN_UP          = 6,
  82     SPIN_DOWN        = 7,
  83     SPIN_LEFT        = 8,
  84     SPIN_RIGHT       = 9,
  85     FIRST            = 10,
  86     LAST             = 11,
  87     PREV             = 12,
  88     NEXT             = 13,
  89     PAGEUP           = 14,
  90     PAGEDOWN         = 15,
  91     PLAY             = 16,
  92     STOP             = 19,
  93     CLOSE            = 25,
  94     CHECKMARK        = 28,
  95     RADIOCHECKMARK   = 29,
  96     FLOAT            = 31,
  97     DOCK             = 32,
  98     HIDE             = 33,
  99     HELP             = 34,
 100     PLUS             = 35,
 101     MENU             = SymbolType::SPIN_DOWN
 102 };
 103
 104
 105 // Border styles for SetBorder()
 106 enum class WindowBorderStyle : sal_Int16
 107 {
 108     NONE              = 0x0000,
 109     NORMAL            = 0x0001,
 110     MONO              = 0x0002,
 111     MENU              = 0x0010,
 112     NWF               = 0x0020,
 113     NOBORDER          = 0x1000,
 114     REMOVEBORDER      = 0x2000,
 115     // Never use native border, used to ensure consistency of form controls
 116     // inside documents across platforms and in pdf/print output
 117     NONATIVEBORDER    = 0x4000,
 118 };
 119 namespace o3tl
 120 {
 121     template<> struct typed_flags<WindowBorderStyle> : is_typed_flags<WindowBorderStyle, 0x7033> {};
 122 }
 123
 124 enum class TimeFormat
 125 {
 126     Hour12, Hour24
 127 };
 128
 129 enum class ExtTimeFieldFormat
 130 {
 131     /** the first 4 of these are only used by base/dbaccess */
 132     Short24H, Long24H,
 133     Short12H, Long12H,
 134     ShortDuration, LongDuration
 135 };
 136
 137 enum class ExtDateFieldFormat
 138 {
 139     SystemShort, SystemShortYY, SystemShortYYYY,
 140     SystemLong,
 141     ShortDDMMYY, ShortMMDDYY, ShortYYMMDD,
 142     ShortDDMMYYYY, ShortMMDDYYYY, ShortYYYYMMDD,
 143     ShortYYMMDD_DIN5008, ShortYYYYMMDD_DIN5008,
 144     FORCE_EQUAL_SIZE=SAL_MAX_ENUM
 145 };
 146
 147 enum class HatchStyle
 148 {
 149     Single = 0,
 150     Double = 1,
 151     Triple = 2,
 152     FORCE_EQUAL_SIZE = SAL_MAX_ENUM
 153 };
 154
 155 enum class LineStyle
 156 {
 157     NONE = 0,
 158     Solid = 1,
 159     Dash = 2,
 160     FORCE_EQUAL_SIZE = SAL_MAX_ENUM
 161 };
 162
 163 typedef sal_uInt32 sal_UCS4;    // TODO: this should be moved to rtl
 164
 165 enum class OutDevSupportType
 166 {
 167     TransparentText     // if alpha in TextColor can be honored
 168 };
 169
 170 struct ItalicMatrix
 171 {
 172     double xx, xy, yx, yy;
 173     ItalicMatrix() : xx(1), xy(0), yx(0), yy(1) {}
 174 };
 175
 176 inline bool operator ==(const ItalicMatrix& a, const ItalicMatrix& b)
 177 {
 178     return a.xx == b.xx && a.xy == b.xy && a.yx == b.yx && a.yy == b.yy;
 179 }
 180
 181 inline bool operator !=(const ItalicMatrix& a, const ItalicMatrix& b)
 182 {
 183     return !(a == b);
 184 }
 185
 186 enum class VclAlign
 187 {
 188     Fill,
 189     Start,
 190     End,
 191     Center
 192 };
 193
 194 enum class VclPackType
 195 {
 196     Start = 0,
 197     End = 1,
 198     LAST = End
 199 };
 200
 201 enum class VclTaskBarStates {
 202     // Default, no specifics
 203     Normal,
 204     // Display some progress defined by SetTaskBarProgress
 205     Progress,
 206     // Something going on, but no exact progress scale
 207     ProgressUnknown,
 208     // Process on pause
 209     Paused,
 210     // Some error did happen
 211     Error
 212 };
 213
 214
 215 // Return Values from Dialog::Execute
 216 //!!! in case of changes adjust /basic/source/runtime/methods.cxx msgbox
 217
 218 enum VclResponseType
 219 {
 220     RET_CANCEL  = 0,
 221     RET_OK      = 1,
 222     RET_YES     = 2,
 223     RET_NO      = 3,
 224     RET_RETRY   = 4,
 225     RET_IGNORE  = 5,
 226     RET_CLOSE   = 7,
 227     RET_HELP    = 10
 228 };
 229
 230 enum class VclButtonsType
 231 {
 232     NONE,
 233     Ok,
 234     Close,
 235     Cancel,
 236     YesNo,
 237     OkCancel
 238 };
 239
 240 enum class VclMessageType
 241 {
 242     Info,
 243     Warning,
 244     Question,
 245     Error,
 246     Other
 247 };
 248
 249 enum class VclSizeGroupMode
 250 {
 251     NONE,
 252     Horizontal,
 253     Vertical,
 254     Both
 255 };
 256
 257 enum class VclPolicyType
 258 {
 259     ALWAYS,
 260     AUTOMATIC,
 261     NEVER
 262 };
 263
 264 enum class WizardButtonFlags : sal_Int16
 265 {
 266     NONE                = 0x0000,
 267     NEXT                = 0x0001,
 268     PREVIOUS            = 0x0002,
 269     FINISH              = 0x0004,
 270     CANCEL              = 0x0008,
 271     HELP                = 0x0010,
 272 };
 273
 274 namespace o3tl
 275 {
 276     template<> struct typed_flags<WizardButtonFlags> : is_typed_flags<WizardButtonFlags, 0x001f> {};
 277 }
 278
 279 // small, large, size32 force an exact toolbox size for proper alignment
 280 // DontCare will let the toolbox decide about its size
 281 enum class ToolBoxButtonSize
 282 {
 283     DontCare,
 284     Small,
 285     Large,
 286     Size32,
 287 };
 288
 289 // available button sizes for navigation bar
 290 enum class NavbarButtonSize
 291 {
 292     Auto,
 293     Small,
 294     Large,
 295     XLarge,
 296 };
 297
 298 namespace vcl
 299 {
 300     // The exact sizes of the icons in each size grouping are not necessarily
 301     // the exact size indicated by the name, but the upper limit of their size.
 302     // e.g. many Size26 icons are often 24x24px and only some 26x26px
 303     enum class ImageType
 304     {
 305         Size16,
 306         Size26,
 307         Size32,
 308         Small = Size16,
 309         LAST = Size32,
 310     };
 311 }
 312
 313 enum class DrawFrameStyle
 314 {
 315     NONE                     = 0x0000,
 316     In                       = 0x0001,
 317     Out                      = 0x0002,
 318     Group                    = 0x0003,
 319     DoubleIn                 = 0x0004,
 320     DoubleOut                = 0x0005,
 321     NWF                      = 0x0006,
 322 };
 323
 324 // Flags for DrawFrame()
 325 enum class DrawFrameFlags
 326 {
 327     NONE                     = 0x0000,
 328     Menu                     = 0x0010,
 329     WindowBorder             = 0x0020,
 330     BorderWindowBorder       = 0x0040,
 331     Mono                     = 0x1000,
 332     NoDraw                   = 0x8000,
 333 };
 334 namespace o3tl
 335 {
 336     template<> struct typed_flags<DrawFrameFlags> : is_typed_flags<DrawFrameFlags, 0x9070> {};
 337 }
 338
 339 enum class TxtAlign
 340 {
 341     Left,
 342     Center,
 343     Right
 344 };
 345
 346 enum class FloatWinPopupFlags
 347 {
 348     NONE                 = 0x000000,
 349     AllowTearOff         = 0x000001,
 350     Down                 = 0x000002,
 351     Up                   = 0x000004,
 352     Left                 = 0x000008,
 353     Right                = 0x000010,
 354     NoKeyClose           = 0x000020,
 355     AllMouseButtonClose  = 0x000040,
 356     NoAppFocusClose      = 0x000080,
 357     NewLevel             = 0x000100,
 358     NoMouseUpClose       = 0x000200,
 359     GrabFocus            = 0x000400,
 360     NoHorzPlacement      = 0x000800,
 361 };
 362 namespace o3tl
 363 {
 364     template<> struct typed_flags<FloatWinPopupFlags> : is_typed_flags<FloatWinPopupFlags, 0x0fff> {};
 365 }
 366
 367 // Flags for Window::Show()
 368 enum class ShowFlags
 369 {
 370     NONE                       = 0x0000,
 371     NoFocusChange              = 0x0002,
 372     NoActivate                 = 0x0004,
 373     ForegroundTask             = 0x0008,
 374 };
 375 namespace o3tl
 376 {
 377     template<> struct typed_flags<ShowFlags> : is_typed_flags<ShowFlags, 0x000e> {};
 378 }
 379
 380 enum class TrackingEventFlags
 381 {
 382     NONE           = 0x0000,
 383     Cancel         = 0x0001,
 384     Key            = 0x0002,
 385     Focus          = 0x0004,
 386     Repeat         = 0x0100,
 387     End            = 0x1000,
 388 };
 389 namespace o3tl
 390 {
 391     template<> struct typed_flags<TrackingEventFlags> : is_typed_flags<TrackingEventFlags, 0x1107> {};
 392 }
 393
 394 enum class ScrollType
 395 {
 396     DontKnow,
 397     LineUp, LineDown,
 398     PageUp, PageDown,
 399     Drag
 400 };
 401
 402 #endif // INCLUDED_VCL_VCLENUM_HXX
 403
 404 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */