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  wxFORWARD              0x00001000
 483 #define  wxBACKWARD             0x00002000
 484 #define  wxRESET                0x00004000
 485 #define  wxHELP                 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 "the
 563     list of stock items" for the subset of standard IDs which are stock IDs as
 564     well.
 565 */
 566 enum wxStandardID
 567 {
 568     /**
 569        This id delimits the lower bound of the range used by automatically-generated ids
 570        (i.e. those used when wxID_ANY is specified during construction).
 571      */
 572     wxID_AUTO_LOWEST,
 573
 574     /**
 575        This id delimits the upper bound of the range used by automatically-generated ids
 576        (i.e. those used when wxID_ANY is specified during construction).
 577      */
 578     wxID_AUTO_HIGHEST,
 579
 580     /**
 581         No id matches this one when compared to it.
 582     */
 583     wxID_NONE = -3,
 584
 585     /**
 586         Id for a separator line in the menu (invalid for normal item).
 587     */
 588     wxID_SEPARATOR = -2,
 589
 590     /**
 591         Any id: means that we don't care about the id, whether when installing
 592         an event handler or when creating a new window.
 593     */
 594     wxID_ANY = -1,
 595
 596     wxID_LOWEST = 4999,
 597
 598     wxID_OPEN,
 599     wxID_CLOSE,
 600     wxID_NEW,
 601     wxID_SAVE,
 602     wxID_SAVEAS,
 603     wxID_REVERT,
 604     wxID_EXIT,
 605     wxID_UNDO,
 606     wxID_REDO,
 607     wxID_HELP,
 608     wxID_PRINT,
 609     wxID_PRINT_SETUP,
 610     wxID_PAGE_SETUP,
 611     wxID_PREVIEW,
 612     wxID_ABOUT,
 613     wxID_HELP_CONTENTS,
 614     wxID_HELP_INDEX,
 615     wxID_HELP_SEARCH,
 616     wxID_HELP_COMMANDS,
 617     wxID_HELP_PROCEDURES,
 618     wxID_HELP_CONTEXT,
 619     wxID_CLOSE_ALL,
 620     wxID_PREFERENCES,
 621
 622     wxID_EDIT = 5030,
 623     wxID_CUT,
 624     wxID_COPY,
 625     wxID_PASTE,
 626     wxID_CLEAR,
 627     wxID_FIND,
 628     wxID_DUPLICATE,
 629     wxID_SELECTALL,
 630     wxID_DELETE,
 631     wxID_REPLACE,
 632     wxID_REPLACE_ALL,
 633     wxID_PROPERTIES,
 634
 635     wxID_VIEW_DETAILS,
 636     wxID_VIEW_LARGEICONS,
 637     wxID_VIEW_SMALLICONS,
 638     wxID_VIEW_LIST,
 639     wxID_VIEW_SORTDATE,
 640     wxID_VIEW_SORTNAME,
 641     wxID_VIEW_SORTSIZE,
 642     wxID_VIEW_SORTTYPE,
 643
 644     wxID_FILE = 5050,
 645     wxID_FILE1,
 646     wxID_FILE2,
 647     wxID_FILE3,
 648     wxID_FILE4,
 649     wxID_FILE5,
 650     wxID_FILE6,
 651     wxID_FILE7,
 652     wxID_FILE8,
 653     wxID_FILE9,
 654
 655     /** Standard button and menu IDs */
 656     wxID_OK = 5100,
 657     wxID_CANCEL,
 658     wxID_APPLY,
 659     wxID_YES,
 660     wxID_NO,
 661     wxID_STATIC,
 662     wxID_FORWARD,
 663     wxID_BACKWARD,
 664     wxID_DEFAULT,
 665     wxID_MORE,
 666     wxID_SETUP,
 667     wxID_RESET,
 668     wxID_CONTEXT_HELP,
 669     wxID_YESTOALL,
 670     wxID_NOTOALL,
 671     wxID_ABORT,
 672     wxID_RETRY,
 673     wxID_IGNORE,
 674     wxID_ADD,
 675     wxID_REMOVE,
 676
 677     wxID_UP,
 678     wxID_DOWN,
 679     wxID_HOME,
 680     wxID_REFRESH,
 681     wxID_STOP,
 682     wxID_INDEX,
 683
 684     wxID_BOLD,
 685     wxID_ITALIC,
 686     wxID_JUSTIFY_CENTER,
 687     wxID_JUSTIFY_FILL,
 688     wxID_JUSTIFY_RIGHT,
 689     wxID_JUSTIFY_LEFT,
 690     wxID_UNDERLINE,
 691     wxID_INDENT,
 692     wxID_UNINDENT,
 693     wxID_ZOOM_100,
 694     wxID_ZOOM_FIT,
 695     wxID_ZOOM_IN,
 696     wxID_ZOOM_OUT,
 697     wxID_UNDELETE,
 698     wxID_REVERT_TO_SAVED,
 699     wxID_CDROM,
 700     wxID_CONVERT,
 701     wxID_EXECUTE,
 702     wxID_FLOPPY,
 703     wxID_HARDDISK,
 704     wxID_BOTTOM,
 705     wxID_FIRST,
 706     wxID_LAST,
 707     wxID_TOP,
 708     wxID_INFO,
 709     wxID_JUMP_TO,
 710     wxID_NETWORK,
 711     wxID_SELECT_COLOR,
 712     wxID_SELECT_FONT,
 713     wxID_SORT_ASCENDING,
 714     wxID_SORT_DESCENDING,
 715     wxID_SPELL_CHECK,
 716     wxID_STRIKETHROUGH,
 717
 718     /** System menu IDs (used by wxUniv): */
 719     wxID_SYSTEM_MENU = 5200,
 720     wxID_CLOSE_FRAME,
 721     wxID_MOVE_FRAME,
 722     wxID_RESIZE_FRAME,
 723     wxID_MAXIMIZE_FRAME,
 724     wxID_ICONIZE_FRAME,
 725     wxID_RESTORE_FRAME,
 726
 727     /** MDI window menu ids */
 728     wxID_MDI_WINDOW_FIRST = 5230,
 729     wxID_MDI_WINDOW_CASCADE = wxID_MDI_WINDOW_FIRST,
 730     wxID_MDI_WINDOW_TILE_HORZ,
 731     wxID_MDI_WINDOW_TILE_VERT,
 732     wxID_MDI_WINDOW_ARRANGE_ICONS,
 733     wxID_MDI_WINDOW_PREV,
 734     wxID_MDI_WINDOW_NEXT,
 735     wxID_MDI_WINDOW_LAST = wxID_MDI_WINDOW_NEXT,
 736
 737     /** IDs used by generic file dialog (13 consecutive starting from this value) */
 738     wxID_FILEDLGG = 5900,
 739
 740     /** IDs used by generic file ctrl (4 consecutive starting from this value) */
 741     wxID_FILECTRL = 5950,
 742
 743     wxID_HIGHEST = 5999
 744 };
 745
 746 /**
 747     Item kinds for use with wxMenu, wxMenuItem, and wxToolBar.
 748
 749     @see wxMenu::Append(), wxMenuItem::wxMenuItem(), wxToolBar::AddTool()
 750 */
 751 enum wxItemKind
 752 {
 753     wxITEM_SEPARATOR = -1,
 754
 755     /**
 756         Normal tool button / menu item.
 757
 758         @see wxToolBar::AddTool(), wxMenu::AppendItem().
 759     */
 760     wxITEM_NORMAL,
 761
 762     /**
 763         Check (or toggle) tool button / menu item.
 764
 765         @see wxToolBar::AddCheckTool(), wxMenu::AppendCheckItem().
 766     */
 767     wxITEM_CHECK,
 768
 769     /**
 770         Radio tool button / menu item.
 771
 772         @see wxToolBar::AddRadioTool(), wxMenu::AppendRadioItem().
 773     */
 774     wxITEM_RADIO,
 775
 776     /**
 777         Normal tool button with a dropdown arrow next to it. Clicking the
 778         dropdown arrow sends a @c wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED event and may
 779         also display the menu previously associated with the item with
 780         wxToolBar::SetDropdownMenu(). Currently this type of tools is supported
 781         under MSW and GTK.
 782     */
 783     wxITEM_DROPDOWN,
 784
 785     wxITEM_MAX
 786 };
 787
 788 /**
 789     Generic hit test results.
 790 */
 791 enum wxHitTest
 792 {
 793     wxHT_NOWHERE,
 794
 795     /*  scrollbar */
 796     wxHT_SCROLLBAR_FIRST = wxHT_NOWHERE,
 797     wxHT_SCROLLBAR_ARROW_LINE_1,    /**< left or upper arrow to scroll by line */
 798     wxHT_SCROLLBAR_ARROW_LINE_2,    /**< right or down */
 799     wxHT_SCROLLBAR_ARROW_PAGE_1,    /**< left or upper arrow to scroll by page */
 800     wxHT_SCROLLBAR_ARROW_PAGE_2,    /**< right or down */
 801     wxHT_SCROLLBAR_THUMB,           /**< on the thumb */
 802     wxHT_SCROLLBAR_BAR_1,           /**< bar to the left/above the thumb */
 803     wxHT_SCROLLBAR_BAR_2,           /**< bar to the right/below the thumb */
 804     wxHT_SCROLLBAR_LAST,
 805
 806     /*  window */
 807     wxHT_WINDOW_OUTSIDE,            /**< not in this window at all */
 808     wxHT_WINDOW_INSIDE,             /**< in the client area */
 809     wxHT_WINDOW_VERT_SCROLLBAR,     /**< on the vertical scrollbar */
 810     wxHT_WINDOW_HORZ_SCROLLBAR,     /**< on the horizontal scrollbar */
 811     wxHT_WINDOW_CORNER,             /**< on the corner between 2 scrollbars */
 812
 813     wxHT_MAX
 814 };
 815
 816 /**
 817     Data format IDs used by wxDataFormat.
 818 */
 819 enum wxDataFormatId
 820 {
 821     wxDF_INVALID =          0,
 822     wxDF_TEXT =             1,  /* CF_TEXT */
 823     wxDF_BITMAP =           2,  /* CF_BITMAP */
 824     wxDF_METAFILE =         3,  /* CF_METAFILEPICT */
 825     wxDF_SYLK =             4,
 826     wxDF_DIF =              5,
 827     wxDF_TIFF =             6,
 828     wxDF_OEMTEXT =          7,  /* CF_OEMTEXT */
 829     wxDF_DIB =              8,  /* CF_DIB */
 830     wxDF_PALETTE =          9,
 831     wxDF_PENDATA =          10,
 832     wxDF_RIFF =             11,
 833     wxDF_WAVE =             12,
 834     wxDF_UNICODETEXT =      13,
 835     wxDF_ENHMETAFILE =      14,
 836     wxDF_FILENAME =         15, /* CF_HDROP */
 837     wxDF_LOCALE =           16,
 838     wxDF_PRIVATE =          20,
 839     wxDF_HTML =             30, /* Note: does not correspond to CF_ constant */
 840     wxDF_MAX
 841 };
 842
 843 /**
 844     Virtual keycodes used by wxKeyEvent and some other wxWidgets functions.
 845
 846     Note that the range <code>0..255</code> corresponds to the characters of
 847     the current locale, in particular the <code>32..127</code> subrange is for
 848     the ASCII symbols, and all the special key values such as @c WXK_END lie
 849     above this range.
 850 */
 851 enum wxKeyCode
 852 {
 853     /**
 854         No key.
 855
 856         This value is returned by wxKeyEvent::GetKeyCode() if there is no
 857         non-Unicode representation for the pressed key (e.g. a Cyrillic letter
 858         was entered when not using a Cyrillic locale) and by
 859         wxKeyEvent::GetUnicodeKey() if there is no Unicode representation for
 860         the key (this happens for the special, non printable, keys only, e.g.
 861         WXK_HOME).
 862
 863         @since 2.9.2 (you can simply use 0 with previous versions).
 864      */
 865     WXK_NONE    =    0,
 866
 867     WXK_BACK    =    8,     //!< Backspace.
 868     WXK_TAB     =    9,
 869     WXK_RETURN  =    13,
 870     WXK_ESCAPE  =    27,
 871     WXK_SPACE   =    32,
 872
 873     WXK_DELETE  =    127,
 874
 875     /**
 876         Special key values.
 877
 878         These are, by design, not compatible with Unicode characters.
 879         If you want to get a Unicode character from a key event, use
 880         wxKeyEvent::GetUnicodeKey() instead.
 881     */
 882     WXK_START   = 300,
 883     WXK_LBUTTON,
 884     WXK_RBUTTON,
 885     WXK_CANCEL,
 886     WXK_MBUTTON,
 887     WXK_CLEAR,
 888     WXK_SHIFT,
 889     WXK_ALT,
 890     WXK_CONTROL,
 891     WXK_MENU,
 892     WXK_PAUSE,
 893     WXK_CAPITAL,
 894     WXK_END,
 895     WXK_HOME,
 896     WXK_LEFT,
 897     WXK_UP,
 898     WXK_RIGHT,
 899     WXK_DOWN,
 900     WXK_SELECT,
 901     WXK_PRINT,
 902     WXK_EXECUTE,
 903     WXK_SNAPSHOT,
 904     WXK_INSERT,
 905     WXK_HELP,
 906     WXK_NUMPAD0,
 907     WXK_NUMPAD1,
 908     WXK_NUMPAD2,
 909     WXK_NUMPAD3,
 910     WXK_NUMPAD4,
 911     WXK_NUMPAD5,
 912     WXK_NUMPAD6,
 913     WXK_NUMPAD7,
 914     WXK_NUMPAD8,
 915     WXK_NUMPAD9,
 916     WXK_MULTIPLY,
 917     WXK_ADD,
 918     WXK_SEPARATOR,
 919     WXK_SUBTRACT,
 920     WXK_DECIMAL,
 921     WXK_DIVIDE,
 922     WXK_F1,
 923     WXK_F2,
 924     WXK_F3,
 925     WXK_F4,
 926     WXK_F5,
 927     WXK_F6,
 928     WXK_F7,
 929     WXK_F8,
 930     WXK_F9,
 931     WXK_F10,
 932     WXK_F11,
 933     WXK_F12,
 934     WXK_F13,
 935     WXK_F14,
 936     WXK_F15,
 937     WXK_F16,
 938     WXK_F17,
 939     WXK_F18,
 940     WXK_F19,
 941     WXK_F20,
 942     WXK_F21,
 943     WXK_F22,
 944     WXK_F23,
 945     WXK_F24,
 946     WXK_NUMLOCK,
 947     WXK_SCROLL,
 948     WXK_PAGEUP,
 949     WXK_PAGEDOWN,
 950
 951     WXK_NUMPAD_SPACE,
 952     WXK_NUMPAD_TAB,
 953     WXK_NUMPAD_ENTER,
 954     WXK_NUMPAD_F1,
 955     WXK_NUMPAD_F2,
 956     WXK_NUMPAD_F3,
 957     WXK_NUMPAD_F4,
 958     WXK_NUMPAD_HOME,
 959     WXK_NUMPAD_LEFT,
 960     WXK_NUMPAD_UP,
 961     WXK_NUMPAD_RIGHT,
 962     WXK_NUMPAD_DOWN,
 963     WXK_NUMPAD_PAGEUP,
 964     WXK_NUMPAD_PAGEDOWN,
 965     WXK_NUMPAD_END,
 966     WXK_NUMPAD_BEGIN,
 967     WXK_NUMPAD_INSERT,
 968     WXK_NUMPAD_DELETE,
 969     WXK_NUMPAD_EQUAL,
 970     WXK_NUMPAD_MULTIPLY,
 971     WXK_NUMPAD_ADD,
 972     WXK_NUMPAD_SEPARATOR,
 973     WXK_NUMPAD_SUBTRACT,
 974     WXK_NUMPAD_DECIMAL,
 975     WXK_NUMPAD_DIVIDE,
 976
 977     /** The following key codes are only generated under Windows currently */
 978     WXK_WINDOWS_LEFT,
 979     WXK_WINDOWS_RIGHT,
 980     WXK_WINDOWS_MENU ,
 981     WXK_COMMAND,
 982
 983     /** Hardware-specific buttons */
 984     WXK_SPECIAL1 = 193,
 985     WXK_SPECIAL2,
 986     WXK_SPECIAL3,
 987     WXK_SPECIAL4,
 988     WXK_SPECIAL5,
 989     WXK_SPECIAL6,
 990     WXK_SPECIAL7,
 991     WXK_SPECIAL8,
 992     WXK_SPECIAL9,
 993     WXK_SPECIAL10,
 994     WXK_SPECIAL11,
 995     WXK_SPECIAL12,
 996     WXK_SPECIAL13,
 997     WXK_SPECIAL14,
 998     WXK_SPECIAL15,
 999     WXK_SPECIAL16,
1000     WXK_SPECIAL17,
1001     WXK_SPECIAL18,
1002     WXK_SPECIAL19,
1003     WXK_SPECIAL20
1004 };
1005
1006 /**
1007     This enum contains bit mask constants used in wxKeyEvent.
1008 */
1009 enum wxKeyModifier
1010 {
1011     wxMOD_NONE      = 0x0000,
1012     wxMOD_ALT       = 0x0001,
1013     /** Ctlr Key, corresponds to Command key on OS X */
1014     wxMOD_CONTROL   = 0x0002,
1015     wxMOD_ALTGR     = wxMOD_ALT | wxMOD_CONTROL,
1016     wxMOD_SHIFT     = 0x0004,
1017     wxMOD_META      = 0x0008,
1018     wxMOD_WIN       = wxMOD_META,
1019
1020     /** used to describe the true Ctrl Key under OSX,
1021     identic to @c wxMOD_CONTROL on other platforms */
1022     wxMOD_RAW_CONTROL,
1023
1024     /** deprecated, identic to @c wxMOD_CONTROL on all platforms */
1025     wxMOD_CMD       = wxMOD_CONTROL,
1026     wxMOD_ALL       = 0xffff
1027 };
1028
1029 /**
1030     Paper size types for use with the printing framework.
1031
1032     @see overview_printing, wxPrintData::SetPaperId()
1033 */
1034 enum wxPaperSize
1035 {
1036     wxPAPER_NONE,               ///<  Use specific dimensions
1037     wxPAPER_LETTER,             ///<  Letter, 8 1/2 by 11 inches
1038     wxPAPER_LEGAL,              ///<  Legal, 8 1/2 by 14 inches
1039     wxPAPER_A4,                 ///<  A4 Sheet, 210 by 297 millimeters
1040     wxPAPER_CSHEET,             ///<  C Sheet, 17 by 22 inches
1041     wxPAPER_DSHEET,             ///<  D Sheet, 22 by 34 inches
1042     wxPAPER_ESHEET,             ///<  E Sheet, 34 by 44 inches
1043     wxPAPER_LETTERSMALL,        ///<  Letter Small, 8 1/2 by 11 inches
1044     wxPAPER_TABLOID,            ///<  Tabloid, 11 by 17 inches
1045     wxPAPER_LEDGER,             ///<  Ledger, 17 by 11 inches
1046     wxPAPER_STATEMENT,          ///<  Statement, 5 1/2 by 8 1/2 inches
1047     wxPAPER_EXECUTIVE,          ///<  Executive, 7 1/4 by 10 1/2 inches
1048     wxPAPER_A3,                 ///<  A3 sheet, 297 by 420 millimeters
1049     wxPAPER_A4SMALL,            ///<  A4 small sheet, 210 by 297 millimeters
1050     wxPAPER_A5,                 ///<  A5 sheet, 148 by 210 millimeters
1051     wxPAPER_B4,                 ///<  B4 sheet, 250 by 354 millimeters
1052     wxPAPER_B5,                 ///<  B5 sheet, 182-by-257-millimeter paper
1053     wxPAPER_FOLIO,              ///<  Folio, 8-1/2-by-13-inch paper
1054     wxPAPER_QUARTO,             ///<  Quarto, 215-by-275-millimeter paper
1055     wxPAPER_10X14,              ///<  10-by-14-inch sheet
1056     wxPAPER_11X17,              ///<  11-by-17-inch sheet
1057     wxPAPER_NOTE,               ///<  Note, 8 1/2 by 11 inches
1058     wxPAPER_ENV_9,              ///<  #9 Envelope, 3 7/8 by 8 7/8 inches
1059     wxPAPER_ENV_10,             ///<  #10 Envelope, 4 1/8 by 9 1/2 inches
1060     wxPAPER_ENV_11,             ///<  #11 Envelope, 4 1/2 by 10 3/8 inches
1061     wxPAPER_ENV_12,             ///<  #12 Envelope, 4 3/4 by 11 inches
1062     wxPAPER_ENV_14,             ///<  #14 Envelope, 5 by 11 1/2 inches
1063     wxPAPER_ENV_DL,             ///<  DL Envelope, 110 by 220 millimeters
1064     wxPAPER_ENV_C5,             ///<  C5 Envelope, 162 by 229 millimeters
1065     wxPAPER_ENV_C3,             ///<  C3 Envelope, 324 by 458 millimeters
1066     wxPAPER_ENV_C4,             ///<  C4 Envelope, 229 by 324 millimeters
1067     wxPAPER_ENV_C6,             ///<  C6 Envelope, 114 by 162 millimeters
1068     wxPAPER_ENV_C65,            ///<  C65 Envelope, 114 by 229 millimeters
1069     wxPAPER_ENV_B4,             ///<  B4 Envelope, 250 by 353 millimeters
1070     wxPAPER_ENV_B5,             ///<  B5 Envelope, 176 by 250 millimeters
1071     wxPAPER_ENV_B6,             ///<  B6 Envelope, 176 by 125 millimeters
1072     wxPAPER_ENV_ITALY,          ///<  Italy Envelope, 110 by 230 millimeters
1073     wxPAPER_ENV_MONARCH,        ///<  Monarch Envelope, 3 7/8 by 7 1/2 inches
1074     wxPAPER_ENV_PERSONAL,       ///<  6 3/4 Envelope, 3 5/8 by 6 1/2 inches
1075     wxPAPER_FANFOLD_US,         ///<  US Std Fanfold, 14 7/8 by 11 inches
1076     wxPAPER_FANFOLD_STD_GERMAN, ///<  German Std Fanfold, 8 1/2 by 12 inches
1077     wxPAPER_FANFOLD_LGL_GERMAN, ///<  German Legal Fanfold, 8 1/2 by 13 inches
1078
1079     // wxMSW Only
1080
1081     wxPAPER_ISO_B4,             ///<  B4 (ISO) 250 x 353 mm
1082     wxPAPER_JAPANESE_POSTCARD,  ///<  Japanese Postcard 100 x 148 mm
1083     wxPAPER_9X11,               ///<  9 x 11 in
1084     wxPAPER_10X11,              ///<  10 x 11 in
1085     wxPAPER_15X11,              ///<  15 x 11 in
1086     wxPAPER_ENV_INVITE,         ///<  Envelope Invite 220 x 220 mm
1087     wxPAPER_LETTER_EXTRA,       ///<  Letter Extra 9.5 x 12 in
1088     wxPAPER_LEGAL_EXTRA,        ///<  Legal Extra 9.5 x 15 in
1089     wxPAPER_TABLOID_EXTRA,      ///<  Tabloid Extra 11.69 x 18 in
1090     wxPAPER_A4_EXTRA,           ///<  A4 Extra 9.27 x 12.69 in
1091     wxPAPER_LETTER_TRANSVERSE,  ///<  Letter Transverse 8.5 x 11 in
1092     wxPAPER_A4_TRANSVERSE,      ///<  A4 Transverse 210 x 297 mm
1093     wxPAPER_LETTER_EXTRA_TRANSVERSE, ///<  Letter Extra Transverse 9.5 x 12 in
1094     wxPAPER_A_PLUS,             ///<  SuperA/SuperA/A4 227 x 356 mm
1095     wxPAPER_B_PLUS,             ///<  SuperB/SuperB/A3 305 x 487 mm
1096     wxPAPER_LETTER_PLUS,        ///<  Letter Plus 8.5 x 12.69 in
1097     wxPAPER_A4_PLUS,            ///<  A4 Plus 210 x 330 mm
1098     wxPAPER_A5_TRANSVERSE,      ///<  A5 Transverse 148 x 210 mm
1099     wxPAPER_B5_TRANSVERSE,      ///<  B5 (JIS) Transverse 182 x 257 mm
1100     wxPAPER_A3_EXTRA,           ///<  A3 Extra 322 x 445 mm
1101     wxPAPER_A5_EXTRA,           ///<  A5 Extra 174 x 235 mm
1102     wxPAPER_B5_EXTRA,           ///<  B5 (ISO) Extra 201 x 276 mm
1103     wxPAPER_A2,                 ///<  A2 420 x 594 mm
1104     wxPAPER_A3_TRANSVERSE,      ///<  A3 Transverse 297 x 420 mm
1105     wxPAPER_A3_EXTRA_TRANSVERSE, ///<  A3 Extra Transverse 322 x 445 mm
1106
1107     wxPAPER_DBL_JAPANESE_POSTCARD, ///< Japanese Double Postcard 200 x 148 mm
1108     wxPAPER_A6,                 ///< A6 105 x 148 mm
1109     wxPAPER_JENV_KAKU2,         ///< Japanese Envelope Kaku #2
1110     wxPAPER_JENV_KAKU3,         ///< Japanese Envelope Kaku #3
1111     wxPAPER_JENV_CHOU3,         ///< Japanese Envelope Chou #3
1112     wxPAPER_JENV_CHOU4,         ///< Japanese Envelope Chou #4
1113     wxPAPER_LETTER_ROTATED,     ///< Letter Rotated 11 x 8 1/2 in
1114     wxPAPER_A3_ROTATED,         ///< A3 Rotated 420 x 297 mm
1115     wxPAPER_A4_ROTATED,         ///< A4 Rotated 297 x 210 mm
1116     wxPAPER_A5_ROTATED,         ///< A5 Rotated 210 x 148 mm
1117     wxPAPER_B4_JIS_ROTATED,     ///< B4 (JIS) Rotated 364 x 257 mm
1118     wxPAPER_B5_JIS_ROTATED,     ///< B5 (JIS) Rotated 257 x 182 mm
1119     wxPAPER_JAPANESE_POSTCARD_ROTATED, ///< Japanese Postcard Rotated 148 x 100 mm
1120     wxPAPER_DBL_JAPANESE_POSTCARD_ROTATED, ///< Double Japanese Postcard Rotated 148 x 200 mm
1121     wxPAPER_A6_ROTATED,         ///< A6 Rotated 148 x 105 mm
1122     wxPAPER_JENV_KAKU2_ROTATED, ///< Japanese Envelope Kaku #2 Rotated
1123     wxPAPER_JENV_KAKU3_ROTATED, ///< Japanese Envelope Kaku #3 Rotated
1124     wxPAPER_JENV_CHOU3_ROTATED, ///< Japanese Envelope Chou #3 Rotated
1125     wxPAPER_JENV_CHOU4_ROTATED, ///< Japanese Envelope Chou #4 Rotated
1126     wxPAPER_B6_JIS,             ///< B6 (JIS) 128 x 182 mm
1127     wxPAPER_B6_JIS_ROTATED,     ///< B6 (JIS) Rotated 182 x 128 mm
1128     wxPAPER_12X11,              ///< 12 x 11 in
1129     wxPAPER_JENV_YOU4,          ///< Japanese Envelope You #4
1130     wxPAPER_JENV_YOU4_ROTATED,  ///< Japanese Envelope You #4 Rotated
1131     wxPAPER_P16K,               ///< PRC 16K 146 x 215 mm
1132     wxPAPER_P32K,               ///< PRC 32K 97 x 151 mm
1133     wxPAPER_P32KBIG,            ///< PRC 32K(Big) 97 x 151 mm
1134     wxPAPER_PENV_1,             ///< PRC Envelope #1 102 x 165 mm
1135     wxPAPER_PENV_2,             ///< PRC Envelope #2 102 x 176 mm
1136     wxPAPER_PENV_3,             ///< PRC Envelope #3 125 x 176 mm
1137     wxPAPER_PENV_4,             ///< PRC Envelope #4 110 x 208 mm
1138     wxPAPER_PENV_5,             ///< PRC Envelope #5 110 x 220 mm
1139     wxPAPER_PENV_6,             ///< PRC Envelope #6 120 x 230 mm
1140     wxPAPER_PENV_7,             ///< PRC Envelope #7 160 x 230 mm
1141     wxPAPER_PENV_8,             ///< PRC Envelope #8 120 x 309 mm
1142     wxPAPER_PENV_9,             ///< PRC Envelope #9 229 x 324 mm
1143     wxPAPER_PENV_10,            ///< PRC Envelope #10 324 x 458 mm
1144     wxPAPER_P16K_ROTATED,       ///< PRC 16K Rotated
1145     wxPAPER_P32K_ROTATED,       ///< PRC 32K Rotated
1146     wxPAPER_P32KBIG_ROTATED,    ///< PRC 32K(Big) Rotated
1147     wxPAPER_PENV_1_ROTATED,     ///< PRC Envelope #1 Rotated 165 x 102 mm
1148     wxPAPER_PENV_2_ROTATED,     ///< PRC Envelope #2 Rotated 176 x 102 mm
1149     wxPAPER_PENV_3_ROTATED,     ///< PRC Envelope #3 Rotated 176 x 125 mm
1150     wxPAPER_PENV_4_ROTATED,     ///< PRC Envelope #4 Rotated 208 x 110 mm
1151     wxPAPER_PENV_5_ROTATED,     ///< PRC Envelope #5 Rotated 220 x 110 mm
1152     wxPAPER_PENV_6_ROTATED,     ///< PRC Envelope #6 Rotated 230 x 120 mm
1153     wxPAPER_PENV_7_ROTATED,     ///< PRC Envelope #7 Rotated 230 x 160 mm
1154     wxPAPER_PENV_8_ROTATED,     ///< PRC Envelope #8 Rotated 309 x 120 mm
1155     wxPAPER_PENV_9_ROTATED,     ///< PRC Envelope #9 Rotated 324 x 229 mm
1156     wxPAPER_PENV_10_ROTATED     ///< PRC Envelope #10 Rotated 458 x 324 m
1157 };
1158
1159 /**
1160     Printing orientation
1161 */
1162
1163 enum wxPrintOrientation
1164 {
1165    wxPORTRAIT,
1166    wxLANDSCAPE
1167 };
1168
1169 /**
1170     Duplex printing modes.
1171 */
1172 enum wxDuplexMode
1173 {
1174     wxDUPLEX_SIMPLEX, /**< Non-duplex */
1175     wxDUPLEX_HORIZONTAL,
1176     wxDUPLEX_VERTICAL
1177 };
1178
1179 /**
1180     Print mode (currently PostScript only).
1181 */
1182 enum wxPrintMode
1183 {
1184     wxPRINT_MODE_NONE =    0,
1185     wxPRINT_MODE_PREVIEW = 1,   /**< Preview in external application */
1186     wxPRINT_MODE_FILE =    2,   /**< Print to file */
1187     wxPRINT_MODE_PRINTER = 3,   /**< Send to printer */
1188     wxPRINT_MODE_STREAM =  4    /**< Send postscript data into a stream */
1189 };
1190
1191 /**
1192     Flags which can be used in wxWindow::UpdateWindowUI().
1193 */
1194 enum wxUpdateUI
1195 {
1196     wxUPDATE_UI_NONE,
1197     wxUPDATE_UI_RECURSE,
1198     wxUPDATE_UI_FROMIDLE  /**<  Invoked from On(Internal)Idle */
1199 };
1200
1201
1202 // ----------------------------------------------------------------------------
1203 // constants
1204 // ----------------------------------------------------------------------------
1205
1206 /**
1207     Top level window styles common to wxFrame and wxDialog
1208 */
1209
1210 #define wxSTAY_ON_TOP           0x8000
1211 #define wxICONIZE               0x4000
1212 #define wxMINIMIZE              wxICONIZE
1213 #define wxMAXIMIZE              0x2000
1214 #define wxCLOSE_BOX             0x1000
1215
1216 #define wxSYSTEM_MENU           0x0800
1217 #define wxMINIMIZE_BOX          0x0400
1218 #define wxMAXIMIZE_BOX          0x0200
1219
1220 #define wxTINY_CAPTION          0x0080  // clashes with wxNO_DEFAULT
1221 #define wxRESIZE_BORDER         0x0040
1222
1223
1224 /**
1225     C99-like sized MIN/MAX constants for all integer types.
1226
1227     For each @c n in the set 8, 16, 32, 64 we define @c wxINTn_MIN, @c
1228     wxINTn_MAX and @c wxUINTc_MAX (@c wxUINTc_MIN is always 0 and so is not
1229     defined).
1230  */
1231 //@{
1232 #define wxINT8_MIN CHAR_MIN
1233 #define wxINT8_MAX CHAR_MAX
1234 #define wxUINT8_MAX UCHAR_MAX
1235
1236 #define wxINT16_MIN SHRT_MIN
1237 #define wxINT16_MAX SHRT_MAX
1238 #define wxUINT16_MAX USHRT_MAX
1239
1240 #define wxINT32_MIN INT_MIN-or-LONG_MIN
1241 #define wxINT32_MAX INT_MAX-or-LONG_MAX
1242 #define wxUINT32_MAX UINT_MAX-or-LONG_MAX
1243
1244 #define wxINT64_MIN LLONG_MIN
1245 #define wxINT64_MAX LLONG_MAX
1246 #define wxUINT64_MAX ULLONG_MAX
1247 //@}
1248
1249 // ----------------------------------------------------------------------------
1250 // types
1251 // ----------------------------------------------------------------------------
1252
1253 /** The type for screen and DC coordinates. */
1254 typedef int wxCoord;
1255
1256 /** A special value meaning "use default coordinate". */
1257 wxCoord wxDefaultCoord = -1;
1258
1259 //@{
1260 /** 8 bit type (the mapping is more complex than a simple @c typedef and is not shown here). */
1261 typedef signed char wxInt8;
1262 typedef unsigned char wxUint8;
1263 typedef wxUint8 wxByte;
1264 //@}
1265
1266 //@{
1267 /** 16 bit type (the mapping is more complex than a simple @c typedef and is not shown here). */
1268 typedef signed short wxInt16;
1269 typedef unsigned short wxUint16;
1270 typedef wxUint16 wxWord;
1271 typedef wxUint16 wxChar16;
1272 //@}
1273
1274 //@{
1275 /** 32 bit type (the mapping is more complex than a simple @c typedef and is not shown here). */
1276 typedef int wxInt32;
1277 typedef unsigned int wxUint32;
1278 typedef wxUint32 wxDword;
1279 typedef wxUint32 wxChar32;
1280 //@}
1281
1282 //@{
1283 /** 64 bit type (the mapping is more complex than a simple @c typedef and is not shown here). */
1284 typedef wxLongLong_t wxInt64;
1285 typedef wxULongLong_t wxUint64;
1286 //@}
1287
1288 //@{
1289 /**
1290     Signed and unsigned integral types big enough to contain all of @c long,
1291     @c size_t and @c void*.
1292     (The mapping is more complex than a simple @c typedef and is not shown here).
1293 */
1294 typedef ssize_t wxIntPtr;
1295 typedef size_t wxUIntPtr;
1296 //@}
1297
1298
1299 /**
1300     32 bit IEEE float ( 1 sign, 8 exponent bits, 23 fraction bits ).
1301     (The mapping is more complex than a simple @c typedef and is not shown here).
1302 */
1303 typedef float wxFloat32;
1304
1305
1306 /**
1307     64 bit IEEE float ( 1 sign, 11 exponent bits, 52 fraction bits ).
1308     (The mapping is more complex than a simple @c typedef and is not shown here).
1309 */
1310 typedef double wxFloat64;
1311
1312 /**
1313     Native fastest representation that has at least wxFloat64 precision, so use
1314     the IEEE types for storage, and this for calculations.
1315     (The mapping is more complex than a simple @c typedef and is not shown here).
1316 */
1317 typedef double wxDouble;
1318
1319
1320
1321 // ----------------------------------------------------------------------------
1322 // macros
1323 // ----------------------------------------------------------------------------
1324
1325
1326 /** @addtogroup group_funcmacro_byteorder */
1327 //@{
1328
1329 /**
1330     This macro will swap the bytes of the @a value variable from little endian
1331     to big endian or vice versa unconditionally, i.e. independently of the
1332     current platform.
1333
1334     @header{wx/defs.h}
1335 */
1336 #define wxINT32_SWAP_ALWAYS( wxInt32_value )
1337 #define wxUINT32_SWAP_ALWAYS( wxUint32_value )
1338 #define wxINT16_SWAP_ALWAYS( wxInt16_value )
1339 #define wxUINT16_SWAP_ALWAYS( wxUint16_value )
1340
1341 //@}
1342
1343 /** @addtogroup group_funcmacro_byteorder */
1344 //@{
1345
1346 /**
1347     This macro will swap the bytes of the @a value variable from little endian
1348     to big endian or vice versa if the program is compiled on a big-endian
1349     architecture (such as Sun work stations). If the program has been compiled
1350     on a little-endian architecture, the value will be unchanged.
1351
1352     Use these macros to read data from and write data to a file that stores
1353     data in little-endian (for example Intel i386) format.
1354
1355     @header{wx/defs.h}
1356 */
1357 #define wxINT32_SWAP_ON_BE( wxInt32_value )
1358 #define wxUINT32_SWAP_ON_BE( wxUint32_value )
1359 #define wxINT16_SWAP_ON_BE( wxInt16_value )
1360 #define wxUINT16_SWAP_ON_BE( wxUint16_value )
1361
1362 //@}
1363
1364 /** @addtogroup group_funcmacro_byteorder */
1365 //@{
1366
1367 /**
1368     This macro will swap the bytes of the @a value variable from little endian
1369     to big endian or vice versa if the program is compiled on a little-endian
1370     architecture (such as Intel PCs). If the program has been compiled on a
1371     big-endian architecture, the value will be unchanged.
1372
1373     Use these macros to read data from and write data to a file that stores
1374     data in big-endian format.
1375
1376     @header{wx/defs.h}
1377 */
1378 #define wxINT32_SWAP_ON_LE( wxInt32_value )
1379 #define wxUINT32_SWAP_ON_LE( wxUint32_value )
1380 #define wxINT16_SWAP_ON_LE( wxInt16_value )
1381 #define wxUINT16_SWAP_ON_LE( wxUint16_value )
1382
1383 //@}
1384
1385
1386
1387 /** @addtogroup group_funcmacro_misc */
1388 //@{
1389
1390 /**
1391     This macro can be used in a class declaration to disable the generation of
1392     default assignment operator.
1393
1394     Some classes have a well-defined copy constructor but cannot have an
1395     assignment operator, typically because they can't be modified once created.
1396     In such case, this macro can be used to disable the automatic assignment
1397     operator generation.
1398
1399     @see wxDECLARE_NO_COPY_CLASS()
1400  */
1401 #define wxDECLARE_NO_ASSIGN_CLASS(classname)
1402
1403 /**
1404     This macro can be used in a class declaration to disable the generation of
1405     default copy ctor and assignment operator.
1406
1407     Some classes don't have a well-defined copying semantics. In this case the
1408     standard C++ convention is to not allow copying them. One way of achieving
1409     it is to use this macro which simply defines a private copy constructor and
1410     assignment operator.
1411
1412     Beware that simply not defining copy constructor and assignment operator is
1413     @em not enough as the compiler would provide its own automatically-generated
1414     versions of them -- hence the usefulness of this macro.
1415
1416     Example of use:
1417     @code
1418     class FooWidget
1419     {
1420     public:
1421         FooWidget();
1422         ...
1423
1424     private:
1425         // widgets can't be copied
1426         wxDECLARE_NO_COPY_CLASS(FooWidget);
1427     };
1428     @endcode
1429
1430     Notice that a semicolon must be used after this macro and that it changes
1431     the access specifier to private internally so it is better to use it at the
1432     end of the class declaration.
1433
1434     @see wxDECLARE_NO_ASSIGN_CLASS(), wxDECLARE_NO_COPY_TEMPLATE_CLASS()
1435  */
1436 #define wxDECLARE_NO_COPY_CLASS(classname)
1437
1438 /**
1439     Analog of wxDECLARE_NO_COPY_CLASS() for template classes.
1440
1441     This macro can be used for template classes (with a single template
1442     parameter) for the same purpose as wxDECLARE_NO_COPY_CLASS() is used with the
1443     non-template classes.
1444
1445     @param classname The name of the template class.
1446     @param arg The name of the template parameter.
1447
1448     @see wxDECLARE_NO_COPY_TEMPLATE_CLASS_2
1449  */
1450 #define wxDECLARE_NO_COPY_TEMPLATE_CLASS(classname, arg)
1451
1452 /**
1453     Analog of wxDECLARE_NO_COPY_TEMPLATE_CLASS() for templates with 2
1454     parameters.
1455
1456     This macro can be used for template classes with two template
1457     parameters for the same purpose as wxDECLARE_NO_COPY_CLASS() is used with
1458     the non-template classes.
1459
1460     @param classname The name of the template class.
1461     @param arg1 The name of the first template parameter.
1462     @param arg2 The name of the second template parameter.
1463
1464     @see wxDECLARE_NO_COPY_TEMPLATE_CLASS
1465  */
1466 #define wxDECLARE_NO_COPY_TEMPLATE_CLASS_2(classname, arg1, arg2)
1467
1468 /**
1469     A function which deletes and nulls the pointer.
1470
1471     This function uses operator delete to free the pointer and also sets it to
1472     @NULL. Notice that this does @em not work for arrays, use wxDELETEA() for
1473     them.
1474
1475     @code
1476         MyClass *ptr = new MyClass;
1477         ...
1478         wxDELETE(ptr);
1479         wxASSERT(!ptr);
1480     @endcode
1481
1482     @header{wx/defs.h}
1483 */
1484 template <typename T> wxDELETE(T*& ptr);
1485
1486 /**
1487     A function which deletes and nulls the pointer.
1488
1489     This function uses vector operator delete (@c delete[]) to free the array
1490     pointer and also sets it to @NULL. Notice that this does @em not work for
1491     non-array pointers, use wxDELETE() for them.
1492
1493     @code
1494         MyClass *array = new MyClass[17];
1495         ...
1496         wxDELETEA(array);
1497         wxASSERT(!array);
1498     @endcode
1499
1500     @see wxDELETE()
1501
1502     @header{wx/defs.h}
1503 */
1504 template <typename T> wxDELETEA(T*& array);
1505
1506 /**
1507     This macro can be used around a function declaration to generate warnings
1508     indicating that this function is deprecated (i.e. obsolete and planned to
1509     be removed in the future) when it is used. Only Visual C++ 7 and higher and
1510     g++ compilers currently support this functionality.
1511
1512     Example of use:
1513
1514     @code
1515     // old function, use wxString version instead
1516     wxDEPRECATED( void wxGetSomething(char *buf, size_t len) );
1517
1518     // ...
1519     wxString wxGetSomething();
1520     @endcode
1521
1522     @header{wx/defs.h}
1523 */
1524 #define wxDEPRECATED(function)
1525
1526 /**
1527     This is a special version of wxDEPRECATED() macro which only does something
1528     when the deprecated function is used from the code outside wxWidgets itself
1529     but doesn't generate warnings when it is used from wxWidgets.
1530
1531     It is used with the virtual functions which are called by the library
1532     itself -- even if such function is deprecated the library still has to call
1533     it to ensure that the existing code overriding it continues to work, but
1534     the use of this macro ensures that a deprecation warning will be generated
1535     if this function is used from the user code or, in case of Visual C++, even
1536     when it is simply overridden.
1537
1538     @header{wx/defs.h}
1539 */
1540 #define wxDEPRECATED_BUT_USED_INTERNALLY(function)
1541
1542 /**
1543     This macro is similar to wxDEPRECATED() but can be used to not only declare
1544     the function @a function as deprecated but to also provide its (inline)
1545     implementation @a body.
1546
1547     It can be used as following:
1548
1549     @code
1550     class wxFoo
1551     {
1552     public:
1553         // OldMethod() is deprecated, use NewMethod() instead
1554         void NewMethod();
1555         wxDEPRECATED_INLINE( void OldMethod(), NewMethod(); )
1556     };
1557     @endcode
1558
1559     @header{wx/defs.h}
1560 */
1561 #define wxDEPRECATED_INLINE(func, body)
1562
1563 /**
1564     A helper macro allowing to easily define a simple deprecated accessor.
1565
1566     Compared to wxDEPRECATED_INLINE() it saves a @c return statement and,
1567     especially, a strangely looking semicolon inside a macro.
1568
1569     Example of use
1570     @code
1571     class wxFoo
1572     {
1573     public:
1574         int GetValue() const { return m_value; }
1575
1576         // this one is deprecated because it was erroneously non-const
1577         wxDEPRECATED_ACCESSOR( int GetValue(), m_value )
1578
1579     private:
1580         int m_value;
1581     };
1582     @endcode
1583  */
1584 #define wxDEPRECATED_ACCESSOR(func, what)
1585
1586 /**
1587     Combination of wxDEPRECATED_BUT_USED_INTERNALLY() and wxDEPRECATED_INLINE().
1588
1589     This macro should be used for deprecated functions called by the library
1590     itself (usually for backwards compatibility reasons) and which are defined
1591     inline.
1592
1593     @header{wx/defs.h}
1594 */
1595 #define wxDEPRECATED_BUT_USED_INTERNALLY_INLINE(func, body)
1596
1597 /**
1598     @c wxEXPLICIT is a macro which expands to the C++ @c explicit keyword if
1599     the compiler supports it or nothing otherwise. Thus, it can be used even in
1600     the code which might have to be compiled with an old compiler without
1601     support for this language feature but still take advantage of it when it is
1602     available.
1603
1604     @header{wx/defs.h}
1605 */
1606 #define wxEXPLICIT
1607
1608 /**
1609     GNU C++ compiler gives a warning for any class whose destructor is private
1610     unless it has a friend. This warning may sometimes be useful but it doesn't
1611     make sense for reference counted class which always delete themselves
1612     (hence destructor should be private) but don't necessarily have any
1613     friends, so this macro is provided to disable the warning in such case. The
1614     @a name parameter should be the name of the class but is only used to
1615     construct a unique friend class name internally.
1616
1617     Example of using the macro:
1618
1619     @code
1620     class RefCounted
1621     {
1622     public:
1623         RefCounted() { m_nRef = 1; }
1624         void IncRef() { m_nRef++ ; }
1625         void DecRef() { if ( !--m_nRef ) delete this; }
1626
1627     private:
1628         ~RefCounted() { }
1629
1630         wxSUPPRESS_GCC_PRIVATE_DTOR(RefCounted)
1631     };
1632     @endcode
1633
1634     Notice that there should be no semicolon after this macro.
1635
1636     @header{wx/defs.h}
1637 */
1638 #define wxSUPPRESS_GCC_PRIVATE_DTOR_WARNING(name)
1639
1640 /**
1641     Swaps the contents of two variables.
1642
1643     This is similar to std::swap() but can be used even on the platforms where
1644     the standard C++ library is not available (if you don't target such
1645     platforms, please use std::swap() instead).
1646
1647     The function relies on type T being copy constructible and assignable.
1648
1649     Example of use:
1650     @code
1651         int x = 3,
1652             y = 4;
1653         wxSwap(x, y);
1654         wxASSERT( x == 4 && y == 3 );
1655     @endcode
1656  */
1657 template <typename T> wxSwap(T& first, T& second);
1658
1659 /**
1660     This macro is the same as the standard C99 @c va_copy for the compilers
1661     which support it or its replacement for those that don't. It must be used
1662     to preserve the value of a @c va_list object if you need to use it after
1663     passing it to another function because it can be modified by the latter.
1664
1665     As with @c va_start, each call to @c wxVaCopy must have a matching
1666     @c va_end.
1667
1668     @header{wx/defs.h}
1669 */
1670 void wxVaCopy(va_list argptrDst, va_list argptrSrc);
1671
1672 //@}
1673
1674