Version: 3.2.8
Loading...
Searching...
No Matches
wxUSE Preprocessor Symbols

This section documents the wxUSE preprocessor symbols used in the wxWidgets source, grouped by category (and sorted by alphabetical order inside each category). These symbols are always defined and whether the given feature is active or not depends on their value: if defined as 1, feature is active, otherwise it is disabled. Because of this these symbols should always be tested using #if and not #ifdef.

Most Important Symbols

This table summarizes some of the global build features affecting the entire library:

wxUSE_STLContainer classes and wxString are implemented using standard classes and provide the same standard API.
wxUSE_STD_STRINGwxString is implemented using std::[w]string and can be constructed from it (but provides wxWidgets-compatible API, in particular is implicitly convertible to char* and not std::[w]string).
wxUSE_STD_IOSTREAMStandard C++ classes are used instead of or in addition to wx stream classes.
wxUSE_UNICODECompiled with Unicode support (default in wxWidgets 3.0, non-Unicode build is deprecated and will be removed in the future).
wxUSE_UNICODE_WCHARwxString uses wchar_t buffer for internal storage (default).
wxUSE_UNICODE_UTF8wxString uses UTF-8 for internal storage (mostly useful for wxGTK where UTF-8 is used by the underlying toolkit).
wxUSE_UTF8_LOCALE_ONLYLibrary supports running only under UTF-8 (and C) locale. This eliminates the code necessary for conversions from the other locales and reduces the library size; useful for embedded systems.
wxUSE_GUIUse the GUI classes; if set to 0 only non-GUI classes are available.
wxUSE_UNSAFE_WXSTRING_CONVDefined as 1 by default for compatibility, but can be set to 0 to globally disable unsafe implicit conversions in wxString class. See wxString Related Compilation Settings for more details.

Generic Symbols

wxUSE_ABOUTDLGUse wxAboutDialogInfo class.
wxUSE_ACCELUse wxAcceleratorTable/Entry classes and support for them in wxMenu, wxMenuBar.
wxUSE_AFM_FOR_POSTSCRIPTIn wxPostScriptDC class use AFM (adobe font metrics) file for character widths.
wxUSE_ACTIVITYINDICATORUse wxActivityIndicator class.
wxUSE_ANIMATIONCTRLUse wxAnimationCtrl class.
wxUSE_ARTPROVIDER_STDUse standard low quality icons in wxArtProvider.
wxUSE_ARTPROVIDER_TANGOUse Tango icons in wxArtProvider.
wxUSE_ANYUse wxAny class.
wxUSE_APPLE_IEEEIEEE Extended to/from double routines, see wxDataOutputStream.
wxUSE_ARCHIVE_STREAMSEnable streams for archive formats.
wxUSE_AUIUse AUI (dockable windows) library.
wxUSE_BASE64Enables Base64 support.
wxUSE_BITMAPCOMBOBOXUse wxBitmapComboBox class.
wxUSE_BMPBUTTONUse wxBitmapButton class.
wxUSE_BUSYINFOUse wxBusyInfo class.
wxUSE_BUTTONUse wxButton class.
wxUSE_CALENDARCTRLUse wxCalendarCtrl class.
wxUSE_CARETUse wxCaret class.
wxUSE_CHECKBOXUse wxCheckBox class.
wxUSE_CHECKLISTBOXUse wxCheckListBox class.
wxUSE_CHOICEUse wxChoice class.
wxUSE_CHOICEBOOKUse wxChoicebook class.
wxUSE_CHOICEDLGUse wxSingleChoiceDialog, or wxMultiChoiceDialog classes.
wxUSE_CLIPBOARDUse wxClipboard class.
wxUSE_CMDLINE_PARSERUse wxCmdLineParser class.
wxUSE_COLLPANEUse wxCollapsiblePane class.
wxUSE_COLOURDLGUse wxColourDialog class.
wxUSE_COLOURPICKERCTRLUse wxColourPickerCtrl class.
wxUSE_COMBOBOXUse wxComboBox class.
wxUSE_COMBOCTRLUse wxComboCtrl class.
wxUSE_COMPILER_TLSCan be set to 0 to prevent using compile thread-specific variables support.
wxUSE_CONFIGUse wxConfig and related classes.
wxUSE_CONFIG_NATIVEWhen enabled use native OS configuration instead of the wxFileConfig class.
wxUSE_CONSOLE_EVENTLOOPEnable event loop in console programs.
wxUSE_CONSTRAINTSUse wxLayoutConstraints
wxUSE_CONTROLSIf set to 0, no classes deriving from wxControl can be used.
wxUSE_CREDENTIALDLGIf set to 0, disabled wxCredentialEntryDialog used by wxWebRequest.
wxUSE_DATAOBJUse wxDataObject and related classes.
wxUSE_DATAVIEWCTRLUse wxDataViewCtrl class.
wxUSE_DATEPICKCTRLUse wxDatePickerCtrl class.
wxUSE_DATETIMEUse wxDateTime and related classes.
wxUSE_DBGHELPPredefine as 0 to avoid using wxDbgHelpDLL and related classes.
wxUSE_DC_TRANSFORM_MATRIXUse wxDC::SetTransformMatrix() and related methods.
wxUSE_DEBUG_CONTEXTUse wxDebugContext class.
wxUSE_DEBUG_NEW_ALWAYSSee Debugging
wxUSE_DEBUGREPORTUse wxDebugReport class.
wxUSE_DIALUP_MANAGERUse wxDialUpManager and related classes.
wxUSE_DIRDLGUse wxDirDialog class.
wxUSE_DIRPICKERCTRLUse wxDirPickerCtrl class.
wxUSE_DISPLAYUse wxDisplay and related classes.
wxUSE_DOC_VIEW_ARCHITECTUREUse wxDocument and related classes.
wxUSE_DRAG_AND_DROPUse Drag and drop classes.
wxUSE_DRAGIMAGEUse wxDragImage class.
wxUSE_DYNAMIC_LOADERUse wxPluginManager and related classes. Requires wxDynamicLibrary
wxUSE_DYNLIB_CLASSUse wxDynamicLibrary
wxUSE_EDITABLELISTBOXUse wxEditableListBox class.
wxUSE_EXCEPTIONSUse exception handling.
wxUSE_EXPATenable XML support using expat parser.
wxUSE_EXTENDED_RTTIUse extended RTTI, see also Runtime class information (RTTI)
wxUSE_FFILEUse wxFFile class.
wxUSE_FILEUse wxFile class.
wxUSE_FILECONFIGUse wxFileConfig class.
wxUSE_FILECTRLUse wxFileCtrl class.
wxUSE_FILEDLGUse wxFileDialog class.
wxUSE_FILEPICKERCTRLUse wxFilePickerCtrl class.
wxUSE_FILESYSTEMUse wxFileSystem and related classes.
wxUSE_FINDREPLDLGUse wxFindReplaceDialog class.
wxUSE_FONTDLGUse wxFontDialog class.
wxUSE_FONTENUMUse wxFontEnumerator class.
wxUSE_FONTMAPUse wxFontMapper class.
wxUSE_FONTPICKERCTRLUse wxFontPickerCtrl class.
wxUSE_FS_ARCHIVEUse virtual archive filesystems like wxArchiveFSHandler in wxFileSystem class.
wxUSE_FS_INETUse virtual HTTP/FTP filesystems like wxInternetFSHandler in wxFileSystem class.
wxUSE_FS_ZIPPlease use wxUSE_FS_ARCHIVE instead.
wxUSE_FSVOLUMEUse wxFSVolume class.
wxUSE_GAUGEUse wxGauge class.
wxUSE_GENERIC_DRAGIMAGEUsed in wxDragImage sample.
wxUSE_GENERIC_DRAWELLIPSESee comment in wx/dc.h file.
wxUSE_GENERIC_MDI_AS_NATIVEThis is not a user-settable symbol, it is only used internally in wx/generic/mdig.h.
wxUSE_GEOMETRYUse common geometry classes
wxUSE_GIFUse GIF wxImageHandler
wxUSE_GLCANVASEnables OpenGL support.
wxUSE_GLOBAL_MEMORY_OPERATORSOverride global operators new and delete to use wxWidgets memory leak detection
wxUSE_GRAPHICS_CONTEXTUse wxGraphicsContext and related classes.
wxUSE_GRIDUse wxGrid and related classes.
wxUSE_HELPUse wxHelpController and related classes.
wxUSE_HTMLUse wxHtmlWindow and related classes.
wxUSE_HYPERLINKCTRLUse wxHyperlinkCtrl
wxUSE_ICO_CURSupport Windows ICO and CUR formats.
wxUSE_IFFEnables the wxImage handler for Amiga IFF images.
wxUSE_IMAGEUse wxImage and related classes.
wxUSE_IMAGLISTUse wxImageList class.
wxUSE_INTLUse wxLocale and related classes.
wxUSE_IPCUse interprocess communication classes.
wxUSE_IPV6Use experimental wxIPV6address and related classes.
wxUSE_JOYSTICKUse wxJoystick class.
wxUSE_LIBJPEGEnables JPEG format support (requires libjpeg).
wxUSE_LIBLZMAEnables LZMA compression support (see Using LZMA compression with liblzma).
wxUSE_LIBPNGEnables PNG format support (requires libpng). Also requires wxUSE_ZLIB.
wxUSE_LIBTIFFEnables TIFF format support (requires libtiff).
wxUSE_LISTBOOKUse wxListbook class.
wxUSE_LISTBOXUse wxListBox class.
wxUSE_LISTCTRLUse wxListCtrl class.
wxUSE_LOGUse wxLog and related classes.
wxUSE_LOG_DEBUGEnabled when wxLog used with __WXDEBUG__ defined.
wxUSE_LOG_DIALOGUse wxLogDialog class.
wxUSE_LOGGUIUse wxLogGui class.
wxUSE_LOGWINDOWUse wxLogFrame class.
wxUSE_LONGLONGUse wxLongLong class.
wxUSE_LONGLONG_NATIVEUse native long long type in wxLongLong implementation.
wxUSE_LONGLONG_WXUse generic wxLongLong implementation.
wxUSE_MARKUPProvide wxControl::SetLabelMarkup() method.
wxUSE_MDIUse wxMDIParentFrame, and wxMDIChildFrame
wxUSE_MDI_ARCHITECTUREUse MDI-based document-view classes.
wxUSE_MEDIACTRLUse wxMediaCtrl.
wxUSE_MEMORY_TRACINGUse wxWidgets memory leak detection, not recommended if using another memory debugging tool.
wxUSE_MENUSUse wxMenu and wxMenuItem.
wxUSE_MENUBARUse wxMenubar.
wxUSE_METAFILEUse wxMetaFile and related classes.
wxUSE_MIMETYPEUse wxFileType class.
wxUSE_MINIFRAMEUse wxMiniFrame class.
wxUSE_MOUSEWHEELSupport mouse wheel events.
wxUSE_MSGDLGUse wxMessageDialog class and wxMessageBox function.
wxUSE_NANOSVGUse NanoSVG for rasterizing SVG (this option is new since wxWidgets 3.1.7).
wxUSE_NANOSVG_EXTERNALUse an external NanoSVG library when wxUSE_NANOSVG is enabled.
wxUSE_NANOSVG_EXTERNAL_ENABLE_IMPLWhen the external NanoSVG library is header only, define this to enable its implementation.
wxUSE_NATIVE_DATAVIEWCTRLUse native wxDataViewCtrl class (this option is new since wxWidgets 3.1.4).
wxUSE_NATIVE_STATUSBARUse native wxStatusBar class.
wxUSE_NOTEBOOKUse wxNotebook and related classes.
wxUSE_NUMBERDLGUse wxNumberEntryDialog class.
wxUSE_ODCOMBOBOXUse wxOwnerDrawnComboBox class.
wxUSE_ON_FATAL_EXCEPTIONCatch signals in wxApp::OnFatalException method.
wxUSE_OPENGLPlease use wxUSE_GLCANVAS to test for enabled OpenGL support instead.
wxUSE_OWNER_DRAWNUse interface for owner-drawn GUI elements.
wxUSE_PALETTEUse wxPalette and related classes.
wxUSE_PCXEnables wxImage PCX handler.
wxUSE_PNMEnables wxImage PNM handler.
wxUSE_POPUPWINUse wxPopupWindow class.
wxUSE_POSTSCRIPTUse wxPostScriptPrinter class.
wxUSE_PRINTF_POS_PARAMSUse wxVsnprintf which supports positional parameters.
wxUSE_PRINTING_ARCHITECTUREEnable printer classes.
wxUSE_PRIVATE_FONTSImplement wxFont::AddPrivateFont() method.
wxUSE_PROGRESSDLGEnables progress dialog classes.
wxUSE_PROPGRIDUse wxPropertyGrid library.
wxUSE_PROTOCOLUse wxProtocol and derived classes.
wxUSE_PROTOCOL_FILEUse wxFileProto class. (requires wxProtocol)
wxUSE_PROTOCOL_FTPUse wxFTP class. (requires wxProtocol)
wxUSE_PROTOCOL_HTTPUse wxHTTP class. (requireswxProtocol)
wxUSE_RADIOBOXUse wxRadioBox class.
wxUSE_RADIOBTNUse wxRadioButton class.
wxUSE_REPRODUCIBLE_BUILDMake library builds reproducible.
wxUSE_REGEXUse wxRegEx class.
wxUSE_RICHTEXTUse wxRichTextCtrl class.
wxUSE_RICHTEXT_XML_HANDLERSee src/xrc/xh_richtext.cpp file.
wxUSE_SASHUse wxSashWindow class.
wxUSE_SCROLLBARUse wxScrollBar class.
wxUSE_SEARCHCTRLUse wxSearchCtrl class.
wxUSE_SELECT_DISPATCHERUse wxSelectDispatcher class.
wxUSE_SLIDERUse wxSlider class.
wxUSE_SNGLINST_CHECKERUse wxSingleInstanceChecker class.
wxUSE_SOCKETSEnables Network address classes.
wxUSE_SOUNDUse wxSound class.
wxUSE_SPINBTNUse wxSpinButton class.
wxUSE_SPINCTRLUse wxSpinCtrl class.
wxUSE_SPLASHUse wxSplashScreen class.
wxUSE_SPLINESProvide methods for spline drawing in wxDC.
wxUSE_SPLITTERUse wxSplitterWindow class.
wxUSE_STACKWALKEREnables wxStackWalker and related classes.
wxUSE_STARTUP_TIPSUse startup tips, wxTipProvider class.
wxUSE_STATBMPUse wxStaticBitmap class.
wxUSE_STATBOXUse wxStaticBox class.
wxUSE_STATLINEUse wxStaticLine class.
wxUSE_STATTEXTUse wxStaticText class.
wxUSE_STATUSBARUse wxStatusBar class.
wxUSE_STCUse wxStyledTextCtrl.
wxUSE_STDPATHSUse wxStandardPaths class.
wxUSE_STOPWATCHUse wxStopWatch class.
wxUSE_STREAMSEnable stream classes.
wxUSE_SVGUse wxSVGFileDC class.
wxUSE_SYSTEM_OPTIONSUse wxSystemOptions class.
wxUSE_TAB_DIALOGUse the obsolete wxTabControl class.
wxUSE_TARSTREAMEnable Tar files support.
wxUSE_TASKBARICONUse wxTaskBarIcon class.
wxUSE_TEXTBUFFERUse wxTextBuffer class.
wxUSE_TEXTCTRLUse wxTextCtrl class.
wxUSE_TEXTDLGUse wxTextEntryDialog class.
wxUSE_TEXTFILEUse wxTextFile class.
wxUSE_TGAEnable wxImage TGA handler.
wxUSE_THREADSUse wxThread and related classes.
wxUSE_TIMERUse wxTimer class.
wxUSE_TIPWINDOWUse wxTipWindow class.
wxUSE_TOGGLEBTNUse wxToggleButton class.
wxUSE_TOOLBARUse wxToolBar class.
wxUSE_TOOLBAR_NATIVEUse native wxToolBar class.
wxUSE_TOOLBOOKUse wxToolbook class.
wxUSE_TOOLTIPSUse wxToolTip class.
wxUSE_TREEBOOKUse wxTreebook class.
wxUSE_TREECTRLUse wxTreeCtrl class.
wxUSE_TREELISTCTRLUse wxTreeListCtrl class.
wxUSE_TTM_WINDOWFROMPOINTObsolete, do not use.
wxUSE_URLUse wxURL class.
wxUSE_URL_NATIVEUse native support for some operations with wxURL.
wxUSE_VALIDATORSUse wxValidator class.
wxUSE_VARIANTUse wxVariant class.
wxUSE_WEBREQUESTUse wxWebRequest class.
wxUSE_WEBVIEWUse wxWebView class.
wxUSE_WIZARDDLGUse wxWizard class.
wxUSE_WXHTML_HELPUse wxHtmlHelpController and related classes.
wxUSE_XMLUse XML parsing classes.
wxUSE_XPMEnable XPM reader for wxImage and wxBitmap classes.
wxUSE_XRCUse XRC XML-based resource system.
wxUSE_ZIPSTREAMEnable streams for Zip files.
wxUSE_ZLIBUse wxZlibInput and wxZlibOutputStream classes, required by wxUSE_LIBPNG.

Unix Platform Symbols

wxUSE_EPOLL_DISPATCHERUse wxEpollDispatcher class. See also wxUSE_SELECT_DISPATCHER.
wxUSE_GSTREAMERUse GStreamer library in wxMediaCtrl.
wxUSE_LIBMSPACKUse libmspack library.
wxUSE_LIBSDLUse SDL for wxSound implementation.
wxUSE_PLUGINSSee also wxUSE_LIBSDL.
wxUSE_UNIXEnabled on Unix Platform.
wxUSE_XTESTUse XTest extension.

wxX11 Symbols

wxUSE_NANOXUse NanoX.
wxUSE_UNIV_TEXTCTRLUse wxUniv's implementation of wxTextCtrl class.

wxGTK Symbols

wxUSE_DETECT_SMUse code to detect X11 session manager.
wxUSE_GTKPRINTUse GTK+ printing support.
wxUSE_LIBGNOMEVFSUse GNOME VFS support. Currently has no effect.

wxMac Symbols

wxUSE_MAC_CRITICAL_REGION_MUTEXSee src/osx/carbon/thread.cpp file.
wxUSE_MAC_PTHREADS_MUTEXSee src/osx/carbon/thread.cpp file.
wxUSE_MAC_SEMAPHORE_MUTEXSee src/osx/carbon/thread.cpp file.
wxUSE_WEBKITUse wxWebKitCtrl class.

wxMotif Symbols

wxUSE_GADGETSUse xmCascadeButtonGadgetClass, xmLabelGadgetClass, xmPushButtonGadgetClass and xmToggleButtonGadgetClass classes.
wxUSE_INVISIBLE_RESIZESee src/motif/dialog.cpp file.

wxMSW Symbols

wxUSE_ACCESSIBILITYEnable accessibility support
wxUSE_ACTIVEXUse wxActiveXContainer and related classes.
wxUSE_COMBOCTRL_POPUP_ANIMATIONSee wx/msw/combo.h file.
wxUSE_COMMON_DIALOGSEnable use of windows common dialogs from header commdlg.h; example PRINTDLG.
wxUSE_CRASHREPORTUse wxCrashReport class.
wxUSE_DATEPICKCTRL_GENERICUse generic wxDatePickerCtrl implementation in addition to the native one.
wxUSE_DC_CACHEINGcache temporary wxDC objects.
wxUSE_DDE_FOR_IPCSee wx/ipc.h file.
wxUSE_DPI_AWARE_MANIFESTSet the DPI awareness of the application (0=none, 1=system, 2=per-monitor). Used by CMake and when wxUSE_RC_MANIFEST is enabled.
wxUSE_ENH_METAFILEUse wxEnhMetaFile.
wxUSE_HOTKEYUse wxWindow::RegisterHotKey() and wxWindow::UnregisterHotKey
wxUSE_INKEDITUse InkEdit library. Related to Tablet PCs.
wxUSE_MS_HTML_HELPUse wxCHMHelpController class.
wxUSE_NO_MANIFESTCan be predefined to disable inclusion of the manifest from wxWidgets RC file. See also wxUSE_RC_MANIFEST.
wxUSE_OLEEnables OLE helper routines.
wxUSE_OLE_AUTOMATIONEnable OLE automation utilities.
wxUSE_OLE_CLIPBOARDUse OLE clipboard.
wxUSE_POSTSCRIPT_ARCHITECTURE_IN_MSWUse PS printing in wxMSW.
wxUSE_PS_PRINTINGSee src/msw/dcprint.cpp file.
wxUSE_RC_MANIFESTInclude manifest for common controls library v6 from wxWidgets RC file. This may be needed to be defined explicitly for MSVC 7 (a.k.a. MSVS 2003) only as later versions of MSVC generate this manifest themselves and the manifest generation is enabled by default for the other compilers. See also wxUSE_NO_MANIFEST.
wxUSE_REGKEYUse wxRegKey class.
wxUSE_RICHEDITEnable use of riched32.dll in wxTextCtrl
wxUSE_RICHEDIT2Enable use of riched20.dll in wxTextCtrl
wxUSE_VC_CRTDBGSee wx/msw/msvcrt.h file.
wxUSE_UXTHEMEEnable support for XP themes.
wxUSE_WIN_METAFILES_ALWAYSUse wxMetaFile even when wxUSE_ENH_METAFILE=1.
wxUSE_WINRTEnable WinRT support.
wxUSE_WXDIBUse wxDIB class.
wxUSE_WINSOCK2Include <winsock2.h> instead of <winsock.h>. Turned on automatically if wxUSE_IPV6 is on (this option is new since wxWidgets 3.1.3).

wxUniversal Symbols

wxUSE_ALL_THEMESUse all themes in wxUniversal; See wx/univ/theme.h file.
wxUSE_THEME_GTKUse GTK+ 1-like theme in wxUniversal
wxUSE_THEME_METALUse GTK+ 2-like theme in wxUniversal
wxUSE_THEME_MONOUse simple monochrome theme in wxUniversal
wxUSE_THEME_WIN32Use Win32-like theme in wxUniversal