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