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