| Version: 3.1.5

Macros | Typedefs | Enumerations | Functions | Variables
defs.h File Reference

## Macros
#define | wxSIZE_AUTO_WIDTH 0x0001
#define | wxSIZE_AUTO_HEIGHT 0x0002
#define | wxSIZE_AUTO (wxSIZE_AUTO_WIDTH|wxSIZE_AUTO_HEIGHT)
#define | wxSIZE_USE_EXISTING 0x0000
#define | wxSIZE_ALLOW_MINUS_ONE 0x0004
#define | wxSIZE_NO_ADJUSTMENTS 0x0008
#define | wxSIZE_FORCE 0x0010
#define | wxSIZE_FORCE_EVENT 0x0020
#define | wxVSCROLL 0x80000000
#define | wxHSCROLL 0x40000000
#define | wxCAPTION 0x20000000
#define | wxDOUBLE_BORDER wxBORDER_DOUBLE
#define | wxSUNKEN_BORDER wxBORDER_SUNKEN
#define | wxRAISED_BORDER wxBORDER_RAISED
#define | wxBORDER wxBORDER_SIMPLE
#define | wxSIMPLE_BORDER wxBORDER_SIMPLE
#define | wxSTATIC_BORDER wxBORDER_STATIC
#define | wxNO_BORDER wxBORDER_NONE
#define | wxALWAYS_SHOW_SB 0x00800000
#define | wxCLIP_CHILDREN 0x00400000
#define | wxCLIP_SIBLINGS 0x20000000
#define | wxTRANSPARENT_WINDOW 0x00100000
#define | wxTAB_TRAVERSAL 0x00080000
#define | wxWANTS_CHARS 0x00040000
#define | wxRETAINED 0x00000000
#define | wxBACKINGSTORE wxRETAINED
#define | wxPOPUP_WINDOW 0x00020000
#define | wxFULL_REPAINT_ON_RESIZE 0x00010000
#define | wxNO_FULL_REPAINT_ON_RESIZE 0
#define | wxWINDOW_STYLE_MASK
#define | wxWS_EX_BLOCK_EVENTS 0x00000002
#define | wxWS_EX_TRANSIENT 0x00000004
#define | wxWS_EX_THEMED_BACKGROUND 0x00000008
#define | wxWS_EX_PROCESS_IDLE 0x00000010
#define | wxWS_EX_PROCESS_UI_UPDATES 0x00000020
#define | wxFRAME_EX_METAL 0x00000040
#define | wxDIALOG_EX_METAL 0x00000040
#define | wxWS_EX_CONTEXTHELP 0x00000080
#define | wxFRAME_EX_CONTEXTHELP wxWS_EX_CONTEXTHELP
#define | wxDIALOG_EX_CONTEXTHELP wxWS_EX_CONTEXTHELP
#define | wxFRAME_DRAWER 0x0020
#define | wxFRAME_NO_WINDOW_MENU 0x0100
#define | wxMB_DOCKABLE 0x0001
#define | wxMENU_TEAROFF 0x0001
#define | wxCOLOURED 0x0800
#define | wxFIXED_LENGTH 0x0400
#define | wxLB_SORT 0x0010
#define | wxLB_SINGLE 0x0020
#define | wxLB_MULTIPLE 0x0040
#define | wxLB_EXTENDED 0x0080
#define | wxLB_NEEDED_SB 0x0000
#define | wxLB_OWNERDRAW 0x0100
#define | wxLB_ALWAYS_SB 0x0200
#define | wxLB_NO_SB 0x0400
#define | wxLB_HSCROLL wxHSCROLL
#define | wxLB_INT_HEIGHT 0x0800
#define | wxCB_SIMPLE 0x0004
#define | wxCB_SORT 0x0008
#define | wxCB_READONLY 0x0010
#define | wxCB_DROPDOWN 0x0020
#define | wxRA_LEFTTORIGHT 0x0001
#define | wxRA_TOPTOBOTTOM 0x0002
#define | wxRA_SPECIFY_COLS wxHORIZONTAL
#define | wxRA_SPECIFY_ROWS wxVERTICAL
#define | wxRA_HORIZONTAL wxHORIZONTAL
#define | wxRA_VERTICAL wxVERTICAL
#define | wxRB_GROUP 0x0004
#define | wxRB_SINGLE 0x0008
#define | wxSB_HORIZONTAL wxHORIZONTAL
#define | wxSB_VERTICAL wxVERTICAL
#define | wxSP_HORIZONTAL wxHORIZONTAL /* 4 */
#define | wxSP_VERTICAL wxVERTICAL /* 8 */
#define | wxSP_ARROW_KEYS 0x4000
#define | wxSP_WRAP 0x8000
#define | wxTC_RIGHTJUSTIFY 0x0010
#define | wxTC_FIXEDWIDTH 0x0020
#define | wxTC_TOP 0x0000 /* default */
#define | wxTC_LEFT 0x0020
#define | wxTC_RIGHT 0x0040
#define | wxTC_BOTTOM 0x0080
#define | wxTC_MULTILINE 0x0200 /* == wxNB_MULTILINE */
#define | wxTC_OWNERDRAW 0x0400
#define | wxBI_EXPAND wxEXPAND
#define | wxLI_HORIZONTAL wxHORIZONTAL
#define | wxLI_VERTICAL wxVERTICAL
#define | wxYES 0x00000002
#define | wxOK 0x00000004
#define | wxNO 0x00000008
#define | wxYES_NO (wxYES | wxNO)
#define | wxCANCEL 0x00000010
#define | wxAPPLY 0x00000020
#define | wxCLOSE 0x00000040
#define | wxOK_DEFAULT 0x00000000 /* has no effect (default) */
#define | wxYES_DEFAULT 0x00000000 /* has no effect (default) */
#define | wxNO_DEFAULT 0x00000080 /* only valid with wxYES_NO */
#define | wxCANCEL_DEFAULT 0x80000000 /* only valid with wxCANCEL */
#define | wxICON_EXCLAMATION 0x00000100
#define | wxICON_HAND 0x00000200
#define | wxICON_WARNING wxICON_EXCLAMATION
#define | wxICON_ERROR wxICON_HAND
#define | wxICON_QUESTION 0x00000400
#define | wxICON_INFORMATION 0x00000800
#define | wxICON_STOP wxICON_HAND
#define | wxICON_ASTERISK wxICON_INFORMATION
#define | wxHELP 0x00001000
#define | wxFORWARD 0x00002000
#define | wxBACKWARD 0x00004000
#define | wxRESET 0x00008000
#define | wxMORE 0x00010000
#define | wxSETUP 0x00020000
#define | wxICON_NONE 0x00040000
#define | wxICON_AUTH_NEEDED 0x00080000
#define | wxICON_MASK (wxICON_EXCLAMATION|wxICON_HAND|wxICON_QUESTION|wxICON_INFORMATION|wxICON_NONE)
#define | wxNOT_FOUND (-1)
#define | wxPRINT_QUALITY_HIGH -1
| Predefined print quality constants. More...
#define | wxPRINT_QUALITY_MEDIUM -2
#define | wxPRINT_QUALITY_LOW -3
#define | wxPRINT_QUALITY_DRAFT -4
#define | wxSTAY_ON_TOP 0x8000
| Top level window styles common to wxFrame and wxDialog. More...
#define | wxICONIZE 0x4000
#define | wxMINIMIZE wxICONIZE
#define | wxMAXIMIZE 0x2000
#define | wxCLOSE_BOX 0x1000
#define | wxSYSTEM_MENU 0x0800
#define | wxMINIMIZE_BOX 0x0400
#define | wxMAXIMIZE_BOX 0x0200
#define | wxTINY_CAPTION 0x0080
#define | wxRESIZE_BORDER 0x0040
#define | wxINT8_MIN CHAR_MIN
| C99-like sized MIN/MAX constants for all integer types. More...
#define | wxINT8_MAX CHAR_MAX
#define | wxUINT8_MAX UCHAR_MAX
#define | wxINT16_MIN SHRT_MIN
#define | wxINT16_MAX SHRT_MAX
#define | wxUINT16_MAX USHRT_MAX
#define | wxINT32_MIN INT_MIN-or-LONG_MIN
#define | wxINT32_MAX INT_MAX-or-LONG_MAX
#define | wxUINT32_MAX UINT_MAX-or-LONG_MAX
#define | wxINT64_MIN LLONG_MIN
#define | wxINT64_MAX LLONG_MAX
#define | wxUINT64_MAX ULLONG_MAX
#define | wxINT32_SWAP_ALWAYS(wxInt32_value)
| This macro will swap the bytes of the value variable from little endian to big endian or vice versa unconditionally, i.e. More...
#define | wxUINT32_SWAP_ALWAYS(wxUint32_value)
#define | wxINT16_SWAP_ALWAYS(wxInt16_value)
#define | wxUINT16_SWAP_ALWAYS(wxUint16_value)
#define | wxINT32_SWAP_ON_BE(wxInt32_value)
| This macro will swap the bytes of the value variable from little endian to big endian or vice versa if the program is compiled on a big-endian architecture (such as Sun work stations). More...
#define | wxUINT32_SWAP_ON_BE(wxUint32_value)
#define | wxINT16_SWAP_ON_BE(wxInt16_value)
#define | wxUINT16_SWAP_ON_BE(wxUint16_value)
#define | wxINT32_SWAP_ON_LE(wxInt32_value)
| This macro will swap the bytes of the value variable from little endian to big endian or vice versa if the program is compiled on a little-endian architecture (such as Intel PCs). More...
#define | wxUINT32_SWAP_ON_LE(wxUint32_value)
#define | wxINT16_SWAP_ON_LE(wxInt16_value)
#define | wxUINT16_SWAP_ON_LE(wxUint16_value)
#define | wxDECLARE_NO_ASSIGN_CLASS(classname)
| This macro can be used in a class declaration to disable the generation of default assignment operator. More...
#define | wxDECLARE_NO_COPY_CLASS(classname)
| This macro can be used in a class declaration to disable the generation of default copy ctor and assignment operator. More...
#define | wxDECLARE_NO_COPY_TEMPLATE_CLASS(classname, arg)
| Analog of wxDECLARE_NO_COPY_CLASS() for template classes. More...
#define | wxDECLARE_NO_COPY_TEMPLATE_CLASS_2(classname, arg1, arg2)
| Analog of wxDECLARE_NO_COPY_TEMPLATE_CLASS() for templates with 2 parameters. More...
#define | wxDEPRECATED_MSG(msg)
| Generate deprecation warning with the given message when a function is used. More...
#define | wxDEPRECATED(function)
| This macro can be used around a function declaration to generate warnings indicating that this function is deprecated (i.e. More...
#define | wxDEPRECATED_BUT_USED_INTERNALLY(function)
| This is a special version of wxDEPRECATED() macro which only does something when the deprecated function is used from the code outside wxWidgets itself but doesn't generate warnings when it is used from wxWidgets. More...
#define | wxDEPRECATED_INLINE(func, body)
| This macro is similar to wxDEPRECATED() but can be used to not only declare the function function as deprecated but to also provide its (inline) implementation body. More...
#define | wxDEPRECATED_ACCESSOR(func, what)
| A helper macro allowing to easily define a simple deprecated accessor. More...
#define | wxDEPRECATED_BUT_USED_INTERNALLY_INLINE(func, body)
| Combination of wxDEPRECATED_BUT_USED_INTERNALLY() and wxDEPRECATED_INLINE(). More...
#define | wxOVERRIDE
| `wxOVERRIDE` expands to the C++11 `override` keyword if it's supported by the compiler or nothing otherwise. More...
#define | wxSUPPRESS_GCC_PRIVATE_DTOR_WARNING(name)
| GNU C++ compiler gives a warning for any class whose destructor is private unless it has a friend. More...

## Typedefs
typedef int | wxPrintQuality
| Specifies the print quality as either a predefined level or explicit resolution. More...
typedef int | wxCoord
| The type for screen and DC coordinates. More...
typedef signed char | wxInt8
| 8 bit type (the mapping is more complex than a simple `typedef` and is not shown here). More...
typedef unsigned char | wxUint8
typedef wxUint8 | wxByte
typedef signed short | wxInt16
| 16 bit type (the mapping is more complex than a simple `typedef` and is not shown here). More...
typedef unsigned short | wxUint16
typedef wxUint16 | wxWord
typedef wxUint16 | wxChar16
typedef int | wxInt32
| 32 bit type (the mapping is more complex than a simple `typedef` and is not shown here). More...
typedef unsigned int | wxUint32
typedef wxUint32 | wxDword
typedef wxUint32 | wxChar32
typedef wxLongLong_t | wxInt64
| 64 bit type (the mapping is more complex than a simple `typedef` and is not shown here). More...
typedef wxULongLong_t | wxUint64
typedef ssize_t | wxIntPtr
| Signed and unsigned integral types big enough to contain all of `long`, `size_t` and `void*`. More...
typedef size_t | wxUIntPtr
typedef float | wxFloat32
| 32 bit IEEE float ( 1 sign, 8 exponent bits, 23 fraction bits ). More...
typedef double | wxFloat64
| 64 bit IEEE float ( 1 sign, 11 exponent bits, 52 fraction bits ). More...
typedef double | wxDouble
| Native fastest representation that has at least wxFloat64 precision, so use the IEEE types for storage, and this for calculations. More...

## Enumerations
enum | wxGeometryCentre { wxCENTRE = 0x0001 , wxCENTER = wxCENTRE }
| Generic flags. More...
enum | wxOrientation { wxHORIZONTAL = 0x0004 , wxVERTICAL = 0x0008 , wxBOTH = wxVERTICAL | wxHORIZONTAL , wxORIENTATION_MASK = wxBOTH }
| A generic orientation value. More...
enum | wxDirection { wxLEFT = 0x0010 , wxRIGHT = 0x0020 , wxUP = 0x0040 , wxDOWN = 0x0080 , wxTOP = wxUP , wxBOTTOM = wxDOWN , wxNORTH = wxUP , wxSOUTH = wxDOWN , wxWEST = wxLEFT , wxEAST = wxRIGHT , wxALL = (wxUP | wxDOWN | wxRIGHT | wxLEFT) , wxDIRECTION_MASK = wxALL }
| A generic direction value. More...
enum | wxAlignment { wxALIGN_INVALID = -1 , wxALIGN_NOT = 0x0000 , wxALIGN_CENTER_HORIZONTAL = 0x0100 , wxALIGN_CENTRE_HORIZONTAL = wxALIGN_CENTER_HORIZONTAL , wxALIGN_LEFT = wxALIGN_NOT , wxALIGN_TOP = wxALIGN_NOT , wxALIGN_RIGHT = 0x0200 , wxALIGN_BOTTOM = 0x0400 , wxALIGN_CENTER_VERTICAL = 0x0800 , wxALIGN_CENTRE_VERTICAL = wxALIGN_CENTER_VERTICAL , wxALIGN_CENTER = (wxALIGN_CENTER_HORIZONTAL | wxALIGN_CENTER_VERTICAL) , wxALIGN_CENTRE = wxALIGN_CENTER , wxALIGN_MASK = 0x0f00 }
| Generic alignment values. More...
enum | wxSizerFlagBits { wxFIXED_MINSIZE = 0x8000 , wxRESERVE_SPACE_EVEN_IF_HIDDEN = 0x0002 , wxSIZER_FLAG_BITS_MASK = 0x8002 }
| Miscellaneous flags for wxSizer items. More...
enum | wxStretch { wxSTRETCH_NOT = 0x0000 , wxSHRINK = 0x1000 , wxGROW = 0x2000 , wxEXPAND = wxGROW , wxSHAPED = 0x4000 , wxTILE = wxSHAPED | wxFIXED_MINSIZE , wxSTRETCH_MASK = 0x7000 }
| Generic stretch values. More...
enum | wxBorder { wxBORDER_DEFAULT = 0 , wxBORDER_NONE = 0x00200000 , wxBORDER_STATIC = 0x01000000 , wxBORDER_SIMPLE = 0x02000000 , wxBORDER_RAISED = 0x04000000 , wxBORDER_SUNKEN = 0x08000000 , wxBORDER_DOUBLE = 0x10000000 , wxBORDER_THEME = wxBORDER_DOUBLE , wxBORDER_MASK = 0x1f200000 }
| Border flags for wxWindow. More...
enum | wxBackgroundStyle { wxBG_STYLE_ERASE , wxBG_STYLE_SYSTEM , wxBG_STYLE_PAINT , wxBG_STYLE_COLOUR , wxBG_STYLE_TRANSPARENT }
| Background styles. More...
enum | wxStandardID { wxID_AUTO_LOWEST , wxID_AUTO_HIGHEST , wxID_NONE = -3 , wxID_SEPARATOR = -2 , wxID_ANY = -1 , wxID_LOWEST = 4999 , wxID_OPEN , wxID_CLOSE , wxID_NEW , wxID_SAVE , wxID_SAVEAS , wxID_REVERT , wxID_EXIT , wxID_UNDO , wxID_REDO , wxID_HELP , wxID_PRINT , wxID_PRINT_SETUP , wxID_PAGE_SETUP , wxID_PREVIEW , wxID_ABOUT , wxID_HELP_CONTENTS , wxID_HELP_INDEX , wxID_HELP_SEARCH , wxID_HELP_COMMANDS , wxID_HELP_PROCEDURES , wxID_HELP_CONTEXT , wxID_CLOSE_ALL , wxID_PREFERENCES , wxID_EDIT = 5030 , wxID_CUT , wxID_COPY , wxID_PASTE , wxID_CLEAR , wxID_FIND , wxID_DUPLICATE , wxID_SELECTALL , wxID_DELETE , wxID_REPLACE , wxID_REPLACE_ALL , wxID_PROPERTIES , wxID_VIEW_DETAILS , wxID_VIEW_LARGEICONS , wxID_VIEW_SMALLICONS , wxID_VIEW_LIST , wxID_VIEW_SORTDATE , wxID_VIEW_SORTNAME , wxID_VIEW_SORTSIZE , wxID_VIEW_SORTTYPE , wxID_FILE = 5050 , wxID_FILE1 , wxID_FILE2 , wxID_FILE3 , wxID_FILE4 , wxID_FILE5 , wxID_FILE6 , wxID_FILE7 , wxID_FILE8 , wxID_FILE9 , wxID_OK = 5100 , wxID_CANCEL , wxID_APPLY , wxID_YES , wxID_NO , wxID_STATIC , wxID_FORWARD , wxID_BACKWARD , wxID_DEFAULT , wxID_MORE , wxID_SETUP , wxID_RESET , wxID_CONTEXT_HELP , wxID_YESTOALL , wxID_NOTOALL , wxID_ABORT , wxID_RETRY , wxID_IGNORE , wxID_ADD , wxID_REMOVE , wxID_UP , wxID_DOWN , wxID_HOME , wxID_REFRESH , wxID_STOP , wxID_INDEX , wxID_BOLD , wxID_ITALIC , wxID_JUSTIFY_CENTER , wxID_JUSTIFY_FILL , wxID_JUSTIFY_RIGHT , wxID_JUSTIFY_LEFT , wxID_UNDERLINE , wxID_INDENT , wxID_UNINDENT , wxID_ZOOM_100 , wxID_ZOOM_FIT , wxID_ZOOM_IN , wxID_ZOOM_OUT , wxID_UNDELETE , wxID_REVERT_TO_SAVED , wxID_CDROM , wxID_CONVERT , wxID_EXECUTE , wxID_FLOPPY , wxID_HARDDISK , wxID_BOTTOM , wxID_FIRST , wxID_LAST , wxID_TOP , wxID_INFO , wxID_JUMP_TO , wxID_NETWORK , wxID_SELECT_COLOR , wxID_SELECT_FONT , wxID_SORT_ASCENDING , wxID_SORT_DESCENDING , wxID_SPELL_CHECK , wxID_STRIKETHROUGH , wxID_SYSTEM_MENU = 5200 , wxID_CLOSE_FRAME , wxID_MOVE_FRAME , wxID_RESIZE_FRAME , wxID_MAXIMIZE_FRAME , wxID_ICONIZE_FRAME , wxID_RESTORE_FRAME , wxID_MDI_WINDOW_FIRST = 5230 , wxID_MDI_WINDOW_CASCADE = wxID_MDI_WINDOW_FIRST , wxID_MDI_WINDOW_TILE_HORZ , wxID_MDI_WINDOW_TILE_VERT , wxID_MDI_WINDOW_ARRANGE_ICONS , wxID_MDI_WINDOW_PREV , wxID_MDI_WINDOW_NEXT , wxID_MDI_WINDOW_LAST = wxID_MDI_WINDOW_NEXT , wxID_FILEDLGG = 5900 , wxID_FILECTRL = 5950 , wxID_HIGHEST = 5999 }
| Standard IDs. More...
enum | wxItemKind { wxITEM_SEPARATOR = -1 , wxITEM_NORMAL , wxITEM_CHECK , wxITEM_RADIO , wxITEM_DROPDOWN , wxITEM_MAX }
| Item kinds for use with wxMenu, wxMenuItem, and wxToolBar. More...
enum | wxHitTest { wxHT_NOWHERE , wxHT_SCROLLBAR_FIRST = wxHT_NOWHERE , wxHT_SCROLLBAR_ARROW_LINE_1 , wxHT_SCROLLBAR_ARROW_LINE_2 , wxHT_SCROLLBAR_ARROW_PAGE_1 , wxHT_SCROLLBAR_ARROW_PAGE_2 , wxHT_SCROLLBAR_THUMB , wxHT_SCROLLBAR_BAR_1 , wxHT_SCROLLBAR_BAR_2 , wxHT_SCROLLBAR_LAST , wxHT_WINDOW_OUTSIDE , wxHT_WINDOW_INSIDE , wxHT_WINDOW_VERT_SCROLLBAR , wxHT_WINDOW_HORZ_SCROLLBAR , wxHT_WINDOW_CORNER , wxHT_MAX }
| Generic hit test results. More...
enum | wxDataFormatId { wxDF_INVALID = 0 , wxDF_TEXT = 1 , wxDF_BITMAP = 2 , wxDF_METAFILE = 3 , wxDF_SYLK = 4 , wxDF_DIF = 5 , wxDF_TIFF = 6 , wxDF_OEMTEXT = 7 , wxDF_DIB = 8 , wxDF_PALETTE = 9 , wxDF_PENDATA = 10 , wxDF_RIFF = 11 , wxDF_WAVE = 12 , wxDF_UNICODETEXT = 13 , wxDF_ENHMETAFILE = 14 , wxDF_FILENAME = 15 , wxDF_LOCALE = 16 , wxDF_PRIVATE = 20 , wxDF_HTML = 30 , wxDF_PNG = 31 , wxDF_MAX }
| Data format IDs used by wxDataFormat. More...
enum | wxKeyCode { WXK_NONE = 0 , WXK_CONTROL_A = 1 , WXK_CONTROL_B , WXK_CONTROL_C , WXK_CONTROL_D , WXK_CONTROL_E , WXK_CONTROL_F , WXK_CONTROL_G , WXK_CONTROL_H , WXK_CONTROL_I , WXK_CONTROL_J , WXK_CONTROL_K , WXK_CONTROL_L , WXK_CONTROL_M , WXK_CONTROL_N , WXK_CONTROL_O , WXK_CONTROL_P , WXK_CONTROL_Q , WXK_CONTROL_R , WXK_CONTROL_S , WXK_CONTROL_T , WXK_CONTROL_U , WXK_CONTROL_V , WXK_CONTROL_W , WXK_CONTROL_X , WXK_CONTROL_Y , WXK_CONTROL_Z , WXK_BACK = 8 , WXK_TAB = 9 , WXK_RETURN = 13 , WXK_ESCAPE = 27 , WXK_SPACE = 32 , WXK_DELETE = 127 , WXK_START = 300 , WXK_LBUTTON , WXK_RBUTTON , WXK_CANCEL , WXK_MBUTTON , WXK_CLEAR , WXK_SHIFT , WXK_ALT , WXK_CONTROL , WXK_RAW_CONTROL , WXK_MENU , WXK_PAUSE , WXK_CAPITAL , WXK_END , WXK_HOME , WXK_LEFT , WXK_UP , WXK_RIGHT , WXK_DOWN , WXK_SELECT , WXK_PRINT , WXK_EXECUTE , WXK_SNAPSHOT , WXK_INSERT , WXK_HELP , WXK_NUMPAD0 , WXK_NUMPAD1 , WXK_NUMPAD2 , WXK_NUMPAD3 , WXK_NUMPAD4 , WXK_NUMPAD5 , WXK_NUMPAD6 , WXK_NUMPAD7 , WXK_NUMPAD8 , WXK_NUMPAD9 , WXK_MULTIPLY , WXK_ADD , WXK_SEPARATOR , WXK_SUBTRACT , WXK_DECIMAL , WXK_DIVIDE , WXK_F1 , WXK_F2 , WXK_F3 , WXK_F4 , WXK_F5 , WXK_F6 , WXK_F7 , WXK_F8 , WXK_F9 , WXK_F10 , WXK_F11 , WXK_F12 , WXK_F13 , WXK_F14 , WXK_F15 , WXK_F16 , WXK_F17 , WXK_F18 , WXK_F19 , WXK_F20 , WXK_F21 , WXK_F22 , WXK_F23 , WXK_F24 , WXK_NUMLOCK , WXK_SCROLL , WXK_PAGEUP , WXK_PAGEDOWN , WXK_NUMPAD_SPACE , WXK_NUMPAD_TAB , WXK_NUMPAD_ENTER , WXK_NUMPAD_F1 , WXK_NUMPAD_F2 , WXK_NUMPAD_F3 , WXK_NUMPAD_F4 , WXK_NUMPAD_HOME , WXK_NUMPAD_LEFT , WXK_NUMPAD_UP , WXK_NUMPAD_RIGHT , WXK_NUMPAD_DOWN , WXK_NUMPAD_PAGEUP , WXK_NUMPAD_PAGEDOWN , WXK_NUMPAD_END , WXK_NUMPAD_BEGIN , WXK_NUMPAD_INSERT , WXK_NUMPAD_DELETE , WXK_NUMPAD_EQUAL , WXK_NUMPAD_MULTIPLY , WXK_NUMPAD_ADD , WXK_NUMPAD_SEPARATOR , WXK_NUMPAD_SUBTRACT , WXK_NUMPAD_DECIMAL , WXK_NUMPAD_DIVIDE , WXK_WINDOWS_LEFT , WXK_WINDOWS_RIGHT , WXK_WINDOWS_MENU , WXK_COMMAND , WXK_SPECIAL1 = 193 , WXK_SPECIAL2 , WXK_SPECIAL3 , WXK_SPECIAL4 , WXK_SPECIAL5 , WXK_SPECIAL6 , WXK_SPECIAL7 , WXK_SPECIAL8 , WXK_SPECIAL9 , WXK_SPECIAL10 , WXK_SPECIAL11 , WXK_SPECIAL12 , WXK_SPECIAL13 , WXK_SPECIAL14 , WXK_SPECIAL15 , WXK_SPECIAL16 , WXK_SPECIAL17 , WXK_SPECIAL18 , WXK_SPECIAL19 , WXK_SPECIAL20 , WXK_BROWSER_BACK = 501 , WXK_BROWSER_FORWARD , WXK_BROWSER_REFRESH , WXK_BROWSER_STOP , WXK_BROWSER_SEARCH , WXK_BROWSER_FAVORITES , WXK_BROWSER_HOME , WXK_VOLUME_MUTE , WXK_VOLUME_DOWN , WXK_VOLUME_UP , WXK_MEDIA_NEXT_TRACK , WXK_MEDIA_PREV_TRACK , WXK_MEDIA_STOP , WXK_MEDIA_PLAY_PAUSE , WXK_LAUNCH_MAIL , WXK_LAUNCH_APP1 , WXK_LAUNCH_APP2 }
| Virtual keycodes used by wxKeyEvent and some other wxWidgets functions. More...
enum | wxKeyModifier { wxMOD_NONE = 0x0000 , wxMOD_ALT = 0x0001 , wxMOD_CONTROL = 0x0002 , wxMOD_ALTGR = wxMOD_ALT | wxMOD_CONTROL , wxMOD_SHIFT = 0x0004 , wxMOD_META = 0x0008 , wxMOD_WIN = wxMOD_META , wxMOD_RAW_CONTROL , wxMOD_CMD = wxMOD_CONTROL , wxMOD_ALL = 0xffff }
| This enum contains bit mask constants used in wxKeyEvent. More...
enum | wxPaperSize { wxPAPER_10X11 , wxPAPER_10X14 , wxPAPER_11X17 , wxPAPER_12X11 , wxPAPER_15X11 , wxPAPER_9X11 , wxPAPER_A2 , wxPAPER_A3 , wxPAPER_A3_EXTRA , wxPAPER_A3_EXTRA_TRANSVERSE , wxPAPER_A3_ROTATED , wxPAPER_A3_TRANSVERSE , wxPAPER_A4 , wxPAPER_A4SMALL , wxPAPER_A4_EXTRA , wxPAPER_A4_PLUS , wxPAPER_A4_ROTATED , wxPAPER_A4_TRANSVERSE , wxPAPER_A5 , wxPAPER_A5_EXTRA , wxPAPER_A5_ROTATED , wxPAPER_A5_TRANSVERSE , wxPAPER_A6 , wxPAPER_A6_ROTATED , wxPAPER_A_PLUS , wxPAPER_B4 , wxPAPER_B4_JIS_ROTATED , wxPAPER_B5 , wxPAPER_B5_EXTRA , wxPAPER_B5_JIS_ROTATED , wxPAPER_B5_TRANSVERSE , wxPAPER_B6_JIS , wxPAPER_B6_JIS_ROTATED , wxPAPER_B_PLUS , wxPAPER_CSHEET , wxPAPER_DBL_JAPANESE_POSTCARD , wxPAPER_DBL_JAPANESE_POSTCARD_ROTATED , wxPAPER_DSHEET , wxPAPER_ENV_10 , wxPAPER_ENV_11 , wxPAPER_ENV_12 , wxPAPER_ENV_14 , wxPAPER_ENV_9 , wxPAPER_ENV_B4 , wxPAPER_ENV_B5 , wxPAPER_ENV_B6 , wxPAPER_ENV_C3 , wxPAPER_ENV_C4 , wxPAPER_ENV_C5 , wxPAPER_ENV_C6 , wxPAPER_ENV_C65 , wxPAPER_ENV_DL , wxPAPER_ENV_INVITE , wxPAPER_ENV_ITALY , wxPAPER_ENV_MONARCH , wxPAPER_ENV_PERSONAL , wxPAPER_ESHEET , wxPAPER_EXECUTIVE , wxPAPER_FANFOLD_LGL_GERMAN , wxPAPER_FANFOLD_STD_GERMAN , wxPAPER_FANFOLD_US , wxPAPER_FOLIO , wxPAPER_ISO_B4 , wxPAPER_JAPANESE_POSTCARD , wxPAPER_JAPANESE_POSTCARD_ROTATED , wxPAPER_JENV_CHOU3 , wxPAPER_JENV_CHOU3_ROTATED , wxPAPER_JENV_CHOU4 , wxPAPER_JENV_CHOU4_ROTATED , wxPAPER_JENV_KAKU2 , wxPAPER_JENV_KAKU2_ROTATED , wxPAPER_JENV_KAKU3 , wxPAPER_JENV_KAKU3_ROTATED , wxPAPER_JENV_YOU4 , wxPAPER_JENV_YOU4_ROTATED , wxPAPER_LEDGER , wxPAPER_LEGAL , wxPAPER_LEGAL_EXTRA , wxPAPER_LETTER , wxPAPER_LETTERSMALL , wxPAPER_LETTER_EXTRA , wxPAPER_LETTER_EXTRA_TRANSVERSE , wxPAPER_LETTER_PLUS , wxPAPER_LETTER_ROTATED , wxPAPER_LETTER_TRANSVERSE , wxPAPER_NONE , wxPAPER_NOTE , wxPAPER_P16K , wxPAPER_P16K_ROTATED , wxPAPER_P32K , wxPAPER_P32KBIG , wxPAPER_P32KBIG_ROTATED , wxPAPER_P32K_ROTATED , wxPAPER_PENV_1 , wxPAPER_PENV_10 , wxPAPER_PENV_10_ROTATED , wxPAPER_PENV_1_ROTATED , wxPAPER_PENV_2 , wxPAPER_PENV_2_ROTATED , wxPAPER_PENV_3 , wxPAPER_PENV_3_ROTATED , wxPAPER_PENV_4 , wxPAPER_PENV_4_ROTATED , wxPAPER_PENV_5 , wxPAPER_PENV_5_ROTATED , wxPAPER_PENV_6 , wxPAPER_PENV_6_ROTATED , wxPAPER_PENV_7 , wxPAPER_PENV_7_ROTATED , wxPAPER_PENV_8 , wxPAPER_PENV_8_ROTATED , wxPAPER_PENV_9 , wxPAPER_PENV_9_ROTATED , wxPAPER_QUARTO , wxPAPER_STATEMENT , wxPAPER_TABLOID , wxPAPER_TABLOID_EXTRA }
| Paper size types for use with the printing framework. More...
enum | wxPrintOrientation { wxPORTRAIT , wxLANDSCAPE }
| Printing orientation. More...
enum | wxDuplexMode { wxDUPLEX_SIMPLEX , wxDUPLEX_HORIZONTAL , wxDUPLEX_VERTICAL }
| Duplex printing modes. More...
enum | wxPrintMode { wxPRINT_MODE_NONE = 0 , wxPRINT_MODE_PREVIEW = 1 , wxPRINT_MODE_FILE = 2 , wxPRINT_MODE_PRINTER = 3 , wxPRINT_MODE_STREAM = 4 }
| Print mode (currently PostScript only). More...
enum | wxUpdateUI { wxUPDATE_UI_NONE , wxUPDATE_UI_RECURSE , wxUPDATE_UI_FROMIDLE }
| Flags which can be used in wxWindow::UpdateWindowUI(). More...

## Functions
template<typename T >
void | wxDELETE (T *&ptr)
| A function which deletes and nulls the pointer. More...
template<typename T >
void | wxDELETEA (T *&array)
| A function which deletes and nulls the pointer. More...
template<typename T >
void | wxSwap (T &first, T &second)
| Swaps the contents of two variables. More...
void | wxVaCopy (va_list argptrDst, va_list argptrSrc)
| This macro is the same as the standard C99 `va_copy` for the compilers which support it or its replacement for those that don't. More...

## Variables
wxCoord | wxDefaultCoord = -1
| A special value meaning "use default coordinate". More...

## Macro Definition Documentation

## ◆ wxALWAYS_SHOW_SB

#define wxALWAYS_SHOW_SB 0x00800000

## ◆ wxAPPLY

#define wxAPPLY 0x00000020

## ◆ wxBACKINGSTORE

#define wxBACKINGSTORE wxRETAINED

## ◆ wxBACKWARD

#define wxBACKWARD 0x00004000

## ◆ wxBI_EXPAND

#define wxBI_EXPAND wxEXPAND

## ◆ wxBORDER

#define wxBORDER wxBORDER_SIMPLE

## ◆ wxCANCEL

#define wxCANCEL 0x00000010

## ◆ wxCANCEL_DEFAULT

#define wxCANCEL_DEFAULT 0x80000000 /* only valid with wxCANCEL */

## ◆ wxCAPTION

#define wxCAPTION 0x20000000

## ◆ wxCB_DROPDOWN

#define wxCB_DROPDOWN 0x0020

## ◆ wxCB_READONLY

#define wxCB_READONLY 0x0010

## ◆ wxCB_SIMPLE

#define wxCB_SIMPLE 0x0004

## ◆ wxCB_SORT

#define wxCB_SORT 0x0008

## ◆ wxCLIP_CHILDREN

#define wxCLIP_CHILDREN 0x00400000

## ◆ wxCLIP_SIBLINGS

#define wxCLIP_SIBLINGS 0x20000000

## ◆ wxCLOSE

#define wxCLOSE 0x00000040

## ◆ wxCLOSE_BOX

#define wxCLOSE_BOX 0x1000

## ◆ wxCOLOURED

#define wxCOLOURED 0x0800

## ◆ wxDECLARE_NO_ASSIGN_CLASS

#define wxDECLARE_NO_ASSIGN_CLASS | ( |  | classname | ) |

This macro can be used in a class declaration to disable the generation of default assignment operator.

Some classes have a well-defined copy constructor but cannot have an assignment operator, typically because they can't be modified once created. In such case, this macro can be used to disable the automatic assignment operator generation.

See also
  wxDECLARE_NO_COPY_CLASS()

## ◆ wxDECLARE_NO_COPY_CLASS

#define wxDECLARE_NO_COPY_CLASS | ( |  | classname | ) |

This macro can be used in a class declaration to disable the generation of default copy ctor and assignment operator.

Some classes don't have a well-defined copying semantics. In this case the standard C++ convention is to not allow copying them. One way of achieving it is to use this macro which simply defines a private copy constructor and assignment operator.

Beware that simply not defining copy constructor and assignment operator is not enough as the compiler would provide its own automatically-generated versions of them – hence the usefulness of this macro.

Example of use:

class FooWidget
{
public:
FooWidget();
...
private:
// widgets can't be copied
wxDECLARE_NO_COPY_CLASS(FooWidget);
};
wxDECLARE_NO_COPY_CLASS
#define wxDECLARE_NO_COPY_CLASS(classname)
This macro can be used in a class declaration to disable the generation of default copy ctor and assi...
Definition: defs.h:1533

Notice that a semicolon must be used after this macro and that it changes the access specifier to private internally so it is better to use it at the end of the class declaration.

See also
  wxDECLARE_NO_ASSIGN_CLASS(), wxDECLARE_NO_COPY_TEMPLATE_CLASS()

## ◆ wxDECLARE_NO_COPY_TEMPLATE_CLASS

#define wxDECLARE_NO_COPY_TEMPLATE_CLASS | ( |  | classname,
|  |  | arg
| ) |  |

Analog of wxDECLARE_NO_COPY_CLASS() for template classes.

This macro can be used for template classes (with a single template parameter) for the same purpose as wxDECLARE_NO_COPY_CLASS() is used with the non-template classes.

Parameters

  classname | The name of the template class.
  arg | The name of the template parameter.

See also
  wxDECLARE_NO_COPY_TEMPLATE_CLASS_2

## ◆ wxDECLARE_NO_COPY_TEMPLATE_CLASS_2

#define wxDECLARE_NO_COPY_TEMPLATE_CLASS_2 | ( |  | classname,
|  |  | arg1,
|  |  | arg2
| ) |  |

Analog of wxDECLARE_NO_COPY_TEMPLATE_CLASS() for templates with 2 parameters.

This macro can be used for template classes with two template parameters for the same purpose as wxDECLARE_NO_COPY_CLASS() is used with the non-template classes.

Parameters

  classname | The name of the template class.
  arg1 | The name of the first template parameter.
  arg2 | The name of the second template parameter.

See also
  wxDECLARE_NO_COPY_TEMPLATE_CLASS

## ◆ wxDEPRECATED

#define wxDEPRECATED | ( |  | function | ) |

This macro can be used around a function declaration to generate warnings indicating that this function is deprecated (i.e.

obsolete and planned to be removed in the future) when it is used.

Notice that this macro itself is deprecated in favour of wxDEPRECATED_MSG()!

Only Visual C++ 7 and higher and g++ compilers currently support this functionality.

Example of use:

// old function, use wxString version instead
wxDEPRECATED( void wxGetSomething(char *buf, size_t len) );
// ...
wxString wxGetSomething();
wxString
String class for passing textual data to or receiving it from wxWidgets.
Definition: string.h:315
wxDEPRECATED
#define wxDEPRECATED(function)
This macro can be used around a function declaration to generate warnings indicating that this functi...
Definition: defs.h:1651

Include file:

    #include <wx/defs.h>

## ◆ wxDEPRECATED_ACCESSOR

#define wxDEPRECATED_ACCESSOR | ( |  | func,
|  |  | what
| ) |  |

A helper macro allowing to easily define a simple deprecated accessor.

Compared to wxDEPRECATED_INLINE() it saves a `return` statement and, especially, a strangely looking semicolon inside a macro.

Example of use

class wxFoo
{
public:
int GetValue() const { return m_value; }
// this one is deprecated because it was erroneously non-const
wxDEPRECATED_ACCESSOR( int GetValue(), m_value )
private:
int m_value;
};
wxDEPRECATED_ACCESSOR
#define wxDEPRECATED_ACCESSOR(func, what)
A helper macro allowing to easily define a simple deprecated accessor.
Definition: defs.h:1711

## ◆ wxDEPRECATED_BUT_USED_INTERNALLY

#define wxDEPRECATED_BUT_USED_INTERNALLY | ( |  | function | ) |

This is a special version of wxDEPRECATED() macro which only does something when the deprecated function is used from the code outside wxWidgets itself but doesn't generate warnings when it is used from wxWidgets.

It is used with the virtual functions which are called by the library itself – even if such function is deprecated the library still has to call it to ensure that the existing code overriding it continues to work, but the use of this macro ensures that a deprecation warning will be generated if this function is used from the user code or, in case of Visual C++, even when it is simply overridden.

Include file:

    #include <wx/defs.h>

## ◆ wxDEPRECATED_BUT_USED_INTERNALLY_INLINE

#define wxDEPRECATED_BUT_USED_INTERNALLY_INLINE | ( |  | func,
|  |  | body
| ) |  |

Combination of wxDEPRECATED_BUT_USED_INTERNALLY() and wxDEPRECATED_INLINE().

This macro should be used for deprecated functions called by the library itself (usually for backwards compatibility reasons) and which are defined inline.

Include file:

    #include <wx/defs.h>

## ◆ wxDEPRECATED_INLINE

#define wxDEPRECATED_INLINE | ( |  | func,
|  |  | body
| ) |  |

This macro is similar to wxDEPRECATED() but can be used to not only declare the function function as deprecated but to also provide its (inline) implementation body.

It can be used as following:

class wxFoo
{
public:
// OldMethod() is deprecated, use NewMethod() instead
void NewMethod();
wxDEPRECATED_INLINE( void OldMethod(), NewMethod(); )
};
wxDEPRECATED_INLINE
#define wxDEPRECATED_INLINE(func, body)
This macro is similar to wxDEPRECATED() but can be used to not only declare the function function as ...
Definition: defs.h:1688

Include file:

    #include <wx/defs.h>

## ◆ wxDEPRECATED_MSG

#define wxDEPRECATED_MSG | ( |  | msg | ) |

Generate deprecation warning with the given message when a function is used.

This macro can be used to generate a warning indicating that a function is deprecated (i.e. scheduled for removal in the future) and explaining why is it so and/or what should it be replaced with. It applies to the declaration following it, for example:

wxDEPRECATED_MSG("use safer overload returning wxString instead")
void wxGetSomething(char* buf, size_t len);
wxString wxGetSomething();
wxDEPRECATED_MSG
#define wxDEPRECATED_MSG(msg)
Generate deprecation warning with the given message when a function is used.
Definition: defs.h:1627

For compilers other than clang, g++ 4.5 or later and MSVC 8 (MSVS 2005) or later, the message is ignored and a generic deprecation warning is given if possible, i.e. if the compiler is g++ (any supported version) or MSVC 7 (MSVS 2003) or later.

Since
  3.0

Include file:

    #include <wx/defs.h>

## ◆ wxDIALOG_EX_CONTEXTHELP

#define wxDIALOG_EX_CONTEXTHELP wxWS_EX_CONTEXTHELP

## ◆ wxDIALOG_EX_METAL

#define wxDIALOG_EX_METAL 0x00000040

## ◆ wxDOUBLE_BORDER

#define wxDOUBLE_BORDER wxBORDER_DOUBLE

## ◆ wxFIXED_LENGTH

#define wxFIXED_LENGTH 0x0400

## ◆ wxFORWARD

#define wxFORWARD 0x00002000

## ◆ wxFRAME_DRAWER

#define wxFRAME_DRAWER 0x0020

## ◆ wxFRAME_EX_CONTEXTHELP

#define wxFRAME_EX_CONTEXTHELP wxWS_EX_CONTEXTHELP

## ◆ wxFRAME_EX_METAL

#define wxFRAME_EX_METAL 0x00000040

## ◆ wxFRAME_NO_WINDOW_MENU

#define wxFRAME_NO_WINDOW_MENU 0x0100

## ◆ wxFULL_REPAINT_ON_RESIZE

#define wxFULL_REPAINT_ON_RESIZE 0x00010000

## ◆ wxHELP

#define wxHELP 0x00001000

## ◆ wxHSCROLL

#define wxHSCROLL 0x40000000

## ◆ wxICON_ASTERISK

#define wxICON_ASTERISK wxICON_INFORMATION

## ◆ wxICON_AUTH_NEEDED

#define wxICON_AUTH_NEEDED 0x00080000

## ◆ wxICON_ERROR

#define wxICON_ERROR wxICON_HAND

## ◆ wxICON_EXCLAMATION

#define wxICON_EXCLAMATION 0x00000100

## ◆ wxICON_HAND

#define wxICON_HAND 0x00000200

## ◆ wxICON_INFORMATION

#define wxICON_INFORMATION 0x00000800

## ◆ wxICON_MASK

#define wxICON_MASK (wxICON_EXCLAMATION|wxICON_HAND|wxICON_QUESTION|wxICON_INFORMATION|wxICON_NONE)

## ◆ wxICON_NONE

#define wxICON_NONE 0x00040000

## ◆ wxICON_QUESTION

#define wxICON_QUESTION 0x00000400

## ◆ wxICON_STOP

#define wxICON_STOP wxICON_HAND

## ◆ wxICON_WARNING

#define wxICON_WARNING wxICON_EXCLAMATION

## ◆ wxICONIZE

#define wxICONIZE 0x4000

## ◆ wxINT16_MAX

#define wxINT16_MAX SHRT_MAX

## ◆ wxINT16_MIN

#define wxINT16_MIN SHRT_MIN

## ◆ wxINT16_SWAP_ALWAYS

#define wxINT16_SWAP_ALWAYS | ( |  | wxInt16_value | ) |

## ◆ wxINT16_SWAP_ON_BE

#define wxINT16_SWAP_ON_BE | ( |  | wxInt16_value | ) |

## ◆ wxINT16_SWAP_ON_LE

#define wxINT16_SWAP_ON_LE | ( |  | wxInt16_value | ) |

## ◆ wxINT32_MAX

#define wxINT32_MAX INT_MAX-or-LONG_MAX

## ◆ wxINT32_MIN

#define wxINT32_MIN INT_MIN-or-LONG_MIN

## ◆ wxINT32_SWAP_ALWAYS

#define wxINT32_SWAP_ALWAYS | ( |  | wxInt32_value | ) |

This macro will swap the bytes of the value variable from little endian to big endian or vice versa unconditionally, i.e.

independently of the current platform.

Include file:

    #include <wx/defs.h>

## ◆ wxINT32_SWAP_ON_BE

#define wxINT32_SWAP_ON_BE | ( |  | wxInt32_value | ) |

This macro will swap the bytes of the value variable from little endian to big endian or vice versa if the program is compiled on a big-endian architecture (such as Sun work stations).

If the program has been compiled on a little-endian architecture, the value will be unchanged.

Use these macros to read data from and write data to a file that stores data in little-endian (for example Intel i386) format.

Include file:

    #include <wx/defs.h>

## ◆ wxINT32_SWAP_ON_LE

#define wxINT32_SWAP_ON_LE | ( |  | wxInt32_value | ) |

This macro will swap the bytes of the value variable from little endian to big endian or vice versa if the program is compiled on a little-endian architecture (such as Intel PCs).

If the program has been compiled on a big-endian architecture, the value will be unchanged.

Use these macros to read data from and write data to a file that stores data in big-endian format.

Include file:

    #include <wx/defs.h>

## ◆ wxINT64_MAX

#define wxINT64_MAX LLONG_MAX

## ◆ wxINT64_MIN

#define wxINT64_MIN LLONG_MIN

## ◆ wxINT8_MAX

#define wxINT8_MAX CHAR_MAX

## ◆ wxINT8_MIN

#define wxINT8_MIN CHAR_MIN

C99-like sized MIN/MAX constants for all integer types.

For each `n` in the set 8, 16, 32, 64 we define `wxINTn_MIN`, `wxINTn_MAX` and `wxUINTc_MAX` (`wxUINTc_MIN` is always 0 and so is not defined).

## ◆ wxLB_ALWAYS_SB

#define wxLB_ALWAYS_SB 0x0200

## ◆ wxLB_EXTENDED

#define wxLB_EXTENDED 0x0080

## ◆ wxLB_HSCROLL

#define wxLB_HSCROLL wxHSCROLL

## ◆ wxLB_INT_HEIGHT

#define wxLB_INT_HEIGHT 0x0800

## ◆ wxLB_MULTIPLE

#define wxLB_MULTIPLE 0x0040

## ◆ wxLB_NEEDED_SB

#define wxLB_NEEDED_SB 0x0000

## ◆ wxLB_NO_SB

#define wxLB_NO_SB 0x0400

## ◆ wxLB_OWNERDRAW

#define wxLB_OWNERDRAW 0x0100

## ◆ wxLB_SINGLE

#define wxLB_SINGLE 0x0020

## ◆ wxLB_SORT

#define wxLB_SORT 0x0010

## ◆ wxLI_HORIZONTAL

#define wxLI_HORIZONTAL wxHORIZONTAL

## ◆ wxLI_VERTICAL

#define wxLI_VERTICAL wxVERTICAL

## ◆ wxMAXIMIZE

#define wxMAXIMIZE 0x2000

## ◆ wxMAXIMIZE_BOX

#define wxMAXIMIZE_BOX 0x0200

## ◆ wxMB_DOCKABLE

#define wxMB_DOCKABLE 0x0001

## ◆ wxMENU_TEAROFF

#define wxMENU_TEAROFF 0x0001

## ◆ wxMINIMIZE

#define wxMINIMIZE wxICONIZE

## ◆ wxMINIMIZE_BOX

#define wxMINIMIZE_BOX 0x0400

## ◆ wxMORE

#define wxMORE 0x00010000

## ◆ wxNO

#define wxNO 0x00000008

## ◆ wxNO_BORDER

#define wxNO_BORDER wxBORDER_NONE

## ◆ wxNO_DEFAULT

#define wxNO_DEFAULT 0x00000080 /* only valid with wxYES_NO */

## ◆ wxNO_FULL_REPAINT_ON_RESIZE

#define wxNO_FULL_REPAINT_ON_RESIZE 0

## ◆ wxNOT_FOUND

#define wxNOT_FOUND (-1)

## ◆ wxOK

#define wxOK 0x00000004

## ◆ wxOK_DEFAULT

#define wxOK_DEFAULT 0x00000000 /* has no effect (default) */

## ◆ wxOVERRIDE

#define wxOVERRIDE

`wxOVERRIDE` expands to the C++11 `override` keyword if it's supported by the compiler or nothing otherwise.

This macro is useful for writing code which may be compiled by both C++11 and non-C++11 compilers and still allow the use of `override` for the former.

Example of using this macro:

class MyApp : public wxApp {
public:
virtual bool OnInit() wxOVERRIDE;
// This would result in an error from a C++11 compiler as the
// method doesn't actually override the base class OnExit() due to
// a typo in its name.
//virtual int OnEzit() wxOVERRIDE;
};
wxAppConsole::OnInit
virtual bool OnInit()
This must be provided by the application, and will usually create the application's main window,...
wxApp
The wxApp class represents the application itself when wxUSE_GUI=1.
Definition: app.h:822
wxOVERRIDE
#define wxOVERRIDE
wxOVERRIDE expands to the C++11 override keyword if it's supported by the compiler or nothing otherwi...
Definition: defs.h:1749

Include file:

    #include <wx/defs.h>

Since
  3.1.0

## ◆ wxPOPUP_WINDOW

#define wxPOPUP_WINDOW 0x00020000

## ◆ wxPRINT_QUALITY_DRAFT

#define wxPRINT_QUALITY_DRAFT -4

## ◆ wxPRINT_QUALITY_HIGH

#define wxPRINT_QUALITY_HIGH -1

Predefined print quality constants.

See also
  wxPrintQuality

## ◆ wxPRINT_QUALITY_LOW

#define wxPRINT_QUALITY_LOW -3

## ◆ wxPRINT_QUALITY_MEDIUM

#define wxPRINT_QUALITY_MEDIUM -2

## ◆ wxRA_HORIZONTAL

#define wxRA_HORIZONTAL wxHORIZONTAL

## ◆ wxRA_LEFTTORIGHT

#define wxRA_LEFTTORIGHT 0x0001

## ◆ wxRA_SPECIFY_COLS

#define wxRA_SPECIFY_COLS wxHORIZONTAL

## ◆ wxRA_SPECIFY_ROWS

#define wxRA_SPECIFY_ROWS wxVERTICAL

## ◆ wxRA_TOPTOBOTTOM

#define wxRA_TOPTOBOTTOM 0x0002

## ◆ wxRA_VERTICAL

#define wxRA_VERTICAL wxVERTICAL

## ◆ wxRAISED_BORDER

#define wxRAISED_BORDER wxBORDER_RAISED

## ◆ wxRB_GROUP

#define wxRB_GROUP 0x0004

## ◆ wxRB_SINGLE

#define wxRB_SINGLE 0x0008

## ◆ wxRESET

#define wxRESET 0x00008000

## ◆ wxRESIZE_BORDER

#define wxRESIZE_BORDER 0x0040

## ◆ wxRETAINED

#define wxRETAINED 0x00000000

## ◆ wxSB_HORIZONTAL

#define wxSB_HORIZONTAL wxHORIZONTAL

## ◆ wxSB_VERTICAL

#define wxSB_VERTICAL wxVERTICAL

## ◆ wxSETUP

#define wxSETUP 0x00020000

## ◆ wxSIMPLE_BORDER

#define wxSIMPLE_BORDER wxBORDER_SIMPLE

## ◆ wxSIZE_ALLOW_MINUS_ONE

#define wxSIZE_ALLOW_MINUS_ONE 0x0004

## ◆ wxSIZE_AUTO

#define wxSIZE_AUTO (wxSIZE_AUTO_WIDTH|wxSIZE_AUTO_HEIGHT)

## ◆ wxSIZE_AUTO_HEIGHT

#define wxSIZE_AUTO_HEIGHT 0x0002

## ◆ wxSIZE_AUTO_WIDTH

#define wxSIZE_AUTO_WIDTH 0x0001

## ◆ wxSIZE_FORCE

#define wxSIZE_FORCE 0x0010

## ◆ wxSIZE_FORCE_EVENT

#define wxSIZE_FORCE_EVENT 0x0020

## ◆ wxSIZE_NO_ADJUSTMENTS

#define wxSIZE_NO_ADJUSTMENTS 0x0008

## ◆ wxSIZE_USE_EXISTING

#define wxSIZE_USE_EXISTING 0x0000

## ◆ wxSP_ARROW_KEYS

#define wxSP_ARROW_KEYS 0x4000

## ◆ wxSP_HORIZONTAL

#define wxSP_HORIZONTAL wxHORIZONTAL /* 4 */

## ◆ wxSP_VERTICAL

#define wxSP_VERTICAL wxVERTICAL /* 8 */

## ◆ wxSP_WRAP

#define wxSP_WRAP 0x8000

## ◆ wxSTATIC_BORDER

#define wxSTATIC_BORDER wxBORDER_STATIC

## ◆ wxSTAY_ON_TOP

#define wxSTAY_ON_TOP 0x8000

Top level window styles common to wxFrame and wxDialog.

## ◆ wxSUNKEN_BORDER

#define wxSUNKEN_BORDER wxBORDER_SUNKEN

## ◆ wxSUPPRESS_GCC_PRIVATE_DTOR_WARNING

#define wxSUPPRESS_GCC_PRIVATE_DTOR_WARNING | ( |  | name | ) |

GNU C++ compiler gives a warning for any class whose destructor is private unless it has a friend.

This warning may sometimes be useful but it doesn't make sense for reference counted class which always delete themselves (hence destructor should be private) but don't necessarily have any friends, so this macro is provided to disable the warning in such case. The name parameter should be the name of the class but is only used to construct a unique friend class name internally.

Example of using the macro:

class RefCounted
{
public:
RefCounted() { m_nRef = 1; }
void IncRef() { m_nRef++ ; }
void DecRef() { if ( !--m_nRef ) delete this; }
private:
~RefCounted() { }
wxSUPPRESS_GCC_PRIVATE_DTOR(RefCounted)
};

Notice that there should be no semicolon after this macro.

Include file:

    #include <wx/defs.h>

## ◆ wxSYSTEM_MENU

#define wxSYSTEM_MENU 0x0800

## ◆ wxTAB_TRAVERSAL

#define wxTAB_TRAVERSAL 0x00080000

## ◆ wxTC_BOTTOM

#define wxTC_BOTTOM 0x0080

## ◆ wxTC_FIXEDWIDTH

#define wxTC_FIXEDWIDTH 0x0020

## ◆ wxTC_LEFT

#define wxTC_LEFT 0x0020

## ◆ wxTC_MULTILINE

#define wxTC_MULTILINE 0x0200 /* == wxNB_MULTILINE */

## ◆ wxTC_OWNERDRAW

#define wxTC_OWNERDRAW 0x0400

## ◆ wxTC_RIGHT

#define wxTC_RIGHT 0x0040

## ◆ wxTC_RIGHTJUSTIFY

#define wxTC_RIGHTJUSTIFY 0x0010

## ◆ wxTC_TOP

#define wxTC_TOP 0x0000 /* default */

## ◆ wxTINY_CAPTION

#define wxTINY_CAPTION 0x0080

## ◆ wxTRANSPARENT_WINDOW

#define wxTRANSPARENT_WINDOW 0x00100000

## ◆ wxUINT16_MAX

#define wxUINT16_MAX USHRT_MAX

## ◆ wxUINT16_SWAP_ALWAYS

#define wxUINT16_SWAP_ALWAYS | ( |  | wxUint16_value | ) |

## ◆ wxUINT16_SWAP_ON_BE

#define wxUINT16_SWAP_ON_BE | ( |  | wxUint16_value | ) |

## ◆ wxUINT16_SWAP_ON_LE

#define wxUINT16_SWAP_ON_LE | ( |  | wxUint16_value | ) |

## ◆ wxUINT32_MAX

#define wxUINT32_MAX UINT_MAX-or-LONG_MAX

## ◆ wxUINT32_SWAP_ALWAYS

#define wxUINT32_SWAP_ALWAYS | ( |  | wxUint32_value | ) |

## ◆ wxUINT32_SWAP_ON_BE

#define wxUINT32_SWAP_ON_BE | ( |  | wxUint32_value | ) |

## ◆ wxUINT32_SWAP_ON_LE

#define wxUINT32_SWAP_ON_LE | ( |  | wxUint32_value | ) |

## ◆ wxUINT64_MAX

#define wxUINT64_MAX ULLONG_MAX

## ◆ wxUINT8_MAX

#define wxUINT8_MAX UCHAR_MAX

## ◆ wxVSCROLL

#define wxVSCROLL 0x80000000

## ◆ wxWANTS_CHARS

#define wxWANTS_CHARS 0x00040000

## ◆ wxWINDOW_STYLE_MASK

#define wxWINDOW_STYLE_MASK

Value:
(wxVSCROLL|wxHSCROLL|wxBORDER_MASK|wxALWAYS_SHOW_SB|wxCLIP_CHILDREN| \
wxCLIP_SIBLINGS|wxTRANSPARENT_WINDOW|wxTAB_TRAVERSAL|wxWANTS_CHARS| \
wxRETAINED|wxPOPUP_WINDOW|wxFULL_REPAINT_ON_RESIZE)
wxHSCROLL
#define wxHSCROLL
Definition: defs.h:217
wxFULL_REPAINT_ON_RESIZE
#define wxFULL_REPAINT_ON_RESIZE
Definition: defs.h:273
wxALWAYS_SHOW_SB
#define wxALWAYS_SHOW_SB
Definition: defs.h:233
wxPOPUP_WINDOW
#define wxPOPUP_WINDOW
Definition: defs.h:269
wxVSCROLL
#define wxVSCROLL
Definition: defs.h:216
wxTAB_TRAVERSAL
#define wxTAB_TRAVERSAL
Definition: defs.h:248
wxWANTS_CHARS
#define wxWANTS_CHARS
Definition: defs.h:252
wxCLIP_CHILDREN
#define wxCLIP_CHILDREN
Definition: defs.h:238
wxBORDER_MASK
@ wxBORDER_MASK
Definition: defs.h:143
wxTRANSPARENT_WINDOW
#define wxTRANSPARENT_WINDOW
Definition: defs.h:244

## ◆ wxWS_EX_BLOCK_EVENTS

#define wxWS_EX_BLOCK_EVENTS 0x00000002

## ◆ wxWS_EX_CONTEXTHELP

#define wxWS_EX_CONTEXTHELP 0x00000080

## ◆ wxWS_EX_PROCESS_IDLE

#define wxWS_EX_PROCESS_IDLE 0x00000010

## ◆ wxWS_EX_PROCESS_UI_UPDATES

#define wxWS_EX_PROCESS_UI_UPDATES 0x00000020

## ◆ wxWS_EX_THEMED_BACKGROUND

#define wxWS_EX_THEMED_BACKGROUND 0x00000008

## ◆ wxWS_EX_TRANSIENT

#define wxWS_EX_TRANSIENT 0x00000004

## ◆ wxYES

#define wxYES 0x00000002

## ◆ wxYES_DEFAULT

#define wxYES_DEFAULT 0x00000000 /* has no effect (default) */

## ◆ wxYES_NO

#define wxYES_NO (wxYES | wxNO)

## Typedef Documentation

## ◆ wxByte

typedef wxUint8 wxByte

## ◆ wxChar16

typedef wxUint16 wxChar16

## ◆ wxChar32

typedef wxUint32 wxChar32

## ◆ wxCoord

typedef int wxCoord

The type for screen and DC coordinates.

## ◆ wxDouble

typedef double wxDouble

Native fastest representation that has at least wxFloat64 precision, so use the IEEE types for storage, and this for calculations.

(The mapping is more complex than a simple `typedef` and is not shown here).

## ◆ wxDword

typedef wxUint32 wxDword

## ◆ wxFloat32

typedef float wxFloat32

32 bit IEEE float ( 1 sign, 8 exponent bits, 23 fraction bits ).

(The mapping is more complex than a simple `typedef` and is not shown here).

## ◆ wxFloat64

typedef double wxFloat64

64 bit IEEE float ( 1 sign, 11 exponent bits, 52 fraction bits ).

(The mapping is more complex than a simple `typedef` and is not shown here).

## ◆ wxInt16

typedef signed short wxInt16

16 bit type (the mapping is more complex than a simple `typedef` and is not shown here).

## ◆ wxInt32

typedef int wxInt32

32 bit type (the mapping is more complex than a simple `typedef` and is not shown here).

## ◆ wxInt64

typedef wxLongLong_t wxInt64

64 bit type (the mapping is more complex than a simple `typedef` and is not shown here).

## ◆ wxInt8

typedef signed char wxInt8

8 bit type (the mapping is more complex than a simple `typedef` and is not shown here).

## ◆ wxIntPtr

typedef ssize_t wxIntPtr

Signed and unsigned integral types big enough to contain all of `long`, `size_t` and `void*`.

(The mapping is more complex than a simple `typedef` and is not shown here).

## ◆ wxPrintQuality

typedef int wxPrintQuality

Specifies the print quality as either a predefined level or explicit resolution.

The print quality may be one of wxPRINT_QUALITY_HIGH, wxPRINT_QUALITY_MEDIUM, wxPRINT_QUALITY_LOW or wxPRINT_QUALITY_DRAFT (which are all negative) or express the desired resolution, in DPI, e.g. 600.

## ◆ wxUint16

typedef unsigned short wxUint16

## ◆ wxUint32

typedef unsigned int wxUint32

## ◆ wxUint64

typedef wxULongLong_t wxUint64

## ◆ wxUint8

typedef unsigned char wxUint8

## ◆ wxUIntPtr

typedef size_t wxUIntPtr

## ◆ wxWord

typedef wxUint16 wxWord

## Enumeration Type Documentation

## ◆ wxAlignment

enum wxAlignment

Generic alignment values.

Can be combined together.

Enumerator
wxALIGN_INVALID | A value different from any valid alignment value. Note that you shouldn't use 0 for this as it's the value of (valid) alignments wxALIGN_LEFT and wxALIGN_TOP. Since 2.9.1
wxALIGN_NOT |
wxALIGN_CENTER_HORIZONTAL |
wxALIGN_CENTRE_HORIZONTAL |
wxALIGN_LEFT |
wxALIGN_TOP |
wxALIGN_RIGHT |
wxALIGN_BOTTOM |
wxALIGN_CENTER_VERTICAL |
wxALIGN_CENTRE_VERTICAL |
wxALIGN_CENTER |
wxALIGN_CENTRE |
wxALIGN_MASK | A mask to extract alignment from the combination of flags.

## ◆ wxBackgroundStyle

enum wxBackgroundStyle

Background styles.

See also
  wxWindow::SetBackgroundStyle()

Enumerator
wxBG_STYLE_ERASE | Default background style value indicating that the background may be erased in the user-defined EVT_ERASE_BACKGROUND handler. If no such handler is defined (or if it skips the event), the effect of this style is the same as wxBG_STYLE_SYSTEM. If an empty handler (not skipping the event) is defined, the effect is the same as wxBG_STYLE_PAINT, i.e. the background is not erased at all until EVT_PAINT handler is executed. This is the only background style value for which erase background events are generated at all.
wxBG_STYLE_SYSTEM | Use the default background, as determined by the system or the current theme. If the window has been assigned a non-default background colour, it will be used for erasing its background. Otherwise the default background (which might be a gradient or a pattern) will be used. EVT_ERASE_BACKGROUND event will not be generated at all for windows with this style.
wxBG_STYLE_PAINT | Indicates that the background is only erased in the user-defined EVT_PAINT handler. Using this style avoids flicker which would result from redrawing the background twice if the EVT_PAINT handler entirely overwrites it. It must not be used however if the paint handler leaves any parts of the window unpainted as their contents is then undetermined. Only use it if you repaint the whole window in your handler. EVT_ERASE_BACKGROUND event will not be generated at all for windows with this style.
wxBG_STYLE_COLOUR |
wxBG_STYLE_TRANSPARENT | Indicates that the window background is not erased, letting the parent window show through. Currently this style is only supported in wxOSX and wxGTK with compositing available, see wxWindow::IsTransparentBackgroundSupported().

## ◆ wxBorder

enum wxBorder

Border flags for wxWindow.

Enumerator
wxBORDER_DEFAULT | This is different from wxBORDER_NONE as by default the controls do have a border.
wxBORDER_NONE |
wxBORDER_STATIC |
wxBORDER_SIMPLE |
wxBORDER_RAISED |
wxBORDER_SUNKEN |
wxBORDER_DOUBLE |
wxBORDER_THEME |
wxBORDER_MASK |

## ◆ wxDataFormatId

enum wxDataFormatId

Data format IDs used by wxDataFormat.

Enumerator
wxDF_INVALID |
wxDF_TEXT |
wxDF_BITMAP |
wxDF_METAFILE |
wxDF_SYLK |
wxDF_DIF |
wxDF_TIFF |
wxDF_OEMTEXT |
wxDF_DIB |
wxDF_PALETTE |
wxDF_PENDATA |
wxDF_RIFF |
wxDF_WAVE |
wxDF_UNICODETEXT |
wxDF_ENHMETAFILE |
wxDF_FILENAME |
wxDF_LOCALE |
wxDF_PRIVATE |
wxDF_HTML |
wxDF_PNG |
wxDF_MAX |

## ◆ wxDirection

enum wxDirection

A generic direction value.

Enumerator
wxLEFT |
wxRIGHT |
wxUP |
wxDOWN |
wxTOP |
wxBOTTOM |
wxNORTH |
wxSOUTH |
wxWEST |
wxEAST |
wxALL |
wxDIRECTION_MASK | A mask to extract direction from the combination of flags.

## ◆ wxDuplexMode

enum wxDuplexMode

Duplex printing modes.

Enumerator
wxDUPLEX_SIMPLEX | Non-duplex.
wxDUPLEX_HORIZONTAL |
wxDUPLEX_VERTICAL |

## ◆ wxGeometryCentre

enum wxGeometryCentre

Generic flags.

Enumerator
wxCENTRE |
wxCENTER |

## ◆ wxHitTest

enum wxHitTest

Generic hit test results.

Enumerator
wxHT_NOWHERE |
wxHT_SCROLLBAR_FIRST |
wxHT_SCROLLBAR_ARROW_LINE_1 | left or upper arrow to scroll by line
wxHT_SCROLLBAR_ARROW_LINE_2 | right or down
wxHT_SCROLLBAR_ARROW_PAGE_1 | left or upper arrow to scroll by page
wxHT_SCROLLBAR_ARROW_PAGE_2 | right or down
wxHT_SCROLLBAR_THUMB | on the thumb
wxHT_SCROLLBAR_BAR_1 | bar to the left/above the thumb
wxHT_SCROLLBAR_BAR_2 | bar to the right/below the thumb
wxHT_SCROLLBAR_LAST |
wxHT_WINDOW_OUTSIDE | not in this window at all
wxHT_WINDOW_INSIDE | in the client area
wxHT_WINDOW_VERT_SCROLLBAR | on the vertical scrollbar
wxHT_WINDOW_HORZ_SCROLLBAR | on the horizontal scrollbar
wxHT_WINDOW_CORNER | on the corner between 2 scrollbars
wxHT_MAX |

## ◆ wxItemKind

enum wxItemKind

Item kinds for use with wxMenu, wxMenuItem, and wxToolBar.

See also
  wxMenu::Append(), wxMenuItem::wxMenuItem(), wxToolBar::AddTool()

Enumerator
wxITEM_SEPARATOR |
wxITEM_NORMAL | Normal tool button / menu item. See also wxToolBar::AddTool(), wxMenu::AppendItem().
wxITEM_CHECK | Check (or toggle) tool button / menu item. See also wxToolBar::AddCheckTool(), wxMenu::AppendCheckItem().
wxITEM_RADIO | Radio tool button / menu item. See also wxToolBar::AddRadioTool(), wxMenu::AppendRadioItem().
wxITEM_DROPDOWN | Normal tool button with a dropdown arrow next to it. Clicking the dropdown arrow sends a `wxEVT_TOOL_DROPDOWN` event and may also display the menu previously associated with the item with wxToolBar::SetDropdownMenu(). Currently this type of tools is supported under MSW and GTK.
wxITEM_MAX |

## ◆ wxKeyCode

enum wxKeyCode

Virtual keycodes used by wxKeyEvent and some other wxWidgets functions.

Note that the range `0..255` corresponds to the characters of the current locale, in particular the `32..127` subrange is for the ASCII symbols, and all the special key values such as `WXK_END` lie above this range.

Enumerator
WXK_NONE | No key. This value is returned by wxKeyEvent::GetKeyCode() if there is no non-Unicode representation for the pressed key (e.g. a Cyrillic letter was entered when not using a Cyrillic locale) and by wxKeyEvent::GetUnicodeKey() if there is no Unicode representation for the key (this happens for the special, non printable, keys only, e.g. WXK_HOME). Since 2.9.2 (you can simply use 0 with previous versions).
WXK_CONTROL_A |
WXK_CONTROL_B |
WXK_CONTROL_C |
WXK_CONTROL_D |
WXK_CONTROL_E |
WXK_CONTROL_F |
WXK_CONTROL_G |
WXK_CONTROL_H |
WXK_CONTROL_I |
WXK_CONTROL_J |
WXK_CONTROL_K |
WXK_CONTROL_L |
WXK_CONTROL_M |
WXK_CONTROL_N |
WXK_CONTROL_O |
WXK_CONTROL_P |
WXK_CONTROL_Q |
WXK_CONTROL_R |
WXK_CONTROL_S |
WXK_CONTROL_T |
WXK_CONTROL_U |
WXK_CONTROL_V |
WXK_CONTROL_W |
WXK_CONTROL_X |
WXK_CONTROL_Y |
WXK_CONTROL_Z |
WXK_BACK | Backspace.
WXK_TAB |
WXK_RETURN |
WXK_ESCAPE |
WXK_SPACE |
WXK_DELETE |
WXK_START | Special key values. These are, by design, not compatible with Unicode characters. If you want to get a Unicode character from a key event, use wxKeyEvent::GetUnicodeKey() instead.
WXK_LBUTTON |
WXK_RBUTTON |
WXK_CANCEL |
WXK_MBUTTON |
WXK_CLEAR |
WXK_SHIFT |
WXK_ALT |
WXK_CONTROL | Note that under macOS, to improve compatibility with other systems, 'WXK_CONTROL' represents the 'Command' key. Use this constant to work with keyboard shortcuts. See 'WXK_RAW_CONTROL' to get the state of the actual 'Control' key.
WXK_RAW_CONTROL | Under macOS, where the 'Command' key is mapped to 'Control' to improve compatibility with other systems, WXK_RAW_CONTROL may be used to obtain the state of the actual 'Control' key ('WXK_CONTROL' would obtain the status of the 'Command' key). Under Windows/Linux/Others, this is equivalent to WXK_CONTROL
WXK_MENU |
WXK_PAUSE |
WXK_CAPITAL |
WXK_END |
WXK_HOME |
WXK_LEFT |
WXK_UP |
WXK_RIGHT |
WXK_DOWN |
WXK_SELECT |
WXK_PRINT |
WXK_EXECUTE |
WXK_SNAPSHOT |
WXK_INSERT |
WXK_HELP |
WXK_NUMPAD0 |
WXK_NUMPAD1 |
WXK_NUMPAD2 |
WXK_NUMPAD3 |
WXK_NUMPAD4 |
WXK_NUMPAD5 |
WXK_NUMPAD6 |
WXK_NUMPAD7 |
WXK_NUMPAD8 |
WXK_NUMPAD9 |
WXK_MULTIPLY |
WXK_ADD |
WXK_SEPARATOR |
WXK_SUBTRACT |
WXK_DECIMAL |
WXK_DIVIDE |
WXK_F1 |
WXK_F2 |
WXK_F3 |
WXK_F4 |
WXK_F5 |
WXK_F6 |
WXK_F7 |
WXK_F8 |
WXK_F9 |
WXK_F10 |
WXK_F11 |
WXK_F12 |
WXK_F13 |
WXK_F14 |
WXK_F15 |
WXK_F16 |
WXK_F17 |
WXK_F18 |
WXK_F19 |
WXK_F20 |
WXK_F21 |
WXK_F22 |
WXK_F23 |
WXK_F24 |
WXK_NUMLOCK |
WXK_SCROLL |
WXK_PAGEUP |
WXK_PAGEDOWN |
WXK_NUMPAD_SPACE |
WXK_NUMPAD_TAB |
WXK_NUMPAD_ENTER |
WXK_NUMPAD_F1 |
WXK_NUMPAD_F2 |
WXK_NUMPAD_F3 |
WXK_NUMPAD_F4 |
WXK_NUMPAD_HOME |
WXK_NUMPAD_LEFT |
WXK_NUMPAD_UP |
WXK_NUMPAD_RIGHT |
WXK_NUMPAD_DOWN |
WXK_NUMPAD_PAGEUP |
WXK_NUMPAD_PAGEDOWN |
WXK_NUMPAD_END |
WXK_NUMPAD_BEGIN |
WXK_NUMPAD_INSERT |
WXK_NUMPAD_DELETE |
WXK_NUMPAD_EQUAL |
WXK_NUMPAD_MULTIPLY |
WXK_NUMPAD_ADD |
WXK_NUMPAD_SEPARATOR |
WXK_NUMPAD_SUBTRACT |
WXK_NUMPAD_DECIMAL |
WXK_NUMPAD_DIVIDE |
WXK_WINDOWS_LEFT | The following key codes are only generated under Windows currently.
WXK_WINDOWS_RIGHT |
WXK_WINDOWS_MENU |
WXK_COMMAND | This special key code was used to represent the key used for keyboard shortcuts. Under macOS, this key maps to the 'Command' (aka logo or 'Apple') key, whereas on Linux/Windows/others this is the Control key, with the new semantic of WXK_CONTROL, WXK_COMMAND is not needed anymore
WXK_SPECIAL1 | Hardware-specific buttons.
WXK_SPECIAL2 |
WXK_SPECIAL3 |
WXK_SPECIAL4 |
WXK_SPECIAL5 |
WXK_SPECIAL6 |
WXK_SPECIAL7 |
WXK_SPECIAL8 |
WXK_SPECIAL9 |
WXK_SPECIAL10 |
WXK_SPECIAL11 |
WXK_SPECIAL12 |
WXK_SPECIAL13 |
WXK_SPECIAL14 |
WXK_SPECIAL15 |
WXK_SPECIAL16 |
WXK_SPECIAL17 |
WXK_SPECIAL18 |
WXK_SPECIAL19 |
WXK_SPECIAL20 |
WXK_BROWSER_BACK |
WXK_BROWSER_FORWARD |
WXK_BROWSER_REFRESH |
WXK_BROWSER_STOP |
WXK_BROWSER_SEARCH |
WXK_BROWSER_FAVORITES |
WXK_BROWSER_HOME |
WXK_VOLUME_MUTE |
WXK_VOLUME_DOWN |
WXK_VOLUME_UP |
WXK_MEDIA_NEXT_TRACK |
WXK_MEDIA_PREV_TRACK |
WXK_MEDIA_STOP |
WXK_MEDIA_PLAY_PAUSE |
WXK_LAUNCH_MAIL |
WXK_LAUNCH_APP1 |
WXK_LAUNCH_APP2 |

## ◆ wxKeyModifier

enum wxKeyModifier

This enum contains bit mask constants used in wxKeyEvent.

Enumerator
wxMOD_NONE |
wxMOD_ALT |
wxMOD_CONTROL | Ctlr Key, corresponds to Command key on macOS.
wxMOD_ALTGR |
wxMOD_SHIFT |
wxMOD_META |
wxMOD_WIN |
wxMOD_RAW_CONTROL | used to describe the true Ctrl Key under macOS, identic to `wxMOD_CONTROL` on other platforms
wxMOD_CMD | deprecated, identic to `wxMOD_CONTROL` on all platforms
wxMOD_ALL |

## ◆ wxOrientation

enum wxOrientation

A generic orientation value.

Enumerator
wxHORIZONTAL |
wxVERTICAL |
wxBOTH | A mask value to indicate both vertical and horizontal orientations.
wxORIENTATION_MASK | A synonym for `wxBOTH`.

## ◆ wxPaperSize

enum wxPaperSize

Paper size types for use with the printing framework.

See also
  overview_printing, wxPrintData::SetPaperId()

Enumerator
wxPAPER_10X11 | 10 x 11 in
wxPAPER_10X14 | 10-by-14-inch sheet
wxPAPER_11X17 | 11-by-17-inch sheet
wxPAPER_12X11 | 12 x 11 in
wxPAPER_15X11 | 15 x 11 in
wxPAPER_9X11 | 9 x 11 in
wxPAPER_A2 | A2 420 x 594 mm.
wxPAPER_A3 | A3 sheet, 297 by 420 millimeters.
wxPAPER_A3_EXTRA | A3 Extra 322 x 445 mm.
wxPAPER_A3_EXTRA_TRANSVERSE | A3 Extra Transverse 322 x 445 mm.
wxPAPER_A3_ROTATED | A3 Rotated 420 x 297 mm.
wxPAPER_A3_TRANSVERSE | A3 Transverse 297 x 420 mm.
wxPAPER_A4 | A4 Sheet, 210 by 297 millimeters.
wxPAPER_A4SMALL | A4 small sheet, 210 by 297 millimeters.
wxPAPER_A4_EXTRA | A4 Extra 9.27 x 12.69 in.
wxPAPER_A4_PLUS | A4 Plus 210 x 330 mm.
wxPAPER_A4_ROTATED | A4 Rotated 297 x 210 mm.
wxPAPER_A4_TRANSVERSE | A4 Transverse 210 x 297 mm.
wxPAPER_A5 | A5 sheet, 148 by 210 millimeters.
wxPAPER_A5_EXTRA | A5 Extra 174 x 235 mm.
wxPAPER_A5_ROTATED | A5 Rotated 210 x 148 mm.
wxPAPER_A5_TRANSVERSE | A5 Transverse 148 x 210 mm.
wxPAPER_A6 | A6 105 x 148 mm.
wxPAPER_A6_ROTATED | A6 Rotated 148 x 105 mm.
wxPAPER_A_PLUS | SuperA/SuperA/A4 227 x 356 mm.
wxPAPER_B4 | B4 sheet, 250 by 354 millimeters.
wxPAPER_B4_JIS_ROTATED | B4 (JIS) Rotated 364 x 257 mm.
wxPAPER_B5 | B5 sheet, 182-by-257-millimeter paper.
wxPAPER_B5_EXTRA | B5 (ISO) Extra 201 x 276 mm.
wxPAPER_B5_JIS_ROTATED | B5 (JIS) Rotated 257 x 182 mm.
wxPAPER_B5_TRANSVERSE | B5 (JIS) Transverse 182 x 257 mm.
wxPAPER_B6_JIS | B6 (JIS) 128 x 182 mm.
wxPAPER_B6_JIS_ROTATED | B6 (JIS) Rotated 182 x 128 mm.
wxPAPER_B_PLUS | SuperB/SuperB/A3 305 x 487 mm.
wxPAPER_CSHEET | C Sheet, 17 by 22 inches.
wxPAPER_DBL_JAPANESE_POSTCARD | Japanese Double Postcard 200 x 148 mm.
wxPAPER_DBL_JAPANESE_POSTCARD_ROTATED | Double Japanese Postcard Rotated 148 x 200 mm.
wxPAPER_DSHEET | D Sheet, 22 by 34 inches.
wxPAPER_ENV_10 | #10 Envelope, 4 1/8 by 9 1/2 inches
wxPAPER_ENV_11 | #11 Envelope, 4 1/2 by 10 3/8 inches
wxPAPER_ENV_12 | #12 Envelope, 4 3/4 by 11 inches
wxPAPER_ENV_14 | #14 Envelope, 5 by 11 1/2 inches
wxPAPER_ENV_9 | #9 Envelope, 3 7/8 by 8 7/8 inches
wxPAPER_ENV_B4 | B4 Envelope, 250 by 353 millimeters.
wxPAPER_ENV_B5 | B5 Envelope, 176 by 250 millimeters.
wxPAPER_ENV_B6 | B6 Envelope, 176 by 125 millimeters.
wxPAPER_ENV_C3 | C3 Envelope, 324 by 458 millimeters.
wxPAPER_ENV_C4 | C4 Envelope, 229 by 324 millimeters.
wxPAPER_ENV_C5 | C5 Envelope, 162 by 229 millimeters.
wxPAPER_ENV_C6 | C6 Envelope, 114 by 162 millimeters.
wxPAPER_ENV_C65 | C65 Envelope, 114 by 229 millimeters.
wxPAPER_ENV_DL | DL Envelope, 110 by 220 millimeters.
wxPAPER_ENV_INVITE | Envelope Invite 220 x 220 mm.
wxPAPER_ENV_ITALY | Italy Envelope, 110 by 230 millimeters.
wxPAPER_ENV_MONARCH | Monarch Envelope, 3 7/8 by 7 1/2 inches.
wxPAPER_ENV_PERSONAL | 6 3/4 Envelope, 3 5/8 by 6 1/2 inches
wxPAPER_ESHEET | E Sheet, 34 by 44 inches.
wxPAPER_EXECUTIVE | Executive, 7 1/4 by 10 1/2 inches.
wxPAPER_FANFOLD_LGL_GERMAN | German Legal Fanfold, 8 1/2 by 13 inches.
wxPAPER_FANFOLD_STD_GERMAN | German Std Fanfold, 8 1/2 by 12 inches.
wxPAPER_FANFOLD_US | US Std Fanfold, 14 7/8 by 11 inches.
wxPAPER_FOLIO | Folio, 8-1/2-by-13-inch paper.
wxPAPER_ISO_B4 | B4 (ISO) 250 x 353 mm.
wxPAPER_JAPANESE_POSTCARD | Japanese Postcard 100 x 148 mm.
wxPAPER_JAPANESE_POSTCARD_ROTATED | Japanese Postcard Rotated 148 x 100 mm.
wxPAPER_JENV_CHOU3 | Japanese Envelope Chou #3.
wxPAPER_JENV_CHOU3_ROTATED | Japanese Envelope Chou #3 Rotated.
wxPAPER_JENV_CHOU4 | Japanese Envelope Chou #4.
wxPAPER_JENV_CHOU4_ROTATED | Japanese Envelope Chou #4 Rotated.
wxPAPER_JENV_KAKU2 | Japanese Envelope Kaku #2.
wxPAPER_JENV_KAKU2_ROTATED | Japanese Envelope Kaku #2 Rotated.
wxPAPER_JENV_KAKU3 | Japanese Envelope Kaku #3.
wxPAPER_JENV_KAKU3_ROTATED | Japanese Envelope Kaku #3 Rotated.
wxPAPER_JENV_YOU4 | Japanese Envelope You #4.
wxPAPER_JENV_YOU4_ROTATED | Japanese Envelope You #4 Rotated.
wxPAPER_LEDGER | Ledger, 17 by 11 inches.
wxPAPER_LEGAL | Legal, 8 1/2 by 14 inches.
wxPAPER_LEGAL_EXTRA | Legal Extra 9.5 x 15 in.
wxPAPER_LETTER | Letter, 8 1/2 by 11 inches.
wxPAPER_LETTERSMALL | Letter Small, 8 1/2 by 11 inches.
wxPAPER_LETTER_EXTRA | Letter Extra 9.5 x 12 in.
wxPAPER_LETTER_EXTRA_TRANSVERSE | Letter Extra Transverse 9.5 x 12 in.
wxPAPER_LETTER_PLUS | Letter Plus 8.5 x 12.69 in.
wxPAPER_LETTER_ROTATED | Letter Rotated 11 x 8 1/2 in.
wxPAPER_LETTER_TRANSVERSE | Letter Transverse 8.5 x 11 in.
wxPAPER_NONE | Use specific dimensions.
wxPAPER_NOTE | Note, 8 1/2 by 11 inches.
wxPAPER_P16K | PRC 16K 146 x 215 mm.
wxPAPER_P16K_ROTATED | PRC 16K Rotated.
wxPAPER_P32K | PRC 32K 97 x 151 mm.
wxPAPER_P32KBIG | PRC 32K(Big) 97 x 151 mm.
wxPAPER_P32KBIG_ROTATED | PRC 32K(Big) Rotated.
wxPAPER_P32K_ROTATED | PRC 32K Rotated.
wxPAPER_PENV_1 | PRC Envelope #1 102 x 165 mm.
wxPAPER_PENV_10 | PRC Envelope #10 324 x 458 mm.
wxPAPER_PENV_10_ROTATED | PRC Envelope #10 Rotated 458 x 324 m.
wxPAPER_PENV_1_ROTATED | PRC Envelope #1 Rotated 165 x 102 mm.
wxPAPER_PENV_2 | PRC Envelope #2 102 x 176 mm.
wxPAPER_PENV_2_ROTATED | PRC Envelope #2 Rotated 176 x 102 mm.
wxPAPER_PENV_3 | PRC Envelope #3 125 x 176 mm.
wxPAPER_PENV_3_ROTATED | PRC Envelope #3 Rotated 176 x 125 mm.
wxPAPER_PENV_4 | PRC Envelope #4 110 x 208 mm.
wxPAPER_PENV_4_ROTATED | PRC Envelope #4 Rotated 208 x 110 mm.
wxPAPER_PENV_5 | PRC Envelope #5 110 x 220 mm.
wxPAPER_PENV_5_ROTATED | PRC Envelope #5 Rotated 220 x 110 mm.
wxPAPER_PENV_6 | PRC Envelope #6 120 x 230 mm.
wxPAPER_PENV_6_ROTATED | PRC Envelope #6 Rotated 230 x 120 mm.
wxPAPER_PENV_7 | PRC Envelope #7 160 x 230 mm.
wxPAPER_PENV_7_ROTATED | PRC Envelope #7 Rotated 230 x 160 mm.
wxPAPER_PENV_8 | PRC Envelope #8 120 x 309 mm.
wxPAPER_PENV_8_ROTATED | PRC Envelope #8 Rotated 309 x 120 mm.
wxPAPER_PENV_9 | PRC Envelope #9 229 x 324 mm.
wxPAPER_PENV_9_ROTATED | PRC Envelope #9 Rotated 324 x 229 mm.
wxPAPER_QUARTO | Quarto, 215-by-275-millimeter paper.
wxPAPER_STATEMENT | Statement, 5 1/2 by 8 1/2 inches.
wxPAPER_TABLOID | Tabloid, 11 by 17 inches.
wxPAPER_TABLOID_EXTRA | Tabloid Extra 11.69 x 18 in.

## ◆ wxPrintMode

enum wxPrintMode

Print mode (currently PostScript only).

Enumerator
wxPRINT_MODE_NONE |
wxPRINT_MODE_PREVIEW | Preview in external application.
wxPRINT_MODE_FILE | Print to file.
wxPRINT_MODE_PRINTER | Send to printer.
wxPRINT_MODE_STREAM | Send postscript data into a stream.

## ◆ wxPrintOrientation

enum wxPrintOrientation

Printing orientation.

Enumerator
wxPORTRAIT |
wxLANDSCAPE |

## ◆ wxSizerFlagBits

enum wxSizerFlagBits

Miscellaneous flags for wxSizer items.

Enumerator
wxFIXED_MINSIZE |
wxRESERVE_SPACE_EVEN_IF_HIDDEN |
wxSIZER_FLAG_BITS_MASK |

## ◆ wxStandardID

enum wxStandardID

Standard IDs.

Notice that some, but not all, of these IDs are also stock IDs, i.e. you can use them for the button or menu items without specifying the label which will be provided by the underlying platform itself. See the list of stock items for the subset of standard IDs which are stock IDs as well.

Enumerator
wxID_AUTO_LOWEST | This id delimits the lower bound of the range used by automatically-generated ids (i.e. those used when wxID_ANY is specified during construction). It is defined as a relatively large negative number and its exact value is platform-dependent.
wxID_AUTO_HIGHEST | This id delimits the upper bound of the range used by automatically-generated ids (i.e. those used when wxID_ANY is specified during construction). It is defined as a relatively small negative number and its exact value is platform-dependent.
wxID_NONE | No id matches this one when compared to it.
wxID_SEPARATOR | Id for a separator line in the menu (invalid for normal item).
wxID_ANY | Any id: means that we don't care about the id, whether when installing an event handler or when creating a new window.
wxID_LOWEST | Start of the range reserved for wxWidgets-defined IDs. Don't define custom IDs in the range from wxID_LOWEST to wxID_HIGHEST.
wxID_OPEN |
wxID_CLOSE |
wxID_NEW |
wxID_SAVE |
wxID_SAVEAS |
wxID_REVERT |
wxID_EXIT |
wxID_UNDO |
wxID_REDO |
wxID_HELP |
wxID_PRINT |
wxID_PRINT_SETUP |
wxID_PAGE_SETUP |
wxID_PREVIEW |
wxID_ABOUT |
wxID_HELP_CONTENTS |
wxID_HELP_INDEX |
wxID_HELP_SEARCH |
wxID_HELP_COMMANDS |
wxID_HELP_PROCEDURES |
wxID_HELP_CONTEXT |
wxID_CLOSE_ALL |
wxID_PREFERENCES |
wxID_EDIT |
wxID_CUT |
wxID_COPY |
wxID_PASTE |
wxID_CLEAR |
wxID_FIND |
wxID_DUPLICATE |
wxID_SELECTALL |
wxID_DELETE |
wxID_REPLACE |
wxID_REPLACE_ALL |
wxID_PROPERTIES |
wxID_VIEW_DETAILS |
wxID_VIEW_LARGEICONS |
wxID_VIEW_SMALLICONS |
wxID_VIEW_LIST |
wxID_VIEW_SORTDATE |
wxID_VIEW_SORTNAME |
wxID_VIEW_SORTSIZE |
wxID_VIEW_SORTTYPE |
wxID_FILE |
wxID_FILE1 |
wxID_FILE2 |
wxID_FILE3 |
wxID_FILE4 |
wxID_FILE5 |
wxID_FILE6 |
wxID_FILE7 |
wxID_FILE8 |
wxID_FILE9 |
wxID_OK | Standard button and menu IDs.
wxID_CANCEL |
wxID_APPLY |
wxID_YES |
wxID_NO |
wxID_STATIC |
wxID_FORWARD |
wxID_BACKWARD |
wxID_DEFAULT |
wxID_MORE |
wxID_SETUP |
wxID_RESET |
wxID_CONTEXT_HELP |
wxID_YESTOALL |
wxID_NOTOALL |
wxID_ABORT |
wxID_RETRY |
wxID_IGNORE |
wxID_ADD |
wxID_REMOVE |
wxID_UP |
wxID_DOWN |
wxID_HOME |
wxID_REFRESH |
wxID_STOP |
wxID_INDEX |
wxID_BOLD |
wxID_ITALIC |
wxID_JUSTIFY_CENTER |
wxID_JUSTIFY_FILL |
wxID_JUSTIFY_RIGHT |
wxID_JUSTIFY_LEFT |
wxID_UNDERLINE |
wxID_INDENT |
wxID_UNINDENT |
wxID_ZOOM_100 |
wxID_ZOOM_FIT |
wxID_ZOOM_IN |
wxID_ZOOM_OUT |
wxID_UNDELETE |
wxID_REVERT_TO_SAVED |
wxID_CDROM |
wxID_CONVERT |
wxID_EXECUTE |
wxID_FLOPPY |
wxID_HARDDISK |
wxID_BOTTOM |
wxID_FIRST |
wxID_LAST |
wxID_TOP |
wxID_INFO |
wxID_JUMP_TO |
wxID_NETWORK |
wxID_SELECT_COLOR |
wxID_SELECT_FONT |
wxID_SORT_ASCENDING |
wxID_SORT_DESCENDING |
wxID_SPELL_CHECK |
wxID_STRIKETHROUGH |
wxID_SYSTEM_MENU | System menu IDs (used by wxUniv):
wxID_CLOSE_FRAME |
wxID_MOVE_FRAME |
wxID_RESIZE_FRAME |
wxID_MAXIMIZE_FRAME |
wxID_ICONIZE_FRAME |
wxID_RESTORE_FRAME |
wxID_MDI_WINDOW_FIRST | MDI window menu ids.
wxID_MDI_WINDOW_CASCADE |
wxID_MDI_WINDOW_TILE_HORZ |
wxID_MDI_WINDOW_TILE_VERT |
wxID_MDI_WINDOW_ARRANGE_ICONS |
wxID_MDI_WINDOW_PREV |
wxID_MDI_WINDOW_NEXT |
wxID_MDI_WINDOW_LAST |
wxID_FILEDLGG | IDs used by generic file dialog (13 consecutive starting from this value)
wxID_FILECTRL | IDs used by generic file ctrl (4 consecutive starting from this value)
wxID_HIGHEST | End of the range reserved for wxWidgets-defined IDs. Don't define custom IDs in the range from wxID_LOWEST to wxID_HIGHEST. When using an enum to define a number of custom IDs, assigning the value of `wxID_HIGHEST+1` to the first element ensures that none of the enum elements will conflict with any standard IDs.

## ◆ wxStretch

enum wxStretch

Generic stretch values.

Enumerator
wxSTRETCH_NOT |
wxSHRINK |
wxGROW |
wxEXPAND |
wxSHAPED |
wxTILE |
wxSTRETCH_MASK |

## ◆ wxUpdateUI

enum wxUpdateUI

Flags which can be used in wxWindow::UpdateWindowUI().

Enumerator
wxUPDATE_UI_NONE |
wxUPDATE_UI_RECURSE |
wxUPDATE_UI_FROMIDLE | Invoked from On(Internal)Idle.

## Function Documentation

## ◆ wxDELETE()

template<typename T >

void wxDELETE | ( | T *& | ptr | ) |

A function which deletes and nulls the pointer.

This function uses operator delete to free the pointer and also sets it to NULL. Notice that this does not work for arrays, use wxDELETEA() for them.

MyClass *ptr = new MyClass;
...
wxDELETE(ptr);
wxASSERT(!ptr);
wxASSERT
#define wxASSERT(condition)
Assert macro.
Definition: debug.h:79

Include file:

    #include <wx/defs.h>

## ◆ wxDELETEA()

template<typename T >

void wxDELETEA | ( | T *& | array | ) |

A function which deletes and nulls the pointer.

This function uses vector operator delete (`delete`[]) to free the array pointer and also sets it to NULL. Notice that this does not work for non-array pointers, use wxDELETE() for them.

MyClass *array = new MyClass[17];
...
wxDELETEA(array);
wxASSERT(!array);

See also
  wxDELETE()

Include file:

    #include <wx/defs.h>

## ◆ wxSwap()

template<typename T >

void wxSwap | ( | T & | first,
|  | T & | second
| ) |  |

Swaps the contents of two variables.

This is similar to std::swap() but can be used even on the platforms where the standard C++ library is not available (if you don't target such platforms, please use std::swap() instead).

The function relies on type T being copy constructible and assignable.

Example of use:

int x = 3,
y = 4;
wxSwap(x, y);
wxASSERT( x == 4 && y == 3 );
wxSwap
void wxSwap(T &first, T &second)
Swaps the contents of two variables.

## ◆ wxVaCopy()

void wxVaCopy | ( | va_list | argptrDst,
|  | va_list | argptrSrc
| ) |  |

This macro is the same as the standard C99 `va_copy` for the compilers which support it or its replacement for those that don't.

It must be used to preserve the value of a `va_list` object if you need to use it after passing it to another function because it can be modified by the latter.

As with `va_start`, each call to `wxVaCopy` must have a matching `va_end`.

Include file:

    #include <wx/defs.h>

## Variable Documentation

## ◆ wxDefaultCoord

wxCoord wxDefaultCoord = -1

A special value meaning "use default coordinate".