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 license
   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 synonim 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     wxALIGN_NOT               = 0x0000,
  70     wxALIGN_CENTER_HORIZONTAL = 0x0100,
  71     wxALIGN_CENTRE_HORIZONTAL = wxALIGN_CENTER_HORIZONTAL,
  72     wxALIGN_LEFT              = wxALIGN_NOT,
  73     wxALIGN_TOP               = wxALIGN_NOT,
  74     wxALIGN_RIGHT             = 0x0200,
  75     wxALIGN_BOTTOM            = 0x0400,
  76     wxALIGN_CENTER_VERTICAL   = 0x0800,
  77     wxALIGN_CENTRE_VERTICAL   = wxALIGN_CENTER_VERTICAL,
  78
  79     wxALIGN_CENTER            = (wxALIGN_CENTER_HORIZONTAL | wxALIGN_CENTER_VERTICAL),
  80     wxALIGN_CENTRE            = wxALIGN_CENTER,
  81
  82     /** A mask to extract alignment from the combination of flags. */
  83     wxALIGN_MASK              = 0x0f00
  84 };
  85
  86 /**
  87     Miscellaneous flags for wxSizer items.
  88 */
  89 enum wxSizerFlagBits
  90 {
  91     wxFIXED_MINSIZE                = 0x8000,
  92     wxRESERVE_SPACE_EVEN_IF_HIDDEN = 0x0002,
  93
  94     /*  a mask to extract wxSizerFlagBits from combination of flags */
  95     wxSIZER_FLAG_BITS_MASK         = 0x8002
  96 };
  97
  98 /**
  99     Generic stretch values.
 100 */
 101 enum wxStretch
 102 {
 103     wxSTRETCH_NOT             = 0x0000,
 104     wxSHRINK                  = 0x1000,
 105     wxGROW                    = 0x2000,
 106     wxEXPAND                  = wxGROW,
 107     wxSHAPED                  = 0x4000,
 108     wxTILE                    = wxSHAPED | wxFIXED_MINSIZE,
 109
 110     /*  a mask to extract stretch from the combination of flags */
 111     wxSTRETCH_MASK            = 0x7000 /* sans wxTILE */
 112 };
 113
 114 /**
 115     Border flags for wxWindow.
 116 */
 117 enum wxBorder
 118 {
 119     /**
 120         This is different from wxBORDER_NONE as by default the controls do have
 121         a border.
 122     */
 123     wxBORDER_DEFAULT = 0,
 124
 125     wxBORDER_NONE   = 0x00200000,
 126     wxBORDER_STATIC = 0x01000000,
 127     wxBORDER_SIMPLE = 0x02000000,
 128     wxBORDER_RAISED = 0x04000000,
 129     wxBORDER_SUNKEN = 0x08000000,
 130     wxBORDER_DOUBLE = 0x10000000, /* deprecated */
 131     wxBORDER_THEME  = wxBORDER_DOUBLE,
 132
 133     /*  a mask to extract border style from the combination of flags */
 134     wxBORDER_MASK   = 0x1f200000
 135 };
 136
 137
 138 /**
 139     Background styles. See wxWindow::SetBackgroundStyle().
 140 */
 141 enum wxBackgroundStyle
 142 {
 143     /// Use the default background, as determined by
 144     /// the system or the current theme.
 145     wxBG_STYLE_SYSTEM,
 146
 147     /// Use a solid colour for the background, this style is set automatically if you call
 148     /// SetBackgroundColour() so you only need to set it explicitly if you had
 149     /// changed the background style to something else before.
 150     wxBG_STYLE_COLOUR,
 151
 152     /// Don't draw the background at all, it's supposed that it is drawn by
 153     /// the user-defined erase background event handler.
 154     /// This style should be used to avoid flicker when the background is entirely
 155     /// custom-drawn.
 156     wxBG_STYLE_CUSTOM,
 157
 158     /// The background is (partially) transparent,this style is automatically set if you call
 159     /// SetTransparent() which is used to set the transparency level.
 160     wxBG_STYLE_TRANSPARENT
 161 };
 162
 163
 164 /**
 165     Standard menu IDs.
 166 */
 167 enum wxStandardID
 168 {
 169     /**
 170        This id delimits the lower bound of the range used by automatically-generated ids
 171        (i.e. those used when wxID_ANY is specified during construction).
 172      */
 173     wxID_AUTO_LOWEST,
 174
 175     /**
 176        This id delimits the upper bound of the range used by automatically-generated ids
 177        (i.e. those used when wxID_ANY is specified during construction).
 178      */
 179     wxID_AUTO_HIGHEST,
 180
 181     /**
 182         No id matches this one when compared to it.
 183     */
 184     wxID_NONE = -3,
 185
 186     /**
 187         Id for a separator line in the menu (invalid for normal item).
 188     */
 189     wxID_SEPARATOR = -2,
 190
 191     /**
 192         Any id: means that we don't care about the id, whether when installing
 193         an event handler or when creating a new window.
 194     */
 195     wxID_ANY = -1,
 196
 197     wxID_LOWEST = 4999,
 198
 199     wxID_OPEN,
 200     wxID_CLOSE,
 201     wxID_NEW,
 202     wxID_SAVE,
 203     wxID_SAVEAS,
 204     wxID_REVERT,
 205     wxID_EXIT,
 206     wxID_UNDO,
 207     wxID_REDO,
 208     wxID_HELP,
 209     wxID_PRINT,
 210     wxID_PRINT_SETUP,
 211     wxID_PAGE_SETUP,
 212     wxID_PREVIEW,
 213     wxID_ABOUT,
 214     wxID_HELP_CONTENTS,
 215     wxID_HELP_INDEX,
 216     wxID_HELP_SEARCH,
 217     wxID_HELP_COMMANDS,
 218     wxID_HELP_PROCEDURES,
 219     wxID_HELP_CONTEXT,
 220     wxID_CLOSE_ALL,
 221     wxID_PREFERENCES,
 222
 223     wxID_EDIT = 5030,
 224     wxID_CUT,
 225     wxID_COPY,
 226     wxID_PASTE,
 227     wxID_CLEAR,
 228     wxID_FIND,
 229     wxID_DUPLICATE,
 230     wxID_SELECTALL,
 231     wxID_DELETE,
 232     wxID_REPLACE,
 233     wxID_REPLACE_ALL,
 234     wxID_PROPERTIES,
 235
 236     wxID_VIEW_DETAILS,
 237     wxID_VIEW_LARGEICONS,
 238     wxID_VIEW_SMALLICONS,
 239     wxID_VIEW_LIST,
 240     wxID_VIEW_SORTDATE,
 241     wxID_VIEW_SORTNAME,
 242     wxID_VIEW_SORTSIZE,
 243     wxID_VIEW_SORTTYPE,
 244
 245     wxID_FILE = 5050,
 246     wxID_FILE1,
 247     wxID_FILE2,
 248     wxID_FILE3,
 249     wxID_FILE4,
 250     wxID_FILE5,
 251     wxID_FILE6,
 252     wxID_FILE7,
 253     wxID_FILE8,
 254     wxID_FILE9,
 255
 256     /** Standard button and menu IDs */
 257     wxID_OK = 5100,
 258     wxID_CANCEL,
 259     wxID_APPLY,
 260     wxID_YES,
 261     wxID_NO,
 262     wxID_STATIC,
 263     wxID_FORWARD,
 264     wxID_BACKWARD,
 265     wxID_DEFAULT,
 266     wxID_MORE,
 267     wxID_SETUP,
 268     wxID_RESET,
 269     wxID_CONTEXT_HELP,
 270     wxID_YESTOALL,
 271     wxID_NOTOALL,
 272     wxID_ABORT,
 273     wxID_RETRY,
 274     wxID_IGNORE,
 275     wxID_ADD,
 276     wxID_REMOVE,
 277
 278     wxID_UP,
 279     wxID_DOWN,
 280     wxID_HOME,
 281     wxID_REFRESH,
 282     wxID_STOP,
 283     wxID_INDEX,
 284
 285     wxID_BOLD,
 286     wxID_ITALIC,
 287     wxID_JUSTIFY_CENTER,
 288     wxID_JUSTIFY_FILL,
 289     wxID_JUSTIFY_RIGHT,
 290     wxID_JUSTIFY_LEFT,
 291     wxID_UNDERLINE,
 292     wxID_INDENT,
 293     wxID_UNINDENT,
 294     wxID_ZOOM_100,
 295     wxID_ZOOM_FIT,
 296     wxID_ZOOM_IN,
 297     wxID_ZOOM_OUT,
 298     wxID_UNDELETE,
 299     wxID_REVERT_TO_SAVED,
 300     wxID_CDROM,
 301     wxID_CONVERT,
 302     wxID_EXECUTE,
 303     wxID_FLOPPY,
 304     wxID_HARDDISK,
 305     wxID_BOTTOM,
 306     wxID_FIRST,
 307     wxID_LAST,
 308     wxID_TOP,
 309     wxID_INFO,
 310     wxID_JUMP_TO,
 311     wxID_NETWORK,
 312     wxID_SELECT_COLOR,
 313     wxID_SELECT_FONT,
 314     wxID_SORT_ASCENDING,
 315     wxID_SORT_DESCENDING,
 316     wxID_SPELL_CHECK,
 317     wxID_STRIKETHROUGH,
 318
 319     /** System menu IDs (used by wxUniv): */
 320     wxID_SYSTEM_MENU = 5200,
 321     wxID_CLOSE_FRAME,
 322     wxID_MOVE_FRAME,
 323     wxID_RESIZE_FRAME,
 324     wxID_MAXIMIZE_FRAME,
 325     wxID_ICONIZE_FRAME,
 326     wxID_RESTORE_FRAME,
 327
 328     /** MDI window menu ids */
 329     wxID_MDI_WINDOW_FIRST = 5230,
 330     wxID_MDI_WINDOW_CASCADE = wxID_MDI_WINDOW_FIRST,
 331     wxID_MDI_WINDOW_TILE_HORZ,
 332     wxID_MDI_WINDOW_TILE_VERT,
 333     wxID_MDI_WINDOW_ARRANGE_ICONS,
 334     wxID_MDI_WINDOW_PREV,
 335     wxID_MDI_WINDOW_NEXT,
 336     wxID_MDI_WINDOW_LAST = wxID_MDI_WINDOW_NEXT,
 337
 338     /** IDs used by generic file dialog (13 consecutive starting from this value) */
 339     wxID_FILEDLGG = 5900,
 340
 341     /** IDs used by generic file ctrl (4 consecutive starting from this value) */
 342     wxID_FILECTRL = 5950,
 343
 344     wxID_HIGHEST = 5999
 345 };
 346
 347 /**
 348     Item kinds for use with wxMenu, wxMenuItem, and wxToolBar.
 349
 350     @see wxMenu::Append(), wxMenuItem::wxMenuItem(), wxToolBar::AddTool()
 351 */
 352 enum wxItemKind
 353 {
 354     wxITEM_SEPARATOR = -1,
 355
 356     /**
 357         Normal tool button / menu item.
 358
 359         @see wxToolBar::AddTool(), wxMenu::AppendItem().
 360     */
 361     wxITEM_NORMAL,
 362
 363     /**
 364         Check (or toggle) tool button / menu item.
 365
 366         @see wxToolBar::AddCheckTool(), wxMenu::AppendCheckItem().
 367     */
 368     wxITEM_CHECK,
 369
 370     /**
 371         Radio tool button / menu item.
 372
 373         @see wxToolBar::AddRadioTool(), wxMenu::AppendRadioItem().
 374     */
 375     wxITEM_RADIO,
 376
 377     /**
 378         Normal tool button with a dropdown arrow next to it. Clicking the
 379         dropdown arrow sends a @c wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED event and may
 380         also display the menu previously associated with the item with
 381         wxToolBar::SetDropdownMenu(). Currently this type of tools is supported
 382         under MSW and GTK.
 383     */
 384     wxITEM_DROPDOWN,
 385
 386     wxITEM_MAX
 387 };
 388
 389 /**
 390     Generic hit test results.
 391 */
 392 enum wxHitTest
 393 {
 394     wxHT_NOWHERE,
 395
 396     /*  scrollbar */
 397     wxHT_SCROLLBAR_FIRST = wxHT_NOWHERE,
 398     wxHT_SCROLLBAR_ARROW_LINE_1,    /**< left or upper arrow to scroll by line */
 399     wxHT_SCROLLBAR_ARROW_LINE_2,    /**< right or down */
 400     wxHT_SCROLLBAR_ARROW_PAGE_1,    /**< left or upper arrow to scroll by page */
 401     wxHT_SCROLLBAR_ARROW_PAGE_2,    /**< right or down */
 402     wxHT_SCROLLBAR_THUMB,           /**< on the thumb */
 403     wxHT_SCROLLBAR_BAR_1,           /**< bar to the left/above the thumb */
 404     wxHT_SCROLLBAR_BAR_2,           /**< bar to the right/below the thumb */
 405     wxHT_SCROLLBAR_LAST,
 406
 407     /*  window */
 408     wxHT_WINDOW_OUTSIDE,            /**< not in this window at all */
 409     wxHT_WINDOW_INSIDE,             /**< in the client area */
 410     wxHT_WINDOW_VERT_SCROLLBAR,     /**< on the vertical scrollbar */
 411     wxHT_WINDOW_HORZ_SCROLLBAR,     /**< on the horizontal scrollbar */
 412     wxHT_WINDOW_CORNER,             /**< on the corner between 2 scrollbars */
 413
 414     wxHT_MAX
 415 };
 416
 417 /**
 418     Data format IDs used by wxDataFormat.
 419 */
 420 enum wxDataFormatId
 421 {
 422     wxDF_INVALID =          0,
 423     wxDF_TEXT =             1,  /* CF_TEXT */
 424     wxDF_BITMAP =           2,  /* CF_BITMAP */
 425     wxDF_METAFILE =         3,  /* CF_METAFILEPICT */
 426     wxDF_SYLK =             4,
 427     wxDF_DIF =              5,
 428     wxDF_TIFF =             6,
 429     wxDF_OEMTEXT =          7,  /* CF_OEMTEXT */
 430     wxDF_DIB =              8,  /* CF_DIB */
 431     wxDF_PALETTE =          9,
 432     wxDF_PENDATA =          10,
 433     wxDF_RIFF =             11,
 434     wxDF_WAVE =             12,
 435     wxDF_UNICODETEXT =      13,
 436     wxDF_ENHMETAFILE =      14,
 437     wxDF_FILENAME =         15, /* CF_HDROP */
 438     wxDF_LOCALE =           16,
 439     wxDF_PRIVATE =          20,
 440     wxDF_HTML =             30, /* Note: does not correspond to CF_ constant */
 441     wxDF_MAX
 442 };
 443
 444 /**
 445     Virtual keycodes used by wxKeyEvent and some other wxWidgets functions.
 446
 447     Note that the range @c 33 - @c 126 is reserved for the standard ASCII
 448     characters and that the range @c 128 - @c 255 is reserved for the
 449     extended ASCII characters (which are not really standard and thus should
 450     be avoid in portable apps!).
 451 */
 452 enum wxKeyCode
 453 {
 454     WXK_BACK    =    8,     //!< Backspace.
 455     WXK_TAB     =    9,
 456     WXK_RETURN  =    13,
 457     WXK_ESCAPE  =    27,
 458     WXK_SPACE   =    32,
 459
 460     WXK_DELETE  =    127,
 461
 462     /**
 463         These are, by design, not compatible with unicode characters.
 464         If you want to get a unicode character from a key event, use
 465         wxKeyEvent::GetUnicodeKey instead.
 466     */
 467     WXK_START   = 300,
 468     WXK_LBUTTON,
 469     WXK_RBUTTON,
 470     WXK_CANCEL,
 471     WXK_MBUTTON,
 472     WXK_CLEAR,
 473     WXK_SHIFT,
 474     WXK_ALT,
 475     WXK_CONTROL,
 476     WXK_MENU,
 477     WXK_PAUSE,
 478     WXK_CAPITAL,
 479     WXK_END,
 480     WXK_HOME,
 481     WXK_LEFT,
 482     WXK_UP,
 483     WXK_RIGHT,
 484     WXK_DOWN,
 485     WXK_SELECT,
 486     WXK_PRINT,
 487     WXK_EXECUTE,
 488     WXK_SNAPSHOT,
 489     WXK_INSERT,
 490     WXK_HELP,
 491     WXK_NUMPAD0,
 492     WXK_NUMPAD1,
 493     WXK_NUMPAD2,
 494     WXK_NUMPAD3,
 495     WXK_NUMPAD4,
 496     WXK_NUMPAD5,
 497     WXK_NUMPAD6,
 498     WXK_NUMPAD7,
 499     WXK_NUMPAD8,
 500     WXK_NUMPAD9,
 501     WXK_MULTIPLY,
 502     WXK_ADD,
 503     WXK_SEPARATOR,
 504     WXK_SUBTRACT,
 505     WXK_DECIMAL,
 506     WXK_DIVIDE,
 507     WXK_F1,
 508     WXK_F2,
 509     WXK_F3,
 510     WXK_F4,
 511     WXK_F5,
 512     WXK_F6,
 513     WXK_F7,
 514     WXK_F8,
 515     WXK_F9,
 516     WXK_F10,
 517     WXK_F11,
 518     WXK_F12,
 519     WXK_F13,
 520     WXK_F14,
 521     WXK_F15,
 522     WXK_F16,
 523     WXK_F17,
 524     WXK_F18,
 525     WXK_F19,
 526     WXK_F20,
 527     WXK_F21,
 528     WXK_F22,
 529     WXK_F23,
 530     WXK_F24,
 531     WXK_NUMLOCK,
 532     WXK_SCROLL,
 533     WXK_PAGEUP,
 534     WXK_PAGEDOWN,
 535
 536     WXK_NUMPAD_SPACE,
 537     WXK_NUMPAD_TAB,
 538     WXK_NUMPAD_ENTER,
 539     WXK_NUMPAD_F1,
 540     WXK_NUMPAD_F2,
 541     WXK_NUMPAD_F3,
 542     WXK_NUMPAD_F4,
 543     WXK_NUMPAD_HOME,
 544     WXK_NUMPAD_LEFT,
 545     WXK_NUMPAD_UP,
 546     WXK_NUMPAD_RIGHT,
 547     WXK_NUMPAD_DOWN,
 548     WXK_NUMPAD_PAGEUP,
 549     WXK_NUMPAD_PAGEDOWN,
 550     WXK_NUMPAD_END,
 551     WXK_NUMPAD_BEGIN,
 552     WXK_NUMPAD_INSERT,
 553     WXK_NUMPAD_DELETE,
 554     WXK_NUMPAD_EQUAL,
 555     WXK_NUMPAD_MULTIPLY,
 556     WXK_NUMPAD_ADD,
 557     WXK_NUMPAD_SEPARATOR,
 558     WXK_NUMPAD_SUBTRACT,
 559     WXK_NUMPAD_DECIMAL,
 560     WXK_NUMPAD_DIVIDE,
 561
 562     /** The following key codes are only generated under Windows currently */
 563     WXK_WINDOWS_LEFT,
 564     WXK_WINDOWS_RIGHT,
 565     WXK_WINDOWS_MENU ,
 566     WXK_COMMAND,
 567
 568     /** Hardware-specific buttons */
 569     WXK_SPECIAL1 = 193,
 570     WXK_SPECIAL2,
 571     WXK_SPECIAL3,
 572     WXK_SPECIAL4,
 573     WXK_SPECIAL5,
 574     WXK_SPECIAL6,
 575     WXK_SPECIAL7,
 576     WXK_SPECIAL8,
 577     WXK_SPECIAL9,
 578     WXK_SPECIAL10,
 579     WXK_SPECIAL11,
 580     WXK_SPECIAL12,
 581     WXK_SPECIAL13,
 582     WXK_SPECIAL14,
 583     WXK_SPECIAL15,
 584     WXK_SPECIAL16,
 585     WXK_SPECIAL17,
 586     WXK_SPECIAL18,
 587     WXK_SPECIAL19,
 588     WXK_SPECIAL20
 589 };
 590
 591 /**
 592     This enum contains bit mask constants used in wxKeyEvent.
 593 */
 594 enum wxKeyModifier
 595 {
 596     wxMOD_NONE      = 0x0000,
 597     wxMOD_ALT       = 0x0001,
 598     wxMOD_CONTROL   = 0x0002,
 599     wxMOD_ALTGR     = wxMOD_ALT | wxMOD_CONTROL,
 600     wxMOD_SHIFT     = 0x0004,
 601     wxMOD_META      = 0x0008,
 602     wxMOD_WIN       = wxMOD_META,
 603
 604     /**
 605         Notice that @c wxMOD_CMD should be used instead of @c wxMOD_CONTROL
 606         in portable code to account for the fact that although
 607         @c Control modifier exists under Mac OS, it is not used for the same
 608         purpose as under Windows or Unix there while the special Mac-specific
 609         @c Command modifier is used in exactly the same way.
 610     */
 611     wxMOD_CMD       = wxMOD_META,
 612     wxMOD_ALL       = 0xffff
 613 };
 614
 615 /**
 616     Paper size types for use with the printing framework.
 617
 618     @see overview_printing, wxPrintData::SetPaperId()
 619 */
 620 enum wxPaperSize
 621 {
 622     wxPAPER_NONE,               ///<  Use specific dimensions
 623     wxPAPER_LETTER,             ///<  Letter, 8 1/2 by 11 inches
 624     wxPAPER_LEGAL,              ///<  Legal, 8 1/2 by 14 inches
 625     wxPAPER_A4,                 ///<  A4 Sheet, 210 by 297 millimeters
 626     wxPAPER_CSHEET,             ///<  C Sheet, 17 by 22 inches
 627     wxPAPER_DSHEET,             ///<  D Sheet, 22 by 34 inches
 628     wxPAPER_ESHEET,             ///<  E Sheet, 34 by 44 inches
 629     wxPAPER_LETTERSMALL,        ///<  Letter Small, 8 1/2 by 11 inches
 630     wxPAPER_TABLOID,            ///<  Tabloid, 11 by 17 inches
 631     wxPAPER_LEDGER,             ///<  Ledger, 17 by 11 inches
 632     wxPAPER_STATEMENT,          ///<  Statement, 5 1/2 by 8 1/2 inches
 633     wxPAPER_EXECUTIVE,          ///<  Executive, 7 1/4 by 10 1/2 inches
 634     wxPAPER_A3,                 ///<  A3 sheet, 297 by 420 millimeters
 635     wxPAPER_A4SMALL,            ///<  A4 small sheet, 210 by 297 millimeters
 636     wxPAPER_A5,                 ///<  A5 sheet, 148 by 210 millimeters
 637     wxPAPER_B4,                 ///<  B4 sheet, 250 by 354 millimeters
 638     wxPAPER_B5,                 ///<  B5 sheet, 182-by-257-millimeter paper
 639     wxPAPER_FOLIO,              ///<  Folio, 8-1/2-by-13-inch paper
 640     wxPAPER_QUARTO,             ///<  Quarto, 215-by-275-millimeter paper
 641     wxPAPER_10X14,              ///<  10-by-14-inch sheet
 642     wxPAPER_11X17,              ///<  11-by-17-inch sheet
 643     wxPAPER_NOTE,               ///<  Note, 8 1/2 by 11 inches
 644     wxPAPER_ENV_9,              ///<  #9 Envelope, 3 7/8 by 8 7/8 inches
 645     wxPAPER_ENV_10,             ///<  #10 Envelope, 4 1/8 by 9 1/2 inches
 646     wxPAPER_ENV_11,             ///<  #11 Envelope, 4 1/2 by 10 3/8 inches
 647     wxPAPER_ENV_12,             ///<  #12 Envelope, 4 3/4 by 11 inches
 648     wxPAPER_ENV_14,             ///<  #14 Envelope, 5 by 11 1/2 inches
 649     wxPAPER_ENV_DL,             ///<  DL Envelope, 110 by 220 millimeters
 650     wxPAPER_ENV_C5,             ///<  C5 Envelope, 162 by 229 millimeters
 651     wxPAPER_ENV_C3,             ///<  C3 Envelope, 324 by 458 millimeters
 652     wxPAPER_ENV_C4,             ///<  C4 Envelope, 229 by 324 millimeters
 653     wxPAPER_ENV_C6,             ///<  C6 Envelope, 114 by 162 millimeters
 654     wxPAPER_ENV_C65,            ///<  C65 Envelope, 114 by 229 millimeters
 655     wxPAPER_ENV_B4,             ///<  B4 Envelope, 250 by 353 millimeters
 656     wxPAPER_ENV_B5,             ///<  B5 Envelope, 176 by 250 millimeters
 657     wxPAPER_ENV_B6,             ///<  B6 Envelope, 176 by 125 millimeters
 658     wxPAPER_ENV_ITALY,          ///<  Italy Envelope, 110 by 230 millimeters
 659     wxPAPER_ENV_MONARCH,        ///<  Monarch Envelope, 3 7/8 by 7 1/2 inches
 660     wxPAPER_ENV_PERSONAL,       ///<  6 3/4 Envelope, 3 5/8 by 6 1/2 inches
 661     wxPAPER_FANFOLD_US,         ///<  US Std Fanfold, 14 7/8 by 11 inches
 662     wxPAPER_FANFOLD_STD_GERMAN, ///<  German Std Fanfold, 8 1/2 by 12 inches
 663     wxPAPER_FANFOLD_LGL_GERMAN, ///<  German Legal Fanfold, 8 1/2 by 13 inches
 664
 665     // wxMSW Only
 666
 667     wxPAPER_ISO_B4,             ///<  B4 (ISO) 250 x 353 mm
 668     wxPAPER_JAPANESE_POSTCARD,  ///<  Japanese Postcard 100 x 148 mm
 669     wxPAPER_9X11,               ///<  9 x 11 in
 670     wxPAPER_10X11,              ///<  10 x 11 in
 671     wxPAPER_15X11,              ///<  15 x 11 in
 672     wxPAPER_ENV_INVITE,         ///<  Envelope Invite 220 x 220 mm
 673     wxPAPER_LETTER_EXTRA,       ///<  Letter Extra 9.5 x 12 in
 674     wxPAPER_LEGAL_EXTRA,        ///<  Legal Extra 9.5 x 15 in
 675     wxPAPER_TABLOID_EXTRA,      ///<  Tabloid Extra 11.69 x 18 in
 676     wxPAPER_A4_EXTRA,           ///<  A4 Extra 9.27 x 12.69 in
 677     wxPAPER_LETTER_TRANSVERSE,  ///<  Letter Transverse 8.5 x 11 in
 678     wxPAPER_A4_TRANSVERSE,      ///<  A4 Transverse 210 x 297 mm
 679     wxPAPER_LETTER_EXTRA_TRANSVERSE, ///<  Letter Extra Transverse 9.5 x 12 in
 680     wxPAPER_A_PLUS,             ///<  SuperA/SuperA/A4 227 x 356 mm
 681     wxPAPER_B_PLUS,             ///<  SuperB/SuperB/A3 305 x 487 mm
 682     wxPAPER_LETTER_PLUS,        ///<  Letter Plus 8.5 x 12.69 in
 683     wxPAPER_A4_PLUS,            ///<  A4 Plus 210 x 330 mm
 684     wxPAPER_A5_TRANSVERSE,      ///<  A5 Transverse 148 x 210 mm
 685     wxPAPER_B5_TRANSVERSE,      ///<  B5 (JIS) Transverse 182 x 257 mm
 686     wxPAPER_A3_EXTRA,           ///<  A3 Extra 322 x 445 mm
 687     wxPAPER_A5_EXTRA,           ///<  A5 Extra 174 x 235 mm
 688     wxPAPER_B5_EXTRA,           ///<  B5 (ISO) Extra 201 x 276 mm
 689     wxPAPER_A2,                 ///<  A2 420 x 594 mm
 690     wxPAPER_A3_TRANSVERSE,      ///<  A3 Transverse 297 x 420 mm
 691     wxPAPER_A3_EXTRA_TRANSVERSE, ///<  A3 Extra Transverse 322 x 445 mm
 692
 693     wxPAPER_DBL_JAPANESE_POSTCARD, ///< Japanese Double Postcard 200 x 148 mm
 694     wxPAPER_A6,                 ///< A6 105 x 148 mm
 695     wxPAPER_JENV_KAKU2,         ///< Japanese Envelope Kaku #2
 696     wxPAPER_JENV_KAKU3,         ///< Japanese Envelope Kaku #3
 697     wxPAPER_JENV_CHOU3,         ///< Japanese Envelope Chou #3
 698     wxPAPER_JENV_CHOU4,         ///< Japanese Envelope Chou #4
 699     wxPAPER_LETTER_ROTATED,     ///< Letter Rotated 11 x 8 1/2 in
 700     wxPAPER_A3_ROTATED,         ///< A3 Rotated 420 x 297 mm
 701     wxPAPER_A4_ROTATED,         ///< A4 Rotated 297 x 210 mm
 702     wxPAPER_A5_ROTATED,         ///< A5 Rotated 210 x 148 mm
 703     wxPAPER_B4_JIS_ROTATED,     ///< B4 (JIS) Rotated 364 x 257 mm
 704     wxPAPER_B5_JIS_ROTATED,     ///< B5 (JIS) Rotated 257 x 182 mm
 705     wxPAPER_JAPANESE_POSTCARD_ROTATED, ///< Japanese Postcard Rotated 148 x 100 mm
 706     wxPAPER_DBL_JAPANESE_POSTCARD_ROTATED, ///< Double Japanese Postcard Rotated 148 x 200 mm
 707     wxPAPER_A6_ROTATED,         ///< A6 Rotated 148 x 105 mm
 708     wxPAPER_JENV_KAKU2_ROTATED, ///< Japanese Envelope Kaku #2 Rotated
 709     wxPAPER_JENV_KAKU3_ROTATED, ///< Japanese Envelope Kaku #3 Rotated
 710     wxPAPER_JENV_CHOU3_ROTATED, ///< Japanese Envelope Chou #3 Rotated
 711     wxPAPER_JENV_CHOU4_ROTATED, ///< Japanese Envelope Chou #4 Rotated
 712     wxPAPER_B6_JIS,             ///< B6 (JIS) 128 x 182 mm
 713     wxPAPER_B6_JIS_ROTATED,     ///< B6 (JIS) Rotated 182 x 128 mm
 714     wxPAPER_12X11,              ///< 12 x 11 in
 715     wxPAPER_JENV_YOU4,          ///< Japanese Envelope You #4
 716     wxPAPER_JENV_YOU4_ROTATED,  ///< Japanese Envelope You #4 Rotated
 717     wxPAPER_P16K,               ///< PRC 16K 146 x 215 mm
 718     wxPAPER_P32K,               ///< PRC 32K 97 x 151 mm
 719     wxPAPER_P32KBIG,            ///< PRC 32K(Big) 97 x 151 mm
 720     wxPAPER_PENV_1,             ///< PRC Envelope #1 102 x 165 mm
 721     wxPAPER_PENV_2,             ///< PRC Envelope #2 102 x 176 mm
 722     wxPAPER_PENV_3,             ///< PRC Envelope #3 125 x 176 mm
 723     wxPAPER_PENV_4,             ///< PRC Envelope #4 110 x 208 mm
 724     wxPAPER_PENV_5,             ///< PRC Envelope #5 110 x 220 mm
 725     wxPAPER_PENV_6,             ///< PRC Envelope #6 120 x 230 mm
 726     wxPAPER_PENV_7,             ///< PRC Envelope #7 160 x 230 mm
 727     wxPAPER_PENV_8,             ///< PRC Envelope #8 120 x 309 mm
 728     wxPAPER_PENV_9,             ///< PRC Envelope #9 229 x 324 mm
 729     wxPAPER_PENV_10,            ///< PRC Envelope #10 324 x 458 mm
 730     wxPAPER_P16K_ROTATED,       ///< PRC 16K Rotated
 731     wxPAPER_P32K_ROTATED,       ///< PRC 32K Rotated
 732     wxPAPER_P32KBIG_ROTATED,    ///< PRC 32K(Big) Rotated
 733     wxPAPER_PENV_1_ROTATED,     ///< PRC Envelope #1 Rotated 165 x 102 mm
 734     wxPAPER_PENV_2_ROTATED,     ///< PRC Envelope #2 Rotated 176 x 102 mm
 735     wxPAPER_PENV_3_ROTATED,     ///< PRC Envelope #3 Rotated 176 x 125 mm
 736     wxPAPER_PENV_4_ROTATED,     ///< PRC Envelope #4 Rotated 208 x 110 mm
 737     wxPAPER_PENV_5_ROTATED,     ///< PRC Envelope #5 Rotated 220 x 110 mm
 738     wxPAPER_PENV_6_ROTATED,     ///< PRC Envelope #6 Rotated 230 x 120 mm
 739     wxPAPER_PENV_7_ROTATED,     ///< PRC Envelope #7 Rotated 230 x 160 mm
 740     wxPAPER_PENV_8_ROTATED,     ///< PRC Envelope #8 Rotated 309 x 120 mm
 741     wxPAPER_PENV_9_ROTATED,     ///< PRC Envelope #9 Rotated 324 x 229 mm
 742     wxPAPER_PENV_10_ROTATED     ///< PRC Envelope #10 Rotated 458 x 324 m
 743 };
 744
 745
 746 /**
 747     Duplex printing modes.
 748 */
 749 enum wxDuplexMode
 750 {
 751     wxDUPLEX_SIMPLEX, /**< Non-duplex */
 752     wxDUPLEX_HORIZONTAL,
 753     wxDUPLEX_VERTICAL
 754 };
 755
 756 /**
 757     Print mode (currently PostScript only).
 758 */
 759 enum wxPrintMode
 760 {
 761     wxPRINT_MODE_NONE =    0,
 762     wxPRINT_MODE_PREVIEW = 1,   /**< Preview in external application */
 763     wxPRINT_MODE_FILE =    2,   /**< Print to file */
 764     wxPRINT_MODE_PRINTER = 3,   /**< Send to printer */
 765     wxPRINT_MODE_STREAM =  4    /**< Send postscript data into a stream */
 766 };
 767
 768 /**
 769     Flags which can be used in wxWindow::UpdateWindowUI().
 770 */
 771 enum wxUpdateUI
 772 {
 773     wxUPDATE_UI_NONE,
 774     wxUPDATE_UI_RECURSE,
 775     wxUPDATE_UI_FROMIDLE  /**<  Invoked from On(Internal)Idle */
 776 };
 777
 778
 779
 780 // ----------------------------------------------------------------------------
 781 // types
 782 // ----------------------------------------------------------------------------
 783
 784 /** The type for screen and DC coordinates. */
 785 typedef int wxCoord;
 786
 787 /** A special value meaning "use default coordinate". */
 788 wxCoord wxDefaultCoord = -1;
 789
 790 //@{
 791 /** 8 bit type (the mapping is more complex than a simple @c typedef and is not shown here). */
 792 typedef signed char wxInt8;
 793 typedef unsigned char wxUint8;
 794 typedef wxUint8 wxByte;
 795 //@}
 796
 797 //@{
 798 /** 16 bit type (the mapping is more complex than a simple @c typedef and is not shown here). */
 799 typedef signed short wxInt16;
 800 typedef unsigned short wxUint16;
 801 typedef wxUint16 wxWord;
 802 typedef wxUint16 wxChar16;
 803 //@}
 804
 805 //@{
 806 /** 32 bit type (the mapping is more complex than a simple @c typedef and is not shown here). */
 807 typedef int wxInt32;
 808 typedef unsigned int wxUint32;
 809 typedef wxUint32 wxDword;
 810 typedef wxUint32 wxChar32;
 811 //@}
 812
 813 //@{
 814 /** 64 bit type (the mapping is more complex than a simple @c typedef and is not shown here). */
 815 typedef wxLongLong_t wxInt64;
 816 typedef wxULongLong_t wxUint64;
 817 //@}
 818
 819 //@{
 820 /**
 821     Signed and unsigned integral types big enough to contain all of @c long,
 822     @c size_t and @c void*.
 823     (The mapping is more complex than a simple @c typedef and is not shown here).
 824 */
 825 typedef ssize_t wxIntPtr;
 826 typedef size_t wxUIntPtr;
 827 //@}
 828
 829
 830 /**
 831     32 bit IEEE float ( 1 sign, 8 exponent bits, 23 fraction bits ).
 832     (The mapping is more complex than a simple @c typedef and is not shown here).
 833 */
 834 typedef float wxFloat32;
 835
 836
 837 /**
 838     64 bit IEEE float ( 1 sign, 11 exponent bits, 52 fraction bits ).
 839     (The mapping is more complex than a simple @c typedef and is not shown here).
 840 */
 841 typedef double wxFloat64;
 842
 843 /**
 844     Native fastest representation that has at least wxFloat64 precision, so use
 845     the IEEE types for storage, and this for calculations.
 846     (The mapping is more complex than a simple @c typedef and is not shown here).
 847 */
 848 typedef double wxDouble;
 849
 850
 851
 852 // ----------------------------------------------------------------------------
 853 // macros
 854 // ----------------------------------------------------------------------------
 855
 856
 857 /** @addtogroup group_funcmacro_byteorder */
 858 //@{
 859
 860 /**
 861     This macro will swap the bytes of the @a value variable from little endian
 862     to big endian or vice versa unconditionally, i.e. independently of the
 863     current platform.
 864
 865     @header{wx/defs.h}
 866 */
 867 #define wxINT32_SWAP_ALWAYS( wxInt32_value )
 868 #define wxUINT32_SWAP_ALWAYS( wxUint32_value )
 869 #define wxINT16_SWAP_ALWAYS( wxInt16_value )
 870 #define wxUINT16_SWAP_ALWAYS( wxUint16_value )
 871
 872 //@}
 873
 874 /** @addtogroup group_funcmacro_byteorder */
 875 //@{
 876
 877 /**
 878     This macro will swap the bytes of the @a value variable from little endian
 879     to big endian or vice versa if the program is compiled on a big-endian
 880     architecture (such as Sun work stations). If the program has been compiled
 881     on a little-endian architecture, the value will be unchanged.
 882
 883     Use these macros to read data from and write data to a file that stores
 884     data in little-endian (for example Intel i386) format.
 885
 886     @header{wx/defs.h}
 887 */
 888 #define wxINT32_SWAP_ON_BE( wxInt32_value )
 889 #define wxUINT32_SWAP_ON_BE( wxUint32_value )
 890 #define wxINT16_SWAP_ON_BE( wxInt16_value )
 891 #define wxUINT16_SWAP_ON_BE( wxUint16_value )
 892
 893 //@}
 894
 895 /** @addtogroup group_funcmacro_byteorder */
 896 //@{
 897
 898 /**
 899     This macro will swap the bytes of the @a value variable from little endian
 900     to big endian or vice versa if the program is compiled on a little-endian
 901     architecture (such as Intel PCs). If the program has been compiled on a
 902     big-endian architecture, the value will be unchanged.
 903
 904     Use these macros to read data from and write data to a file that stores
 905     data in big-endian format.
 906
 907     @header{wx/defs.h}
 908 */
 909 #define wxINT32_SWAP_ON_LE( wxInt32_value )
 910 #define wxUINT32_SWAP_ON_LE( wxUint32_value )
 911 #define wxINT16_SWAP_ON_LE( wxInt16_value )
 912 #define wxUINT16_SWAP_ON_LE( wxUint16_value )
 913
 914 //@}
 915
 916
 917
 918 /** @addtogroup group_funcmacro_misc */
 919 //@{
 920
 921 /**
 922     This macro can be used in a class declaration to disable the generation of
 923     default assignment operator.
 924
 925     Some classes have a well-defined copy constructor but cannot have an
 926     assignment operator, typically because they can't be modified once created.
 927     In such case, this macro can be used to disable the automatic assignment
 928     operator generation.
 929
 930     @see wxDECLARE_NO_COPY_CLASS()
 931  */
 932 #define wxDECLARE_NO_ASSIGN_CLASS(classname)
 933
 934 /**
 935     This macro can be used in a class declaration to disable the generation of
 936     default copy ctor and assignment operator.
 937
 938     Some classes don't have a well-defined copying semantics. In this case the
 939     standard C++ convention is to not allow copying them. One way of achieving
 940     it is to use this macro which simply defines a private copy constructor and
 941     assignment operator.
 942
 943     Beware that simply not defining copy constructor and assignment operator is
 944     @em not enough as the compiler would provide its own automatically-generated
 945     versions of them -- hence the usefulness of this macro.
 946
 947     Example of use:
 948     @code
 949     class FooWidget
 950     {
 951     public:
 952         FooWidget();
 953         ...
 954
 955     private:
 956         // widgets can't be copied
 957         wxDECLARE_NO_COPY_CLASS(FooWidget);
 958     };
 959     @endcode
 960
 961     Notice that a semicolon must be used after this macro and that it changes
 962     the access specifier to private internally so it is better to use it at the
 963     end of the class declaration.
 964
 965     @see wxDECLARE_NO_ASSIGN_CLASS(), wxDECLARE_NO_COPY_TEMPLATE_CLASS()
 966  */
 967 #define wxDECLARE_NO_COPY_CLASS(classname)
 968
 969 /**
 970     Analog of wxDECLARE_NO_COPY_CLASS() for template classes.
 971
 972     This macro can be used for template classes (with a single template
 973     parameter) for the same purpose as wxDECLARE_NO_COPY_CLASS() is used with the
 974     non-template classes.
 975
 976     @param classname The name of the template class.
 977     @param arg The name of the template parameter.
 978  */
 979 #define wxDECLARE_NO_COPY_TEMPLATE_CLASS(classname, arg)
 980
 981 /**
 982     A function which deletes and nulls the pointer.
 983
 984     This function uses operator delete to free the pointer and also sets it to
 985     @NULL. Notice that this does @em not work for arrays, use wxDELETEA() for
 986     them.
 987
 988     @code
 989         MyClass *ptr = new MyClass;
 990         ...
 991         wxDELETE(ptr);
 992         wxASSERT(!ptr);
 993     @endcode
 994
 995     @header{wx/defs.h}
 996 */
 997 template <typename T> wxDELETE(T*& ptr);
 998
 999 /**
1000     A function which deletes and nulls the pointer.
1001
1002     This function uses vector operator delete (@c delete[]) to free the array
1003     pointer and also sets it to @NULL. Notice that this does @em not work for
1004     non-array pointers, use wxDELETE() for them.
1005
1006     @code
1007         MyClass *array = new MyClass[17];
1008         ...
1009         wxDELETEA(array);
1010         wxASSERT(!array);
1011     @endcode
1012
1013     @see wxDELETE()
1014
1015     @header{wx/defs.h}
1016 */
1017 template <typename T> wxDELETEA(T*& array);
1018
1019 /**
1020     This macro can be used around a function declaration to generate warnings
1021     indicating that this function is deprecated (i.e. obsolete and planned to
1022     be removed in the future) when it is used. Only Visual C++ 7 and higher and
1023     g++ compilers currently support this functionality.
1024
1025     Example of use:
1026
1027     @code
1028     // old function, use wxString version instead
1029     wxDEPRECATED( void wxGetSomething(char *buf, size_t len) );
1030
1031     // ...
1032     wxString wxGetSomething();
1033     @endcode
1034
1035     @header{wx/defs.h}
1036 */
1037 #define wxDEPRECATED(function)
1038
1039 /**
1040     This is a special version of wxDEPRECATED() macro which only does something
1041     when the deprecated function is used from the code outside wxWidgets itself
1042     but doesn't generate warnings when it is used from wxWidgets.
1043
1044     It is used with the virtual functions which are called by the library
1045     itself -- even if such function is deprecated the library still has to call
1046     it to ensure that the existing code overriding it continues to work, but
1047     the use of this macro ensures that a deprecation warning will be generated
1048     if this function is used from the user code or, in case of Visual C++, even
1049     when it is simply overridden.
1050
1051     @header{wx/defs.h}
1052 */
1053 #define wxDEPRECATED_BUT_USED_INTERNALLY(function)
1054
1055 /**
1056     This macro is similar to wxDEPRECATED() but can be used to not only declare
1057     the function @a function as deprecated but to also provide its (inline)
1058     implementation @a body.
1059
1060     It can be used as following:
1061
1062     @code
1063     class wxFoo
1064     {
1065     public:
1066         // OldMethod() is deprecated, use NewMethod() instead
1067         void NewMethod();
1068         wxDEPRECATED_INLINE( void OldMethod(), NewMethod() );
1069     };
1070     @endcode
1071
1072     @header{wx/defs.h}
1073 */
1074 #define wxDEPRECATED_INLINE(func, body)
1075
1076 /**
1077     @c wxEXPLICIT is a macro which expands to the C++ @c explicit keyword if
1078     the compiler supports it or nothing otherwise. Thus, it can be used even in
1079     the code which might have to be compiled with an old compiler without
1080     support for this language feature but still take advantage of it when it is
1081     available.
1082
1083     @header{wx/defs.h}
1084 */
1085 #define wxEXPLICIT
1086
1087 /**
1088     GNU C++ compiler gives a warning for any class whose destructor is private
1089     unless it has a friend. This warning may sometimes be useful but it doesn't
1090     make sense for reference counted class which always delete themselves
1091     (hence destructor should be private) but don't necessarily have any
1092     friends, so this macro is provided to disable the warning in such case. The
1093     @a name parameter should be the name of the class but is only used to
1094     construct a unique friend class name internally.
1095
1096     Example of using the macro:
1097
1098     @code
1099     class RefCounted
1100     {
1101     public:
1102         RefCounted() { m_nRef = 1; }
1103         void IncRef() { m_nRef++ ; }
1104         void DecRef() { if ( !--m_nRef ) delete this; }
1105
1106     private:
1107         ~RefCounted() { }
1108
1109         wxSUPPRESS_GCC_PRIVATE_DTOR(RefCounted)
1110     };
1111     @endcode
1112
1113     Notice that there should be no semicolon after this macro.
1114
1115     @header{wx/defs.h}
1116 */
1117 #define wxSUPPRESS_GCC_PRIVATE_DTOR_WARNING(name)
1118
1119 /**
1120     Swaps the contents of two variables.
1121
1122     This is similar to std::swap() but can be used even on the platforms where
1123     the standard C++ library is not available (if you don't target such
1124     platforms, please use std::swap() instead).
1125
1126     The function relies on type T being copy constructible and assignable.
1127
1128     Example of use:
1129     @code
1130         int x = 3,
1131             y = 4;
1132         wxSwap(x, y);
1133         wxASSERT( x == 4 && y == 3 );
1134     @endcode
1135  */
1136 template <typename T> wxSwap(T& first, T& second);
1137
1138 /**
1139     This macro is the same as the standard C99 @c va_copy for the compilers
1140     which support it or its replacement for those that don't. It must be used
1141     to preserve the value of a @c va_list object if you need to use it after
1142     passing it to another function because it can be modified by the latter.
1143
1144     As with @c va_start, each call to @c wxVaCopy must have a matching
1145     @c va_end.
1146
1147     @header{wx/defs.h}
1148 */
1149 void wxVaCopy(va_list argptrDst, va_list argptrSrc);
1150
1151 //@}
1152
1153