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 };
 116 namespace o3tl
 117 {
 118     template<> struct typed_flags<WindowBorderStyle> : is_typed_flags<WindowBorderStyle, 0x3033> {};
 119 }
 120
 121 enum class TimeFormat
 122 {
 123     Hour12, Hour24
 124 };
 125
 126 enum class ExtTimeFieldFormat
 127 {
 128     /** the first 4 of these are only used by base/dbaccess */
 129     Short24H, Long24H,
 130     Short12H, Long12H,
 131     ShortDuration, LongDuration
 132 };
 133
 134 enum class ExtDateFieldFormat
 135 {
 136     SystemShort, SystemShortYY, SystemShortYYYY,
 137     SystemLong,
 138     ShortDDMMYY, ShortMMDDYY, ShortYYMMDD,
 139     ShortDDMMYYYY, ShortMMDDYYYY, ShortYYYYMMDD,
 140     ShortYYMMDD_DIN5008, ShortYYYYMMDD_DIN5008,
 141     FORCE_EQUAL_SIZE=SAL_MAX_ENUM
 142 };
 143
 144 enum class HatchStyle
 145 {
 146     Single = 0,
 147     Double = 1,
 148     Triple = 2,
 149     FORCE_EQUAL_SIZE = SAL_MAX_ENUM
 150 };
 151
 152 enum class LineStyle
 153 {
 154     NONE = 0,
 155     Solid = 1,
 156     Dash = 2,
 157     FORCE_EQUAL_SIZE = SAL_MAX_ENUM
 158 };
 159
 160 typedef sal_uInt32 sal_UCS4;    // TODO: this should be moved to rtl
 161
 162 enum class OutDevSupportType
 163 {
 164     TransparentRect,
 165     TransparentText     // if alpha in TextColor can be honored
 166 };
 167
 168 struct ItalicMatrix
 169 {
 170     double xx, xy, yx, yy;
 171     ItalicMatrix() : xx(1), xy(0), yx(0), yy(1) {}
 172 };
 173
 174 inline bool operator ==(const ItalicMatrix& a, const ItalicMatrix& b)
 175 {
 176     return a.xx == b.xx && a.xy == b.xy && a.yx == b.yx && a.yy == b.yy;
 177 }
 178
 179 inline bool operator !=(const ItalicMatrix& a, const ItalicMatrix& b)
 180 {
 181     return !(a == b);
 182 }
 183
 184 enum class VclAlign
 185 {
 186     Fill,
 187     Start,
 188     End,
 189     Center
 190 };
 191
 192 enum class VclPackType
 193 {
 194     Start = 0,
 195     End = 1,
 196     LAST = End
 197 };
 198
 199 // Return Values from Dialog::Execute
 200 //!!! in case of changes adjust /basic/source/runtime/methods.cxx msgbox
 201
 202 enum VclResponseType
 203 {
 204     RET_CANCEL  = 0,
 205     RET_OK      = 1,
 206     RET_YES     = 2,
 207     RET_NO      = 3,
 208     RET_RETRY   = 4,
 209     RET_IGNORE  = 5,
 210     RET_CLOSE   = 7,
 211     RET_HELP    = 10
 212 };
 213
 214 enum class VclButtonsType
 215 {
 216     NONE,
 217     Ok,
 218     Close,
 219     Cancel,
 220     YesNo,
 221     OkCancel
 222 };
 223
 224 enum class VclMessageType
 225 {
 226     Info,
 227     Warning,
 228     Question,
 229     Error,
 230     Other
 231 };
 232
 233 enum class VclSizeGroupMode
 234 {
 235     NONE,
 236     Horizontal,
 237     Vertical,
 238     Both
 239 };
 240
 241 enum class VclPolicyType
 242 {
 243     ALWAYS,
 244     AUTOMATIC,
 245     NEVER
 246 };
 247
 248 enum class WizardButtonFlags : sal_Int16
 249 {
 250     NONE                = 0x0000,
 251     NEXT                = 0x0001,
 252     PREVIOUS            = 0x0002,
 253     FINISH              = 0x0004,
 254     CANCEL              = 0x0008,
 255     HELP                = 0x0010,
 256 };
 257
 258 namespace o3tl
 259 {
 260     template<> struct typed_flags<WizardButtonFlags> : is_typed_flags<WizardButtonFlags, 0x001f> {};
 261 }
 262
 263 // small, large, size32 force an exact toolbox size for proper alignment
 264 // DontCare will let the toolbox decide about its size
 265 enum class ToolBoxButtonSize
 266 {
 267     DontCare,
 268     Small,
 269     Large,
 270     Size32,
 271 };
 272
 273 // available button sizes for navigation bar
 274 enum class NavbarButtonSize
 275 {
 276     Auto,
 277     Small,
 278     Large,
 279     XLarge,
 280 };
 281
 282 namespace vcl
 283 {
 284     // The exact sizes of the icons in each size grouping are not necessarily
 285     // the exact size indicated by the name, but the upper limit of their size.
 286     // e.g. many Size26 icons are often 24x24px and only some 26x26px
 287     enum class ImageType
 288     {
 289         Size16,
 290         Size26,
 291         Size32,
 292         Small = Size16,
 293         LAST = Size32,
 294     };
 295 }
 296
 297 enum class DrawFrameStyle
 298 {
 299     NONE                     = 0x0000,
 300     In                       = 0x0001,
 301     Out                      = 0x0002,
 302     Group                    = 0x0003,
 303     DoubleIn                 = 0x0004,
 304     DoubleOut                = 0x0005,
 305     NWF                      = 0x0006,
 306 };
 307
 308 // Flags for DrawFrame()
 309 enum class DrawFrameFlags
 310 {
 311     NONE                     = 0x0000,
 312     Menu                     = 0x0010,
 313     WindowBorder             = 0x0020,
 314     BorderWindowBorder       = 0x0040,
 315     Mono                     = 0x1000,
 316     NoDraw                   = 0x8000,
 317 };
 318 namespace o3tl
 319 {
 320     template<> struct typed_flags<DrawFrameFlags> : is_typed_flags<DrawFrameFlags, 0x9070> {};
 321 }
 322
 323 enum class TxtAlign
 324 {
 325     Left,
 326     Center,
 327     Right
 328 };
 329
 330 enum class FloatWinPopupFlags
 331 {
 332     NONE                 = 0x000000,
 333     AllowTearOff         = 0x000001,
 334     Down                 = 0x000002,
 335     Up                   = 0x000004,
 336     Left                 = 0x000008,
 337     Right                = 0x000010,
 338     NoKeyClose           = 0x000020,
 339     AllMouseButtonClose  = 0x000040,
 340     NoAppFocusClose      = 0x000080,
 341     NewLevel             = 0x000100,
 342     NoMouseUpClose       = 0x000200,
 343     GrabFocus            = 0x000400,
 344     NoHorzPlacement      = 0x000800,
 345 };
 346 namespace o3tl
 347 {
 348     template<> struct typed_flags<FloatWinPopupFlags> : is_typed_flags<FloatWinPopupFlags, 0x0fff> {};
 349 }
 350
 351 // Flags for Window::Show()
 352 enum class ShowFlags
 353 {
 354     NONE                       = 0x0000,
 355     NoFocusChange              = 0x0002,
 356     NoActivate                 = 0x0004,
 357     ForegroundTask             = 0x0008,
 358 };
 359 namespace o3tl
 360 {
 361     template<> struct typed_flags<ShowFlags> : is_typed_flags<ShowFlags, 0x000e> {};
 362 }
 363
 364 enum class TrackingEventFlags
 365 {
 366     NONE           = 0x0000,
 367     Cancel         = 0x0001,
 368     Key            = 0x0002,
 369     Focus          = 0x0004,
 370     Repeat         = 0x0100,
 371     End            = 0x1000,
 372 };
 373 namespace o3tl
 374 {
 375     template<> struct typed_flags<TrackingEventFlags> : is_typed_flags<TrackingEventFlags, 0x1107> {};
 376 }
 377
 378 enum class ScrollType
 379 {
 380     DontKnow,
 381     LineUp, LineDown,
 382     PageUp, PageDown,
 383     Drag
 384 };
 385
 386 #endif // INCLUDED_VCL_VCLENUM_HXX
 387
 388 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */