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).
   5
   6 \subsection{GUI system}\label{guisystemconst}
   7
   8 \begin{twocollist}\itemsep=0pt
   9 \twocolitem{\_\_WINDOWS\_\_}{any Windows, yom may also use \_\_WXMSW\_\_}
  10 \twocolitem{\_\_WIN16\_\_}{Win16 API (not supported since wxWidgets 2.6)}
  11 \twocolitem{\_\_WIN32\_\_}{Win32 API}
  12 \twocolitem{\_\_WIN95\_\_}{Windows 95 or NT 4.0 and above system (not NT 3.5x)}
  13 \twocolitem{\_\_WXBASE\_\_}{Only wxBase, no GUI features}
  14 \twocolitem{\_\_WXWINCE\_\_}{Windows CE}
  15 \twocolitem{\_\_WXGTK\_\_}{GTK+}
  16 \twocolitem{\_\_WXGTK12\_\_}{GTK+ 1.2 or higher}
  17 \twocolitem{\_\_WXGTK20\_\_}{GTK+ 2.0 or higher}
  18 \twocolitem{\_\_WXMOTIF\_\_}{Motif}
  19 \twocolitem{\_\_WXMOTIF20\_\_}{Motif 2.0 or higher}
  20 \twocolitem{\_\_WXMAC\_\_}{Mac OS all targets}
  21 \twocolitem{\_\_WXMAC\_CLASSIC\_\_}{MacOS for Classic}
  22 \twocolitem{\_\_WXMAC\_CARBON\_\_}{MacOS for Carbon CFM (running under Classic or OSX) or true OS X Mach-O Builds}
  23 \twocolitem{\_\_WXMAC\_OSX\_\_}{MacOS X Mach-O Builds}
  24 \twocolitem{\_\_WXMGL\_\_}{SciTech Soft MGL (\_\_WXUNIVERSAL\_\_ will be also
  25 defined)}
  26 \twocolitem{\_\_WXMSW\_\_}{Any Windows}
  27 \twocolitem{\_\_WXOS2\_\_}{Identical to \_\_WXPM\_\_}
  28 \twocolitem{\_\_WXPM\_\_}{OS/2 native Presentation Manager}
  29 \twocolitem{\_\_WXSTUBS\_\_}{Stubbed version ('template' wxWin implementation)}
  30 \twocolitem{\_\_WXXT\_\_}{Xt; mutually exclusive with WX\_MOTIF, not
  31 implemented in wxWidgets 2.x}
  32 \twocolitem{\_\_WXX11\_\_}{wxX11 (\_\_WXUNIVERSAL\_\_ will be also defined)}
  33 \twocolitem{\_\_WXWINE\_\_}{WINE (i.e. WIN32 on Unix)}
  34 \twocolitem{\_\_WXUNIVERSAL\_\_}{wxUniversal port, always defined in addition
  35 to one of the symbols above so this should be tested first.}
  36 \twocolitem{\_\_X\_\_}{any X11-based GUI toolkit except GTK+}
  37 \end{twocollist}
  38
  39 In fact, they should better all start with \_\_WX instead of \_\_ only,
  40 so please start any new defines with \_\_WX.
  41
  42 \subsection{Operating systems}\label{osconst}
  43
  44 \begin{twocollist}\itemsep=0pt
  45 \twocolitem{\_\_APPLE\_\_}{any Mac OS version}
  46 \twocolitem{\_\_AIX\_\_}{AIX}
  47 \twocolitem{\_\_BSD\_\_}{Any *BSD system}
  48 \twocolitem{\_\_CYGWIN\_\_}{Cygwin: Unix on Win32}
  49 \twocolitem{\_\_DARWIN\_\_}{Mac OS X using the BSD Unix C library (as opposed to using the Metrowerks MSL C/C++ library)}
  50 \twocolitem{\_\_DATA\_GENERAL\_\_}{DG-UX}
  51 \twocolitem{\_\_DOS\_GENERAL\_\_}{DOS (used with wxMGL only)}
  52 \twocolitem{\_\_FREEBSD\_\_}{FreeBSD}
  53 \twocolitem{\_\_HPUX\_\_}{HP-UX (Unix)}
  54 \twocolitem{\_\_GNU\_\_}{GNU Hurd}
  55 \twocolitem{\_\_LINUX\_\_}{Linux}
  56 \twocolitem{\_\_MACH\_\_}{Mach-O Architecture (Mac OS X only builds)}
  57 \twocolitem{\_\_OSF\_\_}{OSF/1}
  58 \twocolitem{\_\_SGI\_\_}{IRIX}
  59 \twocolitem{\_\_SOLARIS\_\_}{Solaris}
  60 \twocolitem{\_\_SUN\_\_}{Any Sun}
  61 \twocolitem{\_\_SUNOS\_\_}{Sun OS}
  62 \twocolitem{\_\_SVR4\_\_}{SystemV R4}
  63 \twocolitem{\_\_SYSV\_\_}{SystemV generic}
  64 \twocolitem{\_\_ULTRIX\_\_}{Ultrix}
  65 \twocolitem{\_\_UNIX\_\_}{any Unix}
  66 \twocolitem{\_\_UNIX\_LIKE\_\_}{Unix, BeOS or VMS}
  67 \twocolitem{\_\_VMS\_\_}{VMS}
  68 \twocolitem{\_\_WINDOWS\_\_}{any Windows}
  69 \end{twocollist}
  70
  71 \subsection{Hardware architectures (CPU)}\label{cpuconst}
  72
  73 Note that not all of these symbols are always defined, it depends on the
  74 compiler used.
  75
  76 \begin{twocollist}\itemsep=0pt
  77 \twocolitem{\_\_ALPHA\_\_}{DEC Alpha architecture}
  78 \twocolitem{\_\_INTEL\_\_}{Intel i386 or compatible}
  79 \twocolitem{\_\_POWERPC\_\_}{Motorola Power PC}
  80 \end{twocollist}
  81
  82 \subsection{Hardware type}\label{hardwareconst}
  83
  84 Combination of these symbols with GUI symbols describes real hardware
  85 (like \_\_PDA\_\_ $&&$ \_\_WXWINCE\_\_ $==$ PocketPC devices).
  86
  87 \begin{twocollist}\itemsep=0pt
  88 \twocolitem{\_\_SMARTPHONE\_\_}{Mobile devices with dialog capability through
  89 phone buttons and small display}
  90 \twocolitem{\_\_PDA\_\_}{Personal digital assistant usually with touch screen and
  91 middle sized screen}
  92 \twocolitem{\_\_HANDHELD\_\_}{Small enough but powerful computer}
  93 \end{twocollist}
  94
  95 \subsection{Compilers}\label{compilerconst}
  96
  97 \begin{twocollist}\itemsep=0pt
  98 \twocolitem{\_\_BORLANDC\_\_}{Borland C++. The value of the macro corresponds
  99 to the compiler version: $500$ is $5.0$.}
 100 \twocolitem{\_\_DJGPP\_\_}{DJGPP}
 101 \twocolitem{\_\_DIGITALMARS\_\_}{Digital Mars}
 102 \twocolitem{\_\_GNUG\_\_}{Gnu C++ on any platform, see also
 103 \helpref{wxCHECK\_GCC\_VERSION}{wxcheckgccversion}}
 104 \twocolitem{\_\_GNUWIN32\_\_}{Gnu-Win32 compiler, see also
 105 \helpref{wxCHECK\_W32API\_VERSION}{wxcheckw32apiversion}}
 106 \twocolitem{\_\_MINGW32\_\_}{MinGW}
 107 \twocolitem{\_\_MWERKS\_\_}{CodeWarrior MetroWerks compiler}
 108 \twocolitem{\_\_SUNCC\_\_}{Sun CC}
 109 \twocolitem{\_\_SYMANTECC\_\_}{Symantec C++}
 110 \twocolitem{\_\_VISAGECPP\_\_}{IBM Visual Age (OS/2)}
 111 \twocolitem{\_\_VISUALC\_\_}{Microsoft Visual C++. The value of this macro
 112 corresponds to the compiler version: $1020$ for $4.2$ (the first supported
 113 version), $1100$ for $5.0$, $1200$ for $6.0$ and so on}
 114 \twocolitem{\_\_XLC\_\_}{AIX compiler}
 115 \twocolitem{\_\_WATCOMC\_\_}{Watcom C++. The value of this macro corresponds to
 116 the compiler version, $1100$ is $11.0$ and $1200$ is OpenWatcom.}
 117 \twocolitem{\_WIN32\_WCE}{Windows CE version}
 118 \end{twocollist}
 119
 120 \subsection{Miscellaneous}\label{miscellaneousconst}
 121
 122 \begin{twocollist}\itemsep=0pt
 123 \twocolitem{\_\_WXWINDOWS\_\_}{always defined in wxWidgets applications, see
 124 also \helpref{wxCHECK\_VERSION}{wxcheckversion}}
 125 \twocolitem{\_\_WXDEBUG\_\_}{defined in debug mode, undefined in release mode}
 126 \twocolitem{wxUSE\_XXX}{if defined as $1$, feature XXX is active
 127 (the symbols of this form are always defined, use \#if and not \#ifdef to test
 128  for them)}
 129 \twocolitem{wxUSE\_GUI}{this particular feature test macro is defined to $1$
 130 when compiling or using the library with the GUI features activated, if it is
 131 defined as $0$, only wxBase is available.}
 132 \twocolitem{wxUSE\_BASE}{only used by wxWidgets internally (defined as $1$ when
 133 building wxBase code, either as a standalone library or as part of the
 134 monolithic wxWidgets library, defined as $0$ when building GUI library only)}
 135 \end{twocollist}
 136