make wxSTRING_BASE_HASNT_CLEAR check more readable

[wxWidgets.git] / docs / doxygen / mainpages / const_cpp.h

diff --git a/docs/doxygen/mainpages/const_cpp.h b/docs/doxygen/mainpages/const_cpp.h
index 86c85e2c27340b9bb7d987c37bc3e7f3435087e0..3ef7716a18506c6138d63db3350db4de807b5edd 100644 (file)
--- a/docs/doxygen/mainpages/const_cpp.h
+++ b/docs/doxygen/mainpages/const_cpp.h
@@ -36,7 +36,7 @@ always tested using @ifdef_ and not @if_.
 @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{__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{__WXCOCOA__, OS X using wxCocoa Port}

 @itemdef{__WXDFB__, wxUniversal using DirectFB}
 @itemdef{__WXWINCE__, Windows CE}
 @itemdef{__WXGTK__, GTK+}
 @itemdef{__WXDFB__, wxUniversal using DirectFB}
 @itemdef{__WXWINCE__, Windows CE}
 @itemdef{__WXGTK__, GTK+}


@@ -45,16 +45,18 @@ 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{__WXGTK24__, GTK+ 2.4 or higher}
 @itemdef{__WXGTK26__, GTK+ 2.6 or higher}
 @itemdef{__WXGTK210__, GTK+ 2.10 or higher}

+@itemdef{__WXMAC__, old define for Mac OS X}

 @itemdef{__WXMOTIF__, Motif}
 @itemdef{__WXMOTIF20__, Motif 2.0 or higher}
 @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{__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{__WXOSX__, any OS X}
+@itemdef{__WXOSX_IPHONE__, OS X iPhone}
+@itemdef{__WXOSX_CARBON__, Mac OS X using Carbon}
+@itemdef{__WXOSX_COCOA__, Mac OS X using Cocoa}
+@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{__WXPALMOS__, PalmOS}
 @itemdef{__WXPM__, OS/2 native Presentation Manager}
 @itemdef{__WXSTUBS__, Stubbed version ('template' wxWin implementation)}
 @itemdef{__WXPALMOS__, PalmOS}
 @itemdef{__WXPM__, OS/2 native Presentation Manager}
 @itemdef{__WXSTUBS__, Stubbed version ('template' wxWin implementation)}


@@ -66,17 +68,17 @@ always tested using @ifdef_ and not @if_.
 @itemdef{__X__, any X11-based GUI toolkit except GTK+}
 @endDefList
 
 @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
 @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).
 
 @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).
 


@@ -114,6 +116,7 @@ symbols, although this has not always been followed.
 @itemdef{__VMS__, VMS}
 @itemdef{__WINDOWS__, any Windows}
 @itemdef{__WINE__, Wine}
 @itemdef{__VMS__, VMS}
 @itemdef{__WINDOWS__, any Windows}
 @itemdef{__WINE__, Wine}

+@itemdef{_WIN32_WCE, Windows CE version}

 @endDefList
 
 
 @endDefList
 
 


@@ -153,6 +156,7 @@ compiler used.
                         to the compiler version: 500 is 5.0.}
 @itemdef{__DJGPP__, DJGPP}
 @itemdef{__DIGITALMARS__, Digital Mars}
                         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{__GNUG__, Gnu C++ on any platform, see also wxCHECK_GCC_VERSION}
 @itemdef{__GNUWIN32__, Gnu-Win32 compiler, see also wxCHECK_W32API_VERSION}
 @itemdef{__MINGW32__, MinGW}


@@ -170,7 +174,6 @@ compiler used.
 @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{__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
 
 
 @endDefList
 
 


@@ -192,8 +195,11 @@ Currently the following symbols exist:
     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.}
     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_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.}
 @itemdef{wxHAS_LARGE_FFILES, Defined if wxFFile supports files more than 4GB in size.}
 @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_MULTIPLE_FILEDLG_FILTERS, Defined if wxFileDialog supports multiple ('|'-separated) filters.}

 @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_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).}


@@ -220,6 +226,7 @@ with the corresponding library. The following symbols are honoured:
     - wxNO_HTML_LIB
     - wxNO_MEDIA_LIB
     - wxNO_NET_LIB
     - wxNO_HTML_LIB
     - wxNO_MEDIA_LIB
     - wxNO_NET_LIB

+    - wxNO_PROPGRID_LIB

     - wxNO_QA_LIB
     - wxNO_RICHTEXT_LIB
     - wxNO_XML_LIB
     - wxNO_QA_LIB
     - wxNO_RICHTEXT_LIB
     - wxNO_XML_LIB