added documentation of wxUSE_XXX symbols (modified patch 1755127)

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@47551 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/docs/latex/wx/constant.tex b/docs/latex/wx/constant.tex
index c70570f0c47f56422b081c4eeae7724506b75cc1..7beaa29d78e8683999321847c36f54dc5b68c8e7 100644 (file)
--- a/docs/latex/wx/constant.tex
+++ b/docs/latex/wx/constant.tex
@@ -5,6 +5,7 @@
 This chapter describes the constants defined by wxWidgets.
 
 \input cppconst.tex
+\input wxusedef.tex
 \input stdevtid.tex
 \input keycode.tex
 \input keymod.tex

diff --git a/docs/latex/wx/cppconst.tex b/docs/latex/wx/cppconst.tex
index cf8528f2037b0d80fa5578e1e01db334b3ab7507..c5c5f51de1b2b01d62ead2a555fa81dac8450dc5 100644 (file)
--- a/docs/latex/wx/cppconst.tex
+++ b/docs/latex/wx/cppconst.tex
@@ -192,9 +192,9 @@ supports files more than 4GB in size.}
 \twocolitem{\_\_WXWINDOWS\_\_}{always defined in wxWidgets applications, see
 also \helpref{wxCHECK\_VERSION}{wxcheckversion}}
 \twocolitem{\_\_WXDEBUG\_\_}{defined in debug mode, undefined in release mode}
-\twocolitem{wxUSE\_XXX}{if defined as $1$, feature XXX is active
-(the symbols of this form are always defined, use \#if and not \#ifdef to test
- for them)}
+\twocolitem{wxUSE\_XXX}{if defined as $1$, feature XXX is active, see the 
+\helpref{complete list}{wxusedef} (the symbols of this form are always defined,
+use \#if and not \#ifdef to test for them)}
 \twocolitem{WX\_PRECOMP}{is defined if precompiled headers (PCH) are in use. In
 this case, \texttt{wx/wxprec.h} includes \texttt{wx/wx.h} which, in turn,
 includes a number of wxWidgets headers thus making it unnecessary to include

diff --git a/docs/latex/wx/wxusedef.tex b/docs/latex/wx/wxusedef.tex
new file mode 100644 (file)
index 0000000..9c452dd
--- /dev/null
+++ b/docs/latex/wx/wxusedef.tex
@@ -0,0 +1,200 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%\r
+%% Name:        wxusedef.tex\r
+%% Purpose:     wxUSE preprocessor symbols\r
+%% Author:      Tim Stahlhut\r
+%% Created:     2007-07-15\r
+%% RCS-ID:      $Id: $\r
+%% Copyright:   (c) 2007 wxWidgets\r
+%% License:     wxWindows license\r
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%\r
+\r
+\section{wxUSE Preprocessor symbols defined by wxWidgets}\label{wxusedef}\r
+\r
+This section documents the wxUSE preprocessor symbols used in the wxWidgets\r
+source, grouped by category (and sorted by alphabetical order inside each\r
+category). These symbols are always defined and whether the given feature is\r
+active or not depends on their value: if defined as $1$, feature is active,\r
+otherwise it is disabled. Because of this these symbols should be always tested\r
+using \texttt{#if} and not \texttt{#ifdef}.\r
+\r
+\subsection{Generic wxUSE preprocessor symbols}\label{\helpref{wxusedefmulti}{wxusedefmulti}}\r
+\r
+\begin{twocollist}\itemsep=0pt\r
+\twocolitem{wxUSE\_ABOUTDLG}{Use \helpref{wxAboutDialogInfo}{wxaboutdialoginfo} class.}\r
+\twocolitem{wxUSE\_ACCEL}{Use \helpref{wxAcceleratorTable}{wxacceleratortable}/Entry classes and support for them in \helpref{wxMenu}{wxmenu}(Bar).}\r
+\twocolitem{wxUSE\_ANIMATIONCTRL}{Use \helpref{wxAnimationCtrl}{wxanimationctrl} class.}\r
+\twocolitem{wxUSE\_AUI}{Use AUI (dockable windows) library.}\r
+\twocolitem{wxUSE\_BASE64}{Enables Base64 support.}\r
+\twocolitem{wxUSE\_BITMAPCOMBOBOX}{}\r
+\twocolitem{wxUSE\_BMPBUTTON}{Use \helpref{wxBitmapButton}{wxbitmapbutton} class.}\r
+\twocolitem{wxUSE\_BUSYINFO}{Use \helpref{wxBusyInfo}{wxbusyinfo} class.}\r
+\twocolitem{wxUSE\_BUTTON}{Use \helpref{wxButton}{wxbutton} class.}\r
+\twocolitem{wxUSE\_CALENDARCTRL}{Use \helpref{wxCalendarCtrl}{wxcalendarctrl} class.}\r
+\twocolitem{wxUSE\_CARET}{Use \helpref{wxCaret}{wxcaret} class.}\r
+\twocolitem{wxUSE\_CHECKBOX}{Use \helpref{wxCheckBox}{wxcheckbox} class.}\r
+\twocolitem{wxUSE\_CHECKLISTBOX}{Use \helpref{wxCheckListBox}{wxchecklistbox} class.}\r
+\twocolitem{wxUSE\_CHOICE}{Use \helpref{wxChoice}{wxchoice} class.}\r
+\twocolitem{wxUSE\_CHOICEBOOK}{Use \helpref{wxChoicebook}{wxchoicebook} class.}\r
+\twocolitem{wxUSE\_CHOICEDLG}{Use \helpref{wxSingleChoiceDialog}{wxsinglechoicedialog} or \helpref{wxMultiChoiceDialog}{wxmultichoicedialog} classes.}\r
+\twocolitem{wxUSE\_CLIPBOARD}{Use \helpref{wxClipboard}{wxclipboard} class.}\r
+\twocolitem{wxUSE\_COLLPANE}{Use \helpref{wxCollapsiblePane}{wxcollapsiblepane} class.}\r
+\twocolitem{wxUSE\_COLOURDLG}{Use \helpref{wxColourDialog}{wxcolourdialog} class.}\r
+\twocolitem{wxUSE\_COLOURPICKERCTRL}{Use \helpref{wxColourPickerCtrl}{wxcolourpickerctrl} class.}\r
+\twocolitem{wxUSE\_COMBOBOX}{Use \helpref{wxComboBox}{wxcombobox} class.}\r
+\twocolitem{wxUSE\_COMBOCTRL}{Use \helpref{wxComboCtrl}{wxcomboctrl} class.}\r
+\twocolitem{wxUSE\_CONFIG}{Use \helpref{wxConfig}{wxconfigbase} and related classes.}\r
+\twocolitem{wxUSE\_CONSTRAINTS}{Use \helpref{wxLayoutConstraints}{wxlayoutconstraints}}\r
+\twocolitem{wxUSE\_CRASHREPORT}{Use wxCrashReport class.}\r
+\twocolitem{wxUSE\_DATAOBJ}{Use \helpref{wxDataObject}{wxdataobject} and related classes.}\r
+\twocolitem{wxUSE\_DATAVIEWCTRL}{Use \helpref{wxDataViewCtrl}{wxdataviewctrl} class.}\r
+\twocolitem{wxUSE\_DATEPICKCTRL}{Use \helpref{wxDatePickerCtrl}{wxdatepickerctrl} class.}\r
+\twocolitem{wxUSE\_DATETIME}{Use \helpref{wxDateTime}{wxdatetime} and related classes.}\r
+\twocolitem{wxUSE\_DEBUGREPORT}{Use \helpref{wxDebugReport}{wxdebugreport} class.}\r
+\twocolitem{wxUSE\_DIRDLG}{Use \helpref{wxDirDialog}{wxdirdialog} class.}\r
+\twocolitem{wxUSE\_DIRPICKERCTRL}{Use \helpref{wxDirPickerCtrl}{wxdirpickerctrl} class.}\r
+\twocolitem{wxUSE\_DISPLAY}{Use \helpref{wxDisplay}{wxdisplay} and related classes.}\r
+\twocolitem{wxUSE\_DOC\_VIEW\_ARCHITECTURE}{Use \helpref{wxDocument}{wxdocument} and related classes.}\r
+\twocolitem{wxUSE\_DRAGIMAGE}{Use \helpref{wxDragImage}{wxdragimage} class.}\r
+\twocolitem{wxUSE\_EDITABLELISTBOX}{Use \helpref{wxEditableListBox}{wxeditablelistbox} class.}\r
+\twocolitem{wxUSE\_EXCEPTIONS}{}\r
+\twocolitem{wxUSE\_FFILE}{Use \helpref{wxFFile}{wxffile} class.}\r
+\twocolitem{wxUSE\_FILE}{Use \helpref{wxFile}{wxfile} class.}\r
+\twocolitem{wxUSE\_FILEDLG}{Use \helpref{wxFileDialog}{wxfiledialog} class.}\r
+\twocolitem{wxUSE\_FILEPICKERCTRL}{Use \helpref{wxFilePickerCtrl}{wxfilepickerctrl} class.}\r
+\twocolitem{wxUSE\_FILESYSTEM}{Use \helpref{wxFileSystem}{wxfilesystem} and related classes.}\r
+\twocolitem{wxUSE\_FINDREPLDLG}{Use \helpref{wxFindReplaceDialog}{wxfindreplacedialog} class.}\r
+\twocolitem{wxUSE\_FONTDLG}{Use \helpref{wxFontDialog}{wxfontdialog} class.}\r
+\twocolitem{wxUSE\_FONTMAP}{Use \helpref{wxFontMapper}{wxfontmapper} class.}\r
+\twocolitem{wxUSE\_FONTPICKERCTRL}{Use \helpref{wxFontPickerCtrl}{wxfontpickerctrl} class.}\r
+\twocolitem{wxUSE\_FSVOLUME}{Use wxFSVolume class.}\r
+\twocolitem{wxUSE\_GAUGE}{Use \helpref{wxGauge}{wxgauge} class.}\r
+\twocolitem{wxUSE\_GEOMETRY}{Use Common Geometry Classes}\r
+\twocolitem{wxUSE\_GIF}{}\r
+\twocolitem{wxUSE\_GLCANVAS}{Enables OpenGL support.}\r
+\twocolitem{wxUSE\_GRID}{Use \helpref{wxGrid}{wxgrid} and related classes.}\r
+\twocolitem{wxUSE\_GUI}{Use the GUI classes; if set to $0$ only non-GUI classes\r
+are available.}\r
+\twocolitem{wxUSE\_HELP}{Use \helpref{wxHelpController}{wxhelpcontroller} and related classes.}\r
+\twocolitem{wxUSE\_HOTKEY}{}\r
+\twocolitem{wxUSE\_HTML}{Use \helpref{wxHtmlWindow}{wxhtmlwindow} and related classes.}\r
+\twocolitem{wxUSE\_HYPERLINKCTRL}{Use \helpref{wxHyperlinkCtrl}{wxhyperlinkctrl}}\r
+\twocolitem{wxUSE\_IFF}{Enables the \helpref{wxImage}{wximage} handler for Amiga IFF images.}\r
+\twocolitem{wxUSE\_IMAGE}{Use \helpref{wxImage}{wximage} and related classes.}\r
+\twocolitem{wxUSE\_IMAGLIST}{Use \helpref{wxImageList}{wximagelist} class.}\r
+\twocolitem{wxUSE\_INTL}{Use \helpref{wxLocale}{wxlocale} and related classes.}\r
+\twocolitem{wxUSE\_IOSTREAMH}{Use header <iostream.h> instead of <iostream>.}\r
+\twocolitem{wxUSE\_IPC}{Use Interprocess communication classes.}\r
+\twocolitem{wxUSE\_JOYSTICK}{Use \helpref{wxJoystick}{wxjoystick} class.}\r
+\twocolitem{wxUSE\_LIBJPEG}{Enables JPEG format support (requires libjpeg).}\r
+\twocolitem{wxUSE\_LIBPNG}{Enables PNG format support (requires libpng). \r
+Also requires wxUSE\_ZLIB.}\r
+\twocolitem{wxUSE\_LIBTIFF}{Enables TIFF format support (requires libtiff).}\r
+\twocolitem{wxUSE\_LISTBOOK}{Use \helpref{wxListbook}{wxlistbook} class.}\r
+\twocolitem{wxUSE\_LISTBOX}{Use \helpref{wxListBox}{wxlistbox} class.}\r
+\twocolitem{wxUSE\_LISTCTRL}{Use \helpref{wxListCtrl}{wxlistctrl} class.}\r
+\twocolitem{wxUSE\_LOG}{Use \helpref{wxLog}{wxlog} and related classes.}\r
+\twocolitem{wxUSE\_LOGGUI}{Use \helpref{wxLogGui}{wxloggui} class.}\r
+\twocolitem{wxUSE\_LOGWINDOW}{Use wxLogFrame class.}\r
+\twocolitem{wxUSE\_LONGLONG}{Use \helpref{wxLongLong}{wxlonglong} class.}\r
+\twocolitem{wxUSE\_MDI}{}\r
+\twocolitem{wxUSE\_MDI\_ARCHITECTURE}{}\r
+\twocolitem{wxUSE\_MEDIACTRL}{Use \helpref{wxMediaCtrl}{wxmediactrl}.}\r
+\twocolitem{wxUSE\_MENUS}{Use \helpref{wxMenu}{wxmenu} and related classes.}\r
+\twocolitem{wxUSE\_METAFILE}{Use \helpref{wxMetaFile}{wxmetafile} and related classes.}\r
+\twocolitem{wxUSE\_MIMETYPE}{Use \helpref{wxFileType}{wxfiletype} class.}\r
+\twocolitem{wxUSE\_MINIFRAME}{Use \helpref{wxMiniFrame}{wxminiframe} class.}\r
+\twocolitem{wxUSE\_MOUSEWHEEL}{}\r
+\twocolitem{wxUSE\_MSGDLG}{Use wxMessageOutput class.}\r
+\twocolitem{wxUSE\_NOTEBOOK}{Use \helpref{wxNotebook}{wxnotebook} and related classes.}\r
+\twocolitem{wxUSE\_NUMBERDLG}{Use wxNumberEntryDialog class.}\r
+\twocolitem{wxUSE\_ODBC}{Use ODBC classes.}\r
+\twocolitem{wxUSE\_ODCOMBOBOX}{Use \helpref{wxOwnerDrawnComboBox}{wxownerdrawncombobox} class.}\r
+\twocolitem{wxUSE\_OWNER\_DRAWN}{Use interface for owner-drawn GUI elements.}\r
+\twocolitem{wxUSE\_PALETTE}{Use \helpref{wxPalette}{wxpalette} and related classes.}\r
+\twocolitem{wxUSE\_PCX}{Enables \helpref{wxImage}{wximage} PCX handler.}\r
+\twocolitem{wxUSE\_PNM}{Enables \helpref{wxImage}{wximage} PNM handler.}\r
+\twocolitem{wxUSE\_POPUPWIN}{Use wxPopupWindow class.}\r
+\twocolitem{wxUSE\_POSTSCRIPT}{Use wxPostScriptPrinter class.}\r
+\twocolitem{wxUSE\_PRINTING\_ARCHITECTURE}{Enable printer classes.}\r
+\twocolitem{wxUSE\_PROGRESSDLG}{Enables progress dialog classes.}\r
+\twocolitem{wxUSE\_PROTOCOL}{Use \helpref{wxProtocol}{wxprotocol} class.}\r
+\twocolitem{wxUSE\_RADIOBOX}{Use \helpref{wxRadioBox}{wxradiobox} class.}\r
+\twocolitem{wxUSE\_RADIOBTN}{Use \helpref{wxRadioButton}{wxradiobutton} class.}\r
+\twocolitem{wxUSE\_REGEX}{Use \helpref{wxRegEx}{wxregex} class.}\r
+\twocolitem{wxUSE\_RICHEDIT}{}\r
+\twocolitem{wxUSE\_RICHTEXT}{Use \helpref{wxRichTextCtrl}{wxrichtextctrl} class.}\r
+\twocolitem{wxUSE\_SASH}{Use \helpref{wxSashWindow}{wxsashwindow} class.}\r
+\twocolitem{wxUSE\_SCROLLBAR}{Use \helpref{wxScrollBar}{wxscrollbar} class.}\r
+\twocolitem{wxUSE\_SEARCHCTRL}{Use \helpref{wxSearchCtrl}{wxsearchctrl} class.}\r
+\twocolitem{wxUSE\_SLIDER}{Use \helpref{wxSlider}{wxslider} class.}\r
+\twocolitem{wxUSE\_SOCKETS}{Enables Network address classes.}\r
+\twocolitem{wxUSE\_SOUND}{Use \helpref{wxSound}{wxsound} class.}\r
+\twocolitem{wxUSE\_SPINBTN}{Use \helpref{wxSpinButton}{wxspinbutton} class.}\r
+\twocolitem{wxUSE\_SPINCTRL}{Use \helpref{wxSpinCtrl}{wxspinctrl} class.}\r
+\twocolitem{wxUSE\_SPLASH}{Use \helpref{wxSplashScreen}{wxsplashscreen} class.}\r
+\twocolitem{wxUSE\_SPLINES}{}\r
+\twocolitem{wxUSE\_SPLITTER}{Use \helpref{wxSplitterWindow}{wxsplitterwindow} class.}\r
+\twocolitem{wxUSE\_STACKWALKER}{Enables \helpref{wxStackWalker}{wxstackwalker} and related classes.}\r
+\twocolitem{wxUSE\_STATBMP}{Use \helpref{wxStaticBitmap}{wxstaticbitmap} class.}\r
+\twocolitem{wxUSE\_STATBOX}{Use \helpref{wxStaticBox}{wxstaticbox} class.}\r
+\twocolitem{wxUSE\_STATLINE}{Use \helpref{wxStaticLine}{wxstaticline} class.}\r
+\twocolitem{wxUSE\_STATTEXT}{Use \helpref{wxStaticText}{wxstatictext} class.}\r
+\twocolitem{wxUSE\_STATUSBAR}{Use \helpref{wxStatusBar}{wxstatusbar} class.}\r
+\twocolitem{wxUSE\_STC}{Use wxStyledTextCtrl.}\r
+\twocolitem{wxUSE\_STDPATHS}{Use \helpref{wxStandardPaths}{wxstandardpaths} class.}\r
+\twocolitem{wxUSE\_STL}{Use Standard Template Library for the container classes\r
+and \helpref{wxString}{wxstring} implementation.}\r
+\twocolitem{wxUSE\_STOPWATCH}{Use \helpref{wxStopWatch}{wxstopwatch} class.}\r
+\twocolitem{wxUSE\_STREAMS}{Enable stream classes.}\r
+\twocolitem{wxUSE\_SVG}{Use wxSVGFileDC class.}\r
+\twocolitem{wxUSE\_TARSTREAM}{Enable Tar files support.}\r
+\twocolitem{wxUSE\_TEXTBUFFER}{Use wxTextBuffer class.}\r
+\twocolitem{wxUSE\_TEXTCTRL}{Use \helpref{wxTextCtrl}{wxtextctrl} class.}\r
+\twocolitem{wxUSE\_TEXTDLG}{Use \helpref{wxTextEntryDialog}{wxtextentrydialog} class.}\r
+\twocolitem{wxUSE\_TEXTFILE}{Use \helpref{wxTextFile}{wxtextfile} class.}\r
+\twocolitem{wxUSE\_TGA}{Enable \helpref{wxImage}{wximage} TGA handler.}\r
+\twocolitem{wxUSE\_THREADS}{Use \helpref{wxThread}{wxthread} and related classes.}\r
+\twocolitem{wxUSE\_TIMER}{Use \helpref{wxTimer}{wxtimer} class.}\r
+\twocolitem{wxUSE\_TIPWINDOW}{Use \helpref{wxTipWindow}{wxtipwindow} class.}\r
+\twocolitem{wxUSE\_TOGGLEBTN}{Use \helpref{wxToggleButton}{wxtogglebutton} class.}\r
+\twocolitem{wxUSE\_TOOLBAR}{Use \helpref{wxToolBar}{wxtoolbar} class.}\r
+\twocolitem{wxUSE\_TOOLBOOK}{Use \helpref{wxToolbook}{wxtoolbook} class.}\r
+\twocolitem{wxUSE\_TOOLTIPS}{Use \helpref{wxToolTip}{wxtooltip} class.}\r
+\twocolitem{wxUSE\_TREEBOOK}{Use \helpref{wxTreebook}{wxtreebook} class.}\r
+\twocolitem{wxUSE\_TREECTRL}{Use \helpref{wxTreeCtrl}{wxtreectrl} class.}\r
+\twocolitem{wxUSE\_URL}{Use \helpref{wxURL}{wxurl} class.}\r
+\twocolitem{wxUSE\_VALIDATORS}{Use \helpref{wxValidator}{wxvalidator} class.}\r
+\twocolitem{wxUSE\_VARIANT}{Use \helpref{wxVariant}{wxvariant} class.}\r
+\twocolitem{wxUSE\_WIZARDDLG}{Use \helpref{wxWizard}{wxwizard} class.}\r
+\twocolitem{wxUSE\_XML}{Use XML parsing classes.}\r
+\twocolitem{wxUSE\_XPM}{Enable XPM reader for \helpref{wxImage}{wximage} and \helpref{wxBitmap}{wxbitmap} classes.}\r
+\twocolitem{wxUSE\_XRC}{Use XRC XML-based resource system.}\r
+\twocolitem{wxUSE\_ZIPSTREAM}{Enable streams for Zip files.}                \r
+\twocolitem{wxUSE\_ZLIB}{Use \helpref{wxZlibInput}{wxzlibinputstream} and\r
+\helpref{wxZlibOutputStream}{wxzliboutputstream} classes, required by\r
+wxUSE\_LIBPNG.}\r
+\end{twocollist}\r
+\r
+\subsection{wxUSE preprocessor symbols used only under Unix platforms}\label{\helpref{wxusedefunix}{wxusedefunix}}\r
+\begin{twocollist}\itemsep=0pt\r
+\twocolitem{wxUSE\_GSTREAMER}{Use GStreamer library in \helpref{wxMediaCtrl}{wxmediactrl}.}\r
+\twocolitem{wxUSE\_LIBMSPACK}{Use libmspack library.}\r
+\end{twocollist}\r
+\r
+\subsection{wxUSE preprocessor symbols used only in wxMac port}\label{\helpref{wxusedefmac}{wxusedefmac}}\r
+\begin{twocollist}\itemsep=0pt\r
+\twocolitem{wxUSE\_WEBKIT}{Use wxWebKitCtrl class.}\r
+\end{twocollist}\r
+\r
+\subsection{wxUSE preprocessor symbols used only in wxMSW port}\label{\helpref{wxusedefmsw}{wxusedefmsw}}\r
+\begin{twocollist}\itemsep=0pt\r
+\twocolitem{wxUSE\_ACCESSIBILITY}{Enable accessibility support}\r
+\twocolitem{wxUSE\_ACTIVEX}{Use \helpref{wxActiveXContainer}{wxactivexcontainer} and related classes.}\r
+\twocolitem{wxUSE\_WXDIB}{Use wxDIB class.}\r
+\twocolitem{wxUSE\_ENH\_METAFILE}{Use wxEnhMetaFile.}\r
+\twocolitem{wxUSE\_OLE}{Enables OLE helper routines.}\r
+\twocolitem{wxUSE\_OLE\_AUTOMATION}{Enable OLE automation utilities.}\r
+\twocolitem{wxUSE\_RICHEDIT2}{Enable use of richtext20.dll in \helpref{wxTextCtrl}{wxtextctrl}}\r
+\twocolitem{wxUSE\_UXTHEME}{Enable support for XP themes.}\r
+\twocolitem{wxUSE\_XPM\_IN\_MSW}{See also wxUSE\_XPM}\r
+\end{twocollist}\r