interface/wx/defs.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/defs.h
   3 // Purpose:     interface of global functions
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows licence
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9
  10 // ----------------------------------------------------------------------------
  11 // enumerations
  12 // ----------------------------------------------------------------------------
  13
  14 /**
  15     Generic flags.
  16 */
  17 enum wxGeometryCentre
  18 {
  19     wxCENTRE                  = 0x0001,
  20     wxCENTER                  = wxCENTRE
  21 };
  22
  23 /**
  24     A generic orientation value.
  25 */
  26 enum wxOrientation
  27 {
  28     wxHORIZONTAL              = 0x0004,
  29     wxVERTICAL                = 0x0008,
  30
  31     /**
  32         A mask value to indicate both vertical and horizontal orientations.
  33     */
  34     wxBOTH                    = wxVERTICAL | wxHORIZONTAL,
  35
  36     /// A synonym for @c wxBOTH.
  37     wxORIENTATION_MASK        = wxBOTH
  38 };
  39
  40 /**
  41     A generic direction value.
  42 */
  43 enum wxDirection
  44 {
  45     wxLEFT                    = 0x0010,
  46     wxRIGHT                   = 0x0020,
  47     wxUP                      = 0x0040,
  48     wxDOWN                    = 0x0080,
  49
  50     wxTOP                     = wxUP,
  51     wxBOTTOM                  = wxDOWN,
  52
  53     wxNORTH                   = wxUP,
  54     wxSOUTH                   = wxDOWN,
  55     wxWEST                    = wxLEFT,
  56     wxEAST                    = wxRIGHT,
  57
  58     wxALL                     = (wxUP | wxDOWN | wxRIGHT | wxLEFT),
  59
  60     /** A mask to extract direction from the combination of flags. */
  61     wxDIRECTION_MASK           = wxALL
  62 };
  63
  64 /**
  65     Generic alignment values. Can be combined together.
  66 */
  67 enum wxAlignment
  68 {
  69     /**
  70         A value different from any valid alignment value.
  71
  72         Note that you shouldn't use 0 for this as it's the value of (valid)
  73         alignments wxALIGN_LEFT and wxALIGN_TOP.
  74
  75         @since 2.9.1
  76      */
  77     wxALIGN_INVALID           = -1,
  78
  79     wxALIGN_NOT               = 0x0000,
  80     wxALIGN_CENTER_HORIZONTAL = 0x0100,
  81     wxALIGN_CENTRE_HORIZONTAL = wxALIGN_CENTER_HORIZONTAL,
  82     wxALIGN_LEFT              = wxALIGN_NOT,
  83     wxALIGN_TOP               = wxALIGN_NOT,
  84     wxALIGN_RIGHT             = 0x0200,
  85     wxALIGN_BOTTOM            = 0x0400,
  86     wxALIGN_CENTER_VERTICAL   = 0x0800,
  87     wxALIGN_CENTRE_VERTICAL   = wxALIGN_CENTER_VERTICAL,
  88
  89     wxALIGN_CENTER            = (wxALIGN_CENTER_HORIZONTAL | wxALIGN_CENTER_VERTICAL),
  90     wxALIGN_CENTRE            = wxALIGN_CENTER,
  91
  92     /** A mask to extract alignment from the combination of flags. */
  93     wxALIGN_MASK              = 0x0f00
  94 };
  95
  96 /**
  97     Miscellaneous flags for wxSizer items.
  98 */
  99 enum wxSizerFlagBits
 100 {
 101     wxFIXED_MINSIZE                = 0x8000,
 102     wxRESERVE_SPACE_EVEN_IF_HIDDEN = 0x0002,
 103
 104     /*  a mask to extract wxSizerFlagBits from combination of flags */
 105     wxSIZER_FLAG_BITS_MASK         = 0x8002
 106 };
 107
 108 /**
 109     Generic stretch values.
 110 */
 111 enum wxStretch
 112 {
 113     wxSTRETCH_NOT             = 0x0000,
 114     wxSHRINK                  = 0x1000,
 115     wxGROW                    = 0x2000,
 116     wxEXPAND                  = wxGROW,
 117     wxSHAPED                  = 0x4000,
 118     wxTILE                    = wxSHAPED | wxFIXED_MINSIZE,
 119
 120     /*  a mask to extract stretch from the combination of flags */
 121     wxSTRETCH_MASK            = 0x7000 /* sans wxTILE */
 122 };
 123
 124 /**
 125     Border flags for wxWindow.
 126 */
 127 enum wxBorder
 128 {
 129     /**
 130         This is different from wxBORDER_NONE as by default the controls do have
 131         a border.
 132     */
 133     wxBORDER_DEFAULT = 0,
 134
 135     wxBORDER_NONE   = 0x00200000,
 136     wxBORDER_STATIC = 0x01000000,
 137     wxBORDER_SIMPLE = 0x02000000,
 138     wxBORDER_RAISED = 0x04000000,
 139     wxBORDER_SUNKEN = 0x08000000,
 140     wxBORDER_DOUBLE = 0x10000000, /* deprecated */
 141     wxBORDER_THEME  = wxBORDER_DOUBLE,
 142
 143     /*  a mask to extract border style from the combination of flags */
 144     wxBORDER_MASK   = 0x1f200000
 145 };
 146
 147 /*  ---------------------------------------------------------------------------- */
 148 /*  Possible SetSize flags */
 149 /*  ---------------------------------------------------------------------------- */
 150
 151 /*  Use internally-calculated width if -1 */
 152 #define wxSIZE_AUTO_WIDTH       0x0001
 153 /*  Use internally-calculated height if -1 */
 154 #define wxSIZE_AUTO_HEIGHT      0x0002
 155 /*  Use internally-calculated width and height if each is -1 */
 156 #define wxSIZE_AUTO             (wxSIZE_AUTO_WIDTH|wxSIZE_AUTO_HEIGHT)
 157 /*  Ignore missing (-1) dimensions (use existing). */
 158 /*  For readability only: test for wxSIZE_AUTO_WIDTH/HEIGHT in code. */
 159 #define wxSIZE_USE_EXISTING     0x0000
 160 /*  Allow -1 as a valid position */
 161 #define wxSIZE_ALLOW_MINUS_ONE  0x0004
 162 /*  Don't do parent client adjustments (for implementation only) */
 163 #define wxSIZE_NO_ADJUSTMENTS   0x0008
 164 /*  Change the window position even if it seems to be already correct */
 165 #define wxSIZE_FORCE            0x0010
 166 /*  Emit size event even if size didn't change */
 167 #define wxSIZE_FORCE_EVENT      0x0020
 168
 169 /*  ---------------------------------------------------------------------------- */
 170 /*  Window style flags */
 171 /*  ---------------------------------------------------------------------------- */
 172
 173 /*
 174  * Values are chosen so they can be |'ed in a bit list.
 175  * Some styles are used across more than one group,
 176  * so the values mustn't clash with others in the group.
 177  * Otherwise, numbers can be reused across groups.
 178  */
 179
 180 /*
 181     Summary of the bits used by various styles.
 182
 183     High word, containing styles which can be used with many windows:
 184
 185     +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
 186     |31|30|29|28|27|26|25|24|23|22|21|20|19|18|17|16|
 187     +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
 188       |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |
 189       |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  \_ wxFULL_REPAINT_ON_RESIZE
 190       |  |  |  |  |  |  |  |  |  |  |  |  |  |  \____ wxPOPUP_WINDOW
 191       |  |  |  |  |  |  |  |  |  |  |  |  |  \_______ wxWANTS_CHARS
 192       |  |  |  |  |  |  |  |  |  |  |  |  \__________ wxTAB_TRAVERSAL
 193       |  |  |  |  |  |  |  |  |  |  |  \_____________ wxTRANSPARENT_WINDOW
 194       |  |  |  |  |  |  |  |  |  |  \________________ wxBORDER_NONE
 195       |  |  |  |  |  |  |  |  |  \___________________ wxCLIP_CHILDREN
 196       |  |  |  |  |  |  |  |  \______________________ wxALWAYS_SHOW_SB
 197       |  |  |  |  |  |  |  \_________________________ wxBORDER_STATIC
 198       |  |  |  |  |  |  \____________________________ wxBORDER_SIMPLE
 199       |  |  |  |  |  \_______________________________ wxBORDER_RAISED
 200       |  |  |  |  \__________________________________ wxBORDER_SUNKEN
 201       |  |  |  \_____________________________________ wxBORDER_{DOUBLE,THEME}
 202       |  |  \________________________________________ wxCAPTION/wxCLIP_SIBLINGS
 203       |  \___________________________________________ wxHSCROLL
 204       \______________________________________________ wxVSCROLL
 205
 206
 207     Low word style bits is class-specific meaning that the same bit can have
 208     different meanings for different controls (e.g. 0x10 is wxCB_READONLY
 209     meaning that the control can't be modified for wxComboBox but wxLB_SORT
 210     meaning that the control should be kept sorted for wxListBox, while
 211     wxLB_SORT has a different value -- and this is just fine).
 212  */
 213
 214 /*
 215  * Window (Frame/dialog/subwindow/panel item) style flags
 216  */
 217 #define wxVSCROLL               0x80000000
 218 #define wxHSCROLL               0x40000000
 219 #define wxCAPTION               0x20000000
 220
 221 /*  New styles (border styles are now in their own enum) */
 222 #define wxDOUBLE_BORDER         wxBORDER_DOUBLE
 223 #define wxSUNKEN_BORDER         wxBORDER_SUNKEN
 224 #define wxRAISED_BORDER         wxBORDER_RAISED
 225 #define wxBORDER                wxBORDER_SIMPLE
 226 #define wxSIMPLE_BORDER         wxBORDER_SIMPLE
 227 #define wxSTATIC_BORDER         wxBORDER_STATIC
 228 #define wxNO_BORDER             wxBORDER_NONE
 229
 230 /*  wxALWAYS_SHOW_SB: instead of hiding the scrollbar when it is not needed, */
 231 /*  disable it - but still show (see also wxLB_ALWAYS_SB style) */
 232 /*  */
 233 /*  NB: as this style is only supported by wxUniversal and wxMSW so far */
 234 #define wxALWAYS_SHOW_SB        0x00800000
 235
 236 /*  Clip children when painting, which reduces flicker in e.g. frames and */
 237 /*  splitter windows, but can't be used in a panel where a static box must be */
 238 /*  'transparent' (panel paints the background for it) */
 239 #define wxCLIP_CHILDREN         0x00400000
 240
 241 /*  Note we're reusing the wxCAPTION style because we won't need captions */
 242 /*  for subwindows/controls */
 243 #define wxCLIP_SIBLINGS         0x20000000
 244
 245 #define wxTRANSPARENT_WINDOW    0x00100000
 246
 247 /*  Add this style to a panel to get tab traversal working outside of dialogs */
 248 /*  (on by default for wxPanel, wxDialog, wxScrolledWindow) */
 249 #define wxTAB_TRAVERSAL         0x00080000
 250
 251 /*  Add this style if the control wants to get all keyboard messages (under */
 252 /*  Windows, it won't normally get the dialog navigation key events) */
 253 #define wxWANTS_CHARS           0x00040000
 254
 255 /*  Make window retained (Motif only, see src/generic/scrolwing.cpp)
 256  *  This is non-zero only under wxMotif, to avoid a clash with wxPOPUP_WINDOW
 257  *  on other platforms
 258  */
 259
 260 #ifdef __WXMOTIF__
 261 #define wxRETAINED              0x00020000
 262 #else
 263 #define wxRETAINED              0x00000000
 264 #endif
 265 #define wxBACKINGSTORE          wxRETAINED
 266
 267 /*  set this flag to create a special popup window: it will be always shown on */
 268 /*  top of other windows, will capture the mouse and will be dismissed when the */
 269 /*  mouse is clicked outside of it or if it loses focus in any other way */
 270 #define wxPOPUP_WINDOW          0x00020000
 271
 272 /*  force a full repaint when the window is resized (instead of repainting just */
 273 /*  the invalidated area) */
 274 #define wxFULL_REPAINT_ON_RESIZE 0x00010000
 275
 276 /*  obsolete: now this is the default behaviour */
 277 /*  */
 278 /*  don't invalidate the whole window (resulting in a PAINT event) when the */
 279 /*  window is resized (currently, makes sense for wxMSW only) */
 280 #define wxNO_FULL_REPAINT_ON_RESIZE 0
 281
 282 /* A mask which can be used to filter (out) all wxWindow-specific styles.
 283  */
 284 #define wxWINDOW_STYLE_MASK     \
 285     (wxVSCROLL|wxHSCROLL|wxBORDER_MASK|wxALWAYS_SHOW_SB|wxCLIP_CHILDREN| \
 286      wxCLIP_SIBLINGS|wxTRANSPARENT_WINDOW|wxTAB_TRAVERSAL|wxWANTS_CHARS| \
 287      wxRETAINED|wxPOPUP_WINDOW|wxFULL_REPAINT_ON_RESIZE)
 288
 289 /*
 290  * Extra window style flags (use wxWS_EX prefix to make it clear that they
 291  * should be passed to wxWindow::SetExtraStyle(), not SetWindowStyle())
 292  */
 293
 294 /*  by default, TransferDataTo/FromWindow() only work on direct children of the */
 295 /*  window (compatible behaviour), set this flag to make them recursively */
 296 /*  descend into all subwindows */
 297 #define wxWS_EX_VALIDATE_RECURSIVELY    0x00000001
 298
 299 /*  wxCommandEvents and the objects of the derived classes are forwarded to the */
 300 /*  parent window and so on recursively by default. Using this flag for the */
 301 /*  given window allows to block this propagation at this window, i.e. prevent */
 302 /*  the events from being propagated further upwards. The dialogs have this */
 303 /*  flag on by default. */
 304 #define wxWS_EX_BLOCK_EVENTS            0x00000002
 305
 306 /*  don't use this window as an implicit parent for the other windows: this must */
 307 /*  be used with transient windows as otherwise there is the risk of creating a */
 308 /*  dialog/frame with this window as a parent which would lead to a crash if the */
 309 /*  parent is destroyed before the child */
 310 #define wxWS_EX_TRANSIENT               0x00000004
 311
 312 /*  don't paint the window background, we'll assume it will */
 313 /*  be done by a theming engine. This is not yet used but could */
 314 /*  possibly be made to work in the future, at least on Windows */
 315 #define wxWS_EX_THEMED_BACKGROUND       0x00000008
 316
 317 /*  this window should always process idle events */
 318 #define wxWS_EX_PROCESS_IDLE            0x00000010
 319
 320 /*  this window should always process UI update events */
 321 #define wxWS_EX_PROCESS_UI_UPDATES      0x00000020
 322
 323 /*  Draw the window in a metal theme on Mac */
 324 #define wxFRAME_EX_METAL                0x00000040
 325 #define wxDIALOG_EX_METAL               0x00000040
 326
 327 /*  Use this style to add a context-sensitive help to the window (currently for */
 328 /*  Win32 only and it doesn't work if wxMINIMIZE_BOX or wxMAXIMIZE_BOX are used) */
 329 #define wxWS_EX_CONTEXTHELP             0x00000080
 330
 331 /* synonyms for wxWS_EX_CONTEXTHELP for compatibility */
 332 #define wxFRAME_EX_CONTEXTHELP          wxWS_EX_CONTEXTHELP
 333 #define wxDIALOG_EX_CONTEXTHELP         wxWS_EX_CONTEXTHELP
 334
 335 /*  Create a window which is attachable to another top level window */
 336 #define wxFRAME_DRAWER          0x0020
 337
 338 /*
 339  * MDI parent frame style flags
 340  * Can overlap with some of the above.
 341  */
 342
 343 #define wxFRAME_NO_WINDOW_MENU  0x0100
 344
 345 /*
 346  * wxMenuBar style flags
 347  */
 348 /*  use native docking */
 349 #define wxMB_DOCKABLE       0x0001
 350
 351 /*
 352  * wxMenu style flags
 353  */
 354 #define wxMENU_TEAROFF      0x0001
 355
 356 /*
 357  * Apply to all panel items
 358  */
 359 #define wxCOLOURED          0x0800
 360 #define wxFIXED_LENGTH      0x0400
 361
 362 /*
 363  * Styles for wxListBox
 364  */
 365 #define wxLB_SORT           0x0010
 366 #define wxLB_SINGLE         0x0020
 367 #define wxLB_MULTIPLE       0x0040
 368 #define wxLB_EXTENDED       0x0080
 369 /*  wxLB_OWNERDRAW is Windows-only */
 370 #define wxLB_NEEDED_SB      0x0000
 371 #define wxLB_OWNERDRAW      0x0100
 372 #define wxLB_ALWAYS_SB      0x0200
 373 #define wxLB_NO_SB          0x0400
 374 #define wxLB_HSCROLL        wxHSCROLL
 375 /*  always show an entire number of rows */
 376 #define wxLB_INT_HEIGHT     0x0800
 377
 378 /*
 379  * wxComboBox style flags
 380  */
 381 #define wxCB_SIMPLE         0x0004
 382 #define wxCB_SORT           0x0008
 383 #define wxCB_READONLY       0x0010
 384 #define wxCB_DROPDOWN       0x0020
 385
 386 /*
 387  * wxRadioBox style flags
 388  */
 389 /*  should we number the items from left to right or from top to bottom in a 2d */
 390 /*  radiobox? */
 391 #define wxRA_LEFTTORIGHT    0x0001
 392 #define wxRA_TOPTOBOTTOM    0x0002
 393
 394 /*  New, more intuitive names to specify majorDim argument */
 395 #define wxRA_SPECIFY_COLS   wxHORIZONTAL
 396 #define wxRA_SPECIFY_ROWS   wxVERTICAL
 397
 398 /*  Old names for compatibility */
 399 #define wxRA_HORIZONTAL     wxHORIZONTAL
 400 #define wxRA_VERTICAL       wxVERTICAL
 401 #define wxRA_USE_CHECKBOX   0x0010 /* alternative native subcontrols (wxPalmOS) */
 402
 403 /*
 404  * wxRadioButton style flag
 405  */
 406 #define wxRB_GROUP          0x0004
 407 #define wxRB_SINGLE         0x0008
 408 #define wxRB_USE_CHECKBOX   0x0010 /* alternative native control (wxPalmOS) */
 409
 410 /*
 411  * wxScrollBar flags
 412  */
 413 #define wxSB_HORIZONTAL      wxHORIZONTAL
 414 #define wxSB_VERTICAL        wxVERTICAL
 415
 416 /*
 417  * wxSpinButton flags.
 418  * Note that a wxSpinCtrl is sometimes defined as a wxTextCtrl, and so the
 419  * flags shouldn't overlap with wxTextCtrl flags that can be used for a single
 420  * line controls (currently we reuse wxTE_CHARWRAP and wxTE_RICH2 neither of
 421  * which makes sense for them).
 422  */
 423 #define wxSP_HORIZONTAL       wxHORIZONTAL /*  4 */
 424 #define wxSP_VERTICAL         wxVERTICAL   /*  8 */
 425 #define wxSP_ARROW_KEYS       0x4000
 426 #define wxSP_WRAP             0x8000
 427
 428 /*
 429  * wxTabCtrl flags
 430  */
 431 #define wxTC_RIGHTJUSTIFY     0x0010
 432 #define wxTC_FIXEDWIDTH       0x0020
 433 #define wxTC_TOP              0x0000    /*  default */
 434 #define wxTC_LEFT             0x0020
 435 #define wxTC_RIGHT            0x0040
 436 #define wxTC_BOTTOM           0x0080
 437 #define wxTC_MULTILINE        0x0200    /* == wxNB_MULTILINE */
 438 #define wxTC_OWNERDRAW        0x0400
 439
 440 /*
 441  * wxStaticBitmap flags
 442  */
 443 #define wxBI_EXPAND           wxEXPAND
 444
 445 /*
 446  * wxStaticLine flags
 447  */
 448 #define wxLI_HORIZONTAL         wxHORIZONTAL
 449 #define wxLI_VERTICAL           wxVERTICAL
 450
 451
 452 /*
 453  * extended dialog specifiers. these values are stored in a different
 454  * flag and thus do not overlap with other style flags. note that these
 455  * values do not correspond to the return values of the dialogs (for
 456  * those values, look at the wxID_XXX defines).
 457  */
 458
 459 /*  wxCENTRE already defined as  0x00000001 */
 460 #define wxYES                   0x00000002
 461 #define wxOK                    0x00000004
 462 #define wxNO                    0x00000008
 463 #define wxYES_NO                (wxYES | wxNO)
 464 #define wxCANCEL                0x00000010
 465 #define wxAPPLY                 0x00000020
 466 #define wxCLOSE                 0x00000040
 467
 468 #define wxOK_DEFAULT            0x00000000  /* has no effect (default) */
 469 #define wxYES_DEFAULT           0x00000000  /* has no effect (default) */
 470 #define wxNO_DEFAULT            0x00000080  /* only valid with wxYES_NO */
 471 #define wxCANCEL_DEFAULT        0x80000000  /* only valid with wxCANCEL */
 472
 473 #define wxICON_EXCLAMATION      0x00000100
 474 #define wxICON_HAND             0x00000200
 475 #define wxICON_WARNING          wxICON_EXCLAMATION
 476 #define wxICON_ERROR            wxICON_HAND
 477 #define wxICON_QUESTION         0x00000400
 478 #define wxICON_INFORMATION      0x00000800
 479 #define wxICON_STOP             wxICON_HAND
 480 #define wxICON_ASTERISK         wxICON_INFORMATION
 481
 482 #define wxHELP                  0x00001000
 483 #define wxFORWARD               0x00002000
 484 #define wxBACKWARD              0x00004000
 485 #define wxRESET                 0x00008000
 486 #define wxMORE                  0x00010000
 487 #define wxSETUP                 0x00020000
 488 #define wxICON_NONE             0x00040000
 489
 490 #define wxICON_MASK \
 491     (wxICON_EXCLAMATION|wxICON_HAND|wxICON_QUESTION|wxICON_INFORMATION|wxICON_NONE)
 492
 493
 494 /*  symbolic constant used by all Find()-like functions returning positive */
 495 /*  integer on success as failure indicator */
 496 #define wxNOT_FOUND       (-1)
 497
 498 /**
 499     Background styles.
 500
 501     @see wxWindow::SetBackgroundStyle()
 502 */
 503 enum wxBackgroundStyle
 504 {
 505     /**
 506         Default background style value indicating that the background may be
 507         erased in the user-defined EVT_ERASE_BACKGROUND handler.
 508
 509         If no such handler is defined (or if it skips the event), the effect of
 510         this style is the same as wxBG_STYLE_SYSTEM. If an empty handler (@em
 511         not skipping the event) is defined, the effect is the same as
 512         wxBG_STYLE_PAINT, i.e. the background is not erased at all until
 513         EVT_PAINT handler is executed.
 514
 515         This is the only background style value for which erase background
 516         events are generated at all.
 517      */
 518     wxBG_STYLE_ERASE,
 519
 520     /**
 521         Use the default background, as determined by the system or the current
 522         theme.
 523
 524         If the window has been assigned a non-default background colour, it
 525         will be used for erasing its background. Otherwise the default
 526         background (which might be a gradient or a pattern) will be used.
 527
 528         EVT_ERASE_BACKGROUND event will not be generated at all for windows
 529         with this style.
 530      */
 531     wxBG_STYLE_SYSTEM,
 532
 533     /**
 534         Indicates that the background is only erased in the user-defined
 535         EVT_PAINT handler.
 536
 537         Using this style avoids flicker which would result from redrawing the
 538         background twice if the EVT_PAINT handler entirely overwrites it. It
 539         must not be used however if the paint handler leaves any parts of the
 540         window unpainted as their contents is then undetermined. Only use it if
 541         you repaint the whole window in your handler.
 542
 543         EVT_ERASE_BACKGROUND event will not be generated at all for windows
 544         with this style.
 545      */
 546     wxBG_STYLE_PAINT,
 547
 548     /* this style is deprecated and doesn't do anything, don't use */
 549     wxBG_STYLE_COLOUR,
 550
 551     /* this is a Mac-only style, don't use in portable code */
 552     wxBG_STYLE_TRANSPARENT,
 553
 554 };
 555
 556
 557 /**
 558     Standard IDs.
 559
 560     Notice that some, but @em not all, of these IDs are also stock IDs, i.e.
 561     you can use them for the button or menu items without specifying the label
 562     which will be provided by the underlying platform itself. See @ref page_stockitems "the
 563     list of stock items" for the subset of standard IDs which are stock IDs as well.
 564 */
 565 enum wxStandardID
 566 {
 567     /**
 568        This id delimits the lower bound of the range used by automatically-generated ids
 569        (i.e. those used when wxID_ANY is specified during construction).
 570      */
 571     wxID_AUTO_LOWEST,
 572
 573     /**
 574        This id delimits the upper bound of the range used by automatically-generated ids
 575        (i.e. those used when wxID_ANY is specified during construction).
 576      */
 577     wxID_AUTO_HIGHEST,
 578
 579     /**
 580         No id matches this one when compared to it.
 581     */
 582     wxID_NONE = -3,
 583
 584     /**
 585         Id for a separator line in the menu (invalid for normal item).
 586     */
 587     wxID_SEPARATOR = -2,
 588
 589     /**
 590         Any id: means that we don't care about the id, whether when installing
 591         an event handler or when creating a new window.
 592     */
 593     wxID_ANY = -1,
 594
 595     wxID_LOWEST = 4999,
 596
 597     wxID_OPEN,
 598     wxID_CLOSE,
 599     wxID_NEW,
 600     wxID_SAVE,
 601     wxID_SAVEAS,
 602     wxID_REVERT,
 603     wxID_EXIT,
 604     wxID_UNDO,
 605     wxID_REDO,
 606     wxID_HELP,
 607     wxID_PRINT,
 608     wxID_PRINT_SETUP,
 609     wxID_PAGE_SETUP,
 610     wxID_PREVIEW,
 611     wxID_ABOUT,
 612     wxID_HELP_CONTENTS,
 613     wxID_HELP_INDEX,
 614     wxID_HELP_SEARCH,
 615     wxID_HELP_COMMANDS,
 616     wxID_HELP_PROCEDURES,
 617     wxID_HELP_CONTEXT,
 618     wxID_CLOSE_ALL,
 619     wxID_PREFERENCES,
 620
 621     wxID_EDIT = 5030,
 622     wxID_CUT,
 623     wxID_COPY,
 624     wxID_PASTE,
 625     wxID_CLEAR,
 626     wxID_FIND,
 627     wxID_DUPLICATE,
 628     wxID_SELECTALL,
 629     wxID_DELETE,
 630     wxID_REPLACE,
 631     wxID_REPLACE_ALL,
 632     wxID_PROPERTIES,
 633
 634     wxID_VIEW_DETAILS,
 635     wxID_VIEW_LARGEICONS,
 636     wxID_VIEW_SMALLICONS,
 637     wxID_VIEW_LIST,
 638     wxID_VIEW_SORTDATE,
 639     wxID_VIEW_SORTNAME,
 640     wxID_VIEW_SORTSIZE,
 641     wxID_VIEW_SORTTYPE,
 642
 643     wxID_FILE = 5050,
 644     wxID_FILE1,
 645     wxID_FILE2,
 646     wxID_FILE3,
 647     wxID_FILE4,
 648     wxID_FILE5,
 649     wxID_FILE6,
 650     wxID_FILE7,
 651     wxID_FILE8,
 652     wxID_FILE9,
 653
 654     /** Standard button and menu IDs */
 655     wxID_OK = 5100,
 656     wxID_CANCEL,
 657     wxID_APPLY,
 658     wxID_YES,
 659     wxID_NO,
 660     wxID_STATIC,
 661     wxID_FORWARD,
 662     wxID_BACKWARD,
 663     wxID_DEFAULT,
 664     wxID_MORE,
 665     wxID_SETUP,
 666     wxID_RESET,
 667     wxID_CONTEXT_HELP,
 668     wxID_YESTOALL,
 669     wxID_NOTOALL,
 670     wxID_ABORT,
 671     wxID_RETRY,
 672     wxID_IGNORE,
 673     wxID_ADD,
 674     wxID_REMOVE,
 675
 676     wxID_UP,
 677     wxID_DOWN,
 678     wxID_HOME,
 679     wxID_REFRESH,
 680     wxID_STOP,
 681     wxID_INDEX,
 682
 683     wxID_BOLD,
 684     wxID_ITALIC,
 685     wxID_JUSTIFY_CENTER,
 686     wxID_JUSTIFY_FILL,
 687     wxID_JUSTIFY_RIGHT,
 688     wxID_JUSTIFY_LEFT,
 689     wxID_UNDERLINE,
 690     wxID_INDENT,
 691     wxID_UNINDENT,
 692     wxID_ZOOM_100,
 693     wxID_ZOOM_FIT,
 694     wxID_ZOOM_IN,
 695     wxID_ZOOM_OUT,
 696     wxID_UNDELETE,
 697     wxID_REVERT_TO_SAVED,
 698     wxID_CDROM,
 699     wxID_CONVERT,
 700     wxID_EXECUTE,
 701     wxID_FLOPPY,
 702     wxID_HARDDISK,
 703     wxID_BOTTOM,
 704     wxID_FIRST,
 705     wxID_LAST,
 706     wxID_TOP,
 707     wxID_INFO,
 708     wxID_JUMP_TO,
 709     wxID_NETWORK,
 710     wxID_SELECT_COLOR,
 711     wxID_SELECT_FONT,
 712     wxID_SORT_ASCENDING,
 713     wxID_SORT_DESCENDING,
 714     wxID_SPELL_CHECK,
 715     wxID_STRIKETHROUGH,
 716
 717     /** System menu IDs (used by wxUniv): */
 718     wxID_SYSTEM_MENU = 5200,
 719     wxID_CLOSE_FRAME,
 720     wxID_MOVE_FRAME,
 721     wxID_RESIZE_FRAME,
 722     wxID_MAXIMIZE_FRAME,
 723     wxID_ICONIZE_FRAME,
 724     wxID_RESTORE_FRAME,
 725
 726     /** MDI window menu ids */
 727     wxID_MDI_WINDOW_FIRST = 5230,
 728     wxID_MDI_WINDOW_CASCADE = wxID_MDI_WINDOW_FIRST,
 729     wxID_MDI_WINDOW_TILE_HORZ,
 730     wxID_MDI_WINDOW_TILE_VERT,
 731     wxID_MDI_WINDOW_ARRANGE_ICONS,
 732     wxID_MDI_WINDOW_PREV,
 733     wxID_MDI_WINDOW_NEXT,
 734     wxID_MDI_WINDOW_LAST = wxID_MDI_WINDOW_NEXT,
 735
 736     /** IDs used by generic file dialog (13 consecutive starting from this value) */
 737     wxID_FILEDLGG = 5900,
 738
 739     /** IDs used by generic file ctrl (4 consecutive starting from this value) */
 740     wxID_FILECTRL = 5950,
 741
 742     wxID_HIGHEST = 5999
 743 };
 744
 745 /**
 746     Item kinds for use with wxMenu, wxMenuItem, and wxToolBar.
 747
 748     @see wxMenu::Append(), wxMenuItem::wxMenuItem(), wxToolBar::AddTool()
 749 */
 750 enum wxItemKind
 751 {
 752     wxITEM_SEPARATOR = -1,
 753
 754     /**
 755         Normal tool button / menu item.
 756
 757         @see wxToolBar::AddTool(), wxMenu::AppendItem().
 758     */
 759     wxITEM_NORMAL,
 760
 761     /**
 762         Check (or toggle) tool button / menu item.
 763
 764         @see wxToolBar::AddCheckTool(), wxMenu::AppendCheckItem().
 765     */
 766     wxITEM_CHECK,
 767
 768     /**
 769         Radio tool button / menu item.
 770
 771         @see wxToolBar::AddRadioTool(), wxMenu::AppendRadioItem().
 772     */
 773     wxITEM_RADIO,
 774
 775     /**
 776         Normal tool button with a dropdown arrow next to it. Clicking the
 777         dropdown arrow sends a @c wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED event and may
 778         also display the menu previously associated with the item with
 779         wxToolBar::SetDropdownMenu(). Currently this type of tools is supported
 780         under MSW and GTK.
 781     */
 782     wxITEM_DROPDOWN,
 783
 784     wxITEM_MAX
 785 };
 786
 787 /**
 788     Generic hit test results.
 789 */
 790 enum wxHitTest
 791 {
 792     wxHT_NOWHERE,
 793
 794     /*  scrollbar */
 795     wxHT_SCROLLBAR_FIRST = wxHT_NOWHERE,
 796     wxHT_SCROLLBAR_ARROW_LINE_1,    /**< left or upper arrow to scroll by line */
 797     wxHT_SCROLLBAR_ARROW_LINE_2,    /**< right or down */
 798     wxHT_SCROLLBAR_ARROW_PAGE_1,    /**< left or upper arrow to scroll by page */
 799     wxHT_SCROLLBAR_ARROW_PAGE_2,    /**< right or down */
 800     wxHT_SCROLLBAR_THUMB,           /**< on the thumb */
 801     wxHT_SCROLLBAR_BAR_1,           /**< bar to the left/above the thumb */
 802     wxHT_SCROLLBAR_BAR_2,           /**< bar to the right/below the thumb */
 803     wxHT_SCROLLBAR_LAST,
 804
 805     /*  window */
 806     wxHT_WINDOW_OUTSIDE,            /**< not in this window at all */
 807     wxHT_WINDOW_INSIDE,             /**< in the client area */
 808     wxHT_WINDOW_VERT_SCROLLBAR,     /**< on the vertical scrollbar */
 809     wxHT_WINDOW_HORZ_SCROLLBAR,     /**< on the horizontal scrollbar */
 810     wxHT_WINDOW_CORNER,             /**< on the corner between 2 scrollbars */
 811
 812     wxHT_MAX
 813 };
 814
 815 /**
 816     Data format IDs used by wxDataFormat.
 817 */
 818 enum wxDataFormatId
 819 {
 820     wxDF_INVALID =          0,
 821     wxDF_TEXT =             1,  /* CF_TEXT */
 822     wxDF_BITMAP =           2,  /* CF_BITMAP */
 823     wxDF_METAFILE =         3,  /* CF_METAFILEPICT */
 824     wxDF_SYLK =             4,
 825     wxDF_DIF =              5,
 826     wxDF_TIFF =             6,
 827     wxDF_OEMTEXT =          7,  /* CF_OEMTEXT */
 828     wxDF_DIB =              8,  /* CF_DIB */
 829     wxDF_PALETTE =          9,
 830     wxDF_PENDATA =          10,
 831     wxDF_RIFF =             11,
 832     wxDF_WAVE =             12,
 833     wxDF_UNICODETEXT =      13,
 834     wxDF_ENHMETAFILE =      14,
 835     wxDF_FILENAME =         15, /* CF_HDROP */
 836     wxDF_LOCALE =           16,
 837     wxDF_PRIVATE =          20,
 838     wxDF_HTML =             30, /* Note: does not correspond to CF_ constant */
 839     wxDF_MAX
 840 };
 841
 842 /**
 843     Virtual keycodes used by wxKeyEvent and some other wxWidgets functions.
 844
 845     Note that the range <code>0..255</code> corresponds to the characters of
 846     the current locale, in particular the <code>32..127</code> subrange is for
 847     the ASCII symbols, and all the special key values such as @c WXK_END lie
 848     above this range.
 849 */
 850 enum wxKeyCode
 851 {
 852     /**
 853         No key.
 854
 855         This value is returned by wxKeyEvent::GetKeyCode() if there is no
 856         non-Unicode representation for the pressed key (e.g. a Cyrillic letter
 857         was entered when not using a Cyrillic locale) and by
 858         wxKeyEvent::GetUnicodeKey() if there is no Unicode representation for
 859         the key (this happens for the special, non printable, keys only, e.g.
 860         WXK_HOME).
 861
 862         @since 2.9.2 (you can simply use 0 with previous versions).
 863      */
 864     WXK_NONE    =    0,
 865
 866     WXK_BACK    =    8,     //!< Backspace.
 867     WXK_TAB     =    9,
 868     WXK_RETURN  =    13,
 869     WXK_ESCAPE  =    27,
 870     WXK_SPACE   =    32,
 871
 872     WXK_DELETE  =    127,
 873
 874     /**
 875         Special key values.
 876
 877         These are, by design, not compatible with Unicode characters.
 878         If you want to get a Unicode character from a key event, use
 879         wxKeyEvent::GetUnicodeKey() instead.
 880     */
 881     WXK_START   = 300,
 882     WXK_LBUTTON,
 883     WXK_RBUTTON,
 884     WXK_CANCEL,
 885     WXK_MBUTTON,
 886     WXK_CLEAR,
 887     WXK_SHIFT,
 888     WXK_ALT,
 889     WXK_CONTROL,
 890     WXK_MENU,
 891     WXK_PAUSE,
 892     WXK_CAPITAL,
 893     WXK_END,
 894     WXK_HOME,
 895     WXK_LEFT,
 896     WXK_UP,
 897     WXK_RIGHT,
 898     WXK_DOWN,
 899     WXK_SELECT,
 900     WXK_PRINT,
 901     WXK_EXECUTE,
 902     WXK_SNAPSHOT,
 903     WXK_INSERT,
 904     WXK_HELP,
 905     WXK_NUMPAD0,
 906     WXK_NUMPAD1,
 907     WXK_NUMPAD2,
 908     WXK_NUMPAD3,
 909     WXK_NUMPAD4,
 910     WXK_NUMPAD5,
 911     WXK_NUMPAD6,
 912     WXK_NUMPAD7,
 913     WXK_NUMPAD8,
 914     WXK_NUMPAD9,
 915     WXK_MULTIPLY,
 916     WXK_ADD,
 917     WXK_SEPARATOR,
 918     WXK_SUBTRACT,
 919     WXK_DECIMAL,
 920     WXK_DIVIDE,
 921     WXK_F1,
 922     WXK_F2,
 923     WXK_F3,
 924     WXK_F4,
 925     WXK_F5,
 926     WXK_F6,
 927     WXK_F7,
 928     WXK_F8,
 929     WXK_F9,
 930     WXK_F10,
 931     WXK_F11,
 932     WXK_F12,
 933     WXK_F13,
 934     WXK_F14,
 935     WXK_F15,
 936     WXK_F16,
 937     WXK_F17,
 938     WXK_F18,
 939     WXK_F19,
 940     WXK_F20,
 941     WXK_F21,
 942     WXK_F22,
 943     WXK_F23,
 944     WXK_F24,
 945     WXK_NUMLOCK,
 946     WXK_SCROLL,
 947     WXK_PAGEUP,
 948     WXK_PAGEDOWN,
 949
 950     WXK_NUMPAD_SPACE,
 951     WXK_NUMPAD_TAB,
 952     WXK_NUMPAD_ENTER,
 953     WXK_NUMPAD_F1,
 954     WXK_NUMPAD_F2,
 955     WXK_NUMPAD_F3,
 956     WXK_NUMPAD_F4,
 957     WXK_NUMPAD_HOME,
 958     WXK_NUMPAD_LEFT,
 959     WXK_NUMPAD_UP,
 960     WXK_NUMPAD_RIGHT,
 961     WXK_NUMPAD_DOWN,
 962     WXK_NUMPAD_PAGEUP,
 963     WXK_NUMPAD_PAGEDOWN,
 964     WXK_NUMPAD_END,
 965     WXK_NUMPAD_BEGIN,
 966     WXK_NUMPAD_INSERT,
 967     WXK_NUMPAD_DELETE,
 968     WXK_NUMPAD_EQUAL,
 969     WXK_NUMPAD_MULTIPLY,
 970     WXK_NUMPAD_ADD,
 971     WXK_NUMPAD_SEPARATOR,
 972     WXK_NUMPAD_SUBTRACT,
 973     WXK_NUMPAD_DECIMAL,
 974     WXK_NUMPAD_DIVIDE,
 975
 976     /** The following key codes are only generated under Windows currently */
 977     WXK_WINDOWS_LEFT,
 978     WXK_WINDOWS_RIGHT,
 979     WXK_WINDOWS_MENU ,
 980     WXK_COMMAND,
 981
 982     /** Hardware-specific buttons */
 983     WXK_SPECIAL1 = 193,
 984     WXK_SPECIAL2,
 985     WXK_SPECIAL3,
 986     WXK_SPECIAL4,
 987     WXK_SPECIAL5,
 988     WXK_SPECIAL6,
 989     WXK_SPECIAL7,
 990     WXK_SPECIAL8,
 991     WXK_SPECIAL9,
 992     WXK_SPECIAL10,
 993     WXK_SPECIAL11,
 994     WXK_SPECIAL12,
 995     WXK_SPECIAL13,
 996     WXK_SPECIAL14,
 997     WXK_SPECIAL15,
 998     WXK_SPECIAL16,
 999     WXK_SPECIAL17,
1000     WXK_SPECIAL18,
1001     WXK_SPECIAL19,
1002     WXK_SPECIAL20
1003 };
1004
1005 /**
1006     This enum contains bit mask constants used in wxKeyEvent.
1007 */
1008 enum wxKeyModifier
1009 {
1010     wxMOD_NONE      = 0x0000,
1011     wxMOD_ALT       = 0x0001,
1012     /** Ctlr Key, corresponds to Command key on OS X */
1013     wxMOD_CONTROL   = 0x0002,
1014     wxMOD_ALTGR     = wxMOD_ALT | wxMOD_CONTROL,
1015     wxMOD_SHIFT     = 0x0004,
1016     wxMOD_META      = 0x0008,
1017     wxMOD_WIN       = wxMOD_META,
1018
1019     /** used to describe the true Ctrl Key under OSX,
1020     identic to @c wxMOD_CONTROL on other platforms */
1021     wxMOD_RAW_CONTROL,
1022
1023     /** deprecated, identic to @c wxMOD_CONTROL on all platforms */
1024     wxMOD_CMD       = wxMOD_CONTROL,
1025     wxMOD_ALL       = 0xffff
1026 };
1027
1028 /**
1029     Paper size types for use with the printing framework.
1030
1031     @see overview_printing, wxPrintData::SetPaperId()
1032 */
1033 enum wxPaperSize
1034 {
1035     wxPAPER_NONE,               ///<  Use specific dimensions
1036     wxPAPER_LETTER,             ///<  Letter, 8 1/2 by 11 inches
1037     wxPAPER_LEGAL,              ///<  Legal, 8 1/2 by 14 inches
1038     wxPAPER_A4,                 ///<  A4 Sheet, 210 by 297 millimeters
1039     wxPAPER_CSHEET,             ///<  C Sheet, 17 by 22 inches
1040     wxPAPER_DSHEET,             ///<  D Sheet, 22 by 34 inches
1041     wxPAPER_ESHEET,             ///<  E Sheet, 34 by 44 inches
1042     wxPAPER_LETTERSMALL,        ///<  Letter Small, 8 1/2 by 11 inches
1043     wxPAPER_TABLOID,            ///<  Tabloid, 11 by 17 inches
1044     wxPAPER_LEDGER,             ///<  Ledger, 17 by 11 inches
1045     wxPAPER_STATEMENT,          ///<  Statement, 5 1/2 by 8 1/2 inches
1046     wxPAPER_EXECUTIVE,          ///<  Executive, 7 1/4 by 10 1/2 inches
1047     wxPAPER_A3,                 ///<  A3 sheet, 297 by 420 millimeters
1048     wxPAPER_A4SMALL,            ///<  A4 small sheet, 210 by 297 millimeters
1049     wxPAPER_A5,                 ///<  A5 sheet, 148 by 210 millimeters
1050     wxPAPER_B4,                 ///<  B4 sheet, 250 by 354 millimeters
1051     wxPAPER_B5,                 ///<  B5 sheet, 182-by-257-millimeter paper
1052     wxPAPER_FOLIO,              ///<  Folio, 8-1/2-by-13-inch paper
1053     wxPAPER_QUARTO,             ///<  Quarto, 215-by-275-millimeter paper
1054     wxPAPER_10X14,              ///<  10-by-14-inch sheet
1055     wxPAPER_11X17,              ///<  11-by-17-inch sheet
1056     wxPAPER_NOTE,               ///<  Note, 8 1/2 by 11 inches
1057     wxPAPER_ENV_9,              ///<  #9 Envelope, 3 7/8 by 8 7/8 inches
1058     wxPAPER_ENV_10,             ///<  #10 Envelope, 4 1/8 by 9 1/2 inches
1059     wxPAPER_ENV_11,             ///<  #11 Envelope, 4 1/2 by 10 3/8 inches
1060     wxPAPER_ENV_12,             ///<  #12 Envelope, 4 3/4 by 11 inches
1061     wxPAPER_ENV_14,             ///<  #14 Envelope, 5 by 11 1/2 inches
1062     wxPAPER_ENV_DL,             ///<  DL Envelope, 110 by 220 millimeters
1063     wxPAPER_ENV_C5,             ///<  C5 Envelope, 162 by 229 millimeters
1064     wxPAPER_ENV_C3,             ///<  C3 Envelope, 324 by 458 millimeters
1065     wxPAPER_ENV_C4,             ///<  C4 Envelope, 229 by 324 millimeters
1066     wxPAPER_ENV_C6,             ///<  C6 Envelope, 114 by 162 millimeters
1067     wxPAPER_ENV_C65,            ///<  C65 Envelope, 114 by 229 millimeters
1068     wxPAPER_ENV_B4,             ///<  B4 Envelope, 250 by 353 millimeters
1069     wxPAPER_ENV_B5,             ///<  B5 Envelope, 176 by 250 millimeters
1070     wxPAPER_ENV_B6,             ///<  B6 Envelope, 176 by 125 millimeters
1071     wxPAPER_ENV_ITALY,          ///<  Italy Envelope, 110 by 230 millimeters
1072     wxPAPER_ENV_MONARCH,        ///<  Monarch Envelope, 3 7/8 by 7 1/2 inches
1073     wxPAPER_ENV_PERSONAL,       ///<  6 3/4 Envelope, 3 5/8 by 6 1/2 inches
1074     wxPAPER_FANFOLD_US,         ///<  US Std Fanfold, 14 7/8 by 11 inches
1075     wxPAPER_FANFOLD_STD_GERMAN, ///<  German Std Fanfold, 8 1/2 by 12 inches
1076     wxPAPER_FANFOLD_LGL_GERMAN, ///<  German Legal Fanfold, 8 1/2 by 13 inches
1077
1078     // wxMSW Only
1079
1080     wxPAPER_ISO_B4,             ///<  B4 (ISO) 250 x 353 mm
1081     wxPAPER_JAPANESE_POSTCARD,  ///<  Japanese Postcard 100 x 148 mm
1082     wxPAPER_9X11,               ///<  9 x 11 in
1083     wxPAPER_10X11,              ///<  10 x 11 in
1084     wxPAPER_15X11,              ///<  15 x 11 in
1085     wxPAPER_ENV_INVITE,         ///<  Envelope Invite 220 x 220 mm
1086     wxPAPER_LETTER_EXTRA,       ///<  Letter Extra 9.5 x 12 in
1087     wxPAPER_LEGAL_EXTRA,        ///<  Legal Extra 9.5 x 15 in
1088     wxPAPER_TABLOID_EXTRA,      ///<  Tabloid Extra 11.69 x 18 in
1089     wxPAPER_A4_EXTRA,           ///<  A4 Extra 9.27 x 12.69 in
1090     wxPAPER_LETTER_TRANSVERSE,  ///<  Letter Transverse 8.5 x 11 in
1091     wxPAPER_A4_TRANSVERSE,      ///<  A4 Transverse 210 x 297 mm
1092     wxPAPER_LETTER_EXTRA_TRANSVERSE, ///<  Letter Extra Transverse 9.5 x 12 in
1093     wxPAPER_A_PLUS,             ///<  SuperA/SuperA/A4 227 x 356 mm
1094     wxPAPER_B_PLUS,             ///<  SuperB/SuperB/A3 305 x 487 mm
1095     wxPAPER_LETTER_PLUS,        ///<  Letter Plus 8.5 x 12.69 in
1096     wxPAPER_A4_PLUS,            ///<  A4 Plus 210 x 330 mm
1097     wxPAPER_A5_TRANSVERSE,      ///<  A5 Transverse 148 x 210 mm
1098     wxPAPER_B5_TRANSVERSE,      ///<  B5 (JIS) Transverse 182 x 257 mm
1099     wxPAPER_A3_EXTRA,           ///<  A3 Extra 322 x 445 mm
1100     wxPAPER_A5_EXTRA,           ///<  A5 Extra 174 x 235 mm
1101     wxPAPER_B5_EXTRA,           ///<  B5 (ISO) Extra 201 x 276 mm
1102     wxPAPER_A2,                 ///<  A2 420 x 594 mm
1103     wxPAPER_A3_TRANSVERSE,      ///<  A3 Transverse 297 x 420 mm
1104     wxPAPER_A3_EXTRA_TRANSVERSE, ///<  A3 Extra Transverse 322 x 445 mm
1105
1106     wxPAPER_DBL_JAPANESE_POSTCARD, ///< Japanese Double Postcard 200 x 148 mm
1107     wxPAPER_A6,                 ///< A6 105 x 148 mm
1108     wxPAPER_JENV_KAKU2,         ///< Japanese Envelope Kaku #2
1109     wxPAPER_JENV_KAKU3,         ///< Japanese Envelope Kaku #3
1110     wxPAPER_JENV_CHOU3,         ///< Japanese Envelope Chou #3
1111     wxPAPER_JENV_CHOU4,         ///< Japanese Envelope Chou #4
1112     wxPAPER_LETTER_ROTATED,     ///< Letter Rotated 11 x 8 1/2 in
1113     wxPAPER_A3_ROTATED,         ///< A3 Rotated 420 x 297 mm
1114     wxPAPER_A4_ROTATED,         ///< A4 Rotated 297 x 210 mm
1115     wxPAPER_A5_ROTATED,         ///< A5 Rotated 210 x 148 mm
1116     wxPAPER_B4_JIS_ROTATED,     ///< B4 (JIS) Rotated 364 x 257 mm
1117     wxPAPER_B5_JIS_ROTATED,     ///< B5 (JIS) Rotated 257 x 182 mm
1118     wxPAPER_JAPANESE_POSTCARD_ROTATED, ///< Japanese Postcard Rotated 148 x 100 mm
1119     wxPAPER_DBL_JAPANESE_POSTCARD_ROTATED, ///< Double Japanese Postcard Rotated 148 x 200 mm
1120     wxPAPER_A6_ROTATED,         ///< A6 Rotated 148 x 105 mm
1121     wxPAPER_JENV_KAKU2_ROTATED, ///< Japanese Envelope Kaku #2 Rotated
1122     wxPAPER_JENV_KAKU3_ROTATED, ///< Japanese Envelope Kaku #3 Rotated
1123     wxPAPER_JENV_CHOU3_ROTATED, ///< Japanese Envelope Chou #3 Rotated
1124     wxPAPER_JENV_CHOU4_ROTATED, ///< Japanese Envelope Chou #4 Rotated
1125     wxPAPER_B6_JIS,             ///< B6 (JIS) 128 x 182 mm
1126     wxPAPER_B6_JIS_ROTATED,     ///< B6 (JIS) Rotated 182 x 128 mm
1127     wxPAPER_12X11,              ///< 12 x 11 in
1128     wxPAPER_JENV_YOU4,          ///< Japanese Envelope You #4
1129     wxPAPER_JENV_YOU4_ROTATED,  ///< Japanese Envelope You #4 Rotated
1130     wxPAPER_P16K,               ///< PRC 16K 146 x 215 mm
1131     wxPAPER_P32K,               ///< PRC 32K 97 x 151 mm
1132     wxPAPER_P32KBIG,            ///< PRC 32K(Big) 97 x 151 mm
1133     wxPAPER_PENV_1,             ///< PRC Envelope #1 102 x 165 mm
1134     wxPAPER_PENV_2,             ///< PRC Envelope #2 102 x 176 mm
1135     wxPAPER_PENV_3,             ///< PRC Envelope #3 125 x 176 mm
1136     wxPAPER_PENV_4,             ///< PRC Envelope #4 110 x 208 mm
1137     wxPAPER_PENV_5,             ///< PRC Envelope #5 110 x 220 mm
1138     wxPAPER_PENV_6,             ///< PRC Envelope #6 120 x 230 mm
1139     wxPAPER_PENV_7,             ///< PRC Envelope #7 160 x 230 mm
1140     wxPAPER_PENV_8,             ///< PRC Envelope #8 120 x 309 mm
1141     wxPAPER_PENV_9,             ///< PRC Envelope #9 229 x 324 mm
1142     wxPAPER_PENV_10,            ///< PRC Envelope #10 324 x 458 mm
1143     wxPAPER_P16K_ROTATED,       ///< PRC 16K Rotated
1144     wxPAPER_P32K_ROTATED,       ///< PRC 32K Rotated
1145     wxPAPER_P32KBIG_ROTATED,    ///< PRC 32K(Big) Rotated
1146     wxPAPER_PENV_1_ROTATED,     ///< PRC Envelope #1 Rotated 165 x 102 mm
1147     wxPAPER_PENV_2_ROTATED,     ///< PRC Envelope #2 Rotated 176 x 102 mm
1148     wxPAPER_PENV_3_ROTATED,     ///< PRC Envelope #3 Rotated 176 x 125 mm
1149     wxPAPER_PENV_4_ROTATED,     ///< PRC Envelope #4 Rotated 208 x 110 mm
1150     wxPAPER_PENV_5_ROTATED,     ///< PRC Envelope #5 Rotated 220 x 110 mm
1151     wxPAPER_PENV_6_ROTATED,     ///< PRC Envelope #6 Rotated 230 x 120 mm
1152     wxPAPER_PENV_7_ROTATED,     ///< PRC Envelope #7 Rotated 230 x 160 mm
1153     wxPAPER_PENV_8_ROTATED,     ///< PRC Envelope #8 Rotated 309 x 120 mm
1154     wxPAPER_PENV_9_ROTATED,     ///< PRC Envelope #9 Rotated 324 x 229 mm
1155     wxPAPER_PENV_10_ROTATED     ///< PRC Envelope #10 Rotated 458 x 324 m
1156 };
1157
1158 /**
1159     Printing orientation
1160 */
1161
1162 enum wxPrintOrientation
1163 {
1164    wxPORTRAIT,
1165    wxLANDSCAPE
1166 };
1167
1168 /**
1169     Duplex printing modes.
1170 */
1171 enum wxDuplexMode
1172 {
1173     wxDUPLEX_SIMPLEX, /**< Non-duplex */
1174     wxDUPLEX_HORIZONTAL,
1175     wxDUPLEX_VERTICAL
1176 };
1177
1178 /**
1179     Print mode (currently PostScript only).
1180 */
1181 enum wxPrintMode
1182 {
1183     wxPRINT_MODE_NONE =    0,
1184     wxPRINT_MODE_PREVIEW = 1,   /**< Preview in external application */
1185     wxPRINT_MODE_FILE =    2,   /**< Print to file */
1186     wxPRINT_MODE_PRINTER = 3,   /**< Send to printer */
1187     wxPRINT_MODE_STREAM =  4    /**< Send postscript data into a stream */
1188 };
1189
1190 /**
1191     Flags which can be used in wxWindow::UpdateWindowUI().
1192 */
1193 enum wxUpdateUI
1194 {
1195     wxUPDATE_UI_NONE,
1196     wxUPDATE_UI_RECURSE,
1197     wxUPDATE_UI_FROMIDLE  /**<  Invoked from On(Internal)Idle */
1198 };
1199
1200
1201 // ----------------------------------------------------------------------------
1202 // constants
1203 // ----------------------------------------------------------------------------
1204
1205 /**
1206     Top level window styles common to wxFrame and wxDialog
1207 */
1208
1209 #define wxSTAY_ON_TOP           0x8000
1210 #define wxICONIZE               0x4000
1211 #define wxMINIMIZE              wxICONIZE
1212 #define wxMAXIMIZE              0x2000
1213 #define wxCLOSE_BOX             0x1000
1214
1215 #define wxSYSTEM_MENU           0x0800
1216 #define wxMINIMIZE_BOX          0x0400
1217 #define wxMAXIMIZE_BOX          0x0200
1218
1219 #define wxTINY_CAPTION          0x0080  // clashes with wxNO_DEFAULT
1220 #define wxRESIZE_BORDER         0x0040
1221
1222
1223 /**
1224     C99-like sized MIN/MAX constants for all integer types.
1225
1226     For each @c n in the set 8, 16, 32, 64 we define @c wxINTn_MIN, @c
1227     wxINTn_MAX and @c wxUINTc_MAX (@c wxUINTc_MIN is always 0 and so is not
1228     defined).
1229  */
1230 //@{
1231 #define wxINT8_MIN CHAR_MIN
1232 #define wxINT8_MAX CHAR_MAX
1233 #define wxUINT8_MAX UCHAR_MAX
1234
1235 #define wxINT16_MIN SHRT_MIN
1236 #define wxINT16_MAX SHRT_MAX
1237 #define wxUINT16_MAX USHRT_MAX
1238
1239 #define wxINT32_MIN INT_MIN-or-LONG_MIN
1240 #define wxINT32_MAX INT_MAX-or-LONG_MAX
1241 #define wxUINT32_MAX UINT_MAX-or-LONG_MAX
1242
1243 #define wxINT64_MIN LLONG_MIN
1244 #define wxINT64_MAX LLONG_MAX
1245 #define wxUINT64_MAX ULLONG_MAX
1246 //@}
1247
1248 // ----------------------------------------------------------------------------
1249 // types
1250 // ----------------------------------------------------------------------------
1251
1252 /** The type for screen and DC coordinates. */
1253 typedef int wxCoord;
1254
1255 /** A special value meaning "use default coordinate". */
1256 wxCoord wxDefaultCoord = -1;
1257
1258 //@{
1259 /** 8 bit type (the mapping is more complex than a simple @c typedef and is not shown here). */
1260 typedef signed char wxInt8;
1261 typedef unsigned char wxUint8;
1262 typedef wxUint8 wxByte;
1263 //@}
1264
1265 //@{
1266 /** 16 bit type (the mapping is more complex than a simple @c typedef and is not shown here). */
1267 typedef signed short wxInt16;
1268 typedef unsigned short wxUint16;
1269 typedef wxUint16 wxWord;
1270 typedef wxUint16 wxChar16;
1271 //@}
1272
1273 //@{
1274 /** 32 bit type (the mapping is more complex than a simple @c typedef and is not shown here). */
1275 typedef int wxInt32;
1276 typedef unsigned int wxUint32;
1277 typedef wxUint32 wxDword;
1278 typedef wxUint32 wxChar32;
1279 //@}
1280
1281 //@{
1282 /** 64 bit type (the mapping is more complex than a simple @c typedef and is not shown here). */
1283 typedef wxLongLong_t wxInt64;
1284 typedef wxULongLong_t wxUint64;
1285 //@}
1286
1287 //@{
1288 /**
1289     Signed and unsigned integral types big enough to contain all of @c long,
1290     @c size_t and @c void*.
1291     (The mapping is more complex than a simple @c typedef and is not shown here).
1292 */
1293 typedef ssize_t wxIntPtr;
1294 typedef size_t wxUIntPtr;
1295 //@}
1296
1297
1298 /**
1299     32 bit IEEE float ( 1 sign, 8 exponent bits, 23 fraction bits ).
1300     (The mapping is more complex than a simple @c typedef and is not shown here).
1301 */
1302 typedef float wxFloat32;
1303
1304
1305 /**
1306     64 bit IEEE float ( 1 sign, 11 exponent bits, 52 fraction bits ).
1307     (The mapping is more complex than a simple @c typedef and is not shown here).
1308 */
1309 typedef double wxFloat64;
1310
1311 /**
1312     Native fastest representation that has at least wxFloat64 precision, so use
1313     the IEEE types for storage, and this for calculations.
1314     (The mapping is more complex than a simple @c typedef and is not shown here).
1315 */
1316 typedef double wxDouble;
1317
1318
1319
1320 // ----------------------------------------------------------------------------
1321 // macros
1322 // ----------------------------------------------------------------------------
1323
1324
1325 /** @addtogroup group_funcmacro_byteorder */
1326 //@{
1327
1328 /**
1329     This macro will swap the bytes of the @a value variable from little endian
1330     to big endian or vice versa unconditionally, i.e. independently of the
1331     current platform.
1332
1333     @header{wx/defs.h}
1334 */
1335 #define wxINT32_SWAP_ALWAYS( wxInt32_value )
1336 #define wxUINT32_SWAP_ALWAYS( wxUint32_value )
1337 #define wxINT16_SWAP_ALWAYS( wxInt16_value )
1338 #define wxUINT16_SWAP_ALWAYS( wxUint16_value )
1339
1340 //@}
1341
1342 /** @addtogroup group_funcmacro_byteorder */
1343 //@{
1344
1345 /**
1346     This macro will swap the bytes of the @a value variable from little endian
1347     to big endian or vice versa if the program is compiled on a big-endian
1348     architecture (such as Sun work stations). If the program has been compiled
1349     on a little-endian architecture, the value will be unchanged.
1350
1351     Use these macros to read data from and write data to a file that stores
1352     data in little-endian (for example Intel i386) format.
1353
1354     @header{wx/defs.h}
1355 */
1356 #define wxINT32_SWAP_ON_BE( wxInt32_value )
1357 #define wxUINT32_SWAP_ON_BE( wxUint32_value )
1358 #define wxINT16_SWAP_ON_BE( wxInt16_value )
1359 #define wxUINT16_SWAP_ON_BE( wxUint16_value )
1360
1361 //@}
1362
1363 /** @addtogroup group_funcmacro_byteorder */
1364 //@{
1365
1366 /**
1367     This macro will swap the bytes of the @a value variable from little endian
1368     to big endian or vice versa if the program is compiled on a little-endian
1369     architecture (such as Intel PCs). If the program has been compiled on a
1370     big-endian architecture, the value will be unchanged.
1371
1372     Use these macros to read data from and write data to a file that stores
1373     data in big-endian format.
1374
1375     @header{wx/defs.h}
1376 */
1377 #define wxINT32_SWAP_ON_LE( wxInt32_value )
1378 #define wxUINT32_SWAP_ON_LE( wxUint32_value )
1379 #define wxINT16_SWAP_ON_LE( wxInt16_value )
1380 #define wxUINT16_SWAP_ON_LE( wxUint16_value )
1381
1382 //@}
1383
1384
1385
1386 /** @addtogroup group_funcmacro_misc */
1387 //@{
1388
1389 /**
1390     This macro can be used in a class declaration to disable the generation of
1391     default assignment operator.
1392
1393     Some classes have a well-defined copy constructor but cannot have an
1394     assignment operator, typically because they can't be modified once created.
1395     In such case, this macro can be used to disable the automatic assignment
1396     operator generation.
1397
1398     @see wxDECLARE_NO_COPY_CLASS()
1399  */
1400 #define wxDECLARE_NO_ASSIGN_CLASS(classname)
1401
1402 /**
1403     This macro can be used in a class declaration to disable the generation of
1404     default copy ctor and assignment operator.
1405
1406     Some classes don't have a well-defined copying semantics. In this case the
1407     standard C++ convention is to not allow copying them. One way of achieving
1408     it is to use this macro which simply defines a private copy constructor and
1409     assignment operator.
1410
1411     Beware that simply not defining copy constructor and assignment operator is
1412     @em not enough as the compiler would provide its own automatically-generated
1413     versions of them -- hence the usefulness of this macro.
1414
1415     Example of use:
1416     @code
1417     class FooWidget
1418     {
1419     public:
1420         FooWidget();
1421         ...
1422
1423     private:
1424         // widgets can't be copied
1425         wxDECLARE_NO_COPY_CLASS(FooWidget);
1426     };
1427     @endcode
1428
1429     Notice that a semicolon must be used after this macro and that it changes
1430     the access specifier to private internally so it is better to use it at the
1431     end of the class declaration.
1432
1433     @see wxDECLARE_NO_ASSIGN_CLASS(), wxDECLARE_NO_COPY_TEMPLATE_CLASS()
1434  */
1435 #define wxDECLARE_NO_COPY_CLASS(classname)
1436
1437 /**
1438     Analog of wxDECLARE_NO_COPY_CLASS() for template classes.
1439
1440     This macro can be used for template classes (with a single template
1441     parameter) for the same purpose as wxDECLARE_NO_COPY_CLASS() is used with the
1442     non-template classes.
1443
1444     @param classname The name of the template class.
1445     @param arg The name of the template parameter.
1446
1447     @see wxDECLARE_NO_COPY_TEMPLATE_CLASS_2
1448  */
1449 #define wxDECLARE_NO_COPY_TEMPLATE_CLASS(classname, arg)
1450
1451 /**
1452     Analog of wxDECLARE_NO_COPY_TEMPLATE_CLASS() for templates with 2
1453     parameters.
1454
1455     This macro can be used for template classes with two template
1456     parameters for the same purpose as wxDECLARE_NO_COPY_CLASS() is used with
1457     the non-template classes.
1458
1459     @param classname The name of the template class.
1460     @param arg1 The name of the first template parameter.
1461     @param arg2 The name of the second template parameter.
1462
1463     @see wxDECLARE_NO_COPY_TEMPLATE_CLASS
1464  */
1465 #define wxDECLARE_NO_COPY_TEMPLATE_CLASS_2(classname, arg1, arg2)
1466
1467 /**
1468     A function which deletes and nulls the pointer.
1469
1470     This function uses operator delete to free the pointer and also sets it to
1471     @NULL. Notice that this does @em not work for arrays, use wxDELETEA() for
1472     them.
1473
1474     @code
1475         MyClass *ptr = new MyClass;
1476         ...
1477         wxDELETE(ptr);
1478         wxASSERT(!ptr);
1479     @endcode
1480
1481     @header{wx/defs.h}
1482 */
1483 template <typename T> wxDELETE(T*& ptr);
1484
1485 /**
1486     A function which deletes and nulls the pointer.
1487
1488     This function uses vector operator delete (@c delete[]) to free the array
1489     pointer and also sets it to @NULL. Notice that this does @em not work for
1490     non-array pointers, use wxDELETE() for them.
1491
1492     @code
1493         MyClass *array = new MyClass[17];
1494         ...
1495         wxDELETEA(array);
1496         wxASSERT(!array);
1497     @endcode
1498
1499     @see wxDELETE()
1500
1501     @header{wx/defs.h}
1502 */
1503 template <typename T> wxDELETEA(T*& array);
1504
1505 /**
1506     This macro can be used around a function declaration to generate warnings
1507     indicating that this function is deprecated (i.e. obsolete and planned to
1508     be removed in the future) when it is used. Only Visual C++ 7 and higher and
1509     g++ compilers currently support this functionality.
1510
1511     Example of use:
1512
1513     @code
1514     // old function, use wxString version instead
1515     wxDEPRECATED( void wxGetSomething(char *buf, size_t len) );
1516
1517     // ...
1518     wxString wxGetSomething();
1519     @endcode
1520
1521     @header{wx/defs.h}
1522 */
1523 #define wxDEPRECATED(function)
1524
1525 /**
1526     This is a special version of wxDEPRECATED() macro which only does something
1527     when the deprecated function is used from the code outside wxWidgets itself
1528     but doesn't generate warnings when it is used from wxWidgets.
1529
1530     It is used with the virtual functions which are called by the library
1531     itself -- even if such function is deprecated the library still has to call
1532     it to ensure that the existing code overriding it continues to work, but
1533     the use of this macro ensures that a deprecation warning will be generated
1534     if this function is used from the user code or, in case of Visual C++, even
1535     when it is simply overridden.
1536
1537     @header{wx/defs.h}
1538 */
1539 #define wxDEPRECATED_BUT_USED_INTERNALLY(function)
1540
1541 /**
1542     This macro is similar to wxDEPRECATED() but can be used to not only declare
1543     the function @a function as deprecated but to also provide its (inline)
1544     implementation @a body.
1545
1546     It can be used as following:
1547
1548     @code
1549     class wxFoo
1550     {
1551     public:
1552         // OldMethod() is deprecated, use NewMethod() instead
1553         void NewMethod();
1554         wxDEPRECATED_INLINE( void OldMethod(), NewMethod(); )
1555     };
1556     @endcode
1557
1558     @header{wx/defs.h}
1559 */
1560 #define wxDEPRECATED_INLINE(func, body)
1561
1562 /**
1563     A helper macro allowing to easily define a simple deprecated accessor.
1564
1565     Compared to wxDEPRECATED_INLINE() it saves a @c return statement and,
1566     especially, a strangely looking semicolon inside a macro.
1567
1568     Example of use
1569     @code
1570     class wxFoo
1571     {
1572     public:
1573         int GetValue() const { return m_value; }
1574
1575         // this one is deprecated because it was erroneously non-const
1576         wxDEPRECATED_ACCESSOR( int GetValue(), m_value )
1577
1578     private:
1579         int m_value;
1580     };
1581     @endcode
1582  */
1583 #define wxDEPRECATED_ACCESSOR(func, what)
1584
1585 /**
1586     Combination of wxDEPRECATED_BUT_USED_INTERNALLY() and wxDEPRECATED_INLINE().
1587
1588     This macro should be used for deprecated functions called by the library
1589     itself (usually for backwards compatibility reasons) and which are defined
1590     inline.
1591
1592     @header{wx/defs.h}
1593 */
1594 #define wxDEPRECATED_BUT_USED_INTERNALLY_INLINE(func, body)
1595
1596 /**
1597     @c wxEXPLICIT is a macro which expands to the C++ @c explicit keyword if
1598     the compiler supports it or nothing otherwise. Thus, it can be used even in
1599     the code which might have to be compiled with an old compiler without
1600     support for this language feature but still take advantage of it when it is
1601     available.
1602
1603     @header{wx/defs.h}
1604 */
1605 #define wxEXPLICIT
1606
1607 /**
1608     GNU C++ compiler gives a warning for any class whose destructor is private
1609     unless it has a friend. This warning may sometimes be useful but it doesn't
1610     make sense for reference counted class which always delete themselves
1611     (hence destructor should be private) but don't necessarily have any
1612     friends, so this macro is provided to disable the warning in such case. The
1613     @a name parameter should be the name of the class but is only used to
1614     construct a unique friend class name internally.
1615
1616     Example of using the macro:
1617
1618     @code
1619     class RefCounted
1620     {
1621     public:
1622         RefCounted() { m_nRef = 1; }
1623         void IncRef() { m_nRef++ ; }
1624         void DecRef() { if ( !--m_nRef ) delete this; }
1625
1626     private:
1627         ~RefCounted() { }
1628
1629         wxSUPPRESS_GCC_PRIVATE_DTOR(RefCounted)
1630     };
1631     @endcode
1632
1633     Notice that there should be no semicolon after this macro.
1634
1635     @header{wx/defs.h}
1636 */
1637 #define wxSUPPRESS_GCC_PRIVATE_DTOR_WARNING(name)
1638
1639 /**
1640     Swaps the contents of two variables.
1641
1642     This is similar to std::swap() but can be used even on the platforms where
1643     the standard C++ library is not available (if you don't target such
1644     platforms, please use std::swap() instead).
1645
1646     The function relies on type T being copy constructible and assignable.
1647
1648     Example of use:
1649     @code
1650         int x = 3,
1651             y = 4;
1652         wxSwap(x, y);
1653         wxASSERT( x == 4 && y == 3 );
1654     @endcode
1655  */
1656 template <typename T> wxSwap(T& first, T& second);
1657
1658 /**
1659     This macro is the same as the standard C99 @c va_copy for the compilers
1660     which support it or its replacement for those that don't. It must be used
1661     to preserve the value of a @c va_list object if you need to use it after
1662     passing it to another function because it can be modified by the latter.
1663
1664     As with @c va_start, each call to @c wxVaCopy must have a matching
1665     @c va_end.
1666
1667     @header{wx/defs.h}
1668 */
1669 void wxVaCopy(va_list argptrDst, va_list argptrSrc);
1670
1671 //@}
1672
1673