]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/cppconst.tex
added init.cpp
[wxWidgets.git] / docs / latex / wx / cppconst.tex
CommitLineData
14aea4f9
VZ
1\section{Preprocesser symbols defined by wxWindows}\label{cppconst}
2
3Here is the list of preprocessor symbols used in the wxWindows source grouped
4by category (and sorted by alphabetical order inside each category).
5
6\subsection{GUI system}
7
8\begin{twocollist}\itemsep=0pt
9\twocolitem{\_\_WINDOWS\_\_}{any Windows, yom may also use \_\_WXMSW\_\_}
e2478fde 10\twocolitem{\_\_WIN16\_\_}{Win16 API (not supported since wxWindows 2.6)}
14aea4f9
VZ
11\twocolitem{\_\_WIN32\_\_}{Win32 API}
12\twocolitem{\_\_WIN95\_\_}{Windows 95 or NT 4.0 and above system (not NT 3.5x)}
13\twocolitem{\_\_WXGTK\_\_}{GTK}
14\twocolitem{\_\_WXGTK12\_\_}{GTK 1.2 or higher}
15\twocolitem{\_\_WXGTK20\_\_}{GTK 2.0 or higher}
16\twocolitem{\_\_WXMOTIF\_\_}{Motif}
65ed0182 17\twocolitem{\_\_WXMOTIF20\_\_}{Motif 2.0 or higher}
e2478fde
VZ
18\twocolitem{\_\_WXMAC\_\_}{Mac OS whether Classic (Mac OS 8/9 TARGET\_CARBON
19== 0) or Carbon (including Mac OS X TARGET\_CARBON == 1)}
14aea4f9
VZ
20\twocolitem{\_\_WXMGL\_\_}{SciTech Soft MGL (\_\_WXUNIVERSAL\_\_ will be also
21defined)}
22\twocolitem{\_\_WXMSW\_\_}{Any Windows}
23\twocolitem{\_\_WXOS2\_\_}{Identical to \_\_WXPM\_\_}
24\twocolitem{\_\_WXPM\_\_}{OS/2 native Presentation Manager}
25\twocolitem{\_\_WXSTUBS\_\_}{Stubbed version ('template' wxWin implementation)}
26\twocolitem{\_\_WXXT\_\_}{Xt; mutually exclusive with WX\_MOTIF, not
27implemented in wxWindows 2.x}
28\twocolitem{\_\_WXX11\_\_}{wxX11 (\_\_WXUNIVERSAL\_\_ will be also defined)}
29\twocolitem{\_\_WXWINE\_\_}{WINE (i.e. Win32 on Unix)}
30\twocolitem{\_\_WXUNIVERSAL\_\_}{wxUniversal port, always defined in addition
31to one of the symbols above so this should be tested first.}
32\twocolitem{\_\_X\_\_}{any X11-based GUI toolkit except GTK+}
33\end{twocollist}
34
e2478fde
VZ
35In fact, they should better all start with \_\_WX instead of \_\_ only,
36so please start any new defines with \_\_WX.
14aea4f9
VZ
37
38\subsection{Operating systems}
39
40\begin{twocollist}\itemsep=0pt
41\twocolitem{\_\_APPLE\_\_}{any Mac OS version}
42\twocolitem{\_\_AIX\_\_}{AIX}
43\twocolitem{\_\_BSD\_\_}{Any *BSD system}
44\twocolitem{\_\_CYGWIN\_\_}{Cygwin: Unix on Win32}
0211e0d5 45\twocolitem{\_\_DARWIN\_\_}{Mac OS X using the BSD Unix C library (as opposed to using the Metrowerks MSL C/C++ library)}
14aea4f9
VZ
46\twocolitem{\_\_DATA\_GENERAL\_\_}{DG-UX}
47\twocolitem{\_\_DOS\_GENERAL\_\_}{DOS (used with wxMGL only)}
48\twocolitem{\_\_FREEBSD\_\_}{FreeBSD}
49\twocolitem{\_\_HPUX\_\_}{HP-UX (Unix)}
e2478fde 50\twocolitem{\_\_GNU\_\_}{GNU Hurd}
14aea4f9 51\twocolitem{\_\_LINUX\_\_}{Linux}
ab83849c 52\twocolitem{\_\_MACH\_\_}{Mach-O Architecture (Mac OS X only builds)}
14aea4f9
VZ
53\twocolitem{\_\_OSF\_\_}{OSF/1}
54\twocolitem{\_\_SGI\_\_}{IRIX}
55\twocolitem{\_\_SOLARIS\_\_}{Solaris}
56\twocolitem{\_\_SUN\_\_}{Any Sun}
57\twocolitem{\_\_SUNOS\_\_}{Sun OS}
58\twocolitem{\_\_SVR4\_\_}{SystemV R4}
59\twocolitem{\_\_SYSV\_\_}{SystemV generic}
60\twocolitem{\_\_ULTRIX\_\_}{Ultrix}
61\twocolitem{\_\_UNIX\_\_}{any Unix}
62\twocolitem{\_\_UNIX\_LIKE\_\_}{Unix, BeOS or VMS}
63\twocolitem{\_\_VMS\_\_}{VMS}
64\twocolitem{\_\_WINDOWS\_\_}{any Windows}
65\end{twocollist}
66
67\subsection{Hardware architectures}
68
69Note that not all of these symbols are always defined, it depends on the
70compiler used.
71
72\begin{twocollist}\itemsep=0pt
73\twocolitem{\_\_ALPHA\_\_}{DEC Alpha architecture}
74\twocolitem{\_\_INTEL\_\_}{Intel i386 or compatible}
75\twocolitem{\_\_POWERPC\_\_}{Motorola Power PC}
76\end{twocollist}
77
78\subsection{Compilers}
79
80\begin{twocollist}\itemsep=0pt
14347204
VZ
81\twocolitem{\_\_BORLANDC\_\_}{Borland C++. The value of the macro corresponds
82to the compiler version: $500$ is $5.0$.}
14aea4f9 83\twocolitem{\_\_DJGPP\_\_}{DJGPP}
14347204
VZ
84\twocolitem{\_\_GNUG\_\_}{Gnu C++ on any platform, see also
85\helpref{wxCHECK\_GCC\_VERSION}{wxcheckgccversion}}
86\twocolitem{\_\_GNUWIN32\_\_}{Gnu-Win32 compiler, see also
87\helpref{wxCHECK\_W32API\_VERSION}{wxcheckw32apiversion}}
14aea4f9
VZ
88\twocolitem{\_\_MWERKS\_\_}{CodeWarrior MetroWerks compiler}
89\twocolitem{\_\_SUNCC\_\_}{Sun CC}
90\twocolitem{\_\_SYMANTECC\_\_}{Symantec C++}
91\twocolitem{\_\_VISAGECPP\_\_}{IBM Visual Age (OS/2)}
14347204
VZ
92\twocolitem{\_\_VISUALC\_\_}{Microsoft Visual C++. The value of this macro
93corresponds to the compiler version: $1020$ for $4.2$ (the first supported
94version), $1100$ for $5.0$, $1200$ for $6.0$ and so on}
14aea4f9 95\twocolitem{\_\_XLC\_\_}{AIX compiler}
14347204
VZ
96\twocolitem{\_\_WATCOMC\_\_}{Watcom C++. The value of this macro corresponds to
97the compiler version, $1100$ is $11.0$ and $1200$ is OpenWatcom.}
14aea4f9
VZ
98\end{twocollist}
99
100\subsection{Miscellaneous}
101
102\begin{twocollist}\itemsep=0pt
e2478fde
VZ
103\twocolitem{\_\_WXWINDOWS\_\_}{always defined in wxWindows applications, see
104also \helpref{wxCHECK\_VERSION}{wxcheckversion}}
105\twocolitem{\_\_WXBASE\_\_}{only used by wxWindows internally (defined when
106building wxBase code, either as a standalone library or as part of the
107monolithis wxWindows library, not defined when building GUI library only)}
14aea4f9
VZ
108\twocolitem{\_\_WXDEBUG\_\_}{defined in debug mode, undefined in release mode}
109\twocolitem{wxUSE\_XXX}{if defined as $1$, feature XXX is active
bf43ff9a 110(the symbols of this form are always defined, use \#if and not \#ifdef to test
14aea4f9
VZ
111 for them)}
112\end{twocollist}
113