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