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