]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/wxusedef.tex
escape underscores introduced by the last change
[wxWidgets.git] / docs / latex / wx / wxusedef.tex
CommitLineData
4f167b46
VZ
1%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2%% Name: wxusedef.tex
3%% Purpose: wxUSE preprocessor symbols
4%% Author: Tim Stahlhut
5%% Created: 2007-07-15
6%% RCS-ID: $Id: $
7%% Copyright: (c) 2007 wxWidgets
8%% License: wxWindows license
9%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10
11\section{wxUSE Preprocessor symbols defined by wxWidgets}\label{wxusedef}
12
13This section documents the wxUSE preprocessor symbols used in the wxWidgets
14source, grouped by category (and sorted by alphabetical order inside each
15category). These symbols are always defined and whether the given feature is
16active or not depends on their value: if defined as $1$, feature is active,
17otherwise it is disabled. Because of this these symbols should be always tested
18using \texttt{#if} and not \texttt{#ifdef}.
19
404e3102 20\subsection{Generic wxUSE preprocessor symbols}\label{wxusedefmulti}
4f167b46
VZ
21
22\begin{twocollist}\itemsep=0pt
23\twocolitem{wxUSE\_ABOUTDLG}{Use \helpref{wxAboutDialogInfo}{wxaboutdialoginfo} class.}
24\twocolitem{wxUSE\_ACCEL}{Use \helpref{wxAcceleratorTable}{wxacceleratortable}/Entry classes and support for them in \helpref{wxMenu}{wxmenu}(Bar).}
fe906309 25\twocolitem{wxUSE\_AFM\_FOR\_POSTSCRIPT}{In \helpref{wxPostScriptDC}{wxpostscriptdc} class use AFM (adobe font metrics) file for character widths.}
4f167b46 26\twocolitem{wxUSE\_ANIMATIONCTRL}{Use \helpref{wxAnimationCtrl}{wxanimationctrl} class.}
404e3102
VZ
27\twocolitem{wxUSE\_APPLE\_IEEE}{IEEE Extended to/from double routines; see src/common/extended.c file.}
28\twocolitem{wxUSE\_ARCHIVE\_STREAMS}{Enable streams for archive formats.}
4f167b46
VZ
29\twocolitem{wxUSE\_AUI}{Use AUI (dockable windows) library.}
30\twocolitem{wxUSE\_BASE64}{Enables Base64 support.}
fe906309 31\twocolitem{wxUSE\_BITMAPCOMBOBOX}{Use \helpref{wxBitmapComboBox}{wxbitmapcombobox} class.}
4f167b46
VZ
32\twocolitem{wxUSE\_BMPBUTTON}{Use \helpref{wxBitmapButton}{wxbitmapbutton} class.}
33\twocolitem{wxUSE\_BUSYINFO}{Use \helpref{wxBusyInfo}{wxbusyinfo} class.}
34\twocolitem{wxUSE\_BUTTON}{Use \helpref{wxButton}{wxbutton} class.}
35\twocolitem{wxUSE\_CALENDARCTRL}{Use \helpref{wxCalendarCtrl}{wxcalendarctrl} class.}
36\twocolitem{wxUSE\_CARET}{Use \helpref{wxCaret}{wxcaret} class.}
37\twocolitem{wxUSE\_CHECKBOX}{Use \helpref{wxCheckBox}{wxcheckbox} class.}
38\twocolitem{wxUSE\_CHECKLISTBOX}{Use \helpref{wxCheckListBox}{wxchecklistbox} class.}
39\twocolitem{wxUSE\_CHOICE}{Use \helpref{wxChoice}{wxchoice} class.}
40\twocolitem{wxUSE\_CHOICEBOOK}{Use \helpref{wxChoicebook}{wxchoicebook} class.}
41\twocolitem{wxUSE\_CHOICEDLG}{Use \helpref{wxSingleChoiceDialog}{wxsinglechoicedialog} or \helpref{wxMultiChoiceDialog}{wxmultichoicedialog} classes.}
42\twocolitem{wxUSE\_CLIPBOARD}{Use \helpref{wxClipboard}{wxclipboard} class.}
404e3102 43\twocolitem{wxUSE\_CMDLINE\_PARSER}{Use \helpref{wxCmdLineParser}{wxcmdlineparser} class.}
4f167b46
VZ
44\twocolitem{wxUSE\_COLLPANE}{Use \helpref{wxCollapsiblePane}{wxcollapsiblepane} class.}
45\twocolitem{wxUSE\_COLOURDLG}{Use \helpref{wxColourDialog}{wxcolourdialog} class.}
46\twocolitem{wxUSE\_COLOURPICKERCTRL}{Use \helpref{wxColourPickerCtrl}{wxcolourpickerctrl} class.}
47\twocolitem{wxUSE\_COMBOBOX}{Use \helpref{wxComboBox}{wxcombobox} class.}
48\twocolitem{wxUSE\_COMBOCTRL}{Use \helpref{wxComboCtrl}{wxcomboctrl} class.}
49\twocolitem{wxUSE\_CONFIG}{Use \helpref{wxConfig}{wxconfigbase} and related classes.}
404e3102
VZ
50\twocolitem{wxUSE\_CONFIG\_NATIVE}{When enabled use native OS configuration instead of the \helpref{wxFileConfig}{wxfileconfig} class.}
51\twocolitem{wxUSE\_CONSOLE\_EVENTLOOP}{Enable event loop in console programs.}
4f167b46 52\twocolitem{wxUSE\_CONSTRAINTS}{Use \helpref{wxLayoutConstraints}{wxlayoutconstraints}}
404e3102 53\twocolitem{wxUSE\_CONTROLS}{If set to $0$, no classes deriving from \helpref{wxControl}{wxcontrol} can be used.}
4f167b46
VZ
54\twocolitem{wxUSE\_DATAOBJ}{Use \helpref{wxDataObject}{wxdataobject} and related classes.}
55\twocolitem{wxUSE\_DATAVIEWCTRL}{Use \helpref{wxDataViewCtrl}{wxdataviewctrl} class.}
56\twocolitem{wxUSE\_DATEPICKCTRL}{Use \helpref{wxDatePickerCtrl}{wxdatepickerctrl} class.}
57\twocolitem{wxUSE\_DATETIME}{Use \helpref{wxDateTime}{wxdatetime} and related classes.}
404e3102
VZ
58\twocolitem{wxUSE\_DBGHELP}{Use wxDbgHelpDLL class.}
59\twocolitem{wxUSE\_DEBUG\_CONTEXT}{Use \helpref{wxDebugContext}{wxdebugcontext} class.}
fe906309 60\twocolitem{wxUSE\_DEBUG\_NEW\_ALWAYS}{See \helpref{Debugging overview}{wxdebugcontextoverview}}
4f167b46 61\twocolitem{wxUSE\_DEBUGREPORT}{Use \helpref{wxDebugReport}{wxdebugreport} class.}
404e3102 62\twocolitem{wxUSE\_DIALUP\_MANAGER}{Use \helpref{wxDialUpManager}{wxdialupmanager} and related classes.}
4f167b46
VZ
63\twocolitem{wxUSE\_DIRDLG}{Use \helpref{wxDirDialog}{wxdirdialog} class.}
64\twocolitem{wxUSE\_DIRPICKERCTRL}{Use \helpref{wxDirPickerCtrl}{wxdirpickerctrl} class.}
65\twocolitem{wxUSE\_DISPLAY}{Use \helpref{wxDisplay}{wxdisplay} and related classes.}
66\twocolitem{wxUSE\_DOC\_VIEW\_ARCHITECTURE}{Use \helpref{wxDocument}{wxdocument} and related classes.}
404e3102 67\twocolitem{wxUSE\_DRAG\_AND\_DROP}{Use \helpref{Drag and drop}{wxdndoverview} classes.}
4f167b46 68\twocolitem{wxUSE\_DRAGIMAGE}{Use \helpref{wxDragImage}{wxdragimage} class.}
404e3102
VZ
69\twocolitem{wxUSE\_DYNAMIC\_LOADER}{Use wxPluginManager and related classes. Requires \helpref{wxDynamicLibrary}{wxdynamiclibrary}}
70\twocolitem{wxUSE\_DYNLIB\_CLASS}{Use \helpref{wxDynamicLibrary}{wxdynamiclibrary}}
4f167b46 71\twocolitem{wxUSE\_EDITABLELISTBOX}{Use \helpref{wxEditableListBox}{wxeditablelistbox} class.}
fe906309 72\twocolitem{wxUSE\_EXCEPTIONS}{Use \helpref{exception handling}{exceptionsoverview}.}
404e3102
VZ
73\twocolitem{wxUSE\_EXPAT}{enable XML support using expat parser.}
74\twocolitem{wxUSE\_EXTENDED\_RTTI}{Use extended RTTI, see also \helpref{Runtime class information (RTTI)}{runtimeclassoverview}}
4f167b46
VZ
75\twocolitem{wxUSE\_FFILE}{Use \helpref{wxFFile}{wxffile} class.}
76\twocolitem{wxUSE\_FILE}{Use \helpref{wxFile}{wxfile} class.}
404e3102 77\twocolitem{wxUSE\_FILECONFIG}{Use \helpref{wxFileConfig}{wxfileconfig} class.}
0cf3e587 78\twocolitem{wxUSE\_FILECTRL}{Use \helpref{wxFileCtrl}{wxfilectrl} class.}
4f167b46
VZ
79\twocolitem{wxUSE\_FILEDLG}{Use \helpref{wxFileDialog}{wxfiledialog} class.}
80\twocolitem{wxUSE\_FILEPICKERCTRL}{Use \helpref{wxFilePickerCtrl}{wxfilepickerctrl} class.}
81\twocolitem{wxUSE\_FILESYSTEM}{Use \helpref{wxFileSystem}{wxfilesystem} and related classes.}
82\twocolitem{wxUSE\_FINDREPLDLG}{Use \helpref{wxFindReplaceDialog}{wxfindreplacedialog} class.}
83\twocolitem{wxUSE\_FONTDLG}{Use \helpref{wxFontDialog}{wxfontdialog} class.}
fe906309 84\twocolitem{wxUSE\_FONTENUM}{Use \helpref{wxFontEnumerator}{wxfontenumerator} class.}
4f167b46
VZ
85\twocolitem{wxUSE\_FONTMAP}{Use \helpref{wxFontMapper}{wxfontmapper} class.}
86\twocolitem{wxUSE\_FONTPICKERCTRL}{Use \helpref{wxFontPickerCtrl}{wxfontpickerctrl} class.}
fe906309
VZ
87\twocolitem{wxUSE\_FS\_ARCHIVE}{Use virtual archive filesystems like wxArchiveFSHandler in \helpref{wxFileSystem}{wxfilesystem} class.}
88\twocolitem{wxUSE\_FS\_INET}{Use virtual HTTP/FTP filesystems like wxInternetFSHandler in \helpref{wxFileSystem}{wxfilesystem} class.}
89\twocolitem{wxUSE\_FS\_ZIP}{Please use wxUSE\_FS\_ARCHIVE instead.}
4f167b46
VZ
90\twocolitem{wxUSE\_FSVOLUME}{Use wxFSVolume class.}
91\twocolitem{wxUSE\_GAUGE}{Use \helpref{wxGauge}{wxgauge} class.}
404e3102
VZ
92\twocolitem{wxUSE\_GENERIC\_DRAGIMAGE}{Used in wxDragImage sample.}
93\twocolitem{wxUSE\_GENERIC\_DRAWELLIPSE}{See comment in wx/dc.h file.}
94\twocolitem{wxUSE\_GEOMETRY}{Use common geometry classes}
95\twocolitem{wxUSE\_GIF}{Use GIF \helpref{wxImageHandler}{wximagehandler}}
4f167b46 96\twocolitem{wxUSE\_GLCANVAS}{Enables OpenGL support.}
fe906309 97\twocolitem{wxUSE\_GLOBAL\_MEMORY\_OPERATORS}{Override global operators \texttt{new} and \texttt{delete} to use wxWidgets memory leak detection}
404e3102 98\twocolitem{wxUSE\_GRAPHICS\_CONTEXT}{Use \helpref{wxGraphicsContext}{wxgraphicscontext} and related classes.}
4f167b46 99\twocolitem{wxUSE\_GRID}{Use \helpref{wxGrid}{wxgrid} and related classes.}
404e3102 100\twocolitem{wxUSE\_GUI}{Use the GUI classes; if set to $0$ only non-GUI classes are available.}
4f167b46 101\twocolitem{wxUSE\_HELP}{Use \helpref{wxHelpController}{wxhelpcontroller} and related classes.}
4f167b46
VZ
102\twocolitem{wxUSE\_HTML}{Use \helpref{wxHtmlWindow}{wxhtmlwindow} and related classes.}
103\twocolitem{wxUSE\_HYPERLINKCTRL}{Use \helpref{wxHyperlinkCtrl}{wxhyperlinkctrl}}
404e3102 104\twocolitem{wxUSE\_ICO\_CUR}{Support Windows ICO and CUR formats.}
4f167b46
VZ
105\twocolitem{wxUSE\_IFF}{Enables the \helpref{wxImage}{wximage} handler for Amiga IFF images.}
106\twocolitem{wxUSE\_IMAGE}{Use \helpref{wxImage}{wximage} and related classes.}
107\twocolitem{wxUSE\_IMAGLIST}{Use \helpref{wxImageList}{wximagelist} class.}
108\twocolitem{wxUSE\_INTL}{Use \helpref{wxLocale}{wxlocale} and related classes.}
109\twocolitem{wxUSE\_IOSTREAMH}{Use header <iostream.h> instead of <iostream>.}
404e3102
VZ
110\twocolitem{wxUSE\_IPC}{Use interprocess communication classes.}
111\twocolitem{wxUSE\_IPV6}{Use experimental \helpref{wxIPV6address}{wxipaddress} and related classes.}
4f167b46
VZ
112\twocolitem{wxUSE\_JOYSTICK}{Use \helpref{wxJoystick}{wxjoystick} class.}
113\twocolitem{wxUSE\_LIBJPEG}{Enables JPEG format support (requires libjpeg).}
404e3102 114\twocolitem{wxUSE\_LIBPNG}{Enables PNG format support (requires libpng). Also requires wxUSE\_ZLIB.}
4f167b46
VZ
115\twocolitem{wxUSE\_LIBTIFF}{Enables TIFF format support (requires libtiff).}
116\twocolitem{wxUSE\_LISTBOOK}{Use \helpref{wxListbook}{wxlistbook} class.}
117\twocolitem{wxUSE\_LISTBOX}{Use \helpref{wxListBox}{wxlistbox} class.}
118\twocolitem{wxUSE\_LISTCTRL}{Use \helpref{wxListCtrl}{wxlistctrl} class.}
119\twocolitem{wxUSE\_LOG}{Use \helpref{wxLog}{wxlog} and related classes.}
404e3102
VZ
120\twocolitem{wxUSE\_LOG\_DEBUG}{Enabled when wxLog used with \_\_WXDEBUG\_\_ defined.}
121\twocolitem{wxUSE\_LOG\_DIALOG}{Use wxLogDialog class.}
4f167b46
VZ
122\twocolitem{wxUSE\_LOGGUI}{Use \helpref{wxLogGui}{wxloggui} class.}
123\twocolitem{wxUSE\_LOGWINDOW}{Use wxLogFrame class.}
124\twocolitem{wxUSE\_LONGLONG}{Use \helpref{wxLongLong}{wxlonglong} class.}
404e3102
VZ
125\twocolitem{wxUSE\_LONGLONG\_NATIVE}{Use native \texttt{long long} type in \helpref{wxLongLong}{wxlonglong} implementation.}
126\twocolitem{wxUSE\_LONGLONG\_WX}{Use generic wxLongLong implementation.}
127\twocolitem{wxUSE\_MDI}{Use \helpref{wxMDIParentFrame}{wxmdiparentframe} and \helpref{wxMDIChildFrame}{wxmdichildframe}}
128\twocolitem{wxUSE\_MDI\_ARCHITECTURE}{Use MDI-based document-view classes.}
4f167b46 129\twocolitem{wxUSE\_MEDIACTRL}{Use \helpref{wxMediaCtrl}{wxmediactrl}.}
fe906309 130\twocolitem{wxUSE\_MEMORY\_TRACING}{Use wxWidgets memory leak detection, not recommended if using another memory debugging tool.}
4f167b46
VZ
131\twocolitem{wxUSE\_MENUS}{Use \helpref{wxMenu}{wxmenu} and related classes.}
132\twocolitem{wxUSE\_METAFILE}{Use \helpref{wxMetaFile}{wxmetafile} and related classes.}
133\twocolitem{wxUSE\_MIMETYPE}{Use \helpref{wxFileType}{wxfiletype} class.}
134\twocolitem{wxUSE\_MINIFRAME}{Use \helpref{wxMiniFrame}{wxminiframe} class.}
404e3102 135\twocolitem{wxUSE\_MOUSEWHEEL}{Support mouse wheel events.}
4f167b46 136\twocolitem{wxUSE\_MSGDLG}{Use wxMessageOutput class.}
fe906309 137\twocolitem{wxUSE\_NATIVE\_STATUSBAR}{Use native \helpref{wxStatusBar}{wxstatusbar} class.}
4f167b46
VZ
138\twocolitem{wxUSE\_NOTEBOOK}{Use \helpref{wxNotebook}{wxnotebook} and related classes.}
139\twocolitem{wxUSE\_NUMBERDLG}{Use wxNumberEntryDialog class.}
140\twocolitem{wxUSE\_ODBC}{Use ODBC classes.}
141\twocolitem{wxUSE\_ODCOMBOBOX}{Use \helpref{wxOwnerDrawnComboBox}{wxownerdrawncombobox} class.}
404e3102
VZ
142\twocolitem{wxUSE\_ON\_FATAL\_EXCEPTION}{Catch signals in \helpref{wxApp::OnFatalException}{wxapponfatalexception} method.}
143\twocolitem{wxUSE\_OPENGL}{Please use wxUSE\_GLCANVAS to test for enabled OpenGL support instead.}
4f167b46
VZ
144\twocolitem{wxUSE\_OWNER\_DRAWN}{Use interface for owner-drawn GUI elements.}
145\twocolitem{wxUSE\_PALETTE}{Use \helpref{wxPalette}{wxpalette} and related classes.}
146\twocolitem{wxUSE\_PCX}{Enables \helpref{wxImage}{wximage} PCX handler.}
147\twocolitem{wxUSE\_PNM}{Enables \helpref{wxImage}{wximage} PNM handler.}
148\twocolitem{wxUSE\_POPUPWIN}{Use wxPopupWindow class.}
149\twocolitem{wxUSE\_POSTSCRIPT}{Use wxPostScriptPrinter class.}
404e3102 150\twocolitem{wxUSE\_PRINTF\_POS\_PARAMS}{Use \helpref{wxVsnprintf}{wxvsnprintf} which supports positional parameters.}
4f167b46
VZ
151\twocolitem{wxUSE\_PRINTING\_ARCHITECTURE}{Enable printer classes.}
152\twocolitem{wxUSE\_PROGRESSDLG}{Enables progress dialog classes.}
404e3102
VZ
153\twocolitem{wxUSE\_PROTOCOL}{Use \helpref{wxProtocol}{wxprotocol} and derived classes.}
154\twocolitem{wxUSE\_PROTOCOL\_FILE}{Use wxFileProto class. (requires \helpref{wxProtocol}{wxprotocol})}
155\twocolitem{wxUSE\_PROTOCOL\_FTP}{Use \helpref{wxFTP}{wxftp} class. (requires \helpref{wxProtocol}{wxprotocol})}
156\twocolitem{wxUSE\_PROTOCOL\_HTTP}{Use \helpref{wxHTTP}{wxhttp} class. (requires \helpref{wxProtocol}{wxprotocol})}
4f167b46
VZ
157\twocolitem{wxUSE\_RADIOBOX}{Use \helpref{wxRadioBox}{wxradiobox} class.}
158\twocolitem{wxUSE\_RADIOBTN}{Use \helpref{wxRadioButton}{wxradiobutton} class.}
159\twocolitem{wxUSE\_REGEX}{Use \helpref{wxRegEx}{wxregex} class.}
4f167b46 160\twocolitem{wxUSE\_RICHTEXT}{Use \helpref{wxRichTextCtrl}{wxrichtextctrl} class.}
404e3102 161\twocolitem{wxUSE\_RICHTEXT\_XML\_HANDLER}{See src/xrc/xh\_richtext.cpp file.}
4f167b46
VZ
162\twocolitem{wxUSE\_SASH}{Use \helpref{wxSashWindow}{wxsashwindow} class.}
163\twocolitem{wxUSE\_SCROLLBAR}{Use \helpref{wxScrollBar}{wxscrollbar} class.}
164\twocolitem{wxUSE\_SEARCHCTRL}{Use \helpref{wxSearchCtrl}{wxsearchctrl} class.}
404e3102 165\twocolitem{wxUSE\_SELECT\_DISPATCHER}{Use wxSelectDispatcher class.}
4f167b46 166\twocolitem{wxUSE\_SLIDER}{Use \helpref{wxSlider}{wxslider} class.}
404e3102 167\twocolitem{wxUSE\_SNGLINST\_CHECKER}{Use \helpref{wxSingleInstanceChecker}{wxsingleinstancechecker} class.}
4f167b46
VZ
168\twocolitem{wxUSE\_SOCKETS}{Enables Network address classes.}
169\twocolitem{wxUSE\_SOUND}{Use \helpref{wxSound}{wxsound} class.}
170\twocolitem{wxUSE\_SPINBTN}{Use \helpref{wxSpinButton}{wxspinbutton} class.}
171\twocolitem{wxUSE\_SPINCTRL}{Use \helpref{wxSpinCtrl}{wxspinctrl} class.}
172\twocolitem{wxUSE\_SPLASH}{Use \helpref{wxSplashScreen}{wxsplashscreen} class.}
404e3102 173\twocolitem{wxUSE\_SPLINES}{Provide methods for spline drawing in wxDC.}
4f167b46
VZ
174\twocolitem{wxUSE\_SPLITTER}{Use \helpref{wxSplitterWindow}{wxsplitterwindow} class.}
175\twocolitem{wxUSE\_STACKWALKER}{Enables \helpref{wxStackWalker}{wxstackwalker} and related classes.}
404e3102 176\twocolitem{wxUSE\_STARTUP\_TIPS}{Use startup tips, \helpref{wxTipProvider}{wxtipprovider} class.}
4f167b46
VZ
177\twocolitem{wxUSE\_STATBMP}{Use \helpref{wxStaticBitmap}{wxstaticbitmap} class.}
178\twocolitem{wxUSE\_STATBOX}{Use \helpref{wxStaticBox}{wxstaticbox} class.}
179\twocolitem{wxUSE\_STATLINE}{Use \helpref{wxStaticLine}{wxstaticline} class.}
180\twocolitem{wxUSE\_STATTEXT}{Use \helpref{wxStaticText}{wxstatictext} class.}
181\twocolitem{wxUSE\_STATUSBAR}{Use \helpref{wxStatusBar}{wxstatusbar} class.}
182\twocolitem{wxUSE\_STC}{Use wxStyledTextCtrl.}
404e3102
VZ
183\twocolitem{wxUSE\_STD\_IOSTREAM}{Use standard C++ stream classes.}
184\twocolitem{wxUSE\_STD\_STRING}{Use standard C++ string classes.}
4f167b46 185\twocolitem{wxUSE\_STDPATHS}{Use \helpref{wxStandardPaths}{wxstandardpaths} class.}
404e3102 186\twocolitem{wxUSE\_STL}{Use Standard Template Library for the container classes and \helpref{wxString}{wxstring} implementation.}
4f167b46
VZ
187\twocolitem{wxUSE\_STOPWATCH}{Use \helpref{wxStopWatch}{wxstopwatch} class.}
188\twocolitem{wxUSE\_STREAMS}{Enable stream classes.}
189\twocolitem{wxUSE\_SVG}{Use wxSVGFileDC class.}
404e3102 190\twocolitem{wxUSE\_SYSTEM\_OPTIONS}{Use \helpref{wxSystemOptions}{wxsystemoptions} class.}
2df2a65b 191\twocolitem{wxUSE\_TAB\_DIALOG}{Use the obsolete wxTabControl class.}
4f167b46 192\twocolitem{wxUSE\_TARSTREAM}{Enable Tar files support.}
404e3102 193\twocolitem{wxUSE\_TASKBARICON}{Use \helpref{wxTaskBarIcon}{wxtaskbaricon} class.}
4f167b46
VZ
194\twocolitem{wxUSE\_TEXTBUFFER}{Use wxTextBuffer class.}
195\twocolitem{wxUSE\_TEXTCTRL}{Use \helpref{wxTextCtrl}{wxtextctrl} class.}
196\twocolitem{wxUSE\_TEXTDLG}{Use \helpref{wxTextEntryDialog}{wxtextentrydialog} class.}
197\twocolitem{wxUSE\_TEXTFILE}{Use \helpref{wxTextFile}{wxtextfile} class.}
198\twocolitem{wxUSE\_TGA}{Enable \helpref{wxImage}{wximage} TGA handler.}
199\twocolitem{wxUSE\_THREADS}{Use \helpref{wxThread}{wxthread} and related classes.}
200\twocolitem{wxUSE\_TIMER}{Use \helpref{wxTimer}{wxtimer} class.}
201\twocolitem{wxUSE\_TIPWINDOW}{Use \helpref{wxTipWindow}{wxtipwindow} class.}
202\twocolitem{wxUSE\_TOGGLEBTN}{Use \helpref{wxToggleButton}{wxtogglebutton} class.}
203\twocolitem{wxUSE\_TOOLBAR}{Use \helpref{wxToolBar}{wxtoolbar} class.}
fe906309 204\twocolitem{wxUSE\_TOOLBAR\_NATIVE}{Use native \helpref{wxToolBar}{wxtoolbar} class.}
4f167b46
VZ
205\twocolitem{wxUSE\_TOOLBOOK}{Use \helpref{wxToolbook}{wxtoolbook} class.}
206\twocolitem{wxUSE\_TOOLTIPS}{Use \helpref{wxToolTip}{wxtooltip} class.}
207\twocolitem{wxUSE\_TREEBOOK}{Use \helpref{wxTreebook}{wxtreebook} class.}
208\twocolitem{wxUSE\_TREECTRL}{Use \helpref{wxTreeCtrl}{wxtreectrl} class.}
404e3102
VZ
209\twocolitem{wxUSE\_TTM\_WINDOWFROMPOINT}{Obsolete, do not use.}
210\twocolitem{wxUSE\_UNICODE}{Compiled with Unicode support.}
211\twocolitem{wxUSE\_UNICODE\_UTF8}{Compiled with UTF8 support.}
212\twocolitem{wxUSE\_UNICODE\_WCHAR}{Compiled with Unicode support and using wchar\_t type.}
4f167b46 213\twocolitem{wxUSE\_URL}{Use \helpref{wxURL}{wxurl} class.}
404e3102
VZ
214\twocolitem{wxUSE\_URL\_NATIVE}{Use native support for some operations with \helpref{wxURL}{wxurl}.}
215\twocolitem{wxUSE\_UTF8\_LOCALE\_ONLY}{Build wxWidgets to support 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.}
4f167b46
VZ
216\twocolitem{wxUSE\_VALIDATORS}{Use \helpref{wxValidator}{wxvalidator} class.}
217\twocolitem{wxUSE\_VARIANT}{Use \helpref{wxVariant}{wxvariant} class.}
218\twocolitem{wxUSE\_WIZARDDLG}{Use \helpref{wxWizard}{wxwizard} class.}
404e3102 219\twocolitem{wxUSE\_WXHTML\_HELP}{Use \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller} and related classes.}
4f167b46
VZ
220\twocolitem{wxUSE\_XML}{Use XML parsing classes.}
221\twocolitem{wxUSE\_XPM}{Enable XPM reader for \helpref{wxImage}{wximage} and \helpref{wxBitmap}{wxbitmap} classes.}
222\twocolitem{wxUSE\_XRC}{Use XRC XML-based resource system.}
404e3102
VZ
223\twocolitem{wxUSE\_ZIPSTREAM}{Enable streams for Zip files.}
224\twocolitem{wxUSE\_ZLIB}{Use \helpref{wxZlibInput}{wxzlibinputstream} and \helpref{wxZlibOutputStream}{wxzliboutputstream} classes, required by wxUSE\_LIBPNG.}
4f167b46
VZ
225\end{twocollist}
226
404e3102 227\subsection{wxUSE preprocessor symbols used only under Unix platforms}\label{wxusedefunix}
4f167b46 228\begin{twocollist}\itemsep=0pt
404e3102 229\twocolitem{wxUSE\_EPOLL\_DISPATCHER}{Use wxEpollDispatcher class. See also wxUSE\_SELECT\_DISPATCHER.}
4f167b46
VZ
230\twocolitem{wxUSE\_GSTREAMER}{Use GStreamer library in \helpref{wxMediaCtrl}{wxmediactrl}.}
231\twocolitem{wxUSE\_LIBMSPACK}{Use libmspack library.}
404e3102
VZ
232\twocolitem{wxUSE\_LIBSDL}{Use SDL for wxSound implementation.}
233\twocolitem{wxUSE\_PLUGINS}{See also wxUSE\_LIBSDL.}
234\twocolitem{wxUSE\_UNIX}{Enabled on Unix Platform.}
4f167b46
VZ
235\end{twocollist}
236
404e3102 237\subsection{wxUSE preprocessor symbols used only in wxX11 Platform}\label{wxusedefx11}
4f167b46 238\begin{twocollist}\itemsep=0pt
404e3102
VZ
239\twocolitem{wxUSE\_NANOX}{Use NanoX.}
240\twocolitem{wxUSE\_UNIV\_TEXTCTRL}{Use wxUniv's implementation of \helpref{wxTextCtrl}{wxtextctrl} class.}
241\end{twocollist}
242
243\subsection{wxUSE preprocessor symbols used only in wxGTK port}\label{wxusedefgtk}
244\begin{twocollist}\itemsep=0pt
245\twocolitem{wxUSE\_DETECT\_SM}{Use code to detect X11 session manager.}
92fdffb2 246\twocolitem{wxUSE\_GTKPRINT}{Use GTK+ printing support.}
404e3102 247\twocolitem{wxUSE\_LIBGNOMEPRINT}{Use GNOME printing support.}
92fdffb2
RR
248\twocolitem{wxUSE\_LIBGNOMEVFS}{Use GNOME VFS support. Currently has no effect. }
249\twocolitem{wxUSE\_LIBHILDON}{Use Hildon framework for Nokia 770. Currently has no effect. }
404e3102
VZ
250\end{twocollist}
251
252\subsection{wxUSE preprocessor symbols used only in wxMac port}\label{wxusedefmac}
253\begin{twocollist}\itemsep=0pt
254\twocolitem{wxUSE\_MAC\_CRITICAL\_REGION\_MUTEX}{See src/mac/carbon/thread.cpp file.}
255\twocolitem{wxUSE\_MAC\_PTHREADS\_MUTEX}{See src/mac/carbon/thread.cpp file.}
256\twocolitem{wxUSE\_MAC\_SEMAPHORE\_MUTEX}{See src/mac/carbon/thread.cpp file.}
4f167b46
VZ
257\twocolitem{wxUSE\_WEBKIT}{Use wxWebKitCtrl class.}
258\end{twocollist}
259
404e3102
VZ
260\subsection{wxUSE preprocessor symbols used only in wxMotif port}\label{wxusedefmotif}
261\begin{twocollist}\itemsep=0pt
262\twocolitem{wxUSE\_GADGETS}{Use xmCascadeButtonGadgetClass, xmLabelGadgetClass, xmPushButtonGadgetClass and xmToggleButtonGadgetClass classes.}
263\twocolitem{wxUSE\_INVISIBLE\_RESIZE}{See src/motif/dialog.cpp file.}
264\end{twocollist}
265
266\subsection{wxUSE preprocessor symbols used only in Cocoa port}
267\begin{twocollist}\itemsep=0pt
268\twocolitem{wxUSE\_OBJC\_UNIQUIFYING}{Enable Objective-C class name uniquifying.}
269\end{twocollist}
270
271\subsection{wxUSE preprocessor symbols used only in OS2 port}
272\begin{twocollist}\itemsep=0pt
273\twocolitem{wxUSE\_CONSOLEDEBUG}{See src/os2/app.cpp file.}
274\twocolitem{wxUSE\_DDE}{See src/os2/mimetype.cpp file.}
275\twocolitem{wxUSE\_IMAGE\_LOADING\_IN\_MSW}{See src/os2/clipbrd.cpp file.}
276\twocolitem{wxUSE\_IMAGE\_LOADING\_IN\_OS2}{See src/os2/gdiimage.cpp file.}
277\twocolitem{wxUSE\_NET\_API}{Use NetBios32GetInfo API call.}
278\twocolitem{wxUSE\_RESOURCE\_LOADING\_IN\_OS2}{See src/os2/gdiimage.cpp file.}
279\end{twocollist}
280
281\subsection{wxUSE preprocessor symbols used only in wxMSW port}\label{wxusedefmsw}
4f167b46
VZ
282\begin{twocollist}\itemsep=0pt
283\twocolitem{wxUSE\_ACCESSIBILITY}{Enable accessibility support}
284\twocolitem{wxUSE\_ACTIVEX}{Use \helpref{wxActiveXContainer}{wxactivexcontainer} and related classes.}
404e3102
VZ
285\twocolitem{wxUSE\_COMBOCTRL\_POPUP\_ANIMATION}{See wx/msw/combo.h file.}
286\twocolitem{wxUSE\_COMCTL32\_SAFELY}{See src/msw/treectrl.cpp file.}
287\twocolitem{wxUSE\_COMMON\_DIALOGS}{Enable use of windows common dialogs from header commdlg.h; example PRINTDLG.}
fe906309 288\twocolitem{wxUSE\_CRASHREPORT}{Use wxCrashReport class.}
404e3102
VZ
289\twocolitem{wxUSE\_DATEPICKCTRL\_GENERIC}{Use generic \helpref{wxDatePickerCtrl}{wxdatepickerctrl} implementation in addition to the native one.}
290\twocolitem{wxUSE\_DC\_CACHEING}{cache temporary \helpref{wxDC}{wxdc} objects.}
291\twocolitem{wxUSE\_DIRECTDRAW}{Enable use of the system include file ddraw.h.}
292\twocolitem{wxUSE\_DDE\_FOR\_IPC}{See wx/ipc.h file.}
4f167b46 293\twocolitem{wxUSE\_ENH\_METAFILE}{Use wxEnhMetaFile.}
404e3102
VZ
294\twocolitem{wxUSE\_HOTKEY}{Use \helpref{wxWindow::RegisterHotKey()}{wxwindowregisterhotkey} and \helpref{UnregisterHotKey}{wxwindowunregisterhotkey}}
295\twocolitem{wxUSE\_INKEDIT}{Use InkEdit library. Related to Tablet PCs.}
296\twocolitem{wxUSE\_MS\_HTML\_HELP}{Use \helpref{wxCHMHelpController}{wxhelpcontroller} class.}
297\twocolitem{wxUSE\_NO\_MANIFEST}{Use to prevent the auto generation, under MSVC, of manifest file needed by windows XP and above.}
298\twocolitem{wxUSE\_NORLANDER\_HEADERS}{Using headers whose author is Anders Norlander.}
4f167b46
VZ
299\twocolitem{wxUSE\_OLE}{Enables OLE helper routines.}
300\twocolitem{wxUSE\_OLE\_AUTOMATION}{Enable OLE automation utilities.}
404e3102
VZ
301\twocolitem{wxUSE\_OLE\_CLIPBOARD}{Use OLE clipboard.}
302\twocolitem{wxUSE\_PENWINDOWS}{See src/msw/penwin.cpp file.}
303\twocolitem{wxUSE\_POSTSCRIPT\_ARCHITECTURE\_IN\_MSW}{Use PS printing in wxMSW.}
304\twocolitem{wxUSE\_PS\_PRINTING}{See src/msw/dcprint.cpp file.}
f77c0fe3 305\twocolitem{wxUSE\_REGKEY}{Use \helpref{wxRegKey}{wxregkey} class.}
404e3102
VZ
306\twocolitem{wxUSE\_RICHEDIT}{Enable use of riched32.dll in \helpref{wxTextCtrl}{wxtextctrl}}
307\twocolitem{wxUSE\_RICHEDIT2}{Enable use of riched20.dll in \helpref{wxTextCtrl}{wxtextctrl}}
308\twocolitem{wxUSE\_VC\_CRTDBG}{See wx/msw/msvcrt.h file.}
309\twocolitem{wxUSE\_UNICODE\_MSLU}{Use MSLU for Unicode support under Windows 9x systems.}
4f167b46 310\twocolitem{wxUSE\_UXTHEME}{Enable support for XP themes.}
404e3102
VZ
311\twocolitem{wxUSE\_WIN\_METAFILES\_ALWAYS}{Use \helpref{wxMetaFile}{wxmetafile} even when wxUSE\_ENH\_METAFILE=$1$.}
312\twocolitem{wxUSE\_WXDIB}{Use wxDIB class.}
4f167b46
VZ
313\twocolitem{wxUSE\_XPM\_IN\_MSW}{See also wxUSE\_XPM}
314\end{twocollist}
404e3102
VZ
315
316\subsection{wxUSE preprocessor symbols used only in wxUniversal}\label{wxusedefuniv}
317\begin{twocollist}\itemsep=0pt
318\twocolitem{wxUSE\_ALL\_THEMES}{Use all themes in wxUniversal; See wx/univ/theme.h file.}
319\twocolitem{wxUSE\_THEME\_GTK}{Use GTK+ 1-like theme in wxUniversal}
320\twocolitem{wxUSE\_THEME\_METAL}{Use GTK+ 2-like theme in wxUniversal}
321\twocolitem{wxUSE\_THEME\_MONO}{Use simple monochrome theme in wxUniversal}
322\twocolitem{wxUSE\_THEME\_WIN32}{Use Win32-like theme in wxUniversal}
323\end{twocollist}