interface/platform.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        platform.h
   3 // Purpose:     documentation for global functions
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10 Same as wxCHECK_VERSION but also checks that
  11 @c wxSUBRELEASE_NUMBER is at least @e subrel.
  12 */
  13 #define bool wxCHECK_VERSION_FULL(major, minor, release, subrel)     /* implementation is private */
  14
  15
  16 /**
  17 This is a macro which evaluates to @true if the current wxWidgets version is at
  18 least major.minor.release.
  19
  20 For example, to test if the program is compiled with wxWidgets 2.2 or higher,
  21 the following can be done:
  22 @code
  23 wxString s;
  24 #if wxCHECK_VERSION(2, 2, 0)
  25     if ( s.StartsWith("foo") )
  26 #else // replacement code for old version
  27     if ( strncmp(s, "foo", 3) == 0 )
  28 #endif
  29     {
  30         ...
  31     }
  32 @endcode
  33 */
  34 #define bool wxCHECK_VERSION(major, minor, release)     /* implementation is private */
  35
  36 /**
  37     Returns 1 if the compiler being used to compile the code is Visual C++
  38     compiler version @e major or greater. Otherwise, and also if
  39     the compiler is not Visual C++ at all, returns 0.
  40 */
  41 #define bool wxCHECK_VISUALC_VERSION(major)     /* implementation is private */
  42
  43 /**
  44     Returns 1 if the compiler being used to compile the code is GNU C++
  45     compiler (g++) version major.minor or greater. Otherwise, and also if
  46     the compiler is not GNU C++ at all, returns 0.
  47 */
  48 #define bool wxCHECK_GCC_VERSION(major, minor)     /* implementation is private */
  49
  50 /**
  51     Returns 1 if the compiler being used to compile the code is Sun CC Pro
  52     compiler and its version is at least @c major.minor. Otherwise returns
  53     0.
  54 */
  55 #define bool wxCHECK_SUNCC_VERSION(major, minor)     /* implementation is private */
  56