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