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