X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/928f1a076c97a28d27cf03fa04af1131e173c188..5b526f4b85cd56f606db0a4f39b68ea2fad86076:/docs/doxygen/mainpages/const_cpp.h diff --git a/docs/doxygen/mainpages/const_cpp.h b/docs/doxygen/mainpages/const_cpp.h index 90cdaf6414..2581eda5b3 100644 --- a/docs/doxygen/mainpages/const_cpp.h +++ b/docs/doxygen/mainpages/const_cpp.h @@ -3,39 +3,29 @@ // Purpose: Preprocessor symbols // Author: Vadim Zeitlin // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** -@page page_cppconst Preprocessor symbols defined by wxWidgets +@page page_cppconst Preprocessor Symbols -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 @c wxUSE_XXX variety is defined if the -corresponding condition is @true and undefined if it isn't, so they should be -always tested using @ifdef_ and not @if_. +@tableofcontents -@li @ref page_cppconst_guisystem -@li @ref page_cppconst_os -@li @ref page_cppconst_cpu -@li @ref page_cppconst_hardware -@li @ref page_cppconst_compiler -@li @ref page_cppconst_featuretests -@li @ref page_cppconst_miscellaneous +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 @c wxUSE_XXX variety is defined if the corresponding +condition is @true and undefined if it isn't, so they should be always tested +using @ifdef_ and not @if_. -
@section page_cppconst_guisystem GUI system @beginDefList -@itemdef{__WINDOWS__, any Windows, you may also use __WXMSW__} -@itemdef{__WIN16__, Win16 API (not supported since wxWidgets 2.6)} -@itemdef{__WIN32__, Win32 API} -@itemdef{__WXBASE__, Only wxBase, no GUI features (same as @c wxUSE_GUI $== 0$)} -@itemdef{__WXCOCOA__, OS X using Cocoa API} +@itemdef{__WXBASE__, Only wxBase, no GUI features (same as @c wxUSE_GUI == 0)} +@itemdef{__WXCOCOA__, OS X using wxCocoa Port} @itemdef{__WXDFB__, wxUniversal using DirectFB} @itemdef{__WXWINCE__, Windows CE} @itemdef{__WXGTK__, GTK+} @@ -44,17 +34,17 @@ always tested using @ifdef_ and not @if_. @itemdef{__WXGTK24__, GTK+ 2.4 or higher} @itemdef{__WXGTK26__, GTK+ 2.6 or higher} @itemdef{__WXGTK210__, GTK+ 2.10 or higher} +@itemdef{__WXMAC__, old define, same as @c __WXOSX__} @itemdef{__WXMOTIF__, Motif} @itemdef{__WXMOTIF20__, Motif 2.0 or higher} -@itemdef{__WXMAC__, Mac OS all targets} -@itemdef{__WXMAC_CLASSIC__, MacOS for Classic} -@itemdef{__WXMAC_CARBON__, MacOS for Carbon CFM (running under Classic or OSX) - or true OS X Mach-O Builds} -@itemdef{__WXMAC_OSX__, MacOS X Carbon Mach-O Builds} -@itemdef{__WXMGL__, SciTech Soft MGL (__WXUNIVERSAL__ will be also defined)} -@itemdef{__WXMSW__, Any Windows} -@itemdef{__WXOSX__, Any Mac OS X port (either Carbon or Cocoa)} -@itemdef{__WXPALMOS__, PalmOS} +@itemdef{__WXMSW__, GUI using Windows Controls} +@itemdef{__WXOSX__, OS X GUI using any Apple widget framework (Carbon, AppKit or UIKit)} +@itemdef{__WXOSX_IPHONE__, OS X iPhone (UIKit)} +@itemdef{__WXOSX_CARBON__, Mac OS X using Carbon} +@itemdef{__WXOSX_COCOA__, Mac OS X using Cocoa (AppKit)} +@itemdef{__WXOSX_MAC__, Mac OS X (Carbon or Cocoa)} +@itemdef{__WXOSX_OR_COCOA__, Any Mac OS X port (wxOSX-Carbon, wxOSX-Cocoa or + wxCocoa)} @itemdef{__WXPM__, OS/2 native Presentation Manager} @itemdef{__WXSTUBS__, Stubbed version ('template' wxWin implementation)} @itemdef{__WXXT__, Xt; mutually exclusive with WX_MOTIF, not implemented in wxWidgets 2.x} @@ -65,17 +55,17 @@ always tested using @ifdef_ and not @if_. @itemdef{__X__, any X11-based GUI toolkit except GTK+} @endDefList -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: +There are two wxWidgets ports to Mac OS X. One of them, wxOSX is the successor of the +venerable wxMac, it currently exists in three versions: Carbon and Cocoa for the +desktop and a very early iPhone port. And there is the Cocoa port named wxCocoa +which has not been updated very actively since beginning 2008. To summarize: -@li If you want to test for all Mac platforms, classic and OS X, you - should test both @c __WXMAC__ and @c __WXCOCOA__. +@li If you want to test for wxOSX on the desktop, use + @c __WXOSX_MAC__. +@li If you want to test for wxOSX on the iPhone, use + @c __WXOSX_IPHONE__. @li If you want to test for any GUI Mac port under OS X, use - @c __WXOSX__. + @c __WXOSX_OR_COCOA__. @li If you want to test for any port under Mac OS X, including, for example, wxGTK and also wxBase, use @c __DARWIN__ (see below). @@ -83,24 +73,23 @@ The convention is to use the @c __WX prefix for these symbols, although this has not always been followed. -@section page_cppconst_os Operating systems + +@section page_cppconst_os Operating Systems @beginDefList @itemdef{__APPLE__, any Mac OS version} @itemdef{__AIX__, AIX} @itemdef{__BSD__, Any *BSD system} @itemdef{__CYGWIN__, Cygwin: Unix on Win32} -@itemdef{__DARWIN__, Mac OS X using the BSD Unix C library - (as opposed to using the Metrowerks MSL C/C++ library)} +@itemdef{__DARWIN__, Mac OS X (with BSD C library), using any port (see also @c __WXOSX__)} @itemdef{__DATA_GENERAL__, DG-UX} -@itemdef{__DOS_GENERAL__, DOS (used with wxMGL only)} @itemdef{__FREEBSD__, FreeBSD} @itemdef{__HPUX__, HP-UX (Unix)} @itemdef{__GNU__, GNU Hurd} @itemdef{__LINUX__, Linux} @itemdef{__MACH__, Mach-O Architecture (Mac OS X only builds)} @itemdef{__OSF__, OSF/1} -@itemdef{__PALMOS__, PalmOS} +@itemdef{__QNX__, QNX Neutrino RTOS} @itemdef{__SGI__, IRIX} @itemdef{__SOLARIS__, Solaris} @itemdef{__SUN__, Any Sun} @@ -111,13 +100,17 @@ symbols, although this has not always been followed. @itemdef{__UNIX__, any Unix} @itemdef{__UNIX_LIKE__, Unix, BeOS or VMS} @itemdef{__VMS__, VMS} -@itemdef{__WINDOWS__, any Windows} +@itemdef{__WINDOWS__, Any Windows platform, using any port (see also @c __WXMSW__)} +@itemdef{__WIN16__, Win16 API (not supported since wxWidgets 2.6)} +@itemdef{__WIN32__, Win32 API} +@itemdef{__WIN64__, Win64 (mostly same as Win32 but data type sizes are different)} @itemdef{__WINE__, Wine} +@itemdef{_WIN32_WCE, Windows CE version} @endDefList -@section page_cppconst_cpu Hardware architectures (CPU) +@section page_cppconst_cpu Hardware Architectures (CPU) Note that not all of these symbols are always defined, it depends on the compiler used. @@ -131,7 +124,7 @@ compiler used. -@section page_cppconst_hardware Hardware type +@section page_cppconst_hardware Hardware Type @beginDefList @itemdef{__SMARTPHONE__, Generic mobile devices with phone buttons and a small display} @@ -149,49 +142,74 @@ compiler used. @beginDefList @itemdef{__BORLANDC__, Borland C++. The value of the macro corresponds - to the compiler version: $500$ is $5.0$.} + to the compiler version: 500 is 5.0.} @itemdef{__DJGPP__, DJGPP} @itemdef{__DIGITALMARS__, Digital Mars} +@itemdef{__EVC4__, Embedded Visual C++ 4 (can be only used for building wxWinCE)} @itemdef{__GNUG__, Gnu C++ on any platform, see also wxCHECK_GCC_VERSION} @itemdef{__GNUWIN32__, Gnu-Win32 compiler, see also wxCHECK_W32API_VERSION} @itemdef{__MINGW32__, MinGW} -@itemdef{__MWERKS__, CodeWarrior MetroWerks compiler} @itemdef{__SUNCC__, Sun CC, see also wxCHECK_SUNCC_VERSION} @itemdef{__SYMANTECC__, Symantec C++} @itemdef{__VISAGECPP__, IBM Visual Age (OS/2)} -@itemdef{__VISUALC__, Microsoft Visual C++, see also wxCHECK_VISUALC_VERSION. +@itemdef{__VISUALC__, Microsoft Visual C++, see also ::wxCHECK_VISUALC_VERSION. The value of this macro corresponds to the compiler version: @c 1020 for @c 4.2 (the first supported version), @c 1100 for @c 5.0, @c 1200 for @c 6.0 and so on. For convenience, the symbols __VISUALCn__ are also defined for each major compiler version from - 5 to 9, i.e. you can use tests such @ifdef_ __VISUALC7__ to test + 5 to 11, i.e. you can use tests such @ifdef_ __VISUALC7__ to test for compiler version being precisely 7.} @itemdef{__XLC__, AIX compiler} @itemdef{__WATCOMC__, Watcom C++. The value of this macro corresponds to the compiler version, @c 1100 is @c 11.0 and @c 1200 is OpenWatcom.} -@itemdef{_WIN32_WCE, Windows CE version} @endDefList -@section page_cppconst_featuretests Feature tests +@section page_cppconst_featuretests Feature Tests Some library features may not be always available even if they were selected by the user. To make it possible to check if this is the case, the library predefines the symbols in the form @c wxHAS_FEATURE. Unlike @c wxUSE_FEATURE symbols which are defined by the library user (directly in @c setup.h or by running configure script) and which must be always -defined as either $0$ or $1$, the @c wxHAS symbols are only defined if +defined as either 0 or 1, the @c wxHAS symbols are only defined if the corresponding feature is available and not defined at all otherwise. Currently the following symbols exist: @beginDefList -@itemdef{wxHAS_LARGE_FILES, Defined if wxFile supports files more than 4GB in size.} -@itemdef{wxHAS_LARGE_FFILES, Defined if wxFFile supports files more than 4GB in size.} +@itemdef{wxHAS_3STATE_CHECKBOX, Defined if wxCheckBox supports wxCHK_3STATE + flag, i.e. is capable of showing three states and not only the usual two. + Currently defined for almost all ports.} +@itemdef{wxHAS_ATOMIC_OPS, Defined if wxAtomicInc() and wxAtomicDec() functions + have an efficient (CPU-specific) implementation. Notice that the functions + themselves are always available but can be prohibitively slow to use when + implemented in a generic way, using a critical section.} +@itemdef{wxHAS_BITMAPTOGGLEBUTTON, Defined in @c wx/tglbtn.h if + wxBitmapToggleButton class is available in addition to wxToggleButton.} +@itemdef{wxHAS_CONFIG_TEMPLATE_RW, Defined if the currently used compiler + supports template Read() and Write() methods in wxConfig.} +@itemdef{wxHAS_LARGE_FILES, Defined if wxFile supports files more than 4GB in + size (notice that you must include @c wx/filefn.h before testing for this + symbol).} +@itemdef{wxHAS_LARGE_FFILES, Defined if wxFFile supports files more than 4GB in + size (notice that you must include @c wx/filefn.h before testing for this + symbol).} +@itemdef{wxHAS_LONG_LONG_T_DIFFERENT_FROM_LONG, Defined if compiler supports a + 64 bit integer type (available as @c wxLongLong_t) and this type is + different from long. Notice that, provided wxUSE_LONGLONG is not turned + off, some 64 bit type is always available to wxWidgets programs and this + symbol only indicates a presence of such primitive type. It is useful to + decide whether some function should be overloaded for both + long and long long types.} +@itemdef{wxHAS_MULTIPLE_FILEDLG_FILTERS, Defined if wxFileDialog supports multiple ('|'-separated) filters.} +@itemdef{wxHAS_IMAGES_IN_RESOURCES, Defined if + Windows resource files or OS/2 resource files are available on the current platform.} @itemdef{wxHAS_POWER_EVENTS, Defined if wxPowerEvent are ever generated on the current platform.} @itemdef{wxHAS_RADIO_MENU_ITEMS, Defined if the current port supports radio menu items (see wxMenu::AppendRadioItem).} +@itemdef{wxHAS_RAW_BITMAP, Defined if direct access to bitmap data using the classes in @c wx/rawbmp.h is supported.} @itemdef{wxHAS_RAW_KEY_CODES, Defined if raw key codes (see wxKeyEvent::GetRawKeyCode are supported.} @itemdef{wxHAS_REGEX_ADVANCED, Defined if advanced syntax is available in wxRegEx.} @itemdef{wxHAS_TASK_BAR_ICON, Defined if wxTaskBarIcon is available on the current platform.} @@ -199,14 +217,49 @@ Currently the following symbols exist: +@section page_cppconst_msvc_setup_h Library Selection for MSVC + +Microsoft Visual C++ users may use the special @c wx/setup.h file for this +compiler in @c include/msvc subdirectory. This file implicitly links in all the +wxWidgets libraries using MSVC-specific pragmas which usually is much more +convenient than manually specifying the libraries list in all of the project +configurations. However sometimes linking with all the libraries is not +desirable, for example because some of them were not built and this is where +the symbols in this section can be helpful: defining them allows to not link +with the corresponding library. The following symbols are honoured: + + - wxNO_ADV_LIB + - wxNO_AUI_LIB + - wxNO_HTML_LIB + - wxNO_MEDIA_LIB + - wxNO_NET_LIB + - wxNO_PROPGRID_LIB + - wxNO_QA_LIB + - wxNO_RICHTEXT_LIB + - wxNO_WEBVIEW_LIB + - wxNO_XML_LIB + - wxNO_REGEX_LIB + - wxNO_EXPAT_LIB + - wxNO_JPEG_LIB + - wxNO_PNG_LIB + - wxNO_TIFF_LIB + - wxNO_ZLIB_LIB + +Notice that the base library is always included and the core is always included +for the GUI applications (i.e. those which don't define @c wxUSE_GUI as 0). + + @section page_cppconst_miscellaneous Miscellaneous @beginDefList @itemdef{__WXWINDOWS__, always defined in wxWidgets applications, see also wxCHECK_VERSION} -@itemdef{__WXDEBUG__, defined in debug mode, undefined in release mode} +@itemdef{wxDEBUG_LEVEL, defined as 1 by default, may be pre-defined as 0 before + including wxWidgets headers to disable generation of any code at all + for the assertion macros, see @ref overview_debugging} +@itemdef{__WXDEBUG__, defined if wxDEBUG_LEVEL is 1 or more, undefined otherwise} @itemdef{wxUSE_XXX, - if defined as $1$, feature XXX is active, see the + if defined as 1, feature XXX is active, see the @ref page_wxusedef (the symbols of this form are always defined, use @if_ and not @ifdef_ to test for them)} @itemdef{WX_PRECOMP, @@ -219,20 +272,20 @@ Currently the following symbols exist: headers you need.} @itemdef{_UNICODE and UNICODE, both are defined if wxUSE_UNICODE is set to @c 1} @itemdef{wxUSE_GUI, - this particular feature test macro is defined to $1$ + 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 @c 0, only wxBase is available.} @itemdef{wxUSE_BASE, - only used by wxWidgets internally (defined as $1$ when + 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)} + monolithic wxWidgets library, defined as 0 when building GUI library only)} @itemdef{wxNO_RTTI, is defined if the compiler RTTI support has been switched off} @itemdef{wxNO_EXCEPTIONS, is defined if the compiler support for C++ exceptions has been switched off} @itemdef{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 + implies that wxUSE_THREADS is 0 and also that other (non-wx-based) threading packages cannot be used neither.} @itemdef{WXMAKINGDLL_XXX, used internally and defined when building the