X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/73e54eb489b9f7b0379f5cf1f788516059054073..65baafba0e8cd74f2264b7e2f7625ff5bea84864:/docs/latex/wx/cppconst.tex

diff --git a/docs/latex/wx/cppconst.tex b/docs/latex/wx/cppconst.tex
index d751a0c154..9891f0a1c7 100644
--- a/docs/latex/wx/cppconst.tex
+++ b/docs/latex/wx/cppconst.tex
@@ -1,7 +1,10 @@
 \section{Preprocesser symbols defined by wxWidgets}\label{cppconst}
 
-Here is the list of preprocessor symbols used in the wxWidgets source grouped
-by category (and sorted by alphabetical order inside each category).
+These are preprocessor symbols used in the wxWidgets source, grouped
+by category (and sorted by alphabetical order inside each category). All of
+these macros except for the \texttt{wxUSE\_XXX} variety is defined if the
+corresponding condition is true and undefined if it isn't, so they should be
+always tested using \texttt{#ifdef} and not \texttt{#if}.
 
 \subsection{GUI system}\label{guisystemconst}
 
@@ -10,7 +13,8 @@ by category (and sorted by alphabetical order inside each category).
 \twocolitem{\_\_WIN16\_\_}{Win16 API (not supported since wxWidgets 2.6)}
 \twocolitem{\_\_WIN32\_\_}{Win32 API}
 \twocolitem{\_\_WIN95\_\_}{Windows 95 or NT 4.0 and above system (not NT 3.5x)}
-\twocolitem{\_\_WXBASE\_\_}{Only wxBase, no GUI features}
+\twocolitem{\_\_WXBASE\_\_}{Only wxBase, no GUI features (same as \texttt{wxUSE\_GUI} $== 0$)}
+\twocolitem{\_\_WXCOCOA\_\_}{OS X using Cocoa API}
 \twocolitem{\_\_WXWINCE\_\_}{Windows CE}
 \twocolitem{\_\_WXGTK\_\_}{GTK+}
 \twocolitem{\_\_WXGTK12\_\_}{GTK+ 1.2 or higher}
@@ -20,11 +24,13 @@ by category (and sorted by alphabetical order inside each category).
 \twocolitem{\_\_WXMAC\_\_}{Mac OS all targets}
 \twocolitem{\_\_WXMAC\_CLASSIC\_\_}{MacOS for Classic}
 \twocolitem{\_\_WXMAC\_CARBON\_\_}{MacOS for Carbon CFM (running under Classic or OSX) or true OS X Mach-O Builds}
-\twocolitem{\_\_WXMAC\_OSX\_\_}{MacOS X Mach-O Builds}
+\twocolitem{\_\_WXMAC\_OSX\_\_}{MacOS X Carbon Mach-O Builds}
 \twocolitem{\_\_WXMGL\_\_}{SciTech Soft MGL (\_\_WXUNIVERSAL\_\_ will be also
 defined)}
 \twocolitem{\_\_WXMSW\_\_}{Any Windows}
 \twocolitem{\_\_WXOS2\_\_}{Identical to \_\_WXPM\_\_}
+\twocolitem{\_\_WXOSX\_\_}{Any Mac OS X port (either Carbon or Cocoa)}
+\twocolitem{\_\_WXPALMOS\_\_}{PalmOS}
 \twocolitem{\_\_WXPM\_\_}{OS/2 native Presentation Manager}
 \twocolitem{\_\_WXSTUBS\_\_}{Stubbed version ('template' wxWin implementation)}
 \twocolitem{\_\_WXXT\_\_}{Xt; mutually exclusive with WX\_MOTIF, not
@@ -36,8 +42,24 @@ to one of the symbols above so this should be tested first.}
 \twocolitem{\_\_X\_\_}{any X11-based GUI toolkit except GTK+}
 \end{twocollist}
 
-In fact, they should better all start with \_\_WX instead of \_\_ only,
-so please start any new defines with \_\_WX.
+There are two wxWidgets ports to Mac OS. One of them, wxMac, exists in two versions: Classic and
+Carbon. The Classic version is the only one to work on Mac OS version 8. The
+Carbon version may be built either as CFM or Mach-O (binary format, like ELF)
+and the former may run under OS 9 while the latter only runs under OS X.
+Finally, there is a new Cocoa port which can only be used under OS X. To
+summarize:
+
+\begin{itemize}
+\item If you want to test for all Mac platforms, classic and OS X, you
+should test both \texttt{\_\_WXMAC\_\_} and \texttt{\_\_WXCOCOA\_\_}.
+\item If you want to test for any GUI Mac port under OS X, use 
+\texttt{\_\_WXOSX\_\_}.
+\item If you want to test for any port under Mac OS X, including, for
+example, wxGTK and also wxBase, use \texttt{\_\_DARWIN\_\_} (see below).
+\end{itemize}
+
+The convention is to use the \texttt{\_\_WX} prefix for these
+symbols, although this has not always been followed.
 
 \subsection{Operating systems}\label{osconst}
 
@@ -55,6 +77,7 @@ so please start any new defines with \_\_WX.
 \twocolitem{\_\_LINUX\_\_}{Linux}
 \twocolitem{\_\_MACH\_\_}{Mach-O Architecture (Mac OS X only builds)}
 \twocolitem{\_\_OSF\_\_}{OSF/1}
+\twocolitem{\_\_PALMOS\_\_}{PalmOS}
 \twocolitem{\_\_SGI\_\_}{IRIX}
 \twocolitem{\_\_SOLARIS\_\_}{Solaris}
 \twocolitem{\_\_SUN\_\_}{Any Sun}
@@ -68,6 +91,7 @@ so please start any new defines with \_\_WX.
 \twocolitem{\_\_WINDOWS\_\_}{any Windows}
 \end{twocollist}
 
+
 \subsection{Hardware architectures (CPU)}\label{cpuconst}
 
 Note that not all of these symbols are always defined, it depends on the
@@ -76,22 +100,24 @@ compiler used.
 \begin{twocollist}\itemsep=0pt
 \twocolitem{\_\_ALPHA\_\_}{DEC Alpha architecture}
 \twocolitem{\_\_INTEL\_\_}{Intel i386 or compatible}
+\twocolitem{\_\_IA64\_\_}{Intel 64 bit architecture}
 \twocolitem{\_\_POWERPC\_\_}{Motorola Power PC}
 \end{twocollist}
 
-\subsection{Hardware type}\label{hardwareconst}
 
-Combination of these symbols with GUI symbols describes real hardware
-(like \_\_PDA\_\_ $&&$ \_\_WXWINCE\_\_ $==$ PocketPC devices).
+\subsection{Hardware type}\label{hardwareconst}
 
 \begin{twocollist}\itemsep=0pt
-\twocolitem{\_\_SMARTPHONE\_\_}{Mobile devices with dialog capability through 
-phone buttons and small display}
-\twocolitem{\_\_PDA\_\_}{Personal digital assistant usually with touch screen and
-middle sized screen}
-\twocolitem{\_\_HANDHELD\_\_}{Small enough but powerful computer}
+\twocolitem{\_\_SMARTPHONE\_\_}{Generic mobile devices with phone buttons and a small display}
+\twocolitem{\_\_PDA\_\_}{Personal digital assistant, usually with touch screen}
+\twocolitem{\_\_HANDHELD\_\_}{Small but powerful computer, usually with a keyboard}
+\twocolitem{\_\_POCKETPC\_\_}{Microsoft-powered PocketPC devices with touch-screen}
+\twocolitem{\_\_WINCE\_STANDARDSDK\_\_}{Microsoft-powered Windows CE devices, for generic Windows CE applications}
+\twocolitem{\_\_WINCE\_NET\_\_}{Microsoft-powered Windows CE .NET devices (\_WIN32\_WCE is 400 or greater)}
+\twocolitem{WIN32\_PLATFORM\_WFSP}{Microsoft-powered smartphone}
 \end{twocollist}
 
+
 \subsection{Compilers}\label{compilerconst}
 
 \begin{twocollist}\itemsep=0pt
@@ -117,6 +143,7 @@ the compiler version, $1100$ is $11.0$ and $1200$ is OpenWatcom.}
 \twocolitem{\_WIN32\_WCE}{Windows CE version}
 \end{twocollist}
 
+
 \subsection{Miscellaneous}\label{miscellaneousconst}
 
 \begin{twocollist}\itemsep=0pt
@@ -126,11 +153,26 @@ also \helpref{wxCHECK\_VERSION}{wxcheckversion}}
 \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{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
+them explicitly. However if this is not defined, you do need to include them
+and so the usual idiom which allows to support both cases is to first include 
+\texttt{wx/wxprec.h} and then, inside \texttt{#ifndef WX\_PRECOMP}, individual
+headers you need.}
+\twocolitem{\_UNICODE and UNICODE}{both are defined if wxUSE\_UNICODE is set to $1$}
 \twocolitem{wxUSE\_GUI}{this particular feature test macro is defined to $1$
 when compiling or using the library with the GUI features activated, if it is
 defined as $0$, only wxBase is available.}
 \twocolitem{wxUSE\_BASE}{only used by wxWidgets internally (defined as $1$ when
 building wxBase code, either as a standalone library or as part of the
 monolithic wxWidgets library, defined as $0$ when building GUI library only)}
+\twocolitem{wxNO\_RTTI}{is defined if the compiler RTTI support has been switched off}
+\twocolitem{wxNO\_EXCEPTIONS}{is defined if the compiler support for C++
+exceptions has been switched off}
+\twocolitem{wxNO\_THREADS}{if this macro is defined, the compilation options
+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.}
 \end{twocollist}