1 ///////////////////////////////////////////////////////////////////////////// 2 // Name: wx/defs.h 3 // Purpose: interface of global functions 4 // Author: wxWidgets team 5 // Licence: wxWindows licence 6 ///////////////////////////////////////////////////////////////////////////// 7 8 9 // ---------------------------------------------------------------------------- 10 // enumerations 11 // ---------------------------------------------------------------------------- 12 13 /** 14 Generic flags. 15 */ 16 enum wxGeometryCentre 17 { 18 wxCENTRE = 0x0001, 19 wxCENTER = wxCENTRE 20 }; 21 22 /** 23 A generic orientation value. 24 */ 25 enum wxOrientation 26 { 27 wxHORIZONTAL = 0x0004, 28 wxVERTICAL = 0x0008, 29 30 /** 31 A mask value to indicate both vertical and horizontal orientations. 32 */ 33 wxBOTH = wxVERTICAL | wxHORIZONTAL, 34 35 /// A synonym for @c wxBOTH. 36 wxORIENTATION_MASK = wxBOTH 37 }; 38 39 /** 40 A generic direction value. 41 */ 42 enum wxDirection 43 { 44 wxLEFT = 0x0010, 45 wxRIGHT = 0x0020, 46 wxUP = 0x0040, 47 wxDOWN = 0x0080, 48 49 wxTOP = wxUP, 50 wxBOTTOM = wxDOWN, 51 52 wxNORTH = wxUP, 53 wxSOUTH = wxDOWN, 54 wxWEST = wxLEFT, 55 wxEAST = wxRIGHT, 56 57 wxALL = (wxUP | wxDOWN | wxRIGHT | wxLEFT), 58 59 /** A mask to extract direction from the combination of flags. */ 60 wxDIRECTION_MASK = wxALL 61 }; 62 63 /** 64 Generic alignment values. Can be combined together. 65 */ 66 enum wxAlignment 67 { 68 /** 69 A value different from any valid alignment value. 70 71 Note that you shouldn't use 0 for this as it's the value of (valid) 72 alignments wxALIGN_LEFT and wxALIGN_TOP. 73 74 @since 2.9.1 75 */ 76 wxALIGN_INVALID = -1, 77 78 wxALIGN_NOT = 0x0000, 79 wxALIGN_CENTER_HORIZONTAL = 0x0100, 80 wxALIGN_CENTRE_HORIZONTAL = wxALIGN_CENTER_HORIZONTAL, 81 wxALIGN_LEFT = wxALIGN_NOT, 82 wxALIGN_TOP = wxALIGN_NOT, 83 wxALIGN_RIGHT = 0x0200, 84 wxALIGN_BOTTOM = 0x0400, 85 wxALIGN_CENTER_VERTICAL = 0x0800, 86 wxALIGN_CENTRE_VERTICAL = wxALIGN_CENTER_VERTICAL, 87 88 wxALIGN_CENTER = (wxALIGN_CENTER_HORIZONTAL | wxALIGN_CENTER_VERTICAL), 89 wxALIGN_CENTRE = wxALIGN_CENTER, 90 91 /** A mask to extract alignment from the combination of flags. */ 92 wxALIGN_MASK = 0x0f00 93 }; 94 95 /** 96 Miscellaneous flags for wxSizer items. 97 */ 98 enum wxSizerFlagBits 99 { 100 wxFIXED_MINSIZE = 0x8000, 101 wxRESERVE_SPACE_EVEN_IF_HIDDEN = 0x0002, 102 103 /* a mask to extract wxSizerFlagBits from combination of flags */ 104 wxSIZER_FLAG_BITS_MASK = 0x8002 105 }; 106 107 /** 108 Generic stretch values. 109 */ 110 enum wxStretch 111 { 112 wxSTRETCH_NOT = 0x0000, 113 wxSHRINK = 0x1000, 114 wxGROW = 0x2000, 115 wxEXPAND = wxGROW, 116 wxSHAPED = 0x4000, 117 wxTILE = wxSHAPED | wxFIXED_MINSIZE, 118 119 /* a mask to extract stretch from the combination of flags */ 120 wxSTRETCH_MASK = 0x7000 /* sans wxTILE */ 121 }; 122 123 /** 124 Border flags for wxWindow. 125 */ 126 enum wxBorder 127 { 128 /** 129 This is different from wxBORDER_NONE as by default the controls do have 130 a border. 131 */ 132 wxBORDER_DEFAULT = 0, 133 134 wxBORDER_NONE = 0x00200000, 135 wxBORDER_STATIC = 0x01000000, 136 wxBORDER_SIMPLE = 0x02000000, 137 wxBORDER_RAISED = 0x04000000, 138 wxBORDER_SUNKEN = 0x08000000, 139 wxBORDER_DOUBLE = 0x10000000, /* deprecated */ 140 wxBORDER_THEME = wxBORDER_DOUBLE, 141 142 /* a mask to extract border style from the combination of flags */ 143 wxBORDER_MASK = 0x1f200000 144 }; 145 146 /* ---------------------------------------------------------------------------- */ 147 /* Possible SetSize flags */ 148 /* ---------------------------------------------------------------------------- */ 149 150 /* Use internally-calculated width if -1 */ 151 #define wxSIZE_AUTO_WIDTH 0x0001 152 /* Use internally-calculated height if -1 */ 153 #define wxSIZE_AUTO_HEIGHT 0x0002 154 /* Use internally-calculated width and height if each is -1 */ 155 #define wxSIZE_AUTO (wxSIZE_AUTO_WIDTH|wxSIZE_AUTO_HEIGHT) 156 /* Ignore missing (-1) dimensions (use existing). */ 157 /* For readability only: test for wxSIZE_AUTO_WIDTH/HEIGHT in code. */ 158 #define wxSIZE_USE_EXISTING 0x0000 159 /* Allow -1 as a valid position */ 160 #define wxSIZE_ALLOW_MINUS_ONE 0x0004 161 /* Don't do parent client adjustments (for implementation only) */ 162 #define wxSIZE_NO_ADJUSTMENTS 0x0008 163 /* Change the window position even if it seems to be already correct */ 164 #define wxSIZE_FORCE 0x0010 165 /* Emit size event even if size didn't change */ 166 #define wxSIZE_FORCE_EVENT 0x0020 167 168 /* ---------------------------------------------------------------------------- */ 169 /* Window style flags */ 170 /* ---------------------------------------------------------------------------- */ 171 172 /* 173 * Values are chosen so they can be |'ed in a bit list. 174 * Some styles are used across more than one group, 175 * so the values mustn't clash with others in the group. 176 * Otherwise, numbers can be reused across groups. 177 */ 178 179 /* 180 Summary of the bits used by various styles. 181 182 High word, containing styles which can be used with many windows: 183 184 +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+ 185 |31|30|29|28|27|26|25|24|23|22|21|20|19|18|17|16| 186 +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+ 187 | | | | | | | | | | | | | | | | 188 | | | | | | | | | | | | | | | \_ wxFULL_REPAINT_ON_RESIZE 189 | | | | | | | | | | | | | | \____ wxPOPUP_WINDOW 190 | | | | | | | | | | | | | \_______ wxWANTS_CHARS 191 | | | | | | | | | | | | \__________ wxTAB_TRAVERSAL 192 | | | | | | | | | | | \_____________ wxTRANSPARENT_WINDOW 193 | | | | | | | | | | \________________ wxBORDER_NONE 194 | | | | | | | | | \___________________ wxCLIP_CHILDREN 195 | | | | | | | | \______________________ wxALWAYS_SHOW_SB 196 | | | | | | | \_________________________ wxBORDER_STATIC 197 | | | | | | \____________________________ wxBORDER_SIMPLE 198 | | | | | \_______________________________ wxBORDER_RAISED 199 | | | | \__________________________________ wxBORDER_SUNKEN 200 | | | \_____________________________________ wxBORDER_{DOUBLE,THEME} 201 | | \________________________________________ wxCAPTION/wxCLIP_SIBLINGS 202 | \___________________________________________ wxHSCROLL 203 \______________________________________________ wxVSCROLL 204 205 206 Low word style bits is class-specific meaning that the same bit can have 207 different meanings for different controls (e.g. 0x10 is wxCB_READONLY 208 meaning that the control can't be modified for wxComboBox but wxLB_SORT 209 meaning that the control should be kept sorted for wxListBox, while 210 wxLB_SORT has a different value -- and this is just fine). 211 */ 212 213 /* 214 * Window (Frame/dialog/subwindow/panel item) style flags 215 */ 216 #define wxVSCROLL 0x80000000 217 #define wxHSCROLL 0x40000000 218 #define wxCAPTION 0x20000000 219 220 /* New styles (border styles are now in their own enum) */ 221 #define wxDOUBLE_BORDER wxBORDER_DOUBLE 222 #define wxSUNKEN_BORDER wxBORDER_SUNKEN 223 #define wxRAISED_BORDER wxBORDER_RAISED 224 #define wxBORDER wxBORDER_SIMPLE 225 #define wxSIMPLE_BORDER wxBORDER_SIMPLE 226 #define wxSTATIC_BORDER wxBORDER_STATIC 227 #define wxNO_BORDER wxBORDER_NONE 228 229 /* wxALWAYS_SHOW_SB: instead of hiding the scrollbar when it is not needed, */ 230 /* disable it - but still show (see also wxLB_ALWAYS_SB style) */ 231 /* */ 232 /* NB: as this style is only supported by wxUniversal and wxMSW so far */ 233 #define wxALWAYS_SHOW_SB 0x00800000 234 235 /* Clip children when painting, which reduces flicker in e.g. frames and */ 236 /* splitter windows, but can't be used in a panel where a static box must be */ 237 /* 'transparent' (panel paints the background for it) */ 238 #define wxCLIP_CHILDREN 0x00400000 239 240 /* Note we're reusing the wxCAPTION style because we won't need captions */ 241 /* for subwindows/controls */ 242 #define wxCLIP_SIBLINGS 0x20000000 243 244 #define wxTRANSPARENT_WINDOW 0x00100000 245 246 /* Add this style to a panel to get tab traversal working outside of dialogs */ 247 /* (on by default for wxPanel, wxDialog, wxScrolledWindow) */ 248 #define wxTAB_TRAVERSAL 0x00080000 249 250 /* Add this style if the control wants to get all keyboard messages (under */ 251 /* Windows, it won't normally get the dialog navigation key events) */ 252 #define wxWANTS_CHARS 0x00040000 253 254 /* Make window retained (Motif only, see src/generic/scrolwing.cpp) 255 * This is non-zero only under wxMotif, to avoid a clash with wxPOPUP_WINDOW 256 * on other platforms 257 */ 258 259 #ifdef __WXMOTIF__ 260 #define wxRETAINED 0x00020000 261 #else 262 #define wxRETAINED 0x00000000 263 #endif 264 #define wxBACKINGSTORE wxRETAINED 265 266 /* set this flag to create a special popup window: it will be always shown on */ 267 /* top of other windows, will capture the mouse and will be dismissed when the */ 268 /* mouse is clicked outside of it or if it loses focus in any other way */ 269 #define wxPOPUP_WINDOW 0x00020000 270 271 /* force a full repaint when the window is resized (instead of repainting just */ 272 /* the invalidated area) */ 273 #define wxFULL_REPAINT_ON_RESIZE 0x00010000 274 275 /* obsolete: now this is the default behaviour */ 276 /* */ 277 /* don't invalidate the whole window (resulting in a PAINT event) when the */ 278 /* window is resized (currently, makes sense for wxMSW only) */ 279 #define wxNO_FULL_REPAINT_ON_RESIZE 0 280 281 /* A mask which can be used to filter (out) all wxWindow-specific styles. 282 */ 283 #define wxWINDOW_STYLE_MASK \ 284 (wxVSCROLL|wxHSCROLL|wxBORDER_MASK|wxALWAYS_SHOW_SB|wxCLIP_CHILDREN| \ 285 wxCLIP_SIBLINGS|wxTRANSPARENT_WINDOW|wxTAB_TRAVERSAL|wxWANTS_CHARS| \ 286 wxRETAINED|wxPOPUP_WINDOW|wxFULL_REPAINT_ON_RESIZE) 287 288 /* 289 * Extra window style flags (use wxWS_EX prefix to make it clear that they 290 * should be passed to wxWindow::SetExtraStyle(), not SetWindowStyle()) 291 */ 292 293 /* wxCommandEvents and the objects of the derived classes are forwarded to the */ 294 /* parent window and so on recursively by default. Using this flag for the */ 295 /* given window allows blocking this propagation at this window, i.e. preventing */ 296 /* the events from being propagated further upwards. The dialogs have this */ 297 /* flag on by default. */ 298 #define wxWS_EX_BLOCK_EVENTS 0x00000002 299 300 /* don't use this window as an implicit parent for the other windows: this must */ 301 /* be used with transient windows as otherwise there is the risk of creating a */ 302 /* dialog/frame with this window as a parent which would lead to a crash if the */ 303 /* parent is destroyed before the child */ 304 #define wxWS_EX_TRANSIENT 0x00000004 305 306 /* don't paint the window background, we'll assume it will */ 307 /* be done by a theming engine. This is not yet used but could */ 308 /* possibly be made to work in the future, at least on Windows */ 309 #define wxWS_EX_THEMED_BACKGROUND 0x00000008 310 311 /* this window should always process idle events */ 312 #define wxWS_EX_PROCESS_IDLE 0x00000010 313 314 /* this window should always process UI update events */ 315 #define wxWS_EX_PROCESS_UI_UPDATES 0x00000020 316 317 /* Draw the window in a metal theme on Mac */ 318 #define wxFRAME_EX_METAL 0x00000040 319 #define wxDIALOG_EX_METAL 0x00000040 320 321 /* Use this style to add a context-sensitive help to the window (currently for */ 322 /* Win32 only and it doesn't work if wxMINIMIZE_BOX or wxMAXIMIZE_BOX are used) */ 323 #define wxWS_EX_CONTEXTHELP 0x00000080 324 325 /* synonyms for wxWS_EX_CONTEXTHELP for compatibility */ 326 #define wxFRAME_EX_CONTEXTHELP wxWS_EX_CONTEXTHELP 327 #define wxDIALOG_EX_CONTEXTHELP wxWS_EX_CONTEXTHELP 328 329 /* Create a window which is attachable to another top level window */ 330 #define wxFRAME_DRAWER 0x0020 331 332 /* 333 * MDI parent frame style flags 334 * Can overlap with some of the above. 335 */ 336 337 #define wxFRAME_NO_WINDOW_MENU 0x0100 338 339 /* 340 * wxMenuBar style flags 341 */ 342 /* use native docking */ 343 #define wxMB_DOCKABLE 0x0001 344 345 /* 346 * wxMenu style flags 347 */ 348 #define wxMENU_TEAROFF 0x0001 349 350 /* 351 * Apply to all panel items 352 */ 353 #define wxCOLOURED 0x0800 354 #define wxFIXED_LENGTH 0x0400 355 356 /* 357 * Styles for wxListBox 358 */ 359 #define wxLB_SORT 0x0010 360 #define wxLB_SINGLE 0x0020 361 #define wxLB_MULTIPLE 0x0040 362 #define wxLB_EXTENDED 0x0080 363 /* wxLB_OWNERDRAW is Windows-only */ 364 #define wxLB_NEEDED_SB 0x0000 365 #define wxLB_OWNERDRAW 0x0100 366 #define wxLB_ALWAYS_SB 0x0200 367 #define wxLB_NO_SB 0x0400 368 #define wxLB_HSCROLL wxHSCROLL 369 /* always show an entire number of rows */ 370 #define wxLB_INT_HEIGHT 0x0800 371 372 /* 373 * wxComboBox style flags 374 */ 375 #define wxCB_SIMPLE 0x0004 376 #define wxCB_SORT 0x0008 377 #define wxCB_READONLY 0x0010 378 #define wxCB_DROPDOWN 0x0020 379 380 /* 381 * wxRadioBox style flags 382 * These styles are not used in any port. 383 */ 384 #define wxRA_LEFTTORIGHT 0x0001 385 #define wxRA_TOPTOBOTTOM 0x0002 386 387 /* New, more intuitive names to specify majorDim argument */ 388 #define wxRA_SPECIFY_COLS wxHORIZONTAL 389 #define wxRA_SPECIFY_ROWS wxVERTICAL 390 391 /* Old names for compatibility */ 392 #define wxRA_HORIZONTAL wxHORIZONTAL 393 #define wxRA_VERTICAL wxVERTICAL 394 395 /* 396 * wxRadioButton style flag 397 */ 398 #define wxRB_GROUP 0x0004 399 #define wxRB_SINGLE 0x0008 400 401 /* 402 * wxScrollBar flags 403 */ 404 #define wxSB_HORIZONTAL wxHORIZONTAL 405 #define wxSB_VERTICAL wxVERTICAL 406 407 /* 408 * wxSpinButton flags. 409 * Note that a wxSpinCtrl is sometimes defined as a wxTextCtrl, and so the 410 * flags shouldn't overlap with wxTextCtrl flags that can be used for a single 411 * line controls (currently we reuse wxTE_CHARWRAP and wxTE_RICH2 neither of 412 * which makes sense for them). 413 */ 414 #define wxSP_HORIZONTAL wxHORIZONTAL /* 4 */ 415 #define wxSP_VERTICAL wxVERTICAL /* 8 */ 416 #define wxSP_ARROW_KEYS 0x4000 417 #define wxSP_WRAP 0x8000 418 419 /* 420 * wxTabCtrl flags 421 */ 422 #define wxTC_RIGHTJUSTIFY 0x0010 423 #define wxTC_FIXEDWIDTH 0x0020 424 #define wxTC_TOP 0x0000 /* default */ 425 #define wxTC_LEFT 0x0020 426 #define wxTC_RIGHT 0x0040 427 #define wxTC_BOTTOM 0x0080 428 #define wxTC_MULTILINE 0x0200 /* == wxNB_MULTILINE */ 429 #define wxTC_OWNERDRAW 0x0400 430 431 /* 432 * wxStaticBitmap flags 433 */ 434 #define wxBI_EXPAND wxEXPAND 435 436 /* 437 * wxStaticLine flags 438 */ 439 #define wxLI_HORIZONTAL wxHORIZONTAL 440 #define wxLI_VERTICAL wxVERTICAL 441 442 443 /* 444 * extended dialog specifiers. these values are stored in a different 445 * flag and thus do not overlap with other style flags. note that these 446 * values do not correspond to the return values of the dialogs (for 447 * those values, look at the wxID_XXX defines). 448 */ 449 450 /* wxCENTRE already defined as 0x00000001 */ 451 #define wxYES 0x00000002 452 #define wxOK 0x00000004 453 #define wxNO 0x00000008 454 #define wxYES_NO (wxYES | wxNO) 455 #define wxCANCEL 0x00000010 456 #define wxAPPLY 0x00000020 457 #define wxCLOSE 0x00000040 458 459 #define wxOK_DEFAULT 0x00000000 /* has no effect (default) */ 460 #define wxYES_DEFAULT 0x00000000 /* has no effect (default) */ 461 #define wxNO_DEFAULT 0x00000080 /* only valid with wxYES_NO */ 462 #define wxCANCEL_DEFAULT 0x80000000 /* only valid with wxCANCEL */ 463 464 #define wxICON_EXCLAMATION 0x00000100 465 #define wxICON_HAND 0x00000200 466 #define wxICON_WARNING wxICON_EXCLAMATION 467 #define wxICON_ERROR wxICON_HAND 468 #define wxICON_QUESTION 0x00000400 469 #define wxICON_INFORMATION 0x00000800 470 #define wxICON_STOP wxICON_HAND 471 #define wxICON_ASTERISK wxICON_INFORMATION 472 473 #define wxHELP 0x00001000 474 #define wxFORWARD 0x00002000 475 #define wxBACKWARD 0x00004000 476 #define wxRESET 0x00008000 477 #define wxMORE 0x00010000 478 #define wxSETUP 0x00020000 479 #define wxICON_NONE 0x00040000 480 #define wxICON_AUTH_NEEDED 0x00080000 481 482 #define wxICON_MASK \ 483 (wxICON_EXCLAMATION|wxICON_HAND|wxICON_QUESTION|wxICON_INFORMATION|wxICON_NONE) 484 485 486 /* symbolic constant used by all Find()-like functions returning positive */ 487 /* integer on success as failure indicator */ 488 #define wxNOT_FOUND (-1) 489 490 /** 491 Background styles. 492 493 @see wxWindow::SetBackgroundStyle() 494 */ 495 enum wxBackgroundStyle 496 { 497 /** 498 Default background style value indicating that the background may be 499 erased in the user-defined EVT_ERASE_BACKGROUND handler. 500 501 If no such handler is defined (or if it skips the event), the effect of 502 this style is the same as wxBG_STYLE_SYSTEM. If an empty handler (@em 503 not skipping the event) is defined, the effect is the same as 504 wxBG_STYLE_PAINT, i.e. the background is not erased at all until 505 EVT_PAINT handler is executed. 506 507 This is the only background style value for which erase background 508 events are generated at all. 509 */ 510 wxBG_STYLE_ERASE, 511 512 /** 513 Use the default background, as determined by the system or the current 514 theme. 515 516 If the window has been assigned a non-default background colour, it 517 will be used for erasing its background. Otherwise the default 518 background (which might be a gradient or a pattern) will be used. 519 520 EVT_ERASE_BACKGROUND event will not be generated at all for windows 521 with this style. 522 */ 523 wxBG_STYLE_SYSTEM, 524 525 /** 526 Indicates that the background is only erased in the user-defined 527 EVT_PAINT handler. 528 529 Using this style avoids flicker which would result from redrawing the 530 background twice if the EVT_PAINT handler entirely overwrites it. It 531 must not be used however if the paint handler leaves any parts of the 532 window unpainted as their contents is then undetermined. Only use it if 533 you repaint the whole window in your handler. 534 535 EVT_ERASE_BACKGROUND event will not be generated at all for windows 536 with this style. 537 */ 538 wxBG_STYLE_PAINT, 539 540 /* this style is deprecated and doesn't do anything, don't use */ 541 wxBG_STYLE_COLOUR, 542 543 /** 544 Indicates that the window background is not erased, letting the parent 545 window show through. 546 547 Currently this style is only supported in wxOSX and wxGTK with 548 compositing available, see wxWindow::IsTransparentBackgroundSupported(). 549 */ 550 wxBG_STYLE_TRANSPARENT, 551 }; 552 553 554 /** 555 Standard IDs. 556 557 Notice that some, but @em not all, of these IDs are also stock IDs, i.e. 558 you can use them for the button or menu items without specifying the label 559 which will be provided by the underlying platform itself. See 560 @ref page_stockitems "the list of stock items" for the subset of standard 561 IDs which are stock IDs as well. 562 */ 563 enum wxStandardID 564 { 565 /** 566 This id delimits the lower bound of the range used by automatically-generated ids 567 (i.e.\ those used when wxID_ANY is specified during construction). 568 569 It is defined as a relatively large negative number and its exact value 570 is platform-dependent. 571 */ 572 wxID_AUTO_LOWEST, 573 574 /** 575 This id delimits the upper bound of the range used by automatically-generated ids 576 (i.e.\ those used when wxID_ANY is specified during construction). 577 578 It is defined as a relatively small negative number and its exact value 579 is platform-dependent. 580 */ 581 wxID_AUTO_HIGHEST, 582 583 /** 584 No id matches this one when compared to it. 585 */ 586 wxID_NONE = -3, 587 588 /** 589 Id for a separator line in the menu (invalid for normal item). 590 */ 591 wxID_SEPARATOR = -2, 592 593 /** 594 Any id: means that we don't care about the id, whether when installing 595 an event handler or when creating a new window. 596 */ 597 wxID_ANY = -1, 598 599 /** 600 Start of the range reserved for wxWidgets-defined IDs. 601 602 Don't define custom IDs in the range from wxID_LOWEST to wxID_HIGHEST. 603 */ 604 wxID_LOWEST = 4999, 605 606 wxID_OPEN, 607 wxID_CLOSE, 608 wxID_NEW, 609 wxID_SAVE, 610 wxID_SAVEAS, 611 wxID_REVERT, 612 wxID_EXIT, 613 wxID_UNDO, 614 wxID_REDO, 615 wxID_HELP, 616 wxID_PRINT, 617 wxID_PRINT_SETUP, 618 wxID_PAGE_SETUP, 619 wxID_PREVIEW, 620 wxID_ABOUT, 621 wxID_HELP_CONTENTS, 622 wxID_HELP_INDEX, 623 wxID_HELP_SEARCH, 624 wxID_HELP_COMMANDS, 625 wxID_HELP_PROCEDURES, 626 wxID_HELP_CONTEXT, 627 wxID_CLOSE_ALL, 628 wxID_PREFERENCES, 629 630 wxID_EDIT = 5030, 631 wxID_CUT, 632 wxID_COPY, 633 wxID_PASTE, 634 wxID_CLEAR, 635 wxID_FIND, 636 wxID_DUPLICATE, 637 wxID_SELECTALL, 638 wxID_DELETE, 639 wxID_REPLACE, 640 wxID_REPLACE_ALL, 641 wxID_PROPERTIES, 642 643 wxID_VIEW_DETAILS, 644 wxID_VIEW_LARGEICONS, 645 wxID_VIEW_SMALLICONS, 646 wxID_VIEW_LIST, 647 wxID_VIEW_SORTDATE, 648 wxID_VIEW_SORTNAME, 649 wxID_VIEW_SORTSIZE, 650 wxID_VIEW_SORTTYPE, 651 652 wxID_FILE = 5050, 653 wxID_FILE1, 654 wxID_FILE2, 655 wxID_FILE3, 656 wxID_FILE4, 657 wxID_FILE5, 658 wxID_FILE6, 659 wxID_FILE7, 660 wxID_FILE8, 661 wxID_FILE9, 662 663 /** Standard button and menu IDs */ 664 wxID_OK = 5100, 665 wxID_CANCEL, 666 wxID_APPLY, 667 wxID_YES, 668 wxID_NO, 669 wxID_STATIC, 670 wxID_FORWARD, 671 wxID_BACKWARD, 672 wxID_DEFAULT, 673 wxID_MORE, 674 wxID_SETUP, 675 wxID_RESET, 676 wxID_CONTEXT_HELP, 677 wxID_YESTOALL, 678 wxID_NOTOALL, 679 wxID_ABORT, 680 wxID_RETRY, 681 wxID_IGNORE, 682 wxID_ADD, 683 wxID_REMOVE, 684 685 wxID_UP, 686 wxID_DOWN, 687 wxID_HOME, 688 wxID_REFRESH, 689 wxID_STOP, 690 wxID_INDEX, 691 692 wxID_BOLD, 693 wxID_ITALIC, 694 wxID_JUSTIFY_CENTER, 695 wxID_JUSTIFY_FILL, 696 wxID_JUSTIFY_RIGHT, 697 wxID_JUSTIFY_LEFT, 698 wxID_UNDERLINE, 699 wxID_INDENT, 700 wxID_UNINDENT, 701 wxID_ZOOM_100, 702 wxID_ZOOM_FIT, 703 wxID_ZOOM_IN, 704 wxID_ZOOM_OUT, 705 wxID_UNDELETE, 706 wxID_REVERT_TO_SAVED, 707 wxID_CDROM, 708 wxID_CONVERT, 709 wxID_EXECUTE, 710 wxID_FLOPPY, 711 wxID_HARDDISK, 712 wxID_BOTTOM, 713 wxID_FIRST, 714 wxID_LAST, 715 wxID_TOP, 716 wxID_INFO, 717 wxID_JUMP_TO, 718 wxID_NETWORK, 719 wxID_SELECT_COLOR, 720 wxID_SELECT_FONT, 721 wxID_SORT_ASCENDING, 722 wxID_SORT_DESCENDING, 723 wxID_SPELL_CHECK, 724 wxID_STRIKETHROUGH, 725 726 /** System menu IDs (used by wxUniv): */ 727 wxID_SYSTEM_MENU = 5200, 728 wxID_CLOSE_FRAME, 729 wxID_MOVE_FRAME, 730 wxID_RESIZE_FRAME, 731 wxID_MAXIMIZE_FRAME, 732 wxID_ICONIZE_FRAME, 733 wxID_RESTORE_FRAME, 734 735 /** MDI window menu ids */ 736 wxID_MDI_WINDOW_FIRST = 5230, 737 wxID_MDI_WINDOW_CASCADE = wxID_MDI_WINDOW_FIRST, 738 wxID_MDI_WINDOW_TILE_HORZ, 739 wxID_MDI_WINDOW_TILE_VERT, 740 wxID_MDI_WINDOW_ARRANGE_ICONS, 741 wxID_MDI_WINDOW_PREV, 742 wxID_MDI_WINDOW_NEXT, 743 wxID_MDI_WINDOW_LAST = wxID_MDI_WINDOW_NEXT, 744 745 /** IDs used by generic file dialog (13 consecutive starting from this value) */ 746 wxID_FILEDLGG = 5900, 747 748 /** IDs used by generic file ctrl (4 consecutive starting from this value) */ 749 wxID_FILECTRL = 5950, 750 751 /** 752 End of the range reserved for wxWidgets-defined IDs. 753 754 Don't define custom IDs in the range from wxID_LOWEST to wxID_HIGHEST. 755 756 When using an enum to define a number of custom IDs, assigning the 757 value of @c wxID_HIGHEST+1 to the first element ensures that none of 758 the enum elements will conflict with any standard IDs. 759 */ 760 wxID_HIGHEST = 5999 761 }; 762 763 /** 764 Item kinds for use with wxMenu, wxMenuItem, and wxToolBar. 765 766 @see wxMenu::Append(), wxMenuItem::wxMenuItem(), wxToolBar::AddTool() 767 */ 768 enum wxItemKind 769 { 770 wxITEM_SEPARATOR = -1, 771 772 /** 773 Normal tool button / menu item. 774 775 @see wxToolBar::AddTool(), wxMenu::AppendItem(). 776 */ 777 wxITEM_NORMAL, 778 779 /** 780 Check (or toggle) tool button / menu item. 781 782 @see wxToolBar::AddCheckTool(), wxMenu::AppendCheckItem(). 783 */ 784 wxITEM_CHECK, 785 786 /** 787 Radio tool button / menu item. 788 789 @see wxToolBar::AddRadioTool(), wxMenu::AppendRadioItem(). 790 */ 791 wxITEM_RADIO, 792 793 /** 794 Normal tool button with a dropdown arrow next to it. Clicking the 795 dropdown arrow sends a @c wxEVT_TOOL_DROPDOWN event and may 796 also display the menu previously associated with the item with 797 wxToolBar::SetDropdownMenu(). Currently this type of tools is supported 798 under MSW and GTK. 799 */ 800 wxITEM_DROPDOWN, 801 802 wxITEM_MAX 803 }; 804 805 /** 806 Generic hit test results. 807 */ 808 enum wxHitTest 809 { 810 wxHT_NOWHERE, 811 812 /* scrollbar */ 813 wxHT_SCROLLBAR_FIRST = wxHT_NOWHERE, 814 wxHT_SCROLLBAR_ARROW_LINE_1, /**< left or upper arrow to scroll by line */ 815 wxHT_SCROLLBAR_ARROW_LINE_2, /**< right or down */ 816 wxHT_SCROLLBAR_ARROW_PAGE_1, /**< left or upper arrow to scroll by page */ 817 wxHT_SCROLLBAR_ARROW_PAGE_2, /**< right or down */ 818 wxHT_SCROLLBAR_THUMB, /**< on the thumb */ 819 wxHT_SCROLLBAR_BAR_1, /**< bar to the left/above the thumb */ 820 wxHT_SCROLLBAR_BAR_2, /**< bar to the right/below the thumb */ 821 wxHT_SCROLLBAR_LAST, 822 823 /* window */ 824 wxHT_WINDOW_OUTSIDE, /**< not in this window at all */ 825 wxHT_WINDOW_INSIDE, /**< in the client area */ 826 wxHT_WINDOW_VERT_SCROLLBAR, /**< on the vertical scrollbar */ 827 wxHT_WINDOW_HORZ_SCROLLBAR, /**< on the horizontal scrollbar */ 828 wxHT_WINDOW_CORNER, /**< on the corner between 2 scrollbars */ 829 830 wxHT_MAX 831 }; 832 833 /** 834 Data format IDs used by wxDataFormat. 835 */ 836 enum wxDataFormatId 837 { 838 wxDF_INVALID = 0, 839 wxDF_TEXT = 1, /* CF_TEXT */ 840 wxDF_BITMAP = 2, /* CF_BITMAP */ 841 wxDF_METAFILE = 3, /* CF_METAFILEPICT */ 842 wxDF_SYLK = 4, 843 wxDF_DIF = 5, 844 wxDF_TIFF = 6, 845 wxDF_OEMTEXT = 7, /* CF_OEMTEXT */ 846 wxDF_DIB = 8, /* CF_DIB */ 847 wxDF_PALETTE = 9, 848 wxDF_PENDATA = 10, 849 wxDF_RIFF = 11, 850 wxDF_WAVE = 12, 851 wxDF_UNICODETEXT = 13, 852 wxDF_ENHMETAFILE = 14, 853 wxDF_FILENAME = 15, /* CF_HDROP */ 854 wxDF_LOCALE = 16, 855 wxDF_PRIVATE = 20, 856 wxDF_HTML = 30, /* Note: does not correspond to CF_ constant */ 857 wxDF_PNG = 31, /* Note: does not correspond to CF_ constant */ 858 wxDF_MAX 859 }; 860 861 /** 862 Virtual keycodes used by wxKeyEvent and some other wxWidgets functions. 863 864 Note that the range <code>0..255</code> corresponds to the characters of 865 the current locale, in particular the <code>32..127</code> subrange is for 866 the ASCII symbols, and all the special key values such as @c WXK_END lie 867 above this range. 868 */ 869 enum wxKeyCode 870 { 871 /** 872 No key. 873 874 This value is returned by wxKeyEvent::GetKeyCode() if there is no 875 non-Unicode representation for the pressed key (e.g. a Cyrillic letter 876 was entered when not using a Cyrillic locale) and by 877 wxKeyEvent::GetUnicodeKey() if there is no Unicode representation for 878 the key (this happens for the special, non printable, keys only, e.g. 879 WXK_HOME). 880 881 @since 2.9.2 (you can simply use 0 with previous versions). 882 */ 883 WXK_NONE = 0, 884 885 WXK_CONTROL_A = 1, 886 WXK_CONTROL_B, 887 WXK_CONTROL_C, 888 WXK_CONTROL_D, 889 WXK_CONTROL_E, 890 WXK_CONTROL_F, 891 WXK_CONTROL_G, 892 WXK_CONTROL_H, 893 WXK_CONTROL_I, 894 WXK_CONTROL_J, 895 WXK_CONTROL_K, 896 WXK_CONTROL_L, 897 WXK_CONTROL_M, 898 WXK_CONTROL_N, 899 WXK_CONTROL_O, 900 WXK_CONTROL_P, 901 WXK_CONTROL_Q, 902 WXK_CONTROL_R, 903 WXK_CONTROL_S, 904 WXK_CONTROL_T, 905 WXK_CONTROL_U, 906 WXK_CONTROL_V, 907 WXK_CONTROL_W, 908 WXK_CONTROL_X, 909 WXK_CONTROL_Y, 910 WXK_CONTROL_Z, 911 912 WXK_BACK = 8, //!< Backspace. 913 WXK_TAB = 9, 914 WXK_RETURN = 13, 915 WXK_ESCAPE = 27, 916 WXK_SPACE = 32, 917 918 WXK_DELETE = 127, 919 920 /** 921 Special key values. 922 923 These are, by design, not compatible with Unicode characters. 924 If you want to get a Unicode character from a key event, use 925 wxKeyEvent::GetUnicodeKey() instead. 926 */ 927 WXK_START = 300, 928 WXK_LBUTTON, 929 WXK_RBUTTON, 930 WXK_CANCEL, 931 WXK_MBUTTON, 932 WXK_CLEAR, 933 WXK_SHIFT, 934 WXK_ALT, 935 /** Note that under macOS, to improve compatibility with other 936 * systems, 'WXK_CONTROL' represents the 'Command' key. Use this 937 * constant to work with keyboard shortcuts. See 'WXK_RAW_CONTROL' 938 * to get the state of the actual 'Control' key. 939 */ 940 WXK_CONTROL, 941 /** Under macOS, where the 'Command' key is mapped to 'Control' 942 * to improve compatibility with other systems, WXK_RAW_CONTROL may 943 * be used to obtain the state of the actual 'Control' key 944 * ('WXK_CONTROL' would obtain the status of the 'Command' key). 945 * Under Windows/Linux/Others, this is equivalent to WXK_CONTROL 946 */ 947 WXK_RAW_CONTROL, 948 WXK_MENU, 949 WXK_PAUSE, 950 WXK_CAPITAL, 951 WXK_END, 952 WXK_HOME, 953 WXK_LEFT, 954 WXK_UP, 955 WXK_RIGHT, 956 WXK_DOWN, 957 WXK_SELECT, 958 WXK_PRINT, 959 WXK_EXECUTE, 960 WXK_SNAPSHOT, 961 WXK_INSERT, 962 WXK_HELP, 963 WXK_NUMPAD0, 964 WXK_NUMPAD1, 965 WXK_NUMPAD2, 966 WXK_NUMPAD3, 967 WXK_NUMPAD4, 968 WXK_NUMPAD5, 969 WXK_NUMPAD6, 970 WXK_NUMPAD7, 971 WXK_NUMPAD8, 972 WXK_NUMPAD9, 973 WXK_MULTIPLY, 974 WXK_ADD, 975 WXK_SEPARATOR, 976 WXK_SUBTRACT, 977 WXK_DECIMAL, 978 WXK_DIVIDE, 979 WXK_F1, 980 WXK_F2, 981 WXK_F3, 982 WXK_F4, 983 WXK_F5, 984 WXK_F6, 985 WXK_F7, 986 WXK_F8, 987 WXK_F9, 988 WXK_F10, 989 WXK_F11, 990 WXK_F12, 991 WXK_F13, 992 WXK_F14, 993 WXK_F15, 994 WXK_F16, 995 WXK_F17, 996 WXK_F18, 997 WXK_F19, 998 WXK_F20, 999 WXK_F21, 1000 WXK_F22, 1001 WXK_F23, 1002 WXK_F24, 1003 WXK_NUMLOCK, 1004 WXK_SCROLL, 1005 WXK_PAGEUP, 1006 WXK_PAGEDOWN, 1007 1008 WXK_NUMPAD_SPACE, 1009 WXK_NUMPAD_TAB, 1010 WXK_NUMPAD_ENTER, 1011 WXK_NUMPAD_F1, 1012 WXK_NUMPAD_F2, 1013 WXK_NUMPAD_F3, 1014 WXK_NUMPAD_F4, 1015 WXK_NUMPAD_HOME, 1016 WXK_NUMPAD_LEFT, 1017 WXK_NUMPAD_UP, 1018 WXK_NUMPAD_RIGHT, 1019 WXK_NUMPAD_DOWN, 1020 WXK_NUMPAD_PAGEUP, 1021 WXK_NUMPAD_PAGEDOWN, 1022 WXK_NUMPAD_END, 1023 WXK_NUMPAD_BEGIN, 1024 WXK_NUMPAD_INSERT, 1025 WXK_NUMPAD_DELETE, 1026 WXK_NUMPAD_EQUAL, 1027 WXK_NUMPAD_MULTIPLY, 1028 WXK_NUMPAD_ADD, 1029 WXK_NUMPAD_SEPARATOR, 1030 WXK_NUMPAD_SUBTRACT, 1031 WXK_NUMPAD_DECIMAL, 1032 WXK_NUMPAD_DIVIDE, 1033 1034 /** The following key codes are only generated under Windows currently */ 1035 WXK_WINDOWS_LEFT, 1036 WXK_WINDOWS_RIGHT, 1037 WXK_WINDOWS_MENU , 1038 1039 /** This special key code was used to represent the key used for keyboard shortcuts. Under macOS, 1040 * this key maps to the 'Command' (aka logo or 'Apple') key, whereas on Linux/Windows/others 1041 * this is the Control key, with the new semantic of WXK_CONTROL, WXK_COMMAND is not needed anymore 1042 */ 1043 WXK_COMMAND, 1044 1045 /** Hardware-specific buttons */ 1046 WXK_SPECIAL1 = 193, 1047 WXK_SPECIAL2, 1048 WXK_SPECIAL3, 1049 WXK_SPECIAL4, 1050 WXK_SPECIAL5, 1051 WXK_SPECIAL6, 1052 WXK_SPECIAL7, 1053 WXK_SPECIAL8, 1054 WXK_SPECIAL9, 1055 WXK_SPECIAL10, 1056 WXK_SPECIAL11, 1057 WXK_SPECIAL12, 1058 WXK_SPECIAL13, 1059 WXK_SPECIAL14, 1060 WXK_SPECIAL15, 1061 WXK_SPECIAL16, 1062 WXK_SPECIAL17, 1063 WXK_SPECIAL18, 1064 WXK_SPECIAL19, 1065 WXK_SPECIAL20, 1066 1067 WXK_BROWSER_BACK = 501, 1068 WXK_BROWSER_FORWARD, 1069 WXK_BROWSER_REFRESH, 1070 WXK_BROWSER_STOP, 1071 WXK_BROWSER_SEARCH, 1072 WXK_BROWSER_FAVORITES, 1073 WXK_BROWSER_HOME, 1074 WXK_VOLUME_MUTE, 1075 WXK_VOLUME_DOWN, 1076 WXK_VOLUME_UP, 1077 WXK_MEDIA_NEXT_TRACK, 1078 WXK_MEDIA_PREV_TRACK, 1079 WXK_MEDIA_STOP, 1080 WXK_MEDIA_PLAY_PAUSE, 1081 WXK_LAUNCH_MAIL, 1082 WXK_LAUNCH_APP1, 1083 WXK_LAUNCH_APP2 1084 }; 1085 1086 /** 1087 This enum contains bit mask constants used in wxKeyEvent. 1088 */ 1089 enum wxKeyModifier 1090 { 1091 wxMOD_NONE = 0x0000, 1092 wxMOD_ALT = 0x0001, 1093 /** Ctlr Key, corresponds to Command key on macOS */ 1094 wxMOD_CONTROL = 0x0002, 1095 wxMOD_ALTGR = wxMOD_ALT | wxMOD_CONTROL, 1096 wxMOD_SHIFT = 0x0004, 1097 wxMOD_META = 0x0008, 1098 wxMOD_WIN = wxMOD_META, 1099 1100 /** used to describe the true Ctrl Key under macOS, 1101 identic to @c wxMOD_CONTROL on other platforms */ 1102 wxMOD_RAW_CONTROL, 1103 1104 /** deprecated, identic to @c wxMOD_CONTROL on all platforms */ 1105 wxMOD_CMD = wxMOD_CONTROL, 1106 wxMOD_ALL = 0xffff 1107 }; 1108 1109 /** 1110 Paper size types for use with the printing framework. 1111 1112 @see overview_printing, wxPrintData::SetPaperId() 1113 */ 1114 enum wxPaperSize 1115 { 1116 wxPAPER_10X11, ///< 10 x 11 in 1117 wxPAPER_10X14, ///< 10-by-14-inch sheet 1118 wxPAPER_11X17, ///< 11-by-17-inch sheet 1119 wxPAPER_12X11, ///< 12 x 11 in 1120 wxPAPER_15X11, ///< 15 x 11 in 1121 wxPAPER_9X11, ///< 9 x 11 in 1122 wxPAPER_A2, ///< A2 420 x 594 mm 1123 wxPAPER_A3, ///< A3 sheet, 297 by 420 millimeters 1124 wxPAPER_A3_EXTRA, ///< A3 Extra 322 x 445 mm 1125 wxPAPER_A3_EXTRA_TRANSVERSE, ///< A3 Extra Transverse 322 x 445 mm 1126 wxPAPER_A3_ROTATED, ///< A3 Rotated 420 x 297 mm 1127 wxPAPER_A3_TRANSVERSE, ///< A3 Transverse 297 x 420 mm 1128 wxPAPER_A4, ///< A4 Sheet, 210 by 297 millimeters 1129 wxPAPER_A4SMALL, ///< A4 small sheet, 210 by 297 millimeters 1130 wxPAPER_A4_EXTRA, ///< A4 Extra 9.27 x 12.69 in 1131 wxPAPER_A4_PLUS, ///< A4 Plus 210 x 330 mm 1132 wxPAPER_A4_ROTATED, ///< A4 Rotated 297 x 210 mm 1133 wxPAPER_A4_TRANSVERSE, ///< A4 Transverse 210 x 297 mm 1134 wxPAPER_A5, ///< A5 sheet, 148 by 210 millimeters 1135 wxPAPER_A5_EXTRA, ///< A5 Extra 174 x 235 mm 1136 wxPAPER_A5_ROTATED, ///< A5 Rotated 210 x 148 mm 1137 wxPAPER_A5_TRANSVERSE, ///< A5 Transverse 148 x 210 mm 1138 wxPAPER_A6, ///< A6 105 x 148 mm 1139 wxPAPER_A6_ROTATED, ///< A6 Rotated 148 x 105 mm 1140 wxPAPER_A_PLUS, ///< SuperA/SuperA/A4 227 x 356 mm 1141 wxPAPER_B4, ///< B4 sheet, 250 by 354 millimeters 1142 wxPAPER_B4_JIS_ROTATED, ///< B4 (JIS) Rotated 364 x 257 mm 1143 wxPAPER_B5, ///< B5 sheet, 182-by-257-millimeter paper 1144 wxPAPER_B5_EXTRA, ///< B5 (ISO) Extra 201 x 276 mm 1145 wxPAPER_B5_JIS_ROTATED, ///< B5 (JIS) Rotated 257 x 182 mm 1146 wxPAPER_B5_TRANSVERSE, ///< B5 (JIS) Transverse 182 x 257 mm 1147 wxPAPER_B6_JIS, ///< B6 (JIS) 128 x 182 mm 1148 wxPAPER_B6_JIS_ROTATED, ///< B6 (JIS) Rotated 182 x 128 mm 1149 wxPAPER_B_PLUS, ///< SuperB/SuperB/A3 305 x 487 mm 1150 wxPAPER_CSHEET, ///< C Sheet, 17 by 22 inches 1151 wxPAPER_DBL_JAPANESE_POSTCARD, ///< Japanese Double Postcard 200 x 148 mm 1152 wxPAPER_DBL_JAPANESE_POSTCARD_ROTATED, ///< Double Japanese Postcard Rotated 148 x 200 mm 1153 wxPAPER_DSHEET, ///< D Sheet, 22 by 34 inches 1154 wxPAPER_ENV_10, ///< #10 Envelope, 4 1/8 by 9 1/2 inches 1155 wxPAPER_ENV_11, ///< #11 Envelope, 4 1/2 by 10 3/8 inches 1156 wxPAPER_ENV_12, ///< #12 Envelope, 4 3/4 by 11 inches 1157 wxPAPER_ENV_14, ///< #14 Envelope, 5 by 11 1/2 inches 1158 wxPAPER_ENV_9, ///< #9 Envelope, 3 7/8 by 8 7/8 inches 1159 wxPAPER_ENV_B4, ///< B4 Envelope, 250 by 353 millimeters 1160 wxPAPER_ENV_B5, ///< B5 Envelope, 176 by 250 millimeters 1161 wxPAPER_ENV_B6, ///< B6 Envelope, 176 by 125 millimeters 1162 wxPAPER_ENV_C3, ///< C3 Envelope, 324 by 458 millimeters 1163 wxPAPER_ENV_C4, ///< C4 Envelope, 229 by 324 millimeters 1164 wxPAPER_ENV_C5, ///< C5 Envelope, 162 by 229 millimeters 1165 wxPAPER_ENV_C6, ///< C6 Envelope, 114 by 162 millimeters 1166 wxPAPER_ENV_C65, ///< C65 Envelope, 114 by 229 millimeters 1167 wxPAPER_ENV_DL, ///< DL Envelope, 110 by 220 millimeters 1168 wxPAPER_ENV_INVITE, ///< Envelope Invite 220 x 220 mm 1169 wxPAPER_ENV_ITALY, ///< Italy Envelope, 110 by 230 millimeters 1170 wxPAPER_ENV_MONARCH, ///< Monarch Envelope, 3 7/8 by 7 1/2 inches 1171 wxPAPER_ENV_PERSONAL, ///< 6 3/4 Envelope, 3 5/8 by 6 1/2 inches 1172 wxPAPER_ESHEET, ///< E Sheet, 34 by 44 inches 1173 wxPAPER_EXECUTIVE, ///< Executive, 7 1/4 by 10 1/2 inches 1174 wxPAPER_FANFOLD_LGL_GERMAN, ///< German Legal Fanfold, 8 1/2 by 13 inches 1175 wxPAPER_FANFOLD_STD_GERMAN, ///< German Std Fanfold, 8 1/2 by 12 inches 1176 wxPAPER_FANFOLD_US, ///< US Std Fanfold, 14 7/8 by 11 inches 1177 wxPAPER_FOLIO, ///< Folio, 8-1/2-by-13-inch paper 1178 wxPAPER_ISO_B4, ///< B4 (ISO) 250 x 353 mm 1179 wxPAPER_JAPANESE_POSTCARD, ///< Japanese Postcard 100 x 148 mm 1180 wxPAPER_JAPANESE_POSTCARD_ROTATED, ///< Japanese Postcard Rotated 148 x 100 mm 1181 wxPAPER_JENV_CHOU3, ///< Japanese Envelope Chou #3 1182 wxPAPER_JENV_CHOU3_ROTATED, ///< Japanese Envelope Chou #3 Rotated 1183 wxPAPER_JENV_CHOU4, ///< Japanese Envelope Chou #4 1184 wxPAPER_JENV_CHOU4_ROTATED, ///< Japanese Envelope Chou #4 Rotated 1185 wxPAPER_JENV_KAKU2, ///< Japanese Envelope Kaku #2 1186 wxPAPER_JENV_KAKU2_ROTATED, ///< Japanese Envelope Kaku #2 Rotated 1187 wxPAPER_JENV_KAKU3, ///< Japanese Envelope Kaku #3 1188 wxPAPER_JENV_KAKU3_ROTATED, ///< Japanese Envelope Kaku #3 Rotated 1189 wxPAPER_JENV_YOU4, ///< Japanese Envelope You #4 1190 wxPAPER_JENV_YOU4_ROTATED, ///< Japanese Envelope You #4 Rotated 1191 wxPAPER_LEDGER, ///< Ledger, 17 by 11 inches 1192 wxPAPER_LEGAL, ///< Legal, 8 1/2 by 14 inches 1193 wxPAPER_LEGAL_EXTRA, ///< Legal Extra 9.5 x 15 in 1194 wxPAPER_LETTER, ///< Letter, 8 1/2 by 11 inches 1195 wxPAPER_LETTERSMALL, ///< Letter Small, 8 1/2 by 11 inches 1196 wxPAPER_LETTER_EXTRA, ///< Letter Extra 9.5 x 12 in 1197 wxPAPER_LETTER_EXTRA_TRANSVERSE, ///< Letter Extra Transverse 9.5 x 12 in 1198 wxPAPER_LETTER_PLUS, ///< Letter Plus 8.5 x 12.69 in 1199 wxPAPER_LETTER_ROTATED, ///< Letter Rotated 11 x 8 1/2 in 1200 wxPAPER_LETTER_TRANSVERSE, ///< Letter Transverse 8.5 x 11 in 1201 wxPAPER_NONE, ///< Use specific dimensions 1202 wxPAPER_NOTE, ///< Note, 8 1/2 by 11 inches 1203 wxPAPER_P16K, ///< PRC 16K 146 x 215 mm 1204 wxPAPER_P16K_ROTATED, ///< PRC 16K Rotated 1205 wxPAPER_P32K, ///< PRC 32K 97 x 151 mm 1206 wxPAPER_P32KBIG, ///< PRC 32K(Big) 97 x 151 mm 1207 wxPAPER_P32KBIG_ROTATED, ///< PRC 32K(Big) Rotated 1208 wxPAPER_P32K_ROTATED, ///< PRC 32K Rotated 1209 wxPAPER_PENV_1, ///< PRC Envelope #1 102 x 165 mm 1210 wxPAPER_PENV_10, ///< PRC Envelope #10 324 x 458 mm 1211 wxPAPER_PENV_10_ROTATED, ///< PRC Envelope #10 Rotated 458 x 324 m 1212 wxPAPER_PENV_1_ROTATED, ///< PRC Envelope #1 Rotated 165 x 102 mm 1213 wxPAPER_PENV_2, ///< PRC Envelope #2 102 x 176 mm 1214 wxPAPER_PENV_2_ROTATED, ///< PRC Envelope #2 Rotated 176 x 102 mm 1215 wxPAPER_PENV_3, ///< PRC Envelope #3 125 x 176 mm 1216 wxPAPER_PENV_3_ROTATED, ///< PRC Envelope #3 Rotated 176 x 125 mm 1217 wxPAPER_PENV_4, ///< PRC Envelope #4 110 x 208 mm 1218 wxPAPER_PENV_4_ROTATED, ///< PRC Envelope #4 Rotated 208 x 110 mm 1219 wxPAPER_PENV_5, ///< PRC Envelope #5 110 x 220 mm 1220 wxPAPER_PENV_5_ROTATED, ///< PRC Envelope #5 Rotated 220 x 110 mm 1221 wxPAPER_PENV_6, ///< PRC Envelope #6 120 x 230 mm 1222 wxPAPER_PENV_6_ROTATED, ///< PRC Envelope #6 Rotated 230 x 120 mm 1223 wxPAPER_PENV_7, ///< PRC Envelope #7 160 x 230 mm 1224 wxPAPER_PENV_7_ROTATED, ///< PRC Envelope #7 Rotated 230 x 160 mm 1225 wxPAPER_PENV_8, ///< PRC Envelope #8 120 x 309 mm 1226 wxPAPER_PENV_8_ROTATED, ///< PRC Envelope #8 Rotated 309 x 120 mm 1227 wxPAPER_PENV_9, ///< PRC Envelope #9 229 x 324 mm 1228 wxPAPER_PENV_9_ROTATED, ///< PRC Envelope #9 Rotated 324 x 229 mm 1229 wxPAPER_QUARTO, ///< Quarto, 215-by-275-millimeter paper 1230 wxPAPER_STATEMENT, ///< Statement, 5 1/2 by 8 1/2 inches 1231 wxPAPER_TABLOID, ///< Tabloid, 11 by 17 inches 1232 wxPAPER_TABLOID_EXTRA ///< Tabloid Extra 11.69 x 18 in 1233 }; 1234 1235 /** 1236 Printing orientation 1237 */ 1238 1239 enum wxPrintOrientation 1240 { 1241 wxPORTRAIT, 1242 wxLANDSCAPE 1243 }; 1244 1245 /** 1246 Duplex printing modes. 1247 */ 1248 enum wxDuplexMode 1249 { 1250 wxDUPLEX_SIMPLEX, /**< Non-duplex */ 1251 wxDUPLEX_HORIZONTAL, 1252 wxDUPLEX_VERTICAL 1253 }; 1254 1255 /** 1256 Predefined print quality constants. 1257 1258 @see ::wxPrintQuality 1259 */ 1260 #define wxPRINT_QUALITY_HIGH -1 1261 #define wxPRINT_QUALITY_MEDIUM -2 1262 #define wxPRINT_QUALITY_LOW -3 1263 #define wxPRINT_QUALITY_DRAFT -4 1264 1265 /** 1266 Specifies the print quality as either a predefined level or explicit 1267 resolution. 1268 1269 The print quality may be one of ::wxPRINT_QUALITY_HIGH, 1270 ::wxPRINT_QUALITY_MEDIUM, ::wxPRINT_QUALITY_LOW or ::wxPRINT_QUALITY_DRAFT 1271 (which are all negative) or express the desired resolution, in DPI, e.g. 1272 600. 1273 */ 1274 typedef int wxPrintQuality; 1275 1276 /** 1277 Print mode (currently PostScript only). 1278 */ 1279 enum wxPrintMode 1280 { 1281 wxPRINT_MODE_NONE = 0, 1282 wxPRINT_MODE_PREVIEW = 1, /**< Preview in external application */ 1283 wxPRINT_MODE_FILE = 2, /**< Print to file */ 1284 wxPRINT_MODE_PRINTER = 3, /**< Send to printer */ 1285 wxPRINT_MODE_STREAM = 4 /**< Send postscript data into a stream */ 1286 }; 1287 1288 /** 1289 Flags which can be used in wxWindow::UpdateWindowUI(). 1290 */ 1291 enum wxUpdateUI 1292 { 1293 wxUPDATE_UI_NONE, 1294 wxUPDATE_UI_RECURSE, 1295 wxUPDATE_UI_FROMIDLE /**< Invoked from On(Internal)Idle */ 1296 }; 1297 1298 1299 // ---------------------------------------------------------------------------- 1300 // constants 1301 // ---------------------------------------------------------------------------- 1302 1303 /** 1304 Top level window styles common to wxFrame and wxDialog 1305 */ 1306 1307 #define wxSTAY_ON_TOP 0x8000 1308 #define wxICONIZE 0x4000 1309 #define wxMINIMIZE wxICONIZE 1310 #define wxMAXIMIZE 0x2000 1311 #define wxCLOSE_BOX 0x1000 1312 1313 #define wxSYSTEM_MENU 0x0800 1314 #define wxMINIMIZE_BOX 0x0400 1315 #define wxMAXIMIZE_BOX 0x0200 1316 1317 #define wxTINY_CAPTION 0x0080 // clashes with wxNO_DEFAULT 1318 #define wxRESIZE_BORDER 0x0040 1319 1320 1321 /** 1322 C99-like sized MIN/MAX constants for all integer types. 1323 1324 For each @c n in the set 8, 16, 32, 64 we define @c wxINTn_MIN, @c 1325 wxINTn_MAX and @c wxUINTc_MAX (@c wxUINTc_MIN is always 0 and so is not 1326 defined). 1327 */ 1328 //@{ 1329 #define wxINT8_MIN CHAR_MIN 1330 #define wxINT8_MAX CHAR_MAX 1331 #define wxUINT8_MAX UCHAR_MAX 1332 1333 #define wxINT16_MIN SHRT_MIN 1334 #define wxINT16_MAX SHRT_MAX 1335 #define wxUINT16_MAX USHRT_MAX 1336 1337 #define wxINT32_MIN INT_MIN-or-LONG_MIN 1338 #define wxINT32_MAX INT_MAX-or-LONG_MAX 1339 #define wxUINT32_MAX UINT_MAX-or-LONG_MAX 1340 1341 #define wxINT64_MIN LLONG_MIN 1342 #define wxINT64_MAX LLONG_MAX 1343 #define wxUINT64_MAX ULLONG_MAX 1344 //@} 1345 1346 // ---------------------------------------------------------------------------- 1347 // types 1348 // ---------------------------------------------------------------------------- 1349 1350 /** The type for screen and DC coordinates. */ 1351 typedef int wxCoord; 1352 1353 /** A special value meaning "use default coordinate". */ 1354 wxCoord wxDefaultCoord = -1; 1355 1356 //@{ 1357 /** 8 bit type (the mapping is more complex than a simple @c typedef and is not shown here). */ 1358 typedef signed char wxInt8; 1359 typedef unsigned char wxUint8; 1360 typedef wxUint8 wxByte; 1361 //@} 1362 1363 //@{ 1364 /** 16 bit type (the mapping is more complex than a simple @c typedef and is not shown here). */ 1365 typedef signed short wxInt16; 1366 typedef unsigned short wxUint16; 1367 typedef wxUint16 wxWord; 1368 typedef wxUint16 wxChar16; 1369 //@} 1370 1371 //@{ 1372 /** 32 bit type (the mapping is more complex than a simple @c typedef and is not shown here). */ 1373 typedef int wxInt32; 1374 typedef unsigned int wxUint32; 1375 typedef wxUint32 wxDword; 1376 typedef wxUint32 wxChar32; 1377 //@} 1378 1379 //@{ 1380 /** 64 bit type (the mapping is more complex than a simple @c typedef and is not shown here). */ 1381 typedef wxLongLong_t wxInt64; 1382 typedef wxULongLong_t wxUint64; 1383 //@} 1384 1385 //@{ 1386 /** 1387 Signed and unsigned integral types big enough to contain all of @c long, 1388 @c size_t and @c void*. 1389 (The mapping is more complex than a simple @c typedef and is not shown here). 1390 */ 1391 typedef ssize_t wxIntPtr; 1392 typedef size_t wxUIntPtr; 1393 //@} 1394 1395 1396 /** 1397 32 bit IEEE float ( 1 sign, 8 exponent bits, 23 fraction bits ). 1398 (The mapping is more complex than a simple @c typedef and is not shown here). 1399 */ 1400 typedef float wxFloat32; 1401 1402 1403 /** 1404 64 bit IEEE float ( 1 sign, 11 exponent bits, 52 fraction bits ). 1405 (The mapping is more complex than a simple @c typedef and is not shown here). 1406 */ 1407 typedef double wxFloat64; 1408 1409 /** 1410 Native fastest representation that has at least wxFloat64 precision, so use 1411 the IEEE types for storage, and this for calculations. 1412 (The mapping is more complex than a simple @c typedef and is not shown here). 1413 */ 1414 typedef double wxDouble; 1415 1416 1417 1418 // ---------------------------------------------------------------------------- 1419 // macros 1420 // ---------------------------------------------------------------------------- 1421 1422 1423 /** @addtogroup group_funcmacro_byteorder */ 1424 //@{ 1425 1426 /** 1427 This macro will swap the bytes of the @a value variable from little endian 1428 to big endian or vice versa unconditionally, i.e. independently of the 1429 current platform. 1430 1431 @header{wx/defs.h} 1432 */ 1433 #define wxINT32_SWAP_ALWAYS( wxInt32_value ) 1434 #define wxUINT32_SWAP_ALWAYS( wxUint32_value ) 1435 #define wxINT16_SWAP_ALWAYS( wxInt16_value ) 1436 #define wxUINT16_SWAP_ALWAYS( wxUint16_value ) 1437 1438 //@} 1439 1440 /** @addtogroup group_funcmacro_byteorder */ 1441 //@{ 1442 1443 /** 1444 This macro will swap the bytes of the @a value variable from little endian 1445 to big endian or vice versa if the program is compiled on a big-endian 1446 architecture (such as Sun work stations). If the program has been compiled 1447 on a little-endian architecture, the value will be unchanged. 1448 1449 Use these macros to read data from and write data to a file that stores 1450 data in little-endian (for example Intel i386) format. 1451 1452 @header{wx/defs.h} 1453 */ 1454 #define wxINT32_SWAP_ON_BE( wxInt32_value ) 1455 #define wxUINT32_SWAP_ON_BE( wxUint32_value ) 1456 #define wxINT16_SWAP_ON_BE( wxInt16_value ) 1457 #define wxUINT16_SWAP_ON_BE( wxUint16_value ) 1458 1459 //@} 1460 1461 /** @addtogroup group_funcmacro_byteorder */ 1462 //@{ 1463 1464 /** 1465 This macro will swap the bytes of the @a value variable from little endian 1466 to big endian or vice versa if the program is compiled on a little-endian 1467 architecture (such as Intel PCs). If the program has been compiled on a 1468 big-endian architecture, the value will be unchanged. 1469 1470 Use these macros to read data from and write data to a file that stores 1471 data in big-endian format. 1472 1473 @header{wx/defs.h} 1474 */ 1475 #define wxINT32_SWAP_ON_LE( wxInt32_value ) 1476 #define wxUINT32_SWAP_ON_LE( wxUint32_value ) 1477 #define wxINT16_SWAP_ON_LE( wxInt16_value ) 1478 #define wxUINT16_SWAP_ON_LE( wxUint16_value ) 1479 1480 //@} 1481 1482 1483 1484 /** @addtogroup group_funcmacro_misc */ 1485 //@{ 1486 1487 /** 1488 This macro can be used in a class declaration to disable the generation of 1489 default assignment operator. 1490 1491 Some classes have a well-defined copy constructor but cannot have an 1492 assignment operator, typically because they can't be modified once created. 1493 In such case, this macro can be used to disable the automatic assignment 1494 operator generation. 1495 1496 @see wxDECLARE_NO_COPY_CLASS() 1497 */ 1498 #define wxDECLARE_NO_ASSIGN_CLASS(classname) 1499 1500 /** 1501 This macro can be used in a class declaration to disable the generation of 1502 default copy ctor and assignment operator. 1503 1504 Some classes don't have a well-defined copying semantics. In this case the 1505 standard C++ convention is to not allow copying them. One way of achieving 1506 it is to use this macro which simply defines a private copy constructor and 1507 assignment operator. 1508 1509 Beware that simply not defining copy constructor and assignment operator is 1510 @em not enough as the compiler would provide its own automatically-generated 1511 versions of them -- hence the usefulness of this macro. 1512 1513 Example of use: 1514 @code 1515 class FooWidget 1516 { 1517 public: 1518 FooWidget(); 1519 ... 1520 1521 private: 1522 // widgets can't be copied 1523 wxDECLARE_NO_COPY_CLASS(FooWidget); 1524 }; 1525 @endcode 1526 1527 Notice that a semicolon must be used after this macro and that it changes 1528 the access specifier to private internally so it is better to use it at the 1529 end of the class declaration. 1530 1531 @see wxDECLARE_NO_ASSIGN_CLASS(), wxDECLARE_NO_COPY_TEMPLATE_CLASS() 1532 */ 1533 #define wxDECLARE_NO_COPY_CLASS(classname) 1534 1535 /** 1536 Analog of wxDECLARE_NO_COPY_CLASS() for template classes. 1537 1538 This macro can be used for template classes (with a single template 1539 parameter) for the same purpose as wxDECLARE_NO_COPY_CLASS() is used with the 1540 non-template classes. 1541 1542 @param classname The name of the template class. 1543 @param arg The name of the template parameter. 1544 1545 @see wxDECLARE_NO_COPY_TEMPLATE_CLASS_2 1546 */ 1547 #define wxDECLARE_NO_COPY_TEMPLATE_CLASS(classname, arg) 1548 1549 /** 1550 Analog of wxDECLARE_NO_COPY_TEMPLATE_CLASS() for templates with 2 1551 parameters. 1552 1553 This macro can be used for template classes with two template 1554 parameters for the same purpose as wxDECLARE_NO_COPY_CLASS() is used with 1555 the non-template classes. 1556 1557 @param classname The name of the template class. 1558 @param arg1 The name of the first template parameter. 1559 @param arg2 The name of the second template parameter. 1560 1561 @see wxDECLARE_NO_COPY_TEMPLATE_CLASS 1562 */ 1563 #define wxDECLARE_NO_COPY_TEMPLATE_CLASS_2(classname, arg1, arg2) 1564 1565 /** 1566 A function which deletes and nulls the pointer. 1567 1568 This function uses operator delete to free the pointer and also sets it to 1569 @NULL. Notice that this does @em not work for arrays, use wxDELETEA() for 1570 them. 1571 1572 @code 1573 MyClass *ptr = new MyClass; 1574 ... 1575 wxDELETE(ptr); 1576 wxASSERT(!ptr); 1577 @endcode 1578 1579 @header{wx/defs.h} 1580 */ 1581 template <typename T> void wxDELETE(T*& ptr); 1582 1583 /** 1584 A function which deletes and nulls the pointer. 1585 1586 This function uses vector operator delete (@c delete[]) to free the array 1587 pointer and also sets it to @NULL. Notice that this does @em not work for 1588 non-array pointers, use wxDELETE() for them. 1589 1590 @code 1591 MyClass *array = new MyClass[17]; 1592 ... 1593 wxDELETEA(array); 1594 wxASSERT(!array); 1595 @endcode 1596 1597 @see wxDELETE() 1598 1599 @header{wx/defs.h} 1600 */ 1601 template <typename T> void wxDELETEA(T*& array); 1602 1603 /** 1604 Generate deprecation warning with the given message when a function is 1605 used. 1606 1607 This macro can be used to generate a warning indicating that a function is 1608 deprecated (i.e. scheduled for removal in the future) and explaining why is 1609 it so and/or what should it be replaced with. It applies to the declaration 1610 following it, for example: 1611 @code 1612 wxDEPRECATED_MSG("use safer overload returning wxString instead") 1613 void wxGetSomething(char* buf, size_t len); 1614 1615 wxString wxGetSomething(); 1616 @endcode 1617 1618 For compilers other than clang, g++ 4.5 or later and MSVC 8 (MSVS 2005) or 1619 later, the message is ignored and a generic deprecation warning is given if 1620 possible, i.e. if the compiler is g++ (any supported version) or MSVC 7 1621 (MSVS 2003) or later. 1622 1623 @since 3.0 1624 1625 @header{wx/defs.h} 1626 */ 1627 #define wxDEPRECATED_MSG(msg) 1628 1629 /** 1630 This macro can be used around a function declaration to generate warnings 1631 indicating that this function is deprecated (i.e. obsolete and planned to 1632 be removed in the future) when it is used. 1633 1634 Notice that this macro itself is deprecated in favour of wxDEPRECATED_MSG()! 1635 1636 Only Visual C++ 7 and higher and g++ compilers currently support this 1637 functionality. 1638 1639 Example of use: 1640 1641 @code 1642 // old function, use wxString version instead 1643 wxDEPRECATED( void wxGetSomething(char *buf, size_t len) ); 1644 1645 // ... 1646 wxString wxGetSomething(); 1647 @endcode 1648 1649 @header{wx/defs.h} 1650 */ 1651 #define wxDEPRECATED(function) 1652 1653 /** 1654 This is a special version of wxDEPRECATED() macro which only does something 1655 when the deprecated function is used from the code outside wxWidgets itself 1656 but doesn't generate warnings when it is used from wxWidgets. 1657 1658 It is used with the virtual functions which are called by the library 1659 itself -- even if such function is deprecated the library still has to call 1660 it to ensure that the existing code overriding it continues to work, but 1661 the use of this macro ensures that a deprecation warning will be generated 1662 if this function is used from the user code or, in case of Visual C++, even 1663 when it is simply overridden. 1664 1665 @header{wx/defs.h} 1666 */ 1667 #define wxDEPRECATED_BUT_USED_INTERNALLY(function) 1668 1669 /** 1670 This macro is similar to wxDEPRECATED() but can be used to not only declare 1671 the function @a function as deprecated but to also provide its (inline) 1672 implementation @a body. 1673 1674 It can be used as following: 1675 1676 @code 1677 class wxFoo 1678 { 1679 public: 1680 // OldMethod() is deprecated, use NewMethod() instead 1681 void NewMethod(); 1682 wxDEPRECATED_INLINE( void OldMethod(), NewMethod(); ) 1683 }; 1684 @endcode 1685 1686 @header{wx/defs.h} 1687 */ 1688 #define wxDEPRECATED_INLINE(func, body) 1689 1690 /** 1691 A helper macro allowing to easily define a simple deprecated accessor. 1692 1693 Compared to wxDEPRECATED_INLINE() it saves a @c return statement and, 1694 especially, a strangely looking semicolon inside a macro. 1695 1696 Example of use 1697 @code 1698 class wxFoo 1699 { 1700 public: 1701 int GetValue() const { return m_value; } 1702 1703 // this one is deprecated because it was erroneously non-const 1704 wxDEPRECATED_ACCESSOR( int GetValue(), m_value ) 1705 1706 private: 1707 int m_value; 1708 }; 1709 @endcode 1710 */ 1711 #define wxDEPRECATED_ACCESSOR(func, what) 1712 1713 /** 1714 Combination of wxDEPRECATED_BUT_USED_INTERNALLY() and wxDEPRECATED_INLINE(). 1715 1716 This macro should be used for deprecated functions called by the library 1717 itself (usually for backwards compatibility reasons) and which are defined 1718 inline. 1719 1720 @header{wx/defs.h} 1721 */ 1722 #define wxDEPRECATED_BUT_USED_INTERNALLY_INLINE(func, body) 1723 1724 /** 1725 @c wxOVERRIDE expands to the C++11 @c override keyword if it's supported by 1726 the compiler or nothing otherwise. 1727 1728 This macro is useful for writing code which may be compiled by both C++11 1729 and non-C++11 compilers and still allow the use of @c override for the 1730 former. 1731 1732 Example of using this macro: 1733 @code 1734 class MyApp : public wxApp { 1735 public: 1736 virtual bool OnInit() wxOVERRIDE; 1737 1738 // This would result in an error from a C++11 compiler as the 1739 // method doesn't actually override the base class OnExit() due to 1740 // a typo in its name. 1741 //virtual int OnEzit() wxOVERRIDE; 1742 }; 1743 @endcode 1744 1745 @header{wx/defs.h} 1746 1747 @since 3.1.0 1748 */ 1749 #define wxOVERRIDE 1750 1751 /** 1752 GNU C++ compiler gives a warning for any class whose destructor is private 1753 unless it has a friend. This warning may sometimes be useful but it doesn't 1754 make sense for reference counted class which always delete themselves 1755 (hence destructor should be private) but don't necessarily have any 1756 friends, so this macro is provided to disable the warning in such case. The 1757 @a name parameter should be the name of the class but is only used to 1758 construct a unique friend class name internally. 1759 1760 Example of using the macro: 1761 1762 @code 1763 class RefCounted 1764 { 1765 public: 1766 RefCounted() { m_nRef = 1; } 1767 void IncRef() { m_nRef++ ; } 1768 void DecRef() { if ( !--m_nRef ) delete this; } 1769 1770 private: 1771 ~RefCounted() { } 1772 1773 wxSUPPRESS_GCC_PRIVATE_DTOR(RefCounted) 1774 }; 1775 @endcode 1776 1777 Notice that there should be no semicolon after this macro. 1778 1779 @header{wx/defs.h} 1780 */ 1781 #define wxSUPPRESS_GCC_PRIVATE_DTOR_WARNING(name) 1782 1783 /** 1784 Swaps the contents of two variables. 1785 1786 This is similar to std::swap() but can be used even on the platforms where 1787 the standard C++ library is not available (if you don't target such 1788 platforms, please use std::swap() instead). 1789 1790 The function relies on type T being copy constructible and assignable. 1791 1792 Example of use: 1793 @code 1794 int x = 3, 1795 y = 4; 1796 wxSwap(x, y); 1797 wxASSERT( x == 4 && y == 3 ); 1798 @endcode 1799 */ 1800 template <typename T> void wxSwap(T& first, T& second); 1801 1802 /** 1803 This macro is the same as the standard C99 @c va_copy for the compilers 1804 which support it or its replacement for those that don't. It must be used 1805 to preserve the value of a @c va_list object if you need to use it after 1806 passing it to another function because it can be modified by the latter. 1807 1808 As with @c va_start, each call to @c wxVaCopy must have a matching 1809 @c va_end. 1810 1811 @header{wx/defs.h} 1812 */ 1813 void wxVaCopy(va_list argptrDst, va_list argptrSrc); 1814 1815 //@} 1816 1817 1818