]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/cppconst.tex
Missing parts of wxDateTime - bug #825215.
[wxWidgets.git] / docs / latex / wx / cppconst.tex
1 \section{Preprocesser symbols defined by wxWidgets}\label{cppconst}
2
3 Here is the list of preprocessor symbols used in the wxWidgets source grouped
4 by category (and sorted by alphabetical order inside each category). All of
5 these macros except for \texttt{wxUSE\_XXX} variety is defined if the
6 corresponding condition is true and undefined if it isn't, so they should be
7 always tested usin \texttt{#ifdef} and not \texttt{#if}.
8
9
10 \subsection{GUI system}\label{guisystemconst}
11
12 \begin{twocollist}\itemsep=0pt
13 \twocolitem{\_\_WINDOWS\_\_}{any Windows, yom may also use \_\_WXMSW\_\_}
14 \twocolitem{\_\_WIN16\_\_}{Win16 API (not supported since wxWidgets 2.6)}
15 \twocolitem{\_\_WIN32\_\_}{Win32 API}
16 \twocolitem{\_\_WIN95\_\_}{Windows 95 or NT 4.0 and above system (not NT 3.5x)}
17 \twocolitem{\_\_WXBASE\_\_}{Only wxBase, no GUI features (same as \texttt{wxUSE\_GUI} $== 0$)}
18 \twocolitem{\_\_WXCOCOA\_\_}{OS X using Cocoa API}
19 \twocolitem{\_\_WXWINCE\_\_}{Windows CE}
20 \twocolitem{\_\_WXGTK\_\_}{GTK+}
21 \twocolitem{\_\_WXGTK12\_\_}{GTK+ 1.2 or higher}
22 \twocolitem{\_\_WXGTK20\_\_}{GTK+ 2.0 or higher}
23 \twocolitem{\_\_WXMOTIF\_\_}{Motif}
24 \twocolitem{\_\_WXMOTIF20\_\_}{Motif 2.0 or higher}
25 \twocolitem{\_\_WXMAC\_\_}{Mac OS all targets}
26 \twocolitem{\_\_WXMAC\_CLASSIC\_\_}{MacOS for Classic}
27 \twocolitem{\_\_WXMAC\_CARBON\_\_}{MacOS for Carbon CFM (running under Classic or OSX) or true OS X Mach-O Builds}
28 \twocolitem{\_\_WXMAC\_OSX\_\_}{MacOS X Carbon Mach-O Builds}
29 \twocolitem{\_\_WXMGL\_\_}{SciTech Soft MGL (\_\_WXUNIVERSAL\_\_ will be also
30 defined)}
31 \twocolitem{\_\_WXMSW\_\_}{Any Windows}
32 \twocolitem{\_\_WXOS2\_\_}{Identical to \_\_WXPM\_\_}
33 \twocolitem{\_\_WXOSX\_\_}{Any Mac OS X port (either Carbon or Cocoa)}
34 \twocolitem{\_\_WXPM\_\_}{OS/2 native Presentation Manager}
35 \twocolitem{\_\_WXSTUBS\_\_}{Stubbed version ('template' wxWin implementation)}
36 \twocolitem{\_\_WXXT\_\_}{Xt; mutually exclusive with WX\_MOTIF, not
37 implemented in wxWidgets 2.x}
38 \twocolitem{\_\_WXX11\_\_}{wxX11 (\_\_WXUNIVERSAL\_\_ will be also defined)}
39 \twocolitem{\_\_WXWINE\_\_}{WINE (i.e. WIN32 on Unix)}
40 \twocolitem{\_\_WXUNIVERSAL\_\_}{wxUniversal port, always defined in addition
41 to one of the symbols above so this should be tested first.}
42 \twocolitem{\_\_X\_\_}{any X11-based GUI toolkit except GTK+}
43 \end{twocollist}
44
45 Mac situation is a bit confusing so a few extra words to explain it: there are
46 2 wx ports to Mac OS. One of them, wxMac, exists in 2 versions: Classic and
47 Carbon. The Classic version is the only one to work on Mac OS version 8. The
48 Carbon version may be built either as CFM or Mach-O (binary format, like ELF)
49 and the former may run under OS 9 while the latter only runs under OS X.
50 Finally, there is a new Cocoa port which can only be used under OS X. To
51 summarize:
52 \begin{itemize}
53 \item If you want to test for all Mac platforms, classic and OS X, you
54 should test both \texttt{\_\_WXMAC\_\_} and \texttt{\_\_WXCOCOA\_\_}
55 \item If you want to test for any GUI Mac port under OS X, use
56 \texttt{\_\_WXOSX\_\_}
57 \item If you want to test for any port under Mac OS X, including, for
58 example, wxGTK and also wxBase, use \texttt{\_\_DARWIN\_\_} (see below)
59 \end{itemize}
60
61
62 Note to implementors: although some of the symbols above don't start with
63 \texttt{\_\_WX} prefix, they really should always use it, so please do start
64 any new symbols with it.
65
66
67 \subsection{Operating systems}\label{osconst}
68
69 \begin{twocollist}\itemsep=0pt
70 \twocolitem{\_\_APPLE\_\_}{any Mac OS version}
71 \twocolitem{\_\_AIX\_\_}{AIX}
72 \twocolitem{\_\_BSD\_\_}{Any *BSD system}
73 \twocolitem{\_\_CYGWIN\_\_}{Cygwin: Unix on Win32}
74 \twocolitem{\_\_DARWIN\_\_}{Mac OS X using the BSD Unix C library (as opposed to using the Metrowerks MSL C/C++ library)}
75 \twocolitem{\_\_DATA\_GENERAL\_\_}{DG-UX}
76 \twocolitem{\_\_DOS\_GENERAL\_\_}{DOS (used with wxMGL only)}
77 \twocolitem{\_\_FREEBSD\_\_}{FreeBSD}
78 \twocolitem{\_\_HPUX\_\_}{HP-UX (Unix)}
79 \twocolitem{\_\_GNU\_\_}{GNU Hurd}
80 \twocolitem{\_\_LINUX\_\_}{Linux}
81 \twocolitem{\_\_MACH\_\_}{Mach-O Architecture (Mac OS X only builds)}
82 \twocolitem{\_\_OSF\_\_}{OSF/1}
83 \twocolitem{\_\_SGI\_\_}{IRIX}
84 \twocolitem{\_\_SOLARIS\_\_}{Solaris}
85 \twocolitem{\_\_SUN\_\_}{Any Sun}
86 \twocolitem{\_\_SUNOS\_\_}{Sun OS}
87 \twocolitem{\_\_SVR4\_\_}{SystemV R4}
88 \twocolitem{\_\_SYSV\_\_}{SystemV generic}
89 \twocolitem{\_\_ULTRIX\_\_}{Ultrix}
90 \twocolitem{\_\_UNIX\_\_}{any Unix}
91 \twocolitem{\_\_UNIX\_LIKE\_\_}{Unix, BeOS or VMS}
92 \twocolitem{\_\_VMS\_\_}{VMS}
93 \twocolitem{\_\_WINDOWS\_\_}{any Windows}
94 \end{twocollist}
95
96
97 \subsection{Hardware architectures (CPU)}\label{cpuconst}
98
99 Note that not all of these symbols are always defined, it depends on the
100 compiler used.
101
102 \begin{twocollist}\itemsep=0pt
103 \twocolitem{\_\_ALPHA\_\_}{DEC Alpha architecture}
104 \twocolitem{\_\_INTEL\_\_}{Intel i386 or compatible}
105 \twocolitem{\_\_POWERPC\_\_}{Motorola Power PC}
106 \end{twocollist}
107
108
109 \subsection{Hardware type}\label{hardwareconst}
110
111 Combination of these symbols with GUI symbols describes real hardware
112 (like \_\_PDA\_\_ $&&$ \_\_WXWINCE\_\_ $==$ PocketPC devices).
113
114 \begin{twocollist}\itemsep=0pt
115 \twocolitem{\_\_SMARTPHONE\_\_}{Mobile devices with dialog capability through
116 phone buttons and small display}
117 \twocolitem{\_\_PDA\_\_}{Personal digital assistant usually with touch screen and
118 middle sized screen}
119 \twocolitem{\_\_HANDHELD\_\_}{Small enough but powerful computer}
120 \end{twocollist}
121
122
123 \subsection{Compilers}\label{compilerconst}
124
125 \begin{twocollist}\itemsep=0pt
126 \twocolitem{\_\_BORLANDC\_\_}{Borland C++. The value of the macro corresponds
127 to the compiler version: $500$ is $5.0$.}
128 \twocolitem{\_\_DJGPP\_\_}{DJGPP}
129 \twocolitem{\_\_DIGITALMARS\_\_}{Digital Mars}
130 \twocolitem{\_\_GNUG\_\_}{Gnu C++ on any platform, see also
131 \helpref{wxCHECK\_GCC\_VERSION}{wxcheckgccversion}}
132 \twocolitem{\_\_GNUWIN32\_\_}{Gnu-Win32 compiler, see also
133 \helpref{wxCHECK\_W32API\_VERSION}{wxcheckw32apiversion}}
134 \twocolitem{\_\_MINGW32\_\_}{MinGW}
135 \twocolitem{\_\_MWERKS\_\_}{CodeWarrior MetroWerks compiler}
136 \twocolitem{\_\_SUNCC\_\_}{Sun CC}
137 \twocolitem{\_\_SYMANTECC\_\_}{Symantec C++}
138 \twocolitem{\_\_VISAGECPP\_\_}{IBM Visual Age (OS/2)}
139 \twocolitem{\_\_VISUALC\_\_}{Microsoft Visual C++. The value of this macro
140 corresponds to the compiler version: $1020$ for $4.2$ (the first supported
141 version), $1100$ for $5.0$, $1200$ for $6.0$ and so on}
142 \twocolitem{\_\_XLC\_\_}{AIX compiler}
143 \twocolitem{\_\_WATCOMC\_\_}{Watcom C++. The value of this macro corresponds to
144 the compiler version, $1100$ is $11.0$ and $1200$ is OpenWatcom.}
145 \twocolitem{\_WIN32\_WCE}{Windows CE version}
146 \end{twocollist}
147
148
149 \subsection{Miscellaneous}\label{miscellaneousconst}
150
151 \begin{twocollist}\itemsep=0pt
152 \twocolitem{\_\_WXWINDOWS\_\_}{always defined in wxWidgets applications, see
153 also \helpref{wxCHECK\_VERSION}{wxcheckversion}}
154 \twocolitem{\_\_WXDEBUG\_\_}{defined in debug mode, undefined in release mode}
155 \twocolitem{wxUSE\_XXX}{if defined as $1$, feature XXX is active
156 (the symbols of this form are always defined, use \#if and not \#ifdef to test
157 for them)}
158 \twocolitem{wxUSE\_GUI}{this particular feature test macro is defined to $1$
159 when compiling or using the library with the GUI features activated, if it is
160 defined as $0$, only wxBase is available.}
161 \twocolitem{wxUSE\_BASE}{only used by wxWidgets internally (defined as $1$ when
162 building wxBase code, either as a standalone library or as part of the
163 monolithic wxWidgets library, defined as $0$ when building GUI library only)}
164 \end{twocollist}
165