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