Update the date in the manual before 2.9.4 release.

[wxWidgets.git] / docs / doxygen / mainpages / const_wxusedef.h

diff --git a/docs/doxygen/mainpages/const_wxusedef.h b/docs/doxygen/mainpages/const_wxusedef.h
index 39791641a91dddd522d27e090de32b4b6c2827e1..2cbc3639d42408ab8e0de53656da9c405d83c6cf 100644 (file)
--- a/docs/doxygen/mainpages/const_wxusedef.h
+++ b/docs/doxygen/mainpages/const_wxusedef.h
@@ -3,7 +3,7 @@
 // Purpose:     wxUSE preprocessor symbols
 // Author:      Tim Stahlhut
 // RCS-ID:      $Id$
 // Purpose:     wxUSE preprocessor symbols
 // Author:      Tim Stahlhut
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 
 /////////////////////////////////////////////////////////////////////////////
 
 


@@ -18,6 +18,7 @@ active or not depends on their value: if defined as @c 1, feature is active,
 otherwise it is disabled. Because of this these symbols should be always tested
 using @if_ and not @ifdef_.
 
 otherwise it is disabled. Because of this these symbols should be always tested
 using @if_ and not @ifdef_.
 

+@li @ref page_wxusedef_important

 @li @ref page_wxusedef_multi
 @li @ref page_wxusedef_unix
 @li @ref page_wxusedef_x11
 @li @ref page_wxusedef_multi
 @li @ref page_wxusedef_unix
 @li @ref page_wxusedef_x11


@@ -32,6 +33,31 @@ using @if_ and not @ifdef_.
 
 <hr>
 
 
 <hr>
 

+@section page_wxusedef_important Most important wxUSE symbols
+
+This table summarizes some of the global build features affecting the entire
+library:
+
+@beginDefList
+@itemdef{wxUSE_STL, Container classes and wxString are implemented using
+    standard classes and provide the same standard API.}
+@itemdef{wxUSE_STD_STRING, wxString is implemented using std::[w]string and can
+    be constructed from it (but provides wxWidgets-compatible API, in
+    particular is implicitly convertible to @c char* and not std::[w]string).}
+@itemdef{wxUSE_STD_IOSTREAM, Standard C++ classes are used instead of or in
+    addition to wx stream classes.}
+@itemdef{wxUSE_UNICODE, Compiled with Unicode support (default in wxWidgets
+    3.0, non-Unicode build will be deprecated in the future).}
+@itemdef{wxUSE_UNICODE_WCHAR, wxString uses wchar_t buffer for internal storage
+    (default under MSW).}
+@itemdef{wxUSE_UNICODE_UTF8, wxString uses UTF-8 for internal storage (default
+    under Unix and Mac systems).}
+@itemdef{wxUSE_UTF8_LOCALE_ONLY, Library 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.}
+@itemdef{wxUSE_GUI, Use the GUI classes; if set to 0 only non-GUI classes are
+    available.}
+@endDefList

 
 
 @section page_wxusedef_multi Generic wxUSE preprocessor symbols
 
 
 @section page_wxusedef_multi Generic wxUSE preprocessor symbols


@@ -41,6 +67,9 @@ using @if_ and not @ifdef_.
 @itemdef{wxUSE_ACCEL, Use wxAcceleratorTable/Entry classes and support for them in wxMenu, wxMenuBar.}
 @itemdef{wxUSE_AFM_FOR_POSTSCRIPT, In wxPostScriptDC class use AFM (adobe font metrics) file for character widths.}
 @itemdef{wxUSE_ANIMATIONCTRL, Use wxAnimationCtrl class.}
 @itemdef{wxUSE_ACCEL, Use wxAcceleratorTable/Entry classes and support for them in wxMenu, wxMenuBar.}
 @itemdef{wxUSE_AFM_FOR_POSTSCRIPT, In wxPostScriptDC class use AFM (adobe font metrics) file for character widths.}
 @itemdef{wxUSE_ANIMATIONCTRL, Use wxAnimationCtrl class.}

+@itemdef{wxUSE_ARTPROVIDER_STD, Use standard low quality icons in wxArtProvider.}
+@itemdef{wxUSE_ARTPROVIDER_TANGO, Use Tango icons in wxArtProvider.}
+@itemdef{wxUSE_ANY, Use wxAny class.}

 @itemdef{wxUSE_APPLE_IEEE, IEEE Extended to/from double routines; see src/common/extended.c file.}
 @itemdef{wxUSE_ARCHIVE_STREAMS, Enable streams for archive formats.}
 @itemdef{wxUSE_AUI, Use AUI (dockable windows) library.}
 @itemdef{wxUSE_APPLE_IEEE, IEEE Extended to/from double routines; see src/common/extended.c file.}
 @itemdef{wxUSE_ARCHIVE_STREAMS, Enable streams for archive formats.}
 @itemdef{wxUSE_AUI, Use AUI (dockable windows) library.}


@@ -63,16 +92,18 @@ using @if_ and not @ifdef_.
 @itemdef{wxUSE_COLOURPICKERCTRL, Use wxColourPickerCtrl class.}
 @itemdef{wxUSE_COMBOBOX, Use wxComboBox class.}
 @itemdef{wxUSE_COMBOCTRL, Use wxComboCtrl class.}
 @itemdef{wxUSE_COLOURPICKERCTRL, Use wxColourPickerCtrl class.}
 @itemdef{wxUSE_COMBOBOX, Use wxComboBox class.}
 @itemdef{wxUSE_COMBOCTRL, Use wxComboCtrl class.}

+@itemdef{wxUSE_COMPILER_TLS, Can be set to 0 to prevent using compile thread-specific variables support.}

 @itemdef{wxUSE_CONFIG, Use wxConfig and related classes.}
 @itemdef{wxUSE_CONFIG_NATIVE, When enabled use native OS configuration instead of the wxFileConfig class.}
 @itemdef{wxUSE_CONSOLE_EVENTLOOP, Enable event loop in console programs.}
 @itemdef{wxUSE_CONSTRAINTS, Use wxLayoutConstraints}
 @itemdef{wxUSE_CONFIG, Use wxConfig and related classes.}
 @itemdef{wxUSE_CONFIG_NATIVE, When enabled use native OS configuration instead of the wxFileConfig class.}
 @itemdef{wxUSE_CONSOLE_EVENTLOOP, Enable event loop in console programs.}
 @itemdef{wxUSE_CONSTRAINTS, Use wxLayoutConstraints}

-@itemdef{wxUSE_CONTROLS, If set to $0$, no classes deriving from wxControl can be used.}
+@itemdef{wxUSE_CONTROLS, If set to 0, no classes deriving from wxControl can be used.}

 @itemdef{wxUSE_DATAOBJ, Use wxDataObject and related classes.}
 @itemdef{wxUSE_DATAVIEWCTRL, Use wxDataViewCtrl class.}
 @itemdef{wxUSE_DATEPICKCTRL, Use wxDatePickerCtrl class.}
 @itemdef{wxUSE_DATETIME, Use wxDateTime and related classes.}
 @itemdef{wxUSE_DBGHELP, Use wxDbgHelpDLL class.}
 @itemdef{wxUSE_DATAOBJ, Use wxDataObject and related classes.}
 @itemdef{wxUSE_DATAVIEWCTRL, Use wxDataViewCtrl class.}
 @itemdef{wxUSE_DATEPICKCTRL, Use wxDatePickerCtrl class.}
 @itemdef{wxUSE_DATETIME, Use wxDateTime and related classes.}
 @itemdef{wxUSE_DBGHELP, Use wxDbgHelpDLL class.}

+@itemdef{wxUSE_DC_TRANSFORM_MATRIX, Use wxDC::SetTransformMatrix() and related methods.}

 @itemdef{wxUSE_DEBUG_CONTEXT, Use wxDebugContext class.}
 @itemdef{wxUSE_DEBUG_NEW_ALWAYS, See @ref overview_debugging}
 @itemdef{wxUSE_DEBUGREPORT, Use wxDebugReport class.}
 @itemdef{wxUSE_DEBUG_CONTEXT, Use wxDebugContext class.}
 @itemdef{wxUSE_DEBUG_NEW_ALWAYS, See @ref overview_debugging}
 @itemdef{wxUSE_DEBUGREPORT, Use wxDebugReport class.}


@@ -108,13 +139,13 @@ using @if_ and not @ifdef_.
 @itemdef{wxUSE_GAUGE, Use wxGauge class.}
 @itemdef{wxUSE_GENERIC_DRAGIMAGE, Used in wxDragImage sample.}
 @itemdef{wxUSE_GENERIC_DRAWELLIPSE, See comment in wx/dc.h file.}
 @itemdef{wxUSE_GAUGE, Use wxGauge class.}
 @itemdef{wxUSE_GENERIC_DRAGIMAGE, Used in wxDragImage sample.}
 @itemdef{wxUSE_GENERIC_DRAWELLIPSE, See comment in wx/dc.h file.}

+@itemdef{wxUSE_GENERIC_MDI_AS_NATIVE, This is not a user-settable symbol, it is only used internally in wx/generic/mdig.h.}

 @itemdef{wxUSE_GEOMETRY, Use common geometry classes}
 @itemdef{wxUSE_GIF, Use GIF wxImageHandler}
 @itemdef{wxUSE_GLCANVAS, Enables OpenGL support.}
 @itemdef{wxUSE_GLOBAL_MEMORY_OPERATORS, Override global operators @c new and @c delete to use wxWidgets memory leak detection}
 @itemdef{wxUSE_GRAPHICS_CONTEXT, Use wxGraphicsContext and related classes.}
 @itemdef{wxUSE_GRID, Use wxGrid and related classes.}
 @itemdef{wxUSE_GEOMETRY, Use common geometry classes}
 @itemdef{wxUSE_GIF, Use GIF wxImageHandler}
 @itemdef{wxUSE_GLCANVAS, Enables OpenGL support.}
 @itemdef{wxUSE_GLOBAL_MEMORY_OPERATORS, Override global operators @c new and @c delete to use wxWidgets memory leak detection}
 @itemdef{wxUSE_GRAPHICS_CONTEXT, Use wxGraphicsContext and related classes.}
 @itemdef{wxUSE_GRID, Use wxGrid and related classes.}

-@itemdef{wxUSE_GUI, Use the GUI classes; if set to $0$ only non-GUI classes are available.}

 @itemdef{wxUSE_HELP, Use wxHelpController and related classes.}
 @itemdef{wxUSE_HTML, Use wxHtmlWindow and related classes.}
 @itemdef{wxUSE_HYPERLINKCTRL, Use wxHyperlinkCtrl}
 @itemdef{wxUSE_HELP, Use wxHelpController and related classes.}
 @itemdef{wxUSE_HTML, Use wxHtmlWindow and related classes.}
 @itemdef{wxUSE_HYPERLINKCTRL, Use wxHyperlinkCtrl}


@@ -141,6 +172,7 @@ using @if_ and not @ifdef_.
 @itemdef{wxUSE_LONGLONG, Use wxLongLong class.}
 @itemdef{wxUSE_LONGLONG_NATIVE, Use native <tt>long long</tt> type in wxLongLong implementation.}
 @itemdef{wxUSE_LONGLONG_WX, Use generic wxLongLong implementation.}
 @itemdef{wxUSE_LONGLONG, Use wxLongLong class.}
 @itemdef{wxUSE_LONGLONG_NATIVE, Use native <tt>long long</tt> type in wxLongLong implementation.}
 @itemdef{wxUSE_LONGLONG_WX, Use generic wxLongLong implementation.}

+@itemdef{wxUSE_MARKUP, Provide wxControl::SetLabelMarkup() method.}

 @itemdef{wxUSE_MDI, Use wxMDIParentFrame, and wxMDIChildFrame}
 @itemdef{wxUSE_MDI_ARCHITECTURE, Use MDI-based document-view classes.}
 @itemdef{wxUSE_MEDIACTRL, Use wxMediaCtrl.}
 @itemdef{wxUSE_MDI, Use wxMDIParentFrame, and wxMDIChildFrame}
 @itemdef{wxUSE_MDI_ARCHITECTURE, Use MDI-based document-view classes.}
 @itemdef{wxUSE_MEDIACTRL, Use wxMediaCtrl.}


@@ -166,6 +198,7 @@ using @if_ and not @ifdef_.
 @itemdef{wxUSE_PRINTF_POS_PARAMS, Use wxVsnprintf which supports positional parameters.}
 @itemdef{wxUSE_PRINTING_ARCHITECTURE, Enable printer classes.}
 @itemdef{wxUSE_PROGRESSDLG, Enables progress dialog classes.}
 @itemdef{wxUSE_PRINTF_POS_PARAMS, Use wxVsnprintf which supports positional parameters.}
 @itemdef{wxUSE_PRINTING_ARCHITECTURE, Enable printer classes.}
 @itemdef{wxUSE_PROGRESSDLG, Enables progress dialog classes.}

+@itemdef{wxUSE_PROPGRID, Use wxPropertyGrid library.}

 @itemdef{wxUSE_PROTOCOL, Use wxProtocol and derived classes.}
 @itemdef{wxUSE_PROTOCOL_FILE, Use wxFileProto class. (requires wxProtocol)}
 @itemdef{wxUSE_PROTOCOL_FTP, Use wxFTP class. (requires wxProtocol)}
 @itemdef{wxUSE_PROTOCOL, Use wxProtocol and derived classes.}
 @itemdef{wxUSE_PROTOCOL_FILE, Use wxFileProto class. (requires wxProtocol)}
 @itemdef{wxUSE_PROTOCOL_FTP, Use wxFTP class. (requires wxProtocol)}


@@ -196,10 +229,7 @@ using @if_ and not @ifdef_.
 @itemdef{wxUSE_STATTEXT, Use wxStaticText class.}
 @itemdef{wxUSE_STATUSBAR, Use wxStatusBar class.}
 @itemdef{wxUSE_STC, Use wxStyledTextCtrl.}
 @itemdef{wxUSE_STATTEXT, Use wxStaticText class.}
 @itemdef{wxUSE_STATUSBAR, Use wxStatusBar class.}
 @itemdef{wxUSE_STC, Use wxStyledTextCtrl.}

-@itemdef{wxUSE_STD_IOSTREAM, Use standard C++ stream classes.}
-@itemdef{wxUSE_STD_STRING, Use standard C++ string classes.}

 @itemdef{wxUSE_STDPATHS, Use wxStandardPaths class.}
 @itemdef{wxUSE_STDPATHS, Use wxStandardPaths class.}

-@itemdef{wxUSE_STL, Use Standard Template Library for the container classes and wxString implementation.}

 @itemdef{wxUSE_STOPWATCH, Use wxStopWatch class.}
 @itemdef{wxUSE_STREAMS, Enable stream classes.}
 @itemdef{wxUSE_SVG, Use wxSVGFileDC class.}
 @itemdef{wxUSE_STOPWATCH, Use wxStopWatch class.}
 @itemdef{wxUSE_STREAMS, Enable stream classes.}
 @itemdef{wxUSE_SVG, Use wxSVGFileDC class.}


@@ -222,15 +252,13 @@ using @if_ and not @ifdef_.
 @itemdef{wxUSE_TOOLTIPS, Use wxToolTip class.}
 @itemdef{wxUSE_TREEBOOK, Use wxTreebook class.}
 @itemdef{wxUSE_TREECTRL, Use wxTreeCtrl class.}
 @itemdef{wxUSE_TOOLTIPS, Use wxToolTip class.}
 @itemdef{wxUSE_TREEBOOK, Use wxTreebook class.}
 @itemdef{wxUSE_TREECTRL, Use wxTreeCtrl class.}

+@itemdef{wxUSE_TREELISTCTRL, Use wxTreeListCtrl class.}

 @itemdef{wxUSE_TTM_WINDOWFROMPOINT, Obsolete, do not use.}
 @itemdef{wxUSE_TTM_WINDOWFROMPOINT, Obsolete, do not use.}

-@itemdef{wxUSE_UNICODE, Compiled with Unicode support.}
-@itemdef{wxUSE_UNICODE_UTF8, Compiled with UTF8 support.}
-@itemdef{wxUSE_UNICODE_WCHAR, Compiled with Unicode support and using wchar_t type.}

 @itemdef{wxUSE_URL, Use wxURL class.}
 @itemdef{wxUSE_URL_NATIVE, Use native support for some operations with wxURL.}
 @itemdef{wxUSE_URL, Use wxURL class.}
 @itemdef{wxUSE_URL_NATIVE, Use native support for some operations with wxURL.}

-@itemdef{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.}

 @itemdef{wxUSE_VALIDATORS, Use wxValidator class.}
 @itemdef{wxUSE_VARIANT, Use wxVariant class.}
 @itemdef{wxUSE_VALIDATORS, Use wxValidator class.}
 @itemdef{wxUSE_VARIANT, Use wxVariant class.}

+@itemdef{wxUSE_WEBVIEW, Use wxWebView class.}

 @itemdef{wxUSE_WIZARDDLG, Use wxWizard class.}
 @itemdef{wxUSE_WXHTML_HELP, Use wxHtmlHelpController and related classes.}
 @itemdef{wxUSE_XML, Use XML parsing classes.}
 @itemdef{wxUSE_WIZARDDLG, Use wxWizard class.}
 @itemdef{wxUSE_WXHTML_HELP, Use wxHtmlHelpController and related classes.}
 @itemdef{wxUSE_XML, Use XML parsing classes.}


@@ -275,9 +303,9 @@ using @if_ and not @ifdef_.
 @section page_wxusedef_mac wxUSE preprocessor symbols used only in wxMac port
 
 @beginDefList
 @section page_wxusedef_mac wxUSE preprocessor symbols used only in wxMac port
 
 @beginDefList

-@itemdef{wxUSE_MAC_CRITICAL_REGION_MUTEX, See src/mac/carbon/thread.cpp file.}
-@itemdef{wxUSE_MAC_PTHREADS_MUTEX, See src/mac/carbon/thread.cpp file.}
-@itemdef{wxUSE_MAC_SEMAPHORE_MUTEX, See src/mac/carbon/thread.cpp file.}
+@itemdef{wxUSE_MAC_CRITICAL_REGION_MUTEX, See src/osx/carbon/thread.cpp file.}
+@itemdef{wxUSE_MAC_PTHREADS_MUTEX, See src/osx/carbon/thread.cpp file.}
+@itemdef{wxUSE_MAC_SEMAPHORE_MUTEX, See src/osx/carbon/thread.cpp file.}

 @itemdef{wxUSE_WEBKIT, Use wxWebKitCtrl class.}
 @endDefList
 
 @itemdef{wxUSE_WEBKIT, Use wxWebKitCtrl class.}
 @endDefList
 


@@ -320,7 +348,6 @@ using @if_ and not @ifdef_.
 @itemdef{wxUSE_CRASHREPORT, Use wxCrashReport class.}
 @itemdef{wxUSE_DATEPICKCTRL_GENERIC, Use generic wxDatePickerCtrl implementation in addition to the native one.}
 @itemdef{wxUSE_DC_CACHEING, cache temporary wxDC objects.}
 @itemdef{wxUSE_CRASHREPORT, Use wxCrashReport class.}
 @itemdef{wxUSE_DATEPICKCTRL_GENERIC, Use generic wxDatePickerCtrl implementation in addition to the native one.}
 @itemdef{wxUSE_DC_CACHEING, cache temporary wxDC objects.}

-@itemdef{wxUSE_DIRECTDRAW, Enable use of the system include file ddraw.h.}

 @itemdef{wxUSE_DDE_FOR_IPC, See wx/ipc.h file.}
 @itemdef{wxUSE_ENH_METAFILE, Use wxEnhMetaFile.}
 @itemdef{wxUSE_HOTKEY, Use wxWindow::RegisterHotKey() and wxWindow::UnregisterHotKey}
 @itemdef{wxUSE_DDE_FOR_IPC, See wx/ipc.h file.}
 @itemdef{wxUSE_ENH_METAFILE, Use wxEnhMetaFile.}
 @itemdef{wxUSE_HOTKEY, Use wxWindow::RegisterHotKey() and wxWindow::UnregisterHotKey}


@@ -340,7 +367,7 @@ using @if_ and not @ifdef_.
 @itemdef{wxUSE_VC_CRTDBG, See wx/msw/msvcrt.h file.}
 @itemdef{wxUSE_UNICODE_MSLU, Use MSLU for Unicode support under Windows 9x systems.}
 @itemdef{wxUSE_UXTHEME, Enable support for XP themes.}
 @itemdef{wxUSE_VC_CRTDBG, See wx/msw/msvcrt.h file.}
 @itemdef{wxUSE_UNICODE_MSLU, Use MSLU for Unicode support under Windows 9x systems.}
 @itemdef{wxUSE_UXTHEME, Enable support for XP themes.}

-@itemdef{wxUSE_WIN_METAFILES_ALWAYS, Use wxMetaFile even when wxUSE_ENH_METAFILE=$1$.}
+@itemdef{wxUSE_WIN_METAFILES_ALWAYS, Use wxMetaFile even when wxUSE_ENH_METAFILE=1.}

 @itemdef{wxUSE_WXDIB, Use wxDIB class.}
 @itemdef{wxUSE_XPM_IN_MSW, See also wxUSE_XPM}
 @endDefList
 @itemdef{wxUSE_WXDIB, Use wxDIB class.}
 @itemdef{wxUSE_XPM_IN_MSW, See also wxUSE_XPM}
 @endDefList


@@ -356,4 +383,4 @@ using @if_ and not @ifdef_.
 @itemdef{wxUSE_THEME_WIN32, Use Win32-like theme in wxUniversal}
 @endDefList
 
 @itemdef{wxUSE_THEME_WIN32, Use Win32-like theme in wxUniversal}
 @endDefList
 

-*/
\ No newline at end of file
+*/