X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/69a126b0c72e4318adb5b1d526f1082d368c7509..dceb1c097c8c24b398f48b482220c358bc7b4db4:/docs/latex/wx/cppconst.tex?ds=sidebyside

diff --git a/docs/latex/wx/cppconst.tex b/docs/latex/wx/cppconst.tex
index c7ec544a5a..91ac999f2b 100644
--- a/docs/latex/wx/cppconst.tex
+++ b/docs/latex/wx/cppconst.tex
@@ -1,32 +1,40 @@
-\section{Preprocesser symbols defined by wxWindows}\label{cppconst}
+\section{Preprocesser symbols defined by wxWidgets}\label{cppconst}
 
-Here is the list of preprocessor symbols used in the wxWindows 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}
+\subsection{GUI system}\label{guisystemconst}
 
 \begin{twocollist}\itemsep=0pt
 \twocolitem{\_\_WINDOWS\_\_}{any Windows, yom may also use \_\_WXMSW\_\_}
-\twocolitem{\_\_WIN16\_\_}{Win16 API (not supported since wxWindows 2.6)}
+\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}
 \twocolitem{\_\_WXGTK20\_\_}{GTK+ 2.0 or higher}
 \twocolitem{\_\_WXMOTIF\_\_}{Motif}
 \twocolitem{\_\_WXMOTIF20\_\_}{Motif 2.0 or higher}
-\twocolitem{\_\_WXMAC\_\_}{Mac OS whether Classic (Mac OS 8/9 TARGET\_CARBON
-== 0) or Carbon (including Mac OS X TARGET\_CARBON == 1)}
+\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 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
-implemented in wxWindows 2.x}
+implemented in wxWidgets 2.x}
 \twocolitem{\_\_WXX11\_\_}{wxX11 (\_\_WXUNIVERSAL\_\_ will be also defined)}
 \twocolitem{\_\_WXWINE\_\_}{WINE (i.e. WIN32 on Unix)}
 \twocolitem{\_\_WXUNIVERSAL\_\_}{wxUniversal port, always defined in addition
@@ -34,10 +42,29 @@ 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.
+Mac situation is a bit confusing so a few extra words to explain it: there are
+2 wx ports to Mac OS. One of them, wxMac, exists in 2 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}
 
-\subsection{Operating systems}
+
+Note to implementors: although some of the symbols above don't start with 
+\texttt{\_\_WX} prefix, they really should always use it, so please do start
+any new symbols with it.
+
+
+\subsection{Operating systems}\label{osconst}
 
 \begin{twocollist}\itemsep=0pt
 \twocolitem{\_\_APPLE\_\_}{any Mac OS version}
@@ -53,6 +80,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}
@@ -66,7 +94,8 @@ so please start any new defines with \_\_WX.
 \twocolitem{\_\_WINDOWS\_\_}{any Windows}
 \end{twocollist}
 
-\subsection{Hardware architectures}
+
+\subsection{Hardware architectures (CPU)}\label{cpuconst}
 
 Note that not all of these symbols are always defined, it depends on the
 compiler used.
@@ -74,10 +103,26 @@ 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{Compilers}
+
+\subsection{Hardware type}\label{hardwareconst}
+
+Combination of these symbols with GUI symbols describes real hardware
+(like \_\_PDA\_\_ $&&$ \_\_WXWINCE\_\_ $==$ PocketPC devices).
+
+\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}
+\end{twocollist}
+
+
+\subsection{Compilers}\label{compilerconst}
 
 \begin{twocollist}\itemsep=0pt
 \twocolitem{\_\_BORLANDC\_\_}{Borland C++. The value of the macro corresponds
@@ -102,10 +147,11 @@ the compiler version, $1100$ is $11.0$ and $1200$ is OpenWatcom.}
 \twocolitem{\_WIN32\_WCE}{Windows CE version}
 \end{twocollist}
 
-\subsection{Miscellaneous}
+
+\subsection{Miscellaneous}\label{miscellaneousconst}
 
 \begin{twocollist}\itemsep=0pt
-\twocolitem{\_\_WXWINDOWS\_\_}{always defined in wxWindows applications, see
+\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
@@ -114,8 +160,8 @@ also \helpref{wxCHECK\_VERSION}{wxcheckversion}}
 \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 wxWindows internally (defined as $1$ when
+\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 wxWindows library, defined as $0$ when building GUI library only)}
+monolithic wxWidgets library, defined as $0$ when building GUI library only)}
 \end{twocollist}