projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| 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 | ||
| 13 | This section documents the wxUSE preprocessor symbols used in the wxWidgets | |
| 14 | source, grouped by category (and sorted by alphabetical order inside each | |
| 15 | category). These symbols are always defined and whether the given feature is | |
| 16 | active or not depends on their value: if defined as $1$, feature is active, | |
| 17 | otherwise it is disabled. Because of this these symbols should be always tested | |
| 18 | using \texttt{#if} and not \texttt{#ifdef}. | |
| 19 | ||
| 20 | \subsection{Generic wxUSE preprocessor symbols}\label{\helpref{wxusedefmulti}{wxusedefmulti}} | |
| 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.} | |
| 26 | \twocolitem{wxUSE\_AUI}{Use AUI (dockable windows) library.} | |
| 27 | \twocolitem{wxUSE\_BASE64}{Enables Base64 support.} | |
| 28 | \twocolitem{wxUSE\_BITMAPCOMBOBOX}{} | |
| 29 | \twocolitem{wxUSE\_BMPBUTTON}{Use \helpref{wxBitmapButton}{wxbitmapbutton} class.} | |
| 30 | \twocolitem{wxUSE\_BUSYINFO}{Use \helpref{wxBusyInfo}{wxbusyinfo} class.} | |
| 31 | \twocolitem{wxUSE\_BUTTON}{Use \helpref{wxButton}{wxbutton} class.} | |
| 32 | \twocolitem{wxUSE\_CALENDARCTRL}{Use \helpref{wxCalendarCtrl}{wxcalendarctrl} class.} | |
| 33 | \twocolitem{wxUSE\_CARET}{Use \helpref{wxCaret}{wxcaret} class.} | |
| 34 | \twocolitem{wxUSE\_CHECKBOX}{Use \helpref{wxCheckBox}{wxcheckbox} class.} | |
| 35 | \twocolitem{wxUSE\_CHECKLISTBOX}{Use \helpref{wxCheckListBox}{wxchecklistbox} class.} | |
| 36 | \twocolitem{wxUSE\_CHOICE}{Use \helpref{wxChoice}{wxchoice} class.} | |
| 37 | \twocolitem{wxUSE\_CHOICEBOOK}{Use \helpref{wxChoicebook}{wxchoicebook} class.} | |
| 38 | \twocolitem{wxUSE\_CHOICEDLG}{Use \helpref{wxSingleChoiceDialog}{wxsinglechoicedialog} or \helpref{wxMultiChoiceDialog}{wxmultichoicedialog} classes.} | |
| 39 | \twocolitem{wxUSE\_CLIPBOARD}{Use \helpref{wxClipboard}{wxclipboard} class.} | |
| 40 | \twocolitem{wxUSE\_COLLPANE}{Use \helpref{wxCollapsiblePane}{wxcollapsiblepane} class.} | |
| 41 | \twocolitem{wxUSE\_COLOURDLG}{Use \helpref{wxColourDialog}{wxcolourdialog} class.} | |
| 42 | \twocolitem{wxUSE\_COLOURPICKERCTRL}{Use \helpref{wxColourPickerCtrl}{wxcolourpickerctrl} class.} | |
| 43 | \twocolitem{wxUSE\_COMBOBOX}{Use \helpref{wxComboBox}{wxcombobox} class.} | |
| 44 | \twocolitem{wxUSE\_COMBOCTRL}{Use \helpref{wxComboCtrl}{wxcomboctrl} class.} | |
| 45 | \twocolitem{wxUSE\_CONFIG}{Use \helpref{wxConfig}{wxconfigbase} and related classes.} | |
| 46 | \twocolitem{wxUSE\_CONSTRAINTS}{Use \helpref{wxLayoutConstraints}{wxlayoutconstraints}} | |
| 47 | \twocolitem{wxUSE\_CRASHREPORT}{Use wxCrashReport class.} | |
| 48 | \twocolitem{wxUSE\_DATAOBJ}{Use \helpref{wxDataObject}{wxdataobject} and related classes.} | |
| 49 | \twocolitem{wxUSE\_DATAVIEWCTRL}{Use \helpref{wxDataViewCtrl}{wxdataviewctrl} class.} | |
| 50 | \twocolitem{wxUSE\_DATEPICKCTRL}{Use \helpref{wxDatePickerCtrl}{wxdatepickerctrl} class.} | |
| 51 | \twocolitem{wxUSE\_DATETIME}{Use \helpref{wxDateTime}{wxdatetime} and related classes.} | |
| 52 | \twocolitem{wxUSE\_DEBUGREPORT}{Use \helpref{wxDebugReport}{wxdebugreport} class.} | |
| 53 | \twocolitem{wxUSE\_DIRDLG}{Use \helpref{wxDirDialog}{wxdirdialog} class.} | |
| 54 | \twocolitem{wxUSE\_DIRPICKERCTRL}{Use \helpref{wxDirPickerCtrl}{wxdirpickerctrl} class.} | |
| 55 | \twocolitem{wxUSE\_DISPLAY}{Use \helpref{wxDisplay}{wxdisplay} and related classes.} | |
| 56 | \twocolitem{wxUSE\_DOC\_VIEW\_ARCHITECTURE}{Use \helpref{wxDocument}{wxdocument} and related classes.} | |
| 57 | \twocolitem{wxUSE\_DRAGIMAGE}{Use \helpref{wxDragImage}{wxdragimage} class.} | |
| 58 | \twocolitem{wxUSE\_EDITABLELISTBOX}{Use \helpref{wxEditableListBox}{wxeditablelistbox} class.} | |
| 59 | \twocolitem{wxUSE\_EXCEPTIONS}{} | |
| 60 | \twocolitem{wxUSE\_FFILE}{Use \helpref{wxFFile}{wxffile} class.} | |
| 61 | \twocolitem{wxUSE\_FILE}{Use \helpref{wxFile}{wxfile} class.} | |
| 62 | \twocolitem{wxUSE\_FILEDLG}{Use \helpref{wxFileDialog}{wxfiledialog} class.} | |
| 63 | \twocolitem{wxUSE\_FILEPICKERCTRL}{Use \helpref{wxFilePickerCtrl}{wxfilepickerctrl} class.} | |
| 64 | \twocolitem{wxUSE\_FILESYSTEM}{Use \helpref{wxFileSystem}{wxfilesystem} and related classes.} | |
| 65 | \twocolitem{wxUSE\_FINDREPLDLG}{Use \helpref{wxFindReplaceDialog}{wxfindreplacedialog} class.} | |
| 66 | \twocolitem{wxUSE\_FONTDLG}{Use \helpref{wxFontDialog}{wxfontdialog} class.} | |
| 67 | \twocolitem{wxUSE\_FONTMAP}{Use \helpref{wxFontMapper}{wxfontmapper} class.} | |
| 68 | \twocolitem{wxUSE\_FONTPICKERCTRL}{Use \helpref{wxFontPickerCtrl}{wxfontpickerctrl} class.} | |
| 69 | \twocolitem{wxUSE\_FSVOLUME}{Use wxFSVolume class.} | |
| 70 | \twocolitem{wxUSE\_GAUGE}{Use \helpref{wxGauge}{wxgauge} class.} | |
| 71 | \twocolitem{wxUSE\_GEOMETRY}{Use Common Geometry Classes} | |
| 72 | \twocolitem{wxUSE\_GIF}{} | |
| 73 | \twocolitem{wxUSE\_GLCANVAS}{Enables OpenGL support.} | |
| 74 | \twocolitem{wxUSE\_GRID}{Use \helpref{wxGrid}{wxgrid} and related classes.} | |
| 75 | \twocolitem{wxUSE\_GUI}{Use the GUI classes; if set to $0$ only non-GUI classes | |
| 76 | are available.} | |
| 77 | \twocolitem{wxUSE\_HELP}{Use \helpref{wxHelpController}{wxhelpcontroller} and related classes.} | |
| 78 | \twocolitem{wxUSE\_HOTKEY}{} | |
| 79 | \twocolitem{wxUSE\_HTML}{Use \helpref{wxHtmlWindow}{wxhtmlwindow} and related classes.} | |
| 80 | \twocolitem{wxUSE\_HYPERLINKCTRL}{Use \helpref{wxHyperlinkCtrl}{wxhyperlinkctrl}} | |
| 81 | \twocolitem{wxUSE\_IFF}{Enables the \helpref{wxImage}{wximage} handler for Amiga IFF images.} | |
| 82 | \twocolitem{wxUSE\_IMAGE}{Use \helpref{wxImage}{wximage} and related classes.} | |
| 83 | \twocolitem{wxUSE\_IMAGLIST}{Use \helpref{wxImageList}{wximagelist} class.} | |
| 84 | \twocolitem{wxUSE\_INTL}{Use \helpref{wxLocale}{wxlocale} and related classes.} | |
| 85 | \twocolitem{wxUSE\_IOSTREAMH}{Use header <iostream.h> instead of <iostream>.} | |
| 86 | \twocolitem{wxUSE\_IPC}{Use Interprocess communication classes.} | |
| 87 | \twocolitem{wxUSE\_JOYSTICK}{Use \helpref{wxJoystick}{wxjoystick} class.} | |
| 88 | \twocolitem{wxUSE\_LIBJPEG}{Enables JPEG format support (requires libjpeg).} | |
| 89 | \twocolitem{wxUSE\_LIBPNG}{Enables PNG format support (requires libpng). | |
| 90 | Also requires wxUSE\_ZLIB.} | |
| 91 | \twocolitem{wxUSE\_LIBTIFF}{Enables TIFF format support (requires libtiff).} | |
| 92 | \twocolitem{wxUSE\_LISTBOOK}{Use \helpref{wxListbook}{wxlistbook} class.} | |
| 93 | \twocolitem{wxUSE\_LISTBOX}{Use \helpref{wxListBox}{wxlistbox} class.} | |
| 94 | \twocolitem{wxUSE\_LISTCTRL}{Use \helpref{wxListCtrl}{wxlistctrl} class.} | |
| 95 | \twocolitem{wxUSE\_LOG}{Use \helpref{wxLog}{wxlog} and related classes.} | |
| 96 | \twocolitem{wxUSE\_LOGGUI}{Use \helpref{wxLogGui}{wxloggui} class.} | |
| 97 | \twocolitem{wxUSE\_LOGWINDOW}{Use wxLogFrame class.} | |
| 98 | \twocolitem{wxUSE\_LONGLONG}{Use \helpref{wxLongLong}{wxlonglong} class.} | |
| 99 | \twocolitem{wxUSE\_MDI}{} | |
| 100 | \twocolitem{wxUSE\_MDI\_ARCHITECTURE}{} | |
| 101 | \twocolitem{wxUSE\_MEDIACTRL}{Use \helpref{wxMediaCtrl}{wxmediactrl}.} | |
| 102 | \twocolitem{wxUSE\_MENUS}{Use \helpref{wxMenu}{wxmenu} and related classes.} | |
| 103 | \twocolitem{wxUSE\_METAFILE}{Use \helpref{wxMetaFile}{wxmetafile} and related classes.} | |
| 104 | \twocolitem{wxUSE\_MIMETYPE}{Use \helpref{wxFileType}{wxfiletype} class.} | |
| 105 | \twocolitem{wxUSE\_MINIFRAME}{Use \helpref{wxMiniFrame}{wxminiframe} class.} | |
| 106 | \twocolitem{wxUSE\_MOUSEWHEEL}{} | |
| 107 | \twocolitem{wxUSE\_MSGDLG}{Use wxMessageOutput class.} | |
| 108 | \twocolitem{wxUSE\_NOTEBOOK}{Use \helpref{wxNotebook}{wxnotebook} and related classes.} | |
| 109 | \twocolitem{wxUSE\_NUMBERDLG}{Use wxNumberEntryDialog class.} | |
| 110 | \twocolitem{wxUSE\_ODBC}{Use ODBC classes.} | |
| 111 | \twocolitem{wxUSE\_ODCOMBOBOX}{Use \helpref{wxOwnerDrawnComboBox}{wxownerdrawncombobox} class.} | |
| 112 | \twocolitem{wxUSE\_OWNER\_DRAWN}{Use interface for owner-drawn GUI elements.} | |
| 113 | \twocolitem{wxUSE\_PALETTE}{Use \helpref{wxPalette}{wxpalette} and related classes.} | |
| 114 | \twocolitem{wxUSE\_PCX}{Enables \helpref{wxImage}{wximage} PCX handler.} | |
| 115 | \twocolitem{wxUSE\_PNM}{Enables \helpref{wxImage}{wximage} PNM handler.} | |
| 116 | \twocolitem{wxUSE\_POPUPWIN}{Use wxPopupWindow class.} | |
| 117 | \twocolitem{wxUSE\_POSTSCRIPT}{Use wxPostScriptPrinter class.} | |
| 118 | \twocolitem{wxUSE\_PRINTING\_ARCHITECTURE}{Enable printer classes.} | |
| 119 | \twocolitem{wxUSE\_PROGRESSDLG}{Enables progress dialog classes.} | |
| 120 | \twocolitem{wxUSE\_PROTOCOL}{Use \helpref{wxProtocol}{wxprotocol} class.} | |
| 121 | \twocolitem{wxUSE\_RADIOBOX}{Use \helpref{wxRadioBox}{wxradiobox} class.} | |
| 122 | \twocolitem{wxUSE\_RADIOBTN}{Use \helpref{wxRadioButton}{wxradiobutton} class.} | |
| 123 | \twocolitem{wxUSE\_REGEX}{Use \helpref{wxRegEx}{wxregex} class.} | |
| 124 | \twocolitem{wxUSE\_RICHEDIT}{} | |
| 125 | \twocolitem{wxUSE\_RICHTEXT}{Use \helpref{wxRichTextCtrl}{wxrichtextctrl} class.} | |
| 126 | \twocolitem{wxUSE\_SASH}{Use \helpref{wxSashWindow}{wxsashwindow} class.} | |
| 127 | \twocolitem{wxUSE\_SCROLLBAR}{Use \helpref{wxScrollBar}{wxscrollbar} class.} | |
| 128 | \twocolitem{wxUSE\_SEARCHCTRL}{Use \helpref{wxSearchCtrl}{wxsearchctrl} class.} | |
| 129 | \twocolitem{wxUSE\_SLIDER}{Use \helpref{wxSlider}{wxslider} class.} | |
| 130 | \twocolitem{wxUSE\_SOCKETS}{Enables Network address classes.} | |
| 131 | \twocolitem{wxUSE\_SOUND}{Use \helpref{wxSound}{wxsound} class.} | |
| 132 | \twocolitem{wxUSE\_SPINBTN}{Use \helpref{wxSpinButton}{wxspinbutton} class.} | |
| 133 | \twocolitem{wxUSE\_SPINCTRL}{Use \helpref{wxSpinCtrl}{wxspinctrl} class.} | |
| 134 | \twocolitem{wxUSE\_SPLASH}{Use \helpref{wxSplashScreen}{wxsplashscreen} class.} | |
| 135 | \twocolitem{wxUSE\_SPLINES}{} | |
| 136 | \twocolitem{wxUSE\_SPLITTER}{Use \helpref{wxSplitterWindow}{wxsplitterwindow} class.} | |
| 137 | \twocolitem{wxUSE\_STACKWALKER}{Enables \helpref{wxStackWalker}{wxstackwalker} and related classes.} | |
| 138 | \twocolitem{wxUSE\_STATBMP}{Use \helpref{wxStaticBitmap}{wxstaticbitmap} class.} | |
| 139 | \twocolitem{wxUSE\_STATBOX}{Use \helpref{wxStaticBox}{wxstaticbox} class.} | |
| 140 | \twocolitem{wxUSE\_STATLINE}{Use \helpref{wxStaticLine}{wxstaticline} class.} | |
| 141 | \twocolitem{wxUSE\_STATTEXT}{Use \helpref{wxStaticText}{wxstatictext} class.} | |
| 142 | \twocolitem{wxUSE\_STATUSBAR}{Use \helpref{wxStatusBar}{wxstatusbar} class.} | |
| 143 | \twocolitem{wxUSE\_STC}{Use wxStyledTextCtrl.} | |
| 144 | \twocolitem{wxUSE\_STDPATHS}{Use \helpref{wxStandardPaths}{wxstandardpaths} class.} | |
| 145 | \twocolitem{wxUSE\_STL}{Use Standard Template Library for the container classes | |
| 146 | and \helpref{wxString}{wxstring} implementation.} | |
| 147 | \twocolitem{wxUSE\_STOPWATCH}{Use \helpref{wxStopWatch}{wxstopwatch} class.} | |
| 148 | \twocolitem{wxUSE\_STREAMS}{Enable stream classes.} | |
| 149 | \twocolitem{wxUSE\_SVG}{Use wxSVGFileDC class.} | |
| 150 | \twocolitem{wxUSE\_TARSTREAM}{Enable Tar files support.} | |
| 151 | \twocolitem{wxUSE\_TAASKBARICON}{Use \helpref{wxTaskBarIcon}{wxtaskbaricon} class.} | |
| 152 | \twocolitem{wxUSE\_TEXTBUFFER}{Use wxTextBuffer class.} | |
| 153 | \twocolitem{wxUSE\_TEXTCTRL}{Use \helpref{wxTextCtrl}{wxtextctrl} class.} | |
| 154 | \twocolitem{wxUSE\_TEXTDLG}{Use \helpref{wxTextEntryDialog}{wxtextentrydialog} class.} | |
| 155 | \twocolitem{wxUSE\_TEXTFILE}{Use \helpref{wxTextFile}{wxtextfile} class.} | |
| 156 | \twocolitem{wxUSE\_TGA}{Enable \helpref{wxImage}{wximage} TGA handler.} | |
| 157 | \twocolitem{wxUSE\_THREADS}{Use \helpref{wxThread}{wxthread} and related classes.} | |
| 158 | \twocolitem{wxUSE\_TIMER}{Use \helpref{wxTimer}{wxtimer} class.} | |
| 159 | \twocolitem{wxUSE\_TIPWINDOW}{Use \helpref{wxTipWindow}{wxtipwindow} class.} | |
| 160 | \twocolitem{wxUSE\_TOGGLEBTN}{Use \helpref{wxToggleButton}{wxtogglebutton} class.} | |
| 161 | \twocolitem{wxUSE\_TOOLBAR}{Use \helpref{wxToolBar}{wxtoolbar} class.} | |
| 162 | \twocolitem{wxUSE\_TOOLBOOK}{Use \helpref{wxToolbook}{wxtoolbook} class.} | |
| 163 | \twocolitem{wxUSE\_TOOLTIPS}{Use \helpref{wxToolTip}{wxtooltip} class.} | |
| 164 | \twocolitem{wxUSE\_TREEBOOK}{Use \helpref{wxTreebook}{wxtreebook} class.} | |
| 165 | \twocolitem{wxUSE\_TREECTRL}{Use \helpref{wxTreeCtrl}{wxtreectrl} class.} | |
| 166 | \twocolitem{wxUSE\_URL}{Use \helpref{wxURL}{wxurl} class.} | |
| 167 | \twocolitem{wxUSE\_VALIDATORS}{Use \helpref{wxValidator}{wxvalidator} class.} | |
| 168 | \twocolitem{wxUSE\_VARIANT}{Use \helpref{wxVariant}{wxvariant} class.} | |
| 169 | \twocolitem{wxUSE\_WIZARDDLG}{Use \helpref{wxWizard}{wxwizard} class.} | |
| 170 | \twocolitem{wxUSE\_XML}{Use XML parsing classes.} | |
| 171 | \twocolitem{wxUSE\_XPM}{Enable XPM reader for \helpref{wxImage}{wximage} and \helpref{wxBitmap}{wxbitmap} classes.} | |
| 172 | \twocolitem{wxUSE\_XRC}{Use XRC XML-based resource system.} | |
| 173 | \twocolitem{wxUSE\_ZIPSTREAM}{Enable streams for Zip files.} | |
| 174 | \twocolitem{wxUSE\_ZLIB}{Use \helpref{wxZlibInput}{wxzlibinputstream} and | |
| 175 | \helpref{wxZlibOutputStream}{wxzliboutputstream} classes, required by | |
| 176 | wxUSE\_LIBPNG.} | |
| 177 | \end{twocollist} | |
| 178 | ||
| 179 | \subsection{wxUSE preprocessor symbols used only under Unix platforms}\label{\helpref{wxusedefunix}{wxusedefunix}} | |
| 180 | \begin{twocollist}\itemsep=0pt | |
| 181 | \twocolitem{wxUSE\_GSTREAMER}{Use GStreamer library in \helpref{wxMediaCtrl}{wxmediactrl}.} | |
| 182 | \twocolitem{wxUSE\_LIBMSPACK}{Use libmspack library.} | |
| 183 | \end{twocollist} | |
| 184 | ||
| 185 | \subsection{wxUSE preprocessor symbols used only in wxMac port}\label{\helpref{wxusedefmac}{wxusedefmac}} | |
| 186 | \begin{twocollist}\itemsep=0pt | |
| 187 | \twocolitem{wxUSE\_WEBKIT}{Use wxWebKitCtrl class.} | |
| 188 | \end{twocollist} | |
| 189 | ||
| 190 | \subsection{wxUSE preprocessor symbols used only in wxMSW port}\label{\helpref{wxusedefmsw}{wxusedefmsw}} | |
| 191 | \begin{twocollist}\itemsep=0pt | |
| 192 | \twocolitem{wxUSE\_ACCESSIBILITY}{Enable accessibility support} | |
| 193 | \twocolitem{wxUSE\_ACTIVEX}{Use \helpref{wxActiveXContainer}{wxactivexcontainer} and related classes.} | |
| 194 | \twocolitem{wxUSE\_WXDIB}{Use wxDIB class.} | |
| 195 | \twocolitem{wxUSE\_ENH\_METAFILE}{Use wxEnhMetaFile.} | |
| 196 | \twocolitem{wxUSE\_OLE}{Enables OLE helper routines.} | |
| 197 | \twocolitem{wxUSE\_OLE\_AUTOMATION}{Enable OLE automation utilities.} | |
| f77c0fe3 | 198 | \twocolitem{wxUSE\_REGKEY}{Use \helpref{wxRegKey}{wxregkey} class.} |
| 4f167b46 VZ |
199 | \twocolitem{wxUSE\_RICHEDIT2}{Enable use of richtext20.dll in \helpref{wxTextCtrl}{wxtextctrl}} |
| 200 | \twocolitem{wxUSE\_UXTHEME}{Enable support for XP themes.} | |
| 201 | \twocolitem{wxUSE\_XPM\_IN\_MSW}{See also wxUSE\_XPM} | |
| 202 | \end{twocollist} |