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