added copy constr

[wxWidgets.git] / docs / latex / wx / cppconst.tex

diff --git a/docs/latex/wx/cppconst.tex b/docs/latex/wx/cppconst.tex
index 4d63f510debb242911033b5ac3b37416d38748e1..c5c5f51de1b2b01d62ead2a555fa81dac8450dc5 100644 (file)
--- a/docs/latex/wx/cppconst.tex
+++ b/docs/latex/wx/cppconst.tex
@@ -1,11 +1,10 @@
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %% Name:        cppconst.tex
-%% Purpose:     Peprocessor symbols
-%% Author:
-%% Modified by:
-%% Created:
+%% Purpose:     Preprocessor symbols
+%% Author:      Vadim Zeitlin
+%% Created:     2002-08-22
 %% RCS-ID:      $Id$
-%% Copyright:   (c) wxWidgets
+%% Copyright:   (c) 2002-2006 wxWidgets
 %% License:     wxWindows license
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
@@ -20,15 +19,19 @@ always tested using \texttt{#ifdef} and not \texttt{#if}.
 \subsection{GUI system}\label{guisystemconst}
 
 \begin{twocollist}\itemsep=0pt
-\twocolitem{\_\_WINDOWS\_\_}{any Windows, yom may also use \_\_WXMSW\_\_}
+\twocolitem{\_\_WINDOWS\_\_}{any Windows, you may also use \_\_WXMSW\_\_}
 \twocolitem{\_\_WIN16\_\_}{Win16 API (not supported since wxWidgets 2.6)}
 \twocolitem{\_\_WIN32\_\_}{Win32 API}
 \twocolitem{\_\_WXBASE\_\_}{Only wxBase, no GUI features (same as \texttt{wxUSE\_GUI} $== 0$)}
 \twocolitem{\_\_WXCOCOA\_\_}{OS X using Cocoa API}
+\twocolitem{\_\_WXDFB\_\_}{wxUniversal using DirectFB}
 \twocolitem{\_\_WXWINCE\_\_}{Windows CE}
 \twocolitem{\_\_WXGTK\_\_}{GTK+}
 \twocolitem{\_\_WXGTK12\_\_}{GTK+ 1.2 or higher}
 \twocolitem{\_\_WXGTK20\_\_}{GTK+ 2.0 or higher}
+\twocolitem{\_\_WXGTK24\_\_}{GTK+ 2.4 or higher}
+\twocolitem{\_\_WXGTK26\_\_}{GTK+ 2.6 or higher}
+\twocolitem{\_\_WXGTK210\_\_}{GTK+ 2.10 or higher}
 \twocolitem{\_\_WXMOTIF\_\_}{Motif}
 \twocolitem{\_\_WXMOTIF20\_\_}{Motif 2.0 or higher}
 \twocolitem{\_\_WXMAC\_\_}{Mac OS all targets}
@@ -141,7 +144,7 @@ to the compiler version: $500$ is $5.0$.}
 \helpref{wxCHECK\_W32API\_VERSION}{wxcheckw32apiversion}}
 \twocolitem{\_\_MINGW32\_\_}{MinGW}
 \twocolitem{\_\_MWERKS\_\_}{CodeWarrior MetroWerks compiler}
-\twocolitem{\_\_SUNCC\_\_}{Sun CC}
+\twocolitem{\_\_SUNCC\_\_}{Sun CC, see also \helpref{wxCHECK\_SUNCC\_VERSION}{wxchecksunccversion}}
 \twocolitem{\_\_SYMANTECC\_\_}{Symantec C++}
 \twocolitem{\_\_VISAGECPP\_\_}{IBM Visual Age (OS/2)}
 \twocolitem{\_\_VISUALC\_\_}{Microsoft Visual C++. The value of this macro
@@ -154,15 +157,44 @@ the compiler version, $1100$ is $11.0$ and $1200$ is OpenWatcom.}
 \end{twocollist}
 
 
+\subsection{Feature tests}\label{featuretests}
+
+Some library features may not be always available even if they were selected by
+the user. To make it possible to check if this is the case, the library
+predefines the symbols in the form \texttt{wxHAS\_FEATURE}. Unlike 
+\texttt{wxUSE\_FEATURE} symbols which are defined by the library user (directly
+in \texttt{setup.h} or by running configure script) and which must be always
+defined as either $0$ or $1$, the \texttt{wxHAS} symbols are only defined if
+the corresponding feature is available and not defined at all otherwise.
+
+Currently the following symbols exist:
+\begin{twocollist}\itemsep=0pt
+\twocolitem{wxHAS\_LARGE\_FILES}{Defined if \helpref{wxFile}{wxfile} supports
+files more than 4GB in size.}
+\twocolitem{wxHAS\_LARGE\_FFILES}{Defined if \helpref{wxFFile}{wxffile}
+supports files more than 4GB in size.}
+\twocolitem{wxHAS\_POWER\_EVENTS}{Defined if 
+\helpref{wxPowerEvent}{wxpowerevent} are ever generated on the current platform.}
+\twocolitem{wxHAS\_RADIO\_MENU\_ITEMS}{Defined if the current port supports 
+\helpref{radio menu items}{wxmenuappendradioitem}.}
+\twocolitem{wxHAS\_RAW\_KEY\_CODES}{Defined if 
+\helpref{raw key codes}{wxkeyeventgetrawkeycode} are supported.}
+\twocolitem{wxHAS\_REGEX\_ADVANCED}{Defined if advanced syntax is available in 
+\helpref{wxRegEx}{wxregex}.}
+\twocolitem{wxHAS\_TASK\_BAR\_ICON}{Defined if 
+\helpref{wxTaskBarIcon}{wxtaskbaricon} is available on the current platform.}
+\end{twocollist}
+
+
 \subsection{Miscellaneous}\label{miscellaneousconst}
 
 \begin{twocollist}\itemsep=0pt
 \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
@@ -184,4 +216,11 @@ exceptions has been switched off}
 don't include compiler flags needed for multithreaded code generation. This
 implies that wxUSE\_THREADS is $0$ and also that other (non-wx-based) threading
 packages cannot be used neither.}
+\twocolitem{WXMAKINGDLL\_XXX}{used internally and defined when building the
+library \texttt{XXX} as a DLL; when a monolithic wxWidgets build is used only a
+single \texttt{WXMAKINGDLL} symbol is defined}
+\twocolitem{WXUSINGDLL}{defined when compiling code which uses wxWidgets as a
+DLL/shared library}
+\twocolitem{WXBUILDING}{defined when building wxWidgets itself, whether as a
+static or shared library}
 \end{twocollist}