include/wx/defs.h

   1 /*
   2  *  Name:        wx/defs.h
   3  *  Purpose:     Declarations/definitions common to all wx source files
   4  *  Author:      Julian Smart and others
   5  *  Modified by: Ryan Norton (Converted to C)
   6  *  Created:     01/02/97
   7  *  RCS-ID:      $Id$
   8  *  Copyright:   (c) Julian Smart
   9  *  Licence:     wxWindows licence
  10  */
  11
  12 /* THIS IS A C FILE, DON'T USE C++ FEATURES (IN PARTICULAR COMMENTS) IN IT */
  13
  14 #ifndef _WX_DEFS_H_
  15 #define _WX_DEFS_H_
  16
  17 // NOTE: this symbol will be replaced with "WXWIN_COMPATIBILITY_3_0" as soon
  18 //       as the development branch for 3.1 is created
  19 #define FUTURE_WXWIN_COMPATIBILITY_3_0      1
  20 #define wxDEPRECATED_FUTURE( x )            x
  21
  22 /*  ---------------------------------------------------------------------------- */
  23 /*  compiler and OS identification */
  24 /*  ---------------------------------------------------------------------------- */
  25
  26 #include "wx/platform.h"
  27
  28 #ifdef __cplusplus
  29 /*  Make sure the environment is set correctly */
  30 #   if defined(__WXMSW__) && defined(__X__)
  31 #       error "Target can't be both X and Windows"
  32 #   elif defined(__WXMSW__) && defined(__PALMOS__)
  33 #       error "Target can't be both PalmOS and Windows"
  34 #   elif !defined(__WXMOTIF__) && \
  35          !defined(__WXMSW__)   && \
  36          !defined(__WXPALMOS__)&& \
  37          !defined(__WXGTK__)   && \
  38          !defined(__WXPM__)    && \
  39          !defined(__WXOSX_CARBON__)   && \
  40          !defined(__WXOSX_COCOA__)   && \
  41          !defined(__WXOSX_IPHONE__)   && \
  42          !defined(__WXCOCOA__) && \
  43          !defined(__X__)       && \
  44          !defined(__WXMGL__)   && \
  45          !defined(__WXDFB__)   && \
  46          !defined(__WXX11__)   && \
  47           wxUSE_GUI
  48 #       ifdef __UNIX__
  49 #           error "No Target! You should use wx-config program for compilation flags!"
  50 #       else /*  !Unix */
  51 #           error "No Target! You should use supplied makefiles for compilation!"
  52 #       endif /*  Unix/!Unix */
  53 #   endif
  54 #endif /*__cplusplus*/
  55
  56 #ifndef __WXWINDOWS__
  57     #define __WXWINDOWS__ 1
  58 #endif
  59
  60 #ifndef wxUSE_BASE
  61     /*  by default consider that this is a monolithic build */
  62     #define wxUSE_BASE 1
  63 #endif
  64
  65 #if !wxUSE_GUI && !defined(__WXBASE__)
  66     #define __WXBASE__
  67 #endif
  68
  69 /*  suppress some Visual C++ warnings */
  70 #ifdef __VISUALC__
  71     /*  the only "real" warning here is 4244 but there are just too many of them */
  72     /*  in our code... one day someone should go and fix them but until then... */
  73 #   pragma warning(disable:4097)    /*  typedef used as class */
  74 #   pragma warning(disable:4201)    /*  nonstandard extension used: nameless struct/union */
  75 #   pragma warning(disable:4244)    /*  conversion from double to float */
  76 #   pragma warning(disable:4355)    /* 'this' used in base member initializer list */
  77 #   pragma warning(disable:4511)    /*  copy ctor couldn't be generated */
  78 #   pragma warning(disable:4512)    /*  operator=() couldn't be generated */
  79 #   pragma warning(disable:4514)   /*  unreferenced inline func has been removed */
  80 #   pragma warning(disable:4710)    /*  function not inlined */
  81
  82     // TODO: this warning should really be enabled as it can be genuinely
  83     //       useful, check where does it occur in wxWidgets
  84     #pragma warning(disable: 4127) /*  conditional expression is constant */
  85
  86     /* There are too many false positivies for this one, particularly when
  87        using templates like wxVector<T> */
  88     /* class 'foo' needs to have dll-interface to be used by clients of
  89        class 'bar'" */
  90 #   pragma warning(disable:4251)
  91
  92 #   ifdef __VISUALC5__
  93     /* For VC++ 5.0 for release mode, the warning 'C4702: unreachable code */
  94     /* is buggy, and occurs for code that does actually get executed */
  95 #   ifndef __WXDEBUG__
  96 #       pragma warning(disable:4702)    /* unreachable code */
  97 #   endif
  98
  99     /* The VC++ 5.0 warning 'C4003: not enough actual parameters for macro'
 100      * is incompatible with the wxWidgets headers since it is given when
 101      * parameters are empty but not missing. */
 102 #       pragma warning(disable:4003)    /* not enough actual parameters for macro */
 103 #   endif
 104
 105     /*
 106        VC6 insists on complaining about
 107
 108         return type for 'wxVector<T>::reverse_iterator::operator ->' is 'T **'
 109         (ie; not a UDT or reference to a UDT.  Will produce errors if applied
 110         using infix notation)
 111
 112        which is perfectly fine because template classes do routinely define
 113        operators which don't make sense for all template parameter values
 114        (besides this warning was removed in subsequent versions).
 115      */
 116     #ifdef __VISUALC6__
 117         #pragma warning(disable: 4284)
 118     #endif // VC6
 119
 120     /*
 121        When compiling with VC++ 7 /Wp64 option we get thousands of warnings for
 122        conversion from size_t to int or long. Some precious few of them might
 123        be worth looking into but unfortunately it seems infeasible to fix all
 124        the other, harmless ones (e.g. inserting static_cast<int>(s.length())
 125        everywhere this method is used though we are quite sure that using >4GB
 126        strings is a bad idea anyhow) so just disable it globally for now.
 127      */
 128     #if wxCHECK_VISUALC_VERSION(7)
 129         /* conversion from 'size_t' to 'unsigned long', possible loss of data */
 130         #pragma warning(disable:4267)
 131     #endif /* VC++ 7 or later */
 132
 133     /*
 134        VC++ 8 gives a warning when using standard functions such as sprintf,
 135        localtime, ... -- stop this madness, unless the user had already done it
 136      */
 137     #if wxCHECK_VISUALC_VERSION(8)
 138         #ifndef _CRT_SECURE_NO_DEPRECATE
 139             #define _CRT_SECURE_NO_DEPRECATE 1
 140         #endif
 141         #ifndef _CRT_NON_CONFORMING_SWPRINTFS
 142             #define _CRT_NON_CONFORMING_SWPRINTFS 1
 143         #endif
 144         #ifndef _SCL_SECURE_NO_WARNINGS
 145             #define _SCL_SECURE_NO_WARNINGS 1
 146         #endif
 147     #endif /* VC++ 8 */
 148 #endif /*  __VISUALC__ */
 149
 150 /*  suppress some Borland C++ warnings */
 151 #ifdef __BORLANDC__
 152 #   pragma warn -inl                /*  Functions containing reserved words and certain constructs are not expanded inline */
 153 #endif /*  __BORLANDC__ */
 154
 155 /*
 156    g++ gives a warning when a class has private dtor if it has no friends but
 157    this is a perfectly valid situation for a ref-counted class which destroys
 158    itself when its ref count drops to 0, so provide a macro to suppress this
 159    warning
 160  */
 161 #ifdef __GNUG__
 162 #   define wxSUPPRESS_GCC_PRIVATE_DTOR_WARNING(name) \
 163         friend class wxDummyFriendFor ## name;
 164 #else /* !g++ */
 165 #   define wxSUPPRESS_GCC_PRIVATE_DTOR_WARNING(name)
 166 #endif
 167
 168 /*  ---------------------------------------------------------------------------- */
 169 /*  wxWidgets version and compatibility defines */
 170 /*  ---------------------------------------------------------------------------- */
 171
 172 #include "wx/version.h"
 173
 174 /*  ============================================================================ */
 175 /*  non portable C++ features */
 176 /*  ============================================================================ */
 177
 178 /*  ---------------------------------------------------------------------------- */
 179 /*  compiler defects workarounds */
 180 /*  ---------------------------------------------------------------------------- */
 181
 182 /*
 183    Digital Unix C++ compiler only defines this symbol for .cxx and .hxx files,
 184    so define it ourselves (newer versions do it for all files, though, and
 185    don't allow it to be redefined)
 186  */
 187 #if defined(__DECCXX) && !defined(__VMS) && !defined(__cplusplus)
 188 #define __cplusplus
 189 #endif /* __DECCXX */
 190
 191 /*  Resolves linking problems under HP-UX when compiling with gcc/g++ */
 192 #if defined(__HPUX__) && defined(__GNUG__)
 193 #define va_list __gnuc_va_list
 194 #endif /*  HP-UX */
 195
 196 /* Prevents conflicts between sys/types.h and winsock.h with Cygwin, */
 197 /* when using Windows sockets. */
 198 #ifdef __CYGWIN__
 199 #define __USE_W32_SOCKETS
 200 #endif
 201
 202 /*  ---------------------------------------------------------------------------- */
 203 /*  check for native bool type and TRUE/FALSE constants */
 204 /*  ---------------------------------------------------------------------------- */
 205
 206 /*  for backwards compatibility, also define TRUE and FALSE */
 207 /*  */
 208 /*  note that these definitions should work both in C++ and C code, so don't */
 209 /*  use true/false below */
 210 #ifndef TRUE
 211     #define TRUE 1
 212 #endif
 213
 214 #ifndef FALSE
 215     #define FALSE 0
 216 #endif
 217
 218 typedef short int WXTYPE;
 219
 220
 221 /*  ---------------------------------------------------------------------------- */
 222 /*  other feature tests */
 223 /*  ---------------------------------------------------------------------------- */
 224
 225 /*  Every ride down a slippery slope begins with a single step.. */
 226 /*  */
 227 /*  Yes, using nested classes is indeed against our coding standards in */
 228 /*  general, but there are places where you can use them to advantage */
 229 /*  without totally breaking ports that cannot use them.  If you do, then */
 230 /*  wrap it in this guard, but such cases should still be relatively rare. */
 231 #define wxUSE_NESTED_CLASSES    1
 232
 233 /*  check for explicit keyword support */
 234 #ifndef HAVE_EXPLICIT
 235     #if defined(__VISUALC__) && (__VISUALC__ >= 1100)
 236         /*  VC++ 6.0 and 5.0 have explicit (what about earlier versions?) */
 237         #define HAVE_EXPLICIT
 238     #elif ( defined(__MINGW32__) || defined(__CYGWIN32__) ) \
 239           && wxCHECK_GCC_VERSION(2, 95)
 240         /*  GCC 2.95 has explicit, what about earlier versions? */
 241         #define HAVE_EXPLICIT
 242     #elif defined(__BORLANDC__) && (__BORLANDC__ >= 0x0520)
 243         /*  BC++ 4.52 doesn't support explicit, CBuilder 1 does */
 244         #define HAVE_EXPLICIT
 245     #elif defined(__MWERKS__) && (__MWERKS__ >= 0x2400)
 246         /*  Metrowerks CW6 or higher has explicit */
 247         #define HAVE_EXPLICIT
 248     #elif defined(__DIGITALMARS__)
 249         #define HAVE_EXPLICIT
 250     #elif defined(__WATCOMC__)
 251         #define HAVE_EXPLICIT
 252     #endif
 253 #endif /*  !HAVE_EXPLICIT */
 254
 255 #ifdef HAVE_EXPLICIT
 256     #define wxEXPLICIT explicit
 257 #else /*  !HAVE_EXPLICIT */
 258     #define wxEXPLICIT
 259 #endif /*  HAVE_EXPLICIT/!HAVE_EXPLICIT */
 260
 261 /* these macros are obsolete, use the standard C++ casts directly now */
 262 #define wx_static_cast(t, x) static_cast<t>(x)
 263 #define wx_const_cast(t, x) const_cast<t>(x)
 264 #define wx_reinterpret_cast(t, x) reinterpret_cast<t>(x)
 265
 266 /*
 267    This one is a wx invention: like static cast but used when we intentionally
 268    truncate from a larger to smaller type, static_cast<> can't be used for it
 269    as it results in warnings when using some compilers (SGI mipspro for example)
 270  */
 271 #if defined(__INTELC__) && defined(__cplusplus)
 272     template <typename T, typename X>
 273     inline T wx_truncate_cast_impl(X x)
 274     {
 275         #pragma warning(push)
 276         /* implicit conversion of a 64-bit integral type to a smaller integral type */
 277         #pragma warning(disable: 1682)
 278         /* conversion from "X" to "T" may lose significant bits */
 279         #pragma warning(disable: 810)
 280         /* non-pointer conversion from "foo" to "bar" may lose significant bits */
 281         #pragma warning(disable: 2259)
 282
 283         return x;
 284
 285         #pragma warning(pop)
 286     }
 287
 288     #define wx_truncate_cast(t, x) wx_truncate_cast_impl<t>(x)
 289
 290 #elif defined(__cplusplus) && defined(__VISUALC__) && __VISUALC__ >= 1310
 291     template <typename T, typename X>
 292     inline T wx_truncate_cast_impl(X x)
 293     {
 294         #pragma warning(push)
 295         /* conversion from 'X' to 'T', possible loss of data */
 296         #pragma warning(disable: 4267)
 297
 298         return x;
 299
 300         #pragma warning(pop)
 301     }
 302
 303     #define wx_truncate_cast(t, x) wx_truncate_cast_impl<t>(x)
 304 #else
 305     #define wx_truncate_cast(t, x) ((t)(x))
 306 #endif
 307
 308 /* for consistency with wxStatic/DynamicCast defined in wx/object.h */
 309 #define wxConstCast(obj, className) wx_const_cast(className *, obj)
 310
 311 #ifndef HAVE_STD_WSTRING
 312     #if defined(__VISUALC__) && (__VISUALC__ >= 1100)
 313         /*  VC++ 6.0 and 5.0 have std::wstring (what about earlier versions?) */
 314         #define HAVE_STD_WSTRING
 315     #elif defined(__MINGW32__) && wxCHECK_GCC_VERSION(3, 3)
 316         /*  GCC 3.1 has std::wstring; 3.0 never was in MinGW, 2.95 hasn't it */
 317         #define HAVE_STD_WSTRING
 318     #endif
 319 #endif
 320
 321 #ifndef HAVE_STD_STRING_COMPARE
 322     #if defined(__VISUALC__) && (__VISUALC__ >= 1100)
 323         /*  VC++ 6.0 and 5.0 have std::string::compare */
 324         /*  (what about earlier versions?) */
 325         #define HAVE_STD_STRING_COMPARE
 326     #elif ( defined(__MINGW32__) || defined(__CYGWIN32__) ) \
 327           && wxCHECK_GCC_VERSION(3, 1)
 328         /*  GCC 3.1 has std::string::compare; */
 329         /*  3.0 never was in MinGW, 2.95 hasn't it */
 330         #define HAVE_STD_STRING_COMPARE
 331     #endif
 332 #endif
 333
 334 #ifndef HAVE_TR1_TYPE_TRAITS
 335     #if defined(__VISUALC__) && (_MSC_FULL_VER >= 150030729)
 336         #define HAVE_TR1_TYPE_TRAITS
 337     #endif
 338 #endif
 339
 340 /* provide replacement for C99 va_copy() if the compiler doesn't have it */
 341
 342 /* could be already defined by configure or the user */
 343 #ifndef wxVaCopy
 344     /* if va_copy is a macro or configure detected that we have it, use it */
 345     #if defined(va_copy) || defined(HAVE_VA_COPY)
 346         #define wxVaCopy va_copy
 347     #else /* no va_copy, try to provide a replacement */
 348         /*
 349            configure tries to determine whether va_list is an array or struct
 350            type, but it may not be used under Windows, so deal with a few
 351            special cases.
 352          */
 353
 354         #ifdef __WATCOMC__
 355             /* Watcom uses array type for va_list except for PPC and Alpha */
 356             #if !defined(__PPC__) && !defined(__AXP__)
 357                 #define VA_LIST_IS_ARRAY
 358             #endif
 359         #endif /* __WATCOMC__ */
 360
 361         #if defined(__PPC__) && (defined(_CALL_SYSV) || defined (_WIN32))
 362             /*
 363                 PPC using SysV ABI and NT/PPC are special in that they use an
 364                 extra level of indirection.
 365              */
 366             #define VA_LIST_IS_POINTER
 367         #endif /* SysV or Win32 on __PPC__ */
 368
 369         /*
 370             note that we use memmove(), not memcpy(), in case anybody tries
 371             to do wxVaCopy(ap, ap)
 372          */
 373         #if defined(VA_LIST_IS_POINTER)
 374             #define wxVaCopy(d, s)  memmove(*(d), *(s), sizeof(va_list))
 375         #elif defined(VA_LIST_IS_ARRAY)
 376             #define wxVaCopy(d, s) memmove((d), (s), sizeof(va_list))
 377         #else /* we can only hope that va_lists are simple lvalues */
 378             #define wxVaCopy(d, s) ((d) = (s))
 379         #endif
 380     #endif /* va_copy/!va_copy */
 381 #endif /* wxVaCopy */
 382
 383 #ifndef HAVE_VARIADIC_MACROS
 384     #if wxCHECK_WATCOM_VERSION(1,2)
 385         #define HAVE_VARIADIC_MACROS
 386     #endif
 387 #endif /* HAVE_VARIADIC_MACROS */
 388
 389
 390 #ifndef HAVE_WOSTREAM
 391     // Mingw <= 3.4 and all versions of Cygwin as well as any gcc version (so
 392     // far) targeting PalmOS don't have std::wostream
 393     #if defined(__PALMOS__) || \
 394         (defined(__MINGW32__) && !wxCHECK_GCC_VERSION(4, 0)) || \
 395         defined(__CYGWIN__)
 396         #define wxNO_WOSTREAM
 397     #endif
 398
 399     // VC++ doesn't have it in the old iostream library
 400     #if defined(__VISUALC__) && wxUSE_IOSTREAMH
 401         #define wxNO_WOSTREAM
 402     #endif
 403
 404     #ifndef wxNO_WOSTREAM
 405         #define HAVE_WOSTREAM
 406     #endif
 407
 408     #undef wxNO_WOSTREAM
 409 #endif /* HAVE_WOSTREAM */
 410
 411 // ----------------------------------------------------------------------------
 412 // other C++ features
 413 // ----------------------------------------------------------------------------
 414
 415 #ifndef HAVE_PARTIAL_SPECIALIZATION
 416     // be optimistic by default
 417     #define HAVE_PARTIAL_SPECIALIZATION
 418 #endif
 419
 420 #ifdef __VISUALC__
 421     #if __VISUALC__ < 1310
 422         #undef HAVE_PARTIAL_SPECIALIZATION
 423     #endif
 424 #endif // __VISUALC__
 425
 426
 427 #ifndef HAVE_TEMPLATE_OVERLOAD_RESOLUTION
 428     // assume the compiler can use type or const expressions as template
 429     // arguments if it supports partial specialization -- except if it's a
 430     // Borland one which can't
 431     #if defined(HAVE_PARTIAL_SPECIALIZATION) && !defined(__BORLANDC__)
 432         #define HAVE_TEMPLATE_OVERLOAD_RESOLUTION
 433     #endif // __BORLANDC__
 434 #endif // !defined(HAVE_TEMPLATE_OVERLOAD_RESOLUTION)
 435
 436 /*  ---------------------------------------------------------------------------- */
 437 /*  portable calling conventions macros */
 438 /*  ---------------------------------------------------------------------------- */
 439
 440 /*  stdcall is used for all functions called by Windows under Windows */
 441 #if defined(__WINDOWS__)
 442     #if defined(__GNUWIN32__)
 443         #define wxSTDCALL __attribute__((stdcall))
 444     #else
 445         /*  both VC++ and Borland understand this */
 446         #define wxSTDCALL _stdcall
 447     #endif
 448
 449 #else /*  Win */
 450     /*  no such stupidness under Unix */
 451     #define wxSTDCALL
 452 #endif /*  platform */
 453
 454 /*  LINKAGEMODE mode is empty for everyting except OS/2 */
 455 #ifndef LINKAGEMODE
 456     #define LINKAGEMODE
 457 #endif /*  LINKAGEMODE */
 458
 459 /*  wxCALLBACK should be used for the functions which are called back by */
 460 /*  Windows (such as compare function for wxListCtrl) */
 461 #if defined(__WIN32__) && !defined(__WXMICROWIN__)
 462     #define wxCALLBACK wxSTDCALL
 463 #else
 464     /*  no stdcall under Unix nor Win16 */
 465     #define wxCALLBACK
 466 #endif /*  platform */
 467
 468 /*  generic calling convention for the extern "C" functions */
 469
 470 #if defined(__VISUALC__)
 471   #define   wxC_CALLING_CONV    _cdecl
 472 #elif defined(__VISAGECPP__)
 473   #define   wxC_CALLING_CONV    _Optlink
 474 #else   /*  !Visual C++ */
 475   #define   wxC_CALLING_CONV
 476 #endif  /*  compiler */
 477
 478 /*  callling convention for the qsort(3) callback */
 479 #define wxCMPFUNC_CONV wxC_CALLING_CONV
 480
 481 /*  compatibility :-( */
 482 #define CMPFUNC_CONV wxCMPFUNC_CONV
 483
 484 /*  DLL import/export declarations */
 485 #include "wx/dlimpexp.h"
 486
 487 /*  ---------------------------------------------------------------------------- */
 488 /*  Very common macros */
 489 /*  ---------------------------------------------------------------------------- */
 490
 491 /*  Printf-like attribute definitions to obtain warnings with GNU C/C++ */
 492 #ifndef WX_ATTRIBUTE_PRINTF
 493 #   if defined(__GNUC__) && !wxUSE_UNICODE
 494 #       define WX_ATTRIBUTE_PRINTF(m, n) __attribute__ ((__format__ (__printf__, m, n)))
 495 #   else
 496 #       define WX_ATTRIBUTE_PRINTF(m, n)
 497 #   endif
 498
 499 #   define WX_ATTRIBUTE_PRINTF_1 WX_ATTRIBUTE_PRINTF(1, 2)
 500 #   define WX_ATTRIBUTE_PRINTF_2 WX_ATTRIBUTE_PRINTF(2, 3)
 501 #   define WX_ATTRIBUTE_PRINTF_3 WX_ATTRIBUTE_PRINTF(3, 4)
 502 #   define WX_ATTRIBUTE_PRINTF_4 WX_ATTRIBUTE_PRINTF(4, 5)
 503 #   define WX_ATTRIBUTE_PRINTF_5 WX_ATTRIBUTE_PRINTF(5, 6)
 504 #endif /* !defined(WX_ATTRIBUTE_PRINTF) */
 505
 506
 507 /*  Macro to issue warning when using deprecated functions with gcc3 or MSVC7: */
 508 #if wxCHECK_GCC_VERSION(3, 1)
 509     #define wxDEPRECATED(x) __attribute__((deprecated)) x
 510 #elif defined(__VISUALC__) && (__VISUALC__ >= 1300)
 511     #define wxDEPRECATED(x) __declspec(deprecated) x
 512 #else
 513     #define wxDEPRECATED(x) x
 514 #endif
 515
 516 /*
 517     explicitly specifying inline allows gcc < 3.4 to
 518     handle the deprecation attribute even in the constructor.
 519     doesn't seem to work on Apple's gcc 4.0.1 unless using -O0
 520 */
 521 #if wxCHECK_GCC_VERSION(3, 4) || defined( __DARWIN__ )
 522     #define  wxDEPRECATED_CONSTRUCTOR(x) x
 523 #else
 524     #define  wxDEPRECATED_CONSTRUCTOR(x) wxDEPRECATED( inline x)
 525 #endif
 526
 527 /*
 528    Macro which marks the function as being deprecated but also defines it
 529    inline.
 530
 531    Currently it's defined in the same trivial way in all cases but it could
 532    need a special definition with some other compilers in the future which
 533    explains why do we have it.
 534  */
 535 #define wxDEPRECATED_INLINE(func, body) wxDEPRECATED(func) { body }
 536
 537 /*
 538     A macro to define a simple deprecated accessor.
 539  */
 540 #define wxDEPRECATED_ACCESSOR(func, what) wxDEPRECATED_INLINE(func, return what;)
 541
 542 /*
 543    Special variant of the macro above which should be used for the functions
 544    which are deprecated but called by wx itself: this often happens with
 545    deprecated virtual functions which are called by the library.
 546  */
 547 #ifdef WXBUILDING
 548 #   define wxDEPRECATED_BUT_USED_INTERNALLY(x) x
 549 #else
 550 #   define wxDEPRECATED_BUT_USED_INTERNALLY(x) wxDEPRECATED(x)
 551 #endif
 552
 553 /*
 554     Combination of the two variants above: should be used for deprecated
 555     functions which are defined inline and are used by wxWidgets itself.
 556  */
 557 #ifdef WXBUILDING
 558 #   define wxDEPRECATED_BUT_USED_INTERNALLY_INLINE(func, body) func { body }
 559 #else
 560 #   define wxDEPRECATED_BUT_USED_INTERNALLY_INLINE(func, body) \
 561         wxDEPRECATED(func) { body }
 562 #endif
 563
 564 /*  NULL declaration: it must be defined as 0 for C++ programs (in particular, */
 565 /*  it must not be defined as "(void *)0" which is standard for C but completely */
 566 /*  breaks C++ code) */
 567 #if !defined(__HANDHELDPC__) && !defined(__PALMOS__)
 568 #include <stddef.h>
 569 #endif
 570
 571 #ifdef __cplusplus
 572
 573 // everybody gets the assert and other debug macros
 574 #include "wx/debug.h"
 575
 576     // delete pointer if it is not NULL and NULL it afterwards
 577     template <typename T>
 578     inline void wxDELETE(T*& ptr)
 579     {
 580         typedef char TypeIsCompleteCheck[sizeof(T)];
 581
 582         if ( ptr != NULL )
 583         {
 584             delete ptr;
 585             ptr = NULL;
 586         }
 587     }
 588
 589     // delete an array and NULL it (see comments above)
 590     template <typename T>
 591     inline void wxDELETEA(T*& ptr)
 592     {
 593         typedef char TypeIsCompleteCheck[sizeof(T)];
 594
 595         if ( ptr != NULL )
 596         {
 597             delete [] ptr;
 598             ptr = NULL;
 599         }
 600     }
 601
 602     // trivial implementation of std::swap() for primitive types
 603     template <typename T>
 604     inline void wxSwap(T& first, T& second)
 605     {
 606         T tmp(first);
 607         first = second;
 608         second = tmp;
 609     }
 610 #endif /*__cplusplus*/
 611
 612 /*  size of statically declared array */
 613 #define WXSIZEOF(array)   (sizeof(array)/sizeof(array[0]))
 614
 615 /*  symbolic constant used by all Find()-like functions returning positive */
 616 /*  integer on success as failure indicator */
 617 #define wxNOT_FOUND       (-1)
 618
 619 /* the default value for some length parameters meaning that the string is */
 620 /* NUL-terminated */
 621 #define wxNO_LEN ((size_t)-1)
 622
 623 /*  ---------------------------------------------------------------------------- */
 624 /*  macros dealing with comparison operators */
 625 /*  ---------------------------------------------------------------------------- */
 626
 627 /*
 628     Expands into m(op, args...) for each op in the set { ==, !=, <, <=, >, >= }.
 629  */
 630 #define wxFOR_ALL_COMPARISONS(m) \
 631     m(==) m(!=) m(>=) m(<=) m(>) m(<)
 632
 633 #define wxFOR_ALL_COMPARISONS_1(m, x) \
 634     m(==,x) m(!=,x) m(>=,x) m(<=,x) m(>,x) m(<,x)
 635
 636 #define wxFOR_ALL_COMPARISONS_2(m, x, y) \
 637     m(==,x,y) m(!=,x,y) m(>=,x,y) m(<=,x,y) m(>,x,y) m(<,x,y)
 638
 639 #define wxFOR_ALL_COMPARISONS_3(m, x, y, z) \
 640     m(==,x,y,z) m(!=,x,y,z) m(>=,x,y,z) m(<=,x,y,z) m(>,x,y,z) m(<,x,y,z)
 641
 642 /*
 643     This is only used with wxDEFINE_COMPARISON_REV: it passes both the normal
 644     and the reversed comparison operators to the macro.
 645  */
 646 #define wxFOR_ALL_COMPARISONS_3_REV(m, x, y, z) \
 647     m(==,x,y,z,==) m(!=,x,y,z,!=) m(>=,x,y,z,<=) \
 648     m(<=,x,y,z,>=) m(>,x,y,z,<) m(<,x,y,z,>)
 649
 650
 651 #define wxDEFINE_COMPARISON(op, T1, T2, cmp) \
 652     inline bool operator op(T1 x, T2 y) { return cmp(x, y, op); }
 653
 654 #define wxDEFINE_COMPARISON_REV(op, T1, T2, cmp, oprev) \
 655     inline bool operator op(T2 y, T1 x) { return cmp(x, y, oprev); }
 656
 657 /*
 658     Define all 6 comparison operators (==, !=, <, <=, >, >=) for the given
 659     types in the specified order. The implementation is provided by the cmp
 660     macro. Normally wxDEFINE_ALL_COMPARISONS should be used as comparison
 661     operators are usually symmetric.
 662  */
 663 #define wxDEFINE_COMPARISONS(T1, T2, cmp) \
 664     wxFOR_ALL_COMPARISONS_3(wxDEFINE_COMPARISON, T1, T2, cmp)
 665
 666 /*
 667     This macro allows to define all 12 comparison operators (6 operators for
 668     both orders of arguments) for the given types using the provided "cmp"
 669     macro to implement the actual comparison: the macro is called with the 2
 670     arguments names, the first of type T1 and the second of type T2, and the
 671     comparison operator being implemented.
 672  */
 673 #define wxDEFINE_ALL_COMPARISONS(T1, T2, cmp) \
 674     wxFOR_ALL_COMPARISONS_3(wxDEFINE_COMPARISON, T1, T2, cmp) \
 675     wxFOR_ALL_COMPARISONS_3_REV(wxDEFINE_COMPARISON_REV, T1, T2, cmp)
 676
 677 /*  ---------------------------------------------------------------------------- */
 678 /*  macros to avoid compiler warnings */
 679 /*  ---------------------------------------------------------------------------- */
 680
 681 /*  Macro to cut down on compiler warnings. */
 682 #if 1 /*  there should be no more any compilers needing the "#else" version */
 683     #define WXUNUSED(identifier) /* identifier */
 684 #else  /*  stupid, broken compiler */
 685     #define WXUNUSED(identifier) identifier
 686 #endif
 687
 688 /*  some arguments are not used in unicode mode */
 689 #if wxUSE_UNICODE
 690     #define WXUNUSED_IN_UNICODE(param)  WXUNUSED(param)
 691 #else
 692     #define WXUNUSED_IN_UNICODE(param)  param
 693 #endif
 694
 695 /*  some arguments are not used in WinCE build */
 696 #ifdef __WXWINCE__
 697     #define WXUNUSED_IN_WINCE(param)  WXUNUSED(param)
 698 #else
 699     #define WXUNUSED_IN_WINCE(param)  param
 700 #endif
 701
 702 /*  unused parameters in non stream builds */
 703 #if wxUSE_STREAMS
 704     #define WXUNUSED_UNLESS_STREAMS(param)  param
 705 #else
 706     #define WXUNUSED_UNLESS_STREAMS(param)  WXUNUSED(param)
 707 #endif
 708
 709 /*  some compilers give warning about a possibly unused variable if it is */
 710 /*  initialized in both branches of if/else and shut up if it is initialized */
 711 /*  when declared, but other compilers then give warnings about unused variable */
 712 /*  value -- this should satisfy both of them */
 713 #if defined(__VISUALC__)
 714     #define wxDUMMY_INITIALIZE(val) = val
 715 #else
 716     #define wxDUMMY_INITIALIZE(val)
 717 #endif
 718
 719 /*  sometimes the value of a variable is *really* not used, to suppress  the */
 720 /*  resulting warning you may pass it to this function */
 721 #ifdef __cplusplus
 722 #   ifdef __BORLANDC__
 723 #       define wxUnusedVar(identifier) identifier
 724 #   else
 725         template <class T>
 726             inline void wxUnusedVar(const T& WXUNUSED(t)) { }
 727 #   endif
 728 #endif
 729
 730 /*  ---------------------------------------------------------------------------- */
 731 /*  compiler specific settings */
 732 /*  ---------------------------------------------------------------------------- */
 733
 734 #if defined(__MWERKS__)
 735     #undef try
 736     #undef except
 737     #undef finally
 738     #define except(x) catch(...)
 739 #endif /*  Metrowerks */
 740
 741 #if wxONLY_WATCOM_EARLIER_THAN(1,4)
 742     typedef short mode_t;
 743 #endif
 744
 745 /*  where should i put this? we need to make sure of this as it breaks */
 746 /*  the <iostream> code. */
 747 #if !wxUSE_IOSTREAMH && defined(__WXDEBUG__)
 748 #  ifndef __MWERKS__
 749 /*  #undef __WXDEBUG__ */
 750 #    ifdef wxUSE_DEBUG_NEW_ALWAYS
 751 #    undef wxUSE_DEBUG_NEW_ALWAYS
 752 #    define wxUSE_DEBUG_NEW_ALWAYS 0
 753 #    endif
 754 #  endif
 755 #endif
 756
 757 /*  ---------------------------------------------------------------------------- */
 758 /*  standard wxWidgets types */
 759 /*  ---------------------------------------------------------------------------- */
 760
 761 /*  the type for screen and DC coordinates */
 762 typedef int wxCoord;
 763
 764 enum {  wxDefaultCoord = -1 };
 765
 766 /*  ---------------------------------------------------------------------------- */
 767 /*  define fixed length types */
 768 /*  ---------------------------------------------------------------------------- */
 769
 770 #if defined(__WXPALMOS__) || defined(__MINGW32__)
 771   #if !defined(__MWERKS__)
 772     #include <sys/types.h>
 773   #endif
 774 #endif
 775
 776 /*  chars are always one byte (by definition), shorts are always two (in */
 777 /*  practice) */
 778
 779 /*  8bit */
 780 typedef signed char wxInt8;
 781 typedef unsigned char wxUint8;
 782 typedef wxUint8 wxByte;
 783
 784
 785 /*  16bit */
 786 #ifdef SIZEOF_SHORT
 787     #if SIZEOF_SHORT != 2
 788         #error "wxWidgets assumes sizeof(short) == 2, please fix the code"
 789     #endif
 790 #else
 791     #define SIZEOF_SHORT 2
 792 #endif
 793
 794 typedef signed short wxInt16;
 795 typedef unsigned short wxUint16;
 796
 797 typedef wxUint16 wxWord;
 798
 799 /*
 800   things are getting more interesting with ints, longs and pointers
 801
 802   there are several different standard data models described by this table:
 803
 804   +-----------+----------------------------+
 805   |type\model | LP64 ILP64 LLP64 ILP32 LP32|
 806   +-----------+----------------------------+
 807   |char       |  8     8     8     8     8 |
 808   |short      | 16    16    16    16    16 |
 809   |int        | 32    64    32    32    16 |
 810   |long       | 64    64    32    32    32 |
 811   |long long  | 64    64    64    --    -- |
 812   |void *     | 64    64    64    32    32 |
 813   +-----------+----------------------------+
 814
 815   Win16 used LP32 (but we don't support it any longer), Win32 obviously used
 816   ILP32 and Win64 uses LLP64 (a.k.a. P64)
 817
 818   Under Unix LP64 is the most widely used (the only I've ever seen, in fact)
 819  */
 820
 821 /*  32bit */
 822 #ifdef __PALMOS__
 823     typedef int wxInt32;
 824     typedef unsigned int wxUint32;
 825     #define SIZEOF_INT 4
 826     #define SIZEOF_LONG 4
 827     #define SIZEOF_WCHAR_T 2
 828     #define SIZEOF_SIZE_T 4
 829     #ifdef __WXPALMOS6__
 830         #define wxSIZE_T_IS_UINT
 831     #endif
 832     #define SIZEOF_VOID_P 4
 833     #define SIZEOF_SIZE_T 4
 834 #elif defined(__WINDOWS__)
 835     #if defined(__WIN32__)
 836         typedef int wxInt32;
 837         typedef unsigned int wxUint32;
 838
 839         /*
 840             Win64 uses LLP64 model and so ints and longs have the same size as
 841             in Win32.
 842          */
 843         #ifndef SIZEOF_INT
 844             #define SIZEOF_INT 4
 845         #endif
 846
 847         #ifndef SIZEOF_LONG
 848             #define SIZEOF_LONG 4
 849         #endif
 850
 851         #ifndef SIZEOF_WCHAR_T
 852             /* Windows uses UTF-16 */
 853             #define SIZEOF_WCHAR_T 2
 854         #endif
 855
 856         #ifndef SIZEOF_SIZE_T
 857             /*
 858                Under Win64 sizeof(size_t) == 8 and so it is neither unsigned
 859                int nor unsigned long!
 860              */
 861             #ifdef __WIN64__
 862                 #define SIZEOF_SIZE_T 8
 863
 864                 #undef wxSIZE_T_IS_UINT
 865             #else /* Win32 */
 866                 #define SIZEOF_SIZE_T 4
 867
 868                 #define wxSIZE_T_IS_UINT
 869             #endif
 870             #undef wxSIZE_T_IS_ULONG
 871         #endif
 872
 873         #ifndef SIZEOF_VOID_P
 874             #ifdef __WIN64__
 875                 #define SIZEOF_VOID_P 8
 876             #else /*  Win32 */
 877                 #define SIZEOF_VOID_P 4
 878             #endif /*  Win64/32 */
 879         #endif
 880     #else
 881         #error "Unsupported Windows version"
 882     #endif
 883 #else /*  !Windows */
 884     /*  SIZEOF_XXX are normally defined by configure */
 885     #ifdef SIZEOF_INT
 886         #if SIZEOF_INT == 8
 887             /*  must be ILP64 data model, there is normally a special 32 bit */
 888             /*  type in it but we don't know what it is... */
 889             #error "No 32bit int type on this platform"
 890         #elif SIZEOF_INT == 4
 891             typedef int wxInt32;
 892             typedef unsigned int wxUint32;
 893         #elif SIZEOF_INT == 2
 894             /*  must be LP32 */
 895             #if SIZEOF_LONG != 4
 896                 #error "No 32bit int type on this platform"
 897             #endif
 898
 899             typedef long wxInt32;
 900             typedef unsigned long wxUint32;
 901         #else
 902             /*  wxWidgets is not ready for 128bit systems yet... */
 903             #error "Unknown sizeof(int) value, what are you compiling for?"
 904         #endif
 905     #else /*  !defined(SIZEOF_INT) */
 906         /*  assume default 32bit machine -- what else can we do? */
 907         wxCOMPILE_TIME_ASSERT( sizeof(int) == 4, IntMustBeExactly4Bytes);
 908         wxCOMPILE_TIME_ASSERT( sizeof(size_t) == 4, SizeTMustBeExactly4Bytes);
 909         wxCOMPILE_TIME_ASSERT( sizeof(void *) == 4, PtrMustBeExactly4Bytes);
 910
 911         #define SIZEOF_INT 4
 912         #define SIZEOF_SIZE_T 4
 913         #define SIZEOF_VOID_P 4
 914
 915         typedef int wxInt32;
 916         typedef unsigned int wxUint32;
 917
 918         #if defined(__MACH__) && !defined(SIZEOF_WCHAR_T)
 919             #define SIZEOF_WCHAR_T 4
 920         #endif
 921         #if !defined(SIZEOF_WCHAR_T)
 922             /*  also assume that sizeof(wchar_t) == 2 (under Unix the most */
 923             /*  common case is 4 but there configure would have defined */
 924             /*  SIZEOF_WCHAR_T for us) */
 925             /*  the most common case */
 926             wxCOMPILE_TIME_ASSERT( sizeof(wchar_t) == 2,
 927                                     Wchar_tMustBeExactly2Bytes);
 928
 929             #define SIZEOF_WCHAR_T 2
 930         #endif /*  !defined(SIZEOF_WCHAR_T) */
 931     #endif
 932 #endif /*  Win/!Win */
 933
 934 #ifndef SIZEOF_WCHAR_T
 935     #error "SIZEOF_WCHAR_T must be defined, but isn't"
 936 #endif
 937
 938 /* also define C99-like sized MIN/MAX constants */
 939 #define wxINT8_MIN CHAR_MIN
 940 #define wxINT8_MAX CHAR_MAX
 941 #define wxUINT8_MAX UCHAR_MAX
 942
 943 #define wxINT16_MIN SHRT_MIN
 944 #define wxINT16_MAX SHRT_MAX
 945 #define wxUINT16_MAX USHRT_MAX
 946
 947 #if SIZEOF_INT == 4
 948     #define wxINT32_MIN INT_MIN
 949     #define wxINT32_MAX INT_MAX
 950     #define wxUINT32_MAX UINT_MAX
 951 #elif SIZEOF_LONG == 4
 952     #define wxINT32_MIN LONG_MIN
 953     #define wxINT32_MAX LONG_MAX
 954     #define wxUINT32_MAX ULONG_MAX
 955 #else
 956     #error "Unknown 32 bit type"
 957 #endif
 958
 959 typedef wxUint32 wxDword;
 960
 961 #ifdef LLONG_MAX
 962     #define wxINT64_MIN LLONG_MIN
 963     #define wxINT64_MAX LLONG_MAX
 964     #define wxUINT64_MAX ULLONG_MAX
 965 #else
 966     #define wxINT64_MIN (wxLL(-9223372036854775807)-1)
 967     #define wxINT64_MAX wxLL(9223372036854775807)
 968     #define wxUINT64_MAX wxULL(0xFFFFFFFFFFFFFFFF)
 969 #endif
 970
 971 /*  64 bit */
 972
 973 /*  NB: we #define and not typedef wxLongLong_t because we use "#ifdef */
 974 /*      wxLongLong_t" in wx/longlong.h */
 975
 976 /*      wxULongLong_t is set later (usually to unsigned wxLongLong_t) */
 977
 978 /*  to avoid compilation problems on 64bit machines with ambiguous method calls */
 979 /*  we will need to define this */
 980 #undef wxLongLongIsLong
 981
 982 /*
 983    First check for specific compilers which have known 64 bit integer types,
 984    this avoids clashes with SIZEOF_LONG[_LONG] being defined incorrectly for
 985    e.g. MSVC builds (Python.h defines it as 8 even for MSVC).
 986
 987    Also notice that we check for "long long" before checking for 64 bit long as
 988    we still want to use "long long" and not "long" for wxLongLong_t on 64 bit
 989    architectures to be able to pass wxLongLong_t to the standard functions
 990    prototyped as taking "long long" such as strtoll().
 991  */
 992 #if (defined(__VISUALC__) && defined(__WIN32__))
 993     #define wxLongLong_t __int64
 994     #define wxLongLongSuffix i64
 995     #define wxLongLongFmtSpec "I64"
 996 #elif defined(__BORLANDC__) && defined(__WIN32__) && (__BORLANDC__ >= 0x520)
 997     #define wxLongLong_t __int64
 998     #define wxLongLongSuffix i64
 999     #define wxLongLongFmtSpec "L"
1000 #elif (defined(__WATCOMC__) && (defined(__WIN32__) || defined(__DOS__) || defined(__OS2__)))
1001       #define wxLongLong_t __int64
1002       #define wxLongLongSuffix i64
1003       #define wxLongLongFmtSpec "L"
1004 #elif defined(__DIGITALMARS__)
1005       #define wxLongLong_t __int64
1006       #define wxLongLongSuffix LL
1007       #define wxLongLongFmtSpec "ll"
1008 #elif defined(__MINGW32__)
1009     #define wxLongLong_t long long
1010     #define wxLongLongSuffix ll
1011     #define wxLongLongFmtSpec "I64"
1012 #elif defined(__MWERKS__)
1013     #if __option(longlong)
1014         #define wxLongLong_t long long
1015         #define wxLongLongSuffix ll
1016         #define wxLongLongFmtSpec "ll"
1017     #else
1018         #error "The 64 bit integer support in CodeWarrior has been disabled."
1019         #error "See the documentation on the 'longlong' pragma."
1020     #endif
1021 #elif defined(__WXPALMOS__)
1022     #if defined(__WXPALMOS6__)
1023         #define wxLongLong_t int64_t
1024     #else
1025         #define wxLongLong_t long long
1026     #endif /* __WXPALMOS6__ */
1027     #define wxLongLongSuffix ll
1028     #define wxLongLongFmtSpec "ll"
1029 #elif defined(__VISAGECPP__) && __IBMCPP__ >= 400
1030     #define wxLongLong_t long long
1031 #elif (defined(SIZEOF_LONG_LONG) && SIZEOF_LONG_LONG >= 8)  || \
1032         defined(__GNUC__) || \
1033         defined(__CYGWIN__) || \
1034         defined(__WXMICROWIN__) || \
1035         (defined(__DJGPP__) && __DJGPP__ >= 2)
1036     #define wxLongLong_t long long
1037     #define wxLongLongSuffix ll
1038     #define wxLongLongFmtSpec "ll"
1039 #elif defined(SIZEOF_LONG) && (SIZEOF_LONG == 8)
1040     #define wxLongLong_t long
1041     #define wxLongLongSuffix l
1042     #define wxLongLongFmtSpec "l"
1043     #define wxLongLongIsLong
1044 #endif
1045
1046
1047 #ifdef wxLongLong_t
1048
1049     #ifdef __WXPALMOS__
1050     #if defined(__WXPALMOS6__)
1051         #define wxULongLong_t uint64_t
1052     #else
1053         #define wxULongLong_t unsigned long long
1054     #endif /* __WXPALMOS6__ */
1055     #else
1056         #define wxULongLong_t unsigned wxLongLong_t
1057     #endif
1058
1059     /*
1060         wxLL() and wxULL() macros allow to define 64 bit constants in a
1061         portable way.
1062      */
1063     #ifndef wxCOMPILER_BROKEN_CONCAT_OPER
1064         #define wxLL(x) wxCONCAT(x, wxLongLongSuffix)
1065         #define wxULL(x) wxCONCAT(x, wxCONCAT(u, wxLongLongSuffix))
1066     #else
1067         // Currently only Borland compiler has broken concatenation operator
1068         // and this compiler is known to use [u]i64 suffix.
1069         #define wxLL(x) wxAPPEND_i64(x)
1070         #define wxULL(x) wxAPPEND_ui64(x)
1071     #endif
1072
1073     typedef wxLongLong_t wxInt64;
1074     typedef wxULongLong_t wxUint64;
1075
1076     #define wxHAS_INT64 1
1077
1078     #ifndef wxLongLongIsLong
1079         #define wxHAS_LONG_LONG_T_DIFFERENT_FROM_LONG
1080     #endif
1081 #elif wxUSE_LONGLONG
1082     /*  these macros allow to define 64 bit constants in a portable way */
1083     #define wxLL(x) wxLongLong(x)
1084     #define wxULL(x) wxULongLong(x)
1085
1086     #define wxInt64 wxLongLong
1087     #define wxUint64 wxULongLong
1088
1089     #define wxHAS_INT64 1
1090
1091 #else /* !wxUSE_LONGLONG */
1092
1093     #define wxHAS_INT64 0
1094
1095 #endif
1096
1097
1098 /* Make sure ssize_t is defined (a signed type the same size as size_t). */
1099 /* (HAVE_SSIZE_T is not already defined by configure) */
1100 #ifndef HAVE_SSIZE_T
1101 #ifdef __MINGW32__
1102     #if defined(_SSIZE_T_) || defined(_SSIZE_T_DEFINED)
1103         #define HAVE_SSIZE_T
1104     #endif
1105 #elif defined(__PALMOS__)
1106     #define HAVE_SSIZE_T
1107 #elif wxCHECK_WATCOM_VERSION(1,4)
1108     #define HAVE_SSIZE_T
1109 #endif
1110 #endif /* !HAVE_SSIZE_T */
1111
1112 /* If we really don't have ssize_t, provide our own version. */
1113 #ifdef HAVE_SSIZE_T
1114     #ifdef __UNIX__
1115         #include <sys/types.h>
1116     #endif
1117 #else // !HAVE_SSIZE_T
1118     #if SIZEOF_SIZE_T == 4
1119         typedef wxInt32 ssize_t;
1120     #elif SIZEOF_SIZE_T == 8
1121         typedef wxInt64 ssize_t;
1122     #else
1123         #error "error defining ssize_t, size_t is not 4 or 8 bytes"
1124     #endif
1125
1126     /* prevent ssize_t redefinitions in other libraries */
1127     #define HAVE_SSIZE_T
1128 #endif
1129
1130 // we can't rely on Windows _W64 being defined as windows.h may not be included
1131 // so define our own equivalent: this should be used with types like WXLPARAM
1132 // or WXWPARAM which are 64 bit under Win64 to avoid warnings each time we cast
1133 // it to a pointer or a handle (which results in hundreds of warnings as Win32
1134 // API often passes pointers in them)
1135 #if wxCHECK_VISUALC_VERSION(7)
1136     #define wxW64 __w64
1137 #else
1138     #define wxW64
1139 #endif
1140
1141 /*
1142    Define signed and unsigned integral types big enough to contain all of long,
1143    size_t and void *.
1144  */
1145 #if SIZEOF_SIZE_T >= SIZEOF_VOID_P
1146     /*
1147        Win64 case: size_t is the only integral type big enough for "void *".
1148
1149        Notice that we must use __w64 to avoid warnings about casting pointers
1150        to wxIntPtr (which we do often as this is what it is defined for) in 32
1151        bit build with MSVC.
1152      */
1153     typedef wxW64 ssize_t wxIntPtr;
1154     typedef size_t wxUIntPtr;
1155 #elif SIZEOF_LONG >= SIZEOF_VOID_P
1156     /*
1157        Normal case when long is the largest integral type.
1158      */
1159     typedef long wxIntPtr;
1160     typedef unsigned long wxUIntPtr;
1161 #else
1162     /*
1163        This should never happen for the current architectures but if you're
1164        using one where it does, please contact wx-dev@lists.wxwidgets.org.
1165      */
1166     #error "Pointers can't be stored inside integer types."
1167 #endif
1168
1169 #ifdef __cplusplus
1170 /* And also define a couple of simple functions to cast pointer to/from it. */
1171 inline wxUIntPtr wxPtrToUInt(const void *p)
1172 {
1173     /*
1174        VC++ 7.1 gives warnings about casts such as below even when they're
1175        explicit with /Wp64 option, suppress them as we really know what we're
1176        doing here. Same thing with icc with -Wall.
1177      */
1178 #ifdef __VISUALC__
1179     #if __VISUALC__ >= 1200
1180         #pragma warning(push)
1181     #endif
1182     /* pointer truncation from '' to '' */
1183     #pragma warning(disable: 4311)
1184 #elif defined(__INTELC__)
1185     #pragma warning(push)
1186     /* conversion from pointer to same-sized integral type */
1187     #pragma warning(disable: 1684)
1188 #endif
1189
1190     return wx_reinterpret_cast(wxUIntPtr, p);
1191
1192 #if (defined(__VISUALC__) && __VISUALC__ >= 1200) || defined(__INTELC__)
1193     #pragma warning(pop)
1194 #endif
1195 }
1196
1197 inline void *wxUIntToPtr(wxUIntPtr p)
1198 {
1199 #ifdef __VISUALC__
1200     #if __VISUALC__ >= 1200
1201         #pragma warning(push)
1202     #endif
1203     /* conversion to type of greater size */
1204     #pragma warning(disable: 4312)
1205 #elif defined(__INTELC__)
1206     #pragma warning(push)
1207     /* invalid type conversion: "wxUIntPtr={unsigned long}" to "void *" */
1208     #pragma warning(disable: 171)
1209 #endif
1210
1211     return wx_reinterpret_cast(void *, p);
1212
1213 #if (defined(__VISUALC__) && __VISUALC__ >= 1200) || defined(__INTELC__)
1214     #pragma warning(pop)
1215 #endif
1216 }
1217 #endif /*__cplusplus*/
1218
1219
1220
1221 /*  base floating point types */
1222 /*  wxFloat32: 32 bit IEEE float ( 1 sign, 8 exponent bits, 23 fraction bits ) */
1223 /*  wxFloat64: 64 bit IEEE float ( 1 sign, 11 exponent bits, 52 fraction bits ) */
1224 /*  wxDouble: native fastest representation that has at least wxFloat64 */
1225 /*            precision, so use the IEEE types for storage, and this for */
1226 /*            calculations */
1227
1228 typedef float wxFloat32;
1229 #if (defined( __WXMAC__ ) || defined(__WXCOCOA__))  && defined (__MWERKS__)
1230     typedef short double wxFloat64;
1231 #else
1232     typedef double wxFloat64;
1233 #endif
1234
1235 typedef double wxDouble;
1236
1237 /*
1238     Some (non standard) compilers typedef wchar_t as an existing type instead
1239     of treating it as a real fundamental type, set wxWCHAR_T_IS_REAL_TYPE to 0
1240     for them and to 1 for all the others.
1241  */
1242 #ifndef wxWCHAR_T_IS_REAL_TYPE
1243     /*
1244         VC++ typedefs wchar_t as unsigned short by default until VC8, that is
1245         unless /Za or /Zc:wchar_t option is used in which case _WCHAR_T_DEFINED
1246         is defined.
1247      */
1248 #   if defined(__VISUALC__) && !defined(_NATIVE_WCHAR_T_DEFINED)
1249 #       define wxWCHAR_T_IS_REAL_TYPE 0
1250 #   else /* compiler having standard-conforming wchar_t */
1251 #       define wxWCHAR_T_IS_REAL_TYPE 1
1252 #   endif
1253 #endif /* !defined(wxWCHAR_T_IS_REAL_TYPE) */
1254
1255 /* Helper macro for doing something dependent on whether wchar_t is or isn't a
1256    typedef inside another macro. */
1257 #if wxWCHAR_T_IS_REAL_TYPE
1258     #define wxIF_WCHAR_T_TYPE(x) x
1259 #else /* !wxWCHAR_T_IS_REAL_TYPE */
1260     #define wxIF_WCHAR_T_TYPE(x)
1261 #endif /* wxWCHAR_T_IS_REAL_TYPE/!wxWCHAR_T_IS_REAL_TYPE */
1262
1263 /*
1264    This constant should be used instead of NULL in vararg functions taking
1265    wxChar* arguments: passing NULL (which is the same as 0, unless the compiler
1266    defines it specially, e.g. like gcc does with its __null built-in) doesn't
1267    work in this case as va_arg() wouldn't interpret the integer 0 correctly
1268    when trying to convert it to a pointer on architectures where sizeof(int) is
1269    strictly less than sizeof(void *).
1270
1271    Examples of places where this must be used include wxFileTypeInfo ctor.
1272  */
1273 #define wxNullPtr ((void *)NULL)
1274
1275
1276 /* Define wxChar16 and wxChar32                                              */
1277
1278 #if SIZEOF_WCHAR_T == 2
1279     #define wxWCHAR_T_IS_WXCHAR16
1280     typedef wchar_t wxChar16;
1281 #else
1282     typedef wxUint16 wxChar16;
1283 #endif
1284
1285 #if SIZEOF_WCHAR_T == 4
1286     #define wxWCHAR_T_IS_WXCHAR32
1287     typedef wchar_t wxChar32;
1288 #else
1289     typedef wxUint32 wxChar32;
1290 #endif
1291
1292
1293 /*  ---------------------------------------------------------------------------- */
1294 /*  byte ordering related definition and macros */
1295 /*  ---------------------------------------------------------------------------- */
1296
1297 /*  byte sex */
1298
1299 #define  wxBIG_ENDIAN     4321
1300 #define  wxLITTLE_ENDIAN  1234
1301 #define  wxPDP_ENDIAN     3412
1302
1303 #ifdef WORDS_BIGENDIAN
1304 #define  wxBYTE_ORDER  wxBIG_ENDIAN
1305 #else
1306 #define  wxBYTE_ORDER  wxLITTLE_ENDIAN
1307 #endif
1308
1309 /*  byte swapping */
1310
1311 #if defined (__MWERKS__) && ( (__MWERKS__ < 0x0900) || macintosh )
1312 /*  assembler versions for these */
1313 #ifdef __POWERPC__
1314     inline wxUint16 wxUINT16_SWAP_ALWAYS( wxUint16 i )
1315         {return (__lhbrx( &i , 0 ) );}
1316     inline wxInt16 wxINT16_SWAP_ALWAYS( wxInt16 i )
1317         {return (__lhbrx( &i , 0 ) );}
1318     inline wxUint32 wxUINT32_SWAP_ALWAYS( wxUint32 i )
1319         {return (__lwbrx( &i , 0 ) );}
1320     inline wxInt32 wxINT32_SWAP_ALWAYS( wxInt32 i )
1321         {return (__lwbrx( &i , 0 ) );}
1322 #else
1323     #pragma parameter __D0 wxUINT16_SWAP_ALWAYS(__D0)
1324     pascal wxUint16 wxUINT16_SWAP_ALWAYS(wxUint16 value)
1325         = { 0xE158 };
1326
1327     #pragma parameter __D0 wxINT16_SWAP_ALWAYS(__D0)
1328     pascal wxInt16 wxINT16_SWAP_ALWAYS(wxInt16 value)
1329         = { 0xE158 };
1330
1331     #pragma parameter __D0 wxUINT32_SWAP_ALWAYS (__D0)
1332     pascal wxUint32 wxUINT32_SWAP_ALWAYS(wxUint32 value)
1333         = { 0xE158, 0x4840, 0xE158 };
1334
1335     #pragma parameter __D0 wxINT32_SWAP_ALWAYS (__D0)
1336     pascal wxInt32 wxINT32_SWAP_ALWAYS(wxInt32 value)
1337         = { 0xE158, 0x4840, 0xE158 };
1338
1339 #endif
1340 #else /*  !MWERKS */
1341 #define wxUINT16_SWAP_ALWAYS(val) \
1342    ((wxUint16) ( \
1343     (((wxUint16) (val) & (wxUint16) 0x00ffU) << 8) | \
1344     (((wxUint16) (val) & (wxUint16) 0xff00U) >> 8)))
1345
1346 #define wxINT16_SWAP_ALWAYS(val) \
1347    ((wxInt16) ( \
1348     (((wxUint16) (val) & (wxUint16) 0x00ffU) << 8) | \
1349     (((wxUint16) (val) & (wxUint16) 0xff00U) >> 8)))
1350
1351 #define wxUINT32_SWAP_ALWAYS(val) \
1352    ((wxUint32) ( \
1353     (((wxUint32) (val) & (wxUint32) 0x000000ffU) << 24) | \
1354     (((wxUint32) (val) & (wxUint32) 0x0000ff00U) <<  8) | \
1355     (((wxUint32) (val) & (wxUint32) 0x00ff0000U) >>  8) | \
1356     (((wxUint32) (val) & (wxUint32) 0xff000000U) >> 24)))
1357
1358 #define wxINT32_SWAP_ALWAYS(val) \
1359    ((wxInt32) ( \
1360     (((wxUint32) (val) & (wxUint32) 0x000000ffU) << 24) | \
1361     (((wxUint32) (val) & (wxUint32) 0x0000ff00U) <<  8) | \
1362     (((wxUint32) (val) & (wxUint32) 0x00ff0000U) >>  8) | \
1363     (((wxUint32) (val) & (wxUint32) 0xff000000U) >> 24)))
1364 #endif
1365 /*  machine specific byte swapping */
1366
1367 #ifdef wxLongLong_t
1368     #define wxUINT64_SWAP_ALWAYS(val) \
1369        ((wxUint64) ( \
1370         (((wxUint64) (val) & (wxUint64) wxULL(0x00000000000000ff)) << 56) | \
1371         (((wxUint64) (val) & (wxUint64) wxULL(0x000000000000ff00)) << 40) | \
1372         (((wxUint64) (val) & (wxUint64) wxULL(0x0000000000ff0000)) << 24) | \
1373         (((wxUint64) (val) & (wxUint64) wxULL(0x00000000ff000000)) <<  8) | \
1374         (((wxUint64) (val) & (wxUint64) wxULL(0x000000ff00000000)) >>  8) | \
1375         (((wxUint64) (val) & (wxUint64) wxULL(0x0000ff0000000000)) >> 24) | \
1376         (((wxUint64) (val) & (wxUint64) wxULL(0x00ff000000000000)) >> 40) | \
1377         (((wxUint64) (val) & (wxUint64) wxULL(0xff00000000000000)) >> 56)))
1378
1379     #define wxINT64_SWAP_ALWAYS(val) \
1380        ((wxInt64) ( \
1381         (((wxUint64) (val) & (wxUint64) wxULL(0x00000000000000ff)) << 56) | \
1382         (((wxUint64) (val) & (wxUint64) wxULL(0x000000000000ff00)) << 40) | \
1383         (((wxUint64) (val) & (wxUint64) wxULL(0x0000000000ff0000)) << 24) | \
1384         (((wxUint64) (val) & (wxUint64) wxULL(0x00000000ff000000)) <<  8) | \
1385         (((wxUint64) (val) & (wxUint64) wxULL(0x000000ff00000000)) >>  8) | \
1386         (((wxUint64) (val) & (wxUint64) wxULL(0x0000ff0000000000)) >> 24) | \
1387         (((wxUint64) (val) & (wxUint64) wxULL(0x00ff000000000000)) >> 40) | \
1388         (((wxUint64) (val) & (wxUint64) wxULL(0xff00000000000000)) >> 56)))
1389 #elif wxUSE_LONGLONG /*  !wxLongLong_t */
1390     #define wxUINT64_SWAP_ALWAYS(val) \
1391        ((wxUint64) ( \
1392         ((wxULongLong(val) & wxULongLong(0L, 0x000000ffU)) << 56) | \
1393         ((wxULongLong(val) & wxULongLong(0L, 0x0000ff00U)) << 40) | \
1394         ((wxULongLong(val) & wxULongLong(0L, 0x00ff0000U)) << 24) | \
1395         ((wxULongLong(val) & wxULongLong(0L, 0xff000000U)) <<  8) | \
1396         ((wxULongLong(val) & wxULongLong(0x000000ffL, 0U)) >>  8) | \
1397         ((wxULongLong(val) & wxULongLong(0x0000ff00L, 0U)) >> 24) | \
1398         ((wxULongLong(val) & wxULongLong(0x00ff0000L, 0U)) >> 40) | \
1399         ((wxULongLong(val) & wxULongLong(0xff000000L, 0U)) >> 56)))
1400
1401     #define wxINT64_SWAP_ALWAYS(val) \
1402        ((wxInt64) ( \
1403         ((wxLongLong(val) & wxLongLong(0L, 0x000000ffU)) << 56) | \
1404         ((wxLongLong(val) & wxLongLong(0L, 0x0000ff00U)) << 40) | \
1405         ((wxLongLong(val) & wxLongLong(0L, 0x00ff0000U)) << 24) | \
1406         ((wxLongLong(val) & wxLongLong(0L, 0xff000000U)) <<  8) | \
1407         ((wxLongLong(val) & wxLongLong(0x000000ffL, 0U)) >>  8) | \
1408         ((wxLongLong(val) & wxLongLong(0x0000ff00L, 0U)) >> 24) | \
1409         ((wxLongLong(val) & wxLongLong(0x00ff0000L, 0U)) >> 40) | \
1410         ((wxLongLong(val) & wxLongLong(0xff000000L, 0U)) >> 56)))
1411 #endif /*  wxLongLong_t/!wxLongLong_t */
1412
1413 #ifdef WORDS_BIGENDIAN
1414     #define wxUINT16_SWAP_ON_BE(val)  wxUINT16_SWAP_ALWAYS(val)
1415     #define wxINT16_SWAP_ON_BE(val)   wxINT16_SWAP_ALWAYS(val)
1416     #define wxUINT16_SWAP_ON_LE(val)  (val)
1417     #define wxINT16_SWAP_ON_LE(val)   (val)
1418     #define wxUINT32_SWAP_ON_BE(val)  wxUINT32_SWAP_ALWAYS(val)
1419     #define wxINT32_SWAP_ON_BE(val)   wxINT32_SWAP_ALWAYS(val)
1420     #define wxUINT32_SWAP_ON_LE(val)  (val)
1421     #define wxINT32_SWAP_ON_LE(val)   (val)
1422     #if wxHAS_INT64
1423         #define wxUINT64_SWAP_ON_BE(val)  wxUINT64_SWAP_ALWAYS(val)
1424         #define wxUINT64_SWAP_ON_LE(val)  (val)
1425         #define wxINT64_SWAP_ON_BE(val)  wxINT64_SWAP_ALWAYS(val)
1426         #define wxINT64_SWAP_ON_LE(val)  (val)
1427     #endif
1428 #else
1429     #define wxUINT16_SWAP_ON_LE(val)  wxUINT16_SWAP_ALWAYS(val)
1430     #define wxINT16_SWAP_ON_LE(val)   wxINT16_SWAP_ALWAYS(val)
1431     #define wxUINT16_SWAP_ON_BE(val)  (val)
1432     #define wxINT16_SWAP_ON_BE(val)   (val)
1433     #define wxUINT32_SWAP_ON_LE(val)  wxUINT32_SWAP_ALWAYS(val)
1434     #define wxINT32_SWAP_ON_LE(val)   wxINT32_SWAP_ALWAYS(val)
1435     #define wxUINT32_SWAP_ON_BE(val)  (val)
1436     #define wxINT32_SWAP_ON_BE(val)   (val)
1437     #if wxHAS_INT64
1438         #define wxUINT64_SWAP_ON_LE(val)  wxUINT64_SWAP_ALWAYS(val)
1439         #define wxUINT64_SWAP_ON_BE(val)  (val)
1440         #define wxINT64_SWAP_ON_LE(val)  wxINT64_SWAP_ALWAYS(val)
1441         #define wxINT64_SWAP_ON_BE(val)  (val)
1442     #endif
1443 #endif
1444
1445 /*  ---------------------------------------------------------------------------- */
1446 /*  template workarounds for buggy compilers */
1447 /*  ---------------------------------------------------------------------------- */
1448
1449 #if defined(__GNUC__) && !wxCHECK_GCC_VERSION( 3, 4 )
1450     // GCC <= 3.4 has buggy template support
1451 #  define wxUSE_MEMBER_TEMPLATES 0
1452 #endif
1453
1454 #if defined(_MSC_VER) && _MSC_VER <= 1200
1455     // MSVC <= 6.0 has buggy template support
1456 #  define wxUSE_MEMBER_TEMPLATES 0
1457 #  define wxUSE_FUNC_TEMPLATE_POINTER 0
1458 #endif
1459
1460 #ifndef wxUSE_MEMBER_TEMPLATES
1461 #  define wxUSE_MEMBER_TEMPLATES 1
1462 #endif
1463
1464 #ifndef wxUSE_FUNC_TEMPLATE_POINTER
1465 #  define wxUSE_FUNC_TEMPLATE_POINTER 1
1466 #endif
1467
1468 #if wxUSE_MEMBER_TEMPLATES
1469 #  define wxTEMPLATED_MEMBER_CALL( method, type ) method<type>()
1470 #  define wxTEMPLATED_MEMBER_FIX( type )
1471 #else
1472 #  define wxTEMPLATED_MEMBER_CALL( method, type ) method((type*)NULL)
1473 #  define wxTEMPLATED_MEMBER_FIX( type ) type* =NULL
1474 #endif
1475
1476 #if defined(_MSC_VER) && _MSC_VER <= 1200
1477 #  define wxTEMPLATED_FUNCTION_FIX( type ), wxTEMPLATED_MEMBER_FIX(type)
1478 #  define wxINFUNC_CLASS_TYPE_FIX( type ) typedef type type;
1479 #else
1480 #  define wxTEMPLATED_FUNCTION_FIX( type )
1481 #  define wxINFUNC_CLASS_TYPE_FIX( type )
1482 #endif
1483
1484 /*  ---------------------------------------------------------------------------- */
1485 /*  Geometric flags */
1486 /*  ---------------------------------------------------------------------------- */
1487
1488 enum wxGeometryCentre
1489 {
1490     wxCENTRE                  = 0x0001,
1491     wxCENTER                  = wxCENTRE
1492 };
1493
1494 /*  centering into frame rather than screen (obsolete) */
1495 #define wxCENTER_FRAME          0x0000
1496 /*  centre on screen rather than parent */
1497 #define wxCENTRE_ON_SCREEN      0x0002
1498 #define wxCENTER_ON_SCREEN      wxCENTRE_ON_SCREEN
1499
1500 enum wxOrientation
1501 {
1502     /* don't change the values of these elements, they are used elsewhere */
1503     wxHORIZONTAL              = 0x0004,
1504     wxVERTICAL                = 0x0008,
1505
1506     wxBOTH                    = wxVERTICAL | wxHORIZONTAL,
1507
1508     /*  a mask to extract orientation from the combination of flags */
1509     wxORIENTATION_MASK        = wxBOTH
1510 };
1511
1512 enum wxDirection
1513 {
1514     wxLEFT                    = 0x0010,
1515     wxRIGHT                   = 0x0020,
1516     wxUP                      = 0x0040,
1517     wxDOWN                    = 0x0080,
1518
1519     wxTOP                     = wxUP,
1520     wxBOTTOM                  = wxDOWN,
1521
1522     wxNORTH                   = wxUP,
1523     wxSOUTH                   = wxDOWN,
1524     wxWEST                    = wxLEFT,
1525     wxEAST                    = wxRIGHT,
1526
1527     wxALL                     = (wxUP | wxDOWN | wxRIGHT | wxLEFT),
1528
1529     /*  a mask to extract direction from the combination of flags */
1530     wxDIRECTION_MASK           = wxALL
1531 };
1532
1533 enum wxAlignment
1534 {
1535     // 0 is a valid wxAlignment value (both wxALIGN_LEFT and wxALIGN_TOP use
1536     // it) so define a symbolic name for an invalid alignment value which can
1537     // be assumed to be different from anything else
1538     wxALIGN_INVALID           = -1,
1539
1540     wxALIGN_NOT               = 0x0000,
1541     wxALIGN_CENTER_HORIZONTAL = 0x0100,
1542     wxALIGN_CENTRE_HORIZONTAL = wxALIGN_CENTER_HORIZONTAL,
1543     wxALIGN_LEFT              = wxALIGN_NOT,
1544     wxALIGN_TOP               = wxALIGN_NOT,
1545     wxALIGN_RIGHT             = 0x0200,
1546     wxALIGN_BOTTOM            = 0x0400,
1547     wxALIGN_CENTER_VERTICAL   = 0x0800,
1548     wxALIGN_CENTRE_VERTICAL   = wxALIGN_CENTER_VERTICAL,
1549
1550     wxALIGN_CENTER            = (wxALIGN_CENTER_HORIZONTAL | wxALIGN_CENTER_VERTICAL),
1551     wxALIGN_CENTRE            = wxALIGN_CENTER,
1552
1553     /*  a mask to extract alignment from the combination of flags */
1554     wxALIGN_MASK              = 0x0f00
1555 };
1556
1557 /* misc. flags for wxSizer items */
1558 enum wxSizerFlagBits
1559 {
1560     // wxADJUST_MINSIZE doesn't do anything any more but we still define it for
1561     // compatibility. Notice that it may be also predefined (as 0, hopefully)
1562     // in the user code in order to use it even in !WXWIN_COMPATIBILITY_2_8
1563     // builds so don't redefine it in such case.
1564 #if WXWIN_COMPATIBILITY_2_8 && !defined(wxADJUST_MINSIZE)
1565     wxADJUST_MINSIZE               = 0,
1566 #endif
1567     wxFIXED_MINSIZE                = 0x8000,
1568     wxRESERVE_SPACE_EVEN_IF_HIDDEN = 0x0002,
1569
1570     /*  a mask to extract wxSizerFlagBits from combination of flags */
1571     wxSIZER_FLAG_BITS_MASK         = 0x8002
1572 };
1573
1574 enum wxStretch
1575 {
1576     wxSTRETCH_NOT             = 0x0000,
1577     wxSHRINK                  = 0x1000,
1578     wxGROW                    = 0x2000,
1579     wxEXPAND                  = wxGROW,
1580     wxSHAPED                  = 0x4000,
1581     wxTILE                    = wxSHAPED | wxFIXED_MINSIZE,
1582
1583     /*  a mask to extract stretch from the combination of flags */
1584     wxSTRETCH_MASK            = 0x7000 /* sans wxTILE */
1585 };
1586
1587 /*  border flags: the values are chosen for backwards compatibility */
1588 enum wxBorder
1589 {
1590     /*  this is different from wxBORDER_NONE as by default the controls do have */
1591     /*  border */
1592     wxBORDER_DEFAULT = 0,
1593
1594     wxBORDER_NONE   = 0x00200000,
1595     wxBORDER_STATIC = 0x01000000,
1596     wxBORDER_SIMPLE = 0x02000000,
1597     wxBORDER_RAISED = 0x04000000,
1598     wxBORDER_SUNKEN = 0x08000000,
1599     wxBORDER_DOUBLE = 0x10000000, /* deprecated */
1600     wxBORDER_THEME  = wxBORDER_DOUBLE,
1601
1602     /*  a mask to extract border style from the combination of flags */
1603     wxBORDER_MASK   = 0x1f200000
1604 };
1605
1606 /* This makes it easier to specify a 'normal' border for a control */
1607 #if defined(__SMARTPHONE__) || defined(__POCKETPC__)
1608 #define wxDEFAULT_CONTROL_BORDER    wxBORDER_SIMPLE
1609 #else
1610 #define wxDEFAULT_CONTROL_BORDER    wxBORDER_SUNKEN
1611 #endif
1612
1613 /*  ---------------------------------------------------------------------------- */
1614 /*  Window style flags */
1615 /*  ---------------------------------------------------------------------------- */
1616
1617 /*
1618  * Values are chosen so they can be |'ed in a bit list.
1619  * Some styles are used across more than one group,
1620  * so the values mustn't clash with others in the group.
1621  * Otherwise, numbers can be reused across groups.
1622  */
1623
1624 /*
1625     Summary of the bits used by various styles.
1626
1627     High word, containing styles which can be used with many windows:
1628
1629     +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
1630     |31|30|29|28|27|26|25|24|23|22|21|20|19|18|17|16|
1631     +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
1632       |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |
1633       |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  \_ wxFULL_REPAINT_ON_RESIZE
1634       |  |  |  |  |  |  |  |  |  |  |  |  |  |  \____ wxPOPUP_WINDOW
1635       |  |  |  |  |  |  |  |  |  |  |  |  |  \_______ wxWANTS_CHARS
1636       |  |  |  |  |  |  |  |  |  |  |  |  \__________ wxTAB_TRAVERSAL
1637       |  |  |  |  |  |  |  |  |  |  |  \_____________ wxTRANSPARENT_WINDOW
1638       |  |  |  |  |  |  |  |  |  |  \________________ wxBORDER_NONE
1639       |  |  |  |  |  |  |  |  |  \___________________ wxCLIP_CHILDREN
1640       |  |  |  |  |  |  |  |  \______________________ wxALWAYS_SHOW_SB
1641       |  |  |  |  |  |  |  \_________________________ wxBORDER_STATIC
1642       |  |  |  |  |  |  \____________________________ wxBORDER_SIMPLE
1643       |  |  |  |  |  \_______________________________ wxBORDER_RAISED
1644       |  |  |  |  \__________________________________ wxBORDER_SUNKEN
1645       |  |  |  \_____________________________________ wxBORDER_{DOUBLE,THEME}
1646       |  |  \________________________________________ wxCAPTION/wxCLIP_SIBLINGS
1647       |  \___________________________________________ wxHSCROLL
1648       \______________________________________________ wxVSCROLL
1649
1650
1651     Low word style bits is class-specific meaning that the same bit can have
1652     different meanings for different controls (e.g. 0x10 is wxCB_READONLY
1653     meaning that the control can't be modified for wxComboBox but wxLB_SORT
1654     meaning that the control should be kept sorted for wxListBox, while
1655     wxLB_SORT has a different value -- and this is just fine).
1656  */
1657
1658 /*
1659  * Window (Frame/dialog/subwindow/panel item) style flags
1660  */
1661 #define wxVSCROLL               0x80000000
1662 #define wxHSCROLL               0x40000000
1663 #define wxCAPTION               0x20000000
1664
1665 /*  New styles (border styles are now in their own enum) */
1666 #define wxDOUBLE_BORDER         wxBORDER_DOUBLE
1667 #define wxSUNKEN_BORDER         wxBORDER_SUNKEN
1668 #define wxRAISED_BORDER         wxBORDER_RAISED
1669 #define wxBORDER                wxBORDER_SIMPLE
1670 #define wxSIMPLE_BORDER         wxBORDER_SIMPLE
1671 #define wxSTATIC_BORDER         wxBORDER_STATIC
1672 #define wxNO_BORDER             wxBORDER_NONE
1673
1674 /*  wxALWAYS_SHOW_SB: instead of hiding the scrollbar when it is not needed, */
1675 /*  disable it - but still show (see also wxLB_ALWAYS_SB style) */
1676 /*  */
1677 /*  NB: as this style is only supported by wxUniversal and wxMSW so far */
1678 #define wxALWAYS_SHOW_SB        0x00800000
1679
1680 /*  Clip children when painting, which reduces flicker in e.g. frames and */
1681 /*  splitter windows, but can't be used in a panel where a static box must be */
1682 /*  'transparent' (panel paints the background for it) */
1683 #define wxCLIP_CHILDREN         0x00400000
1684
1685 /*  Note we're reusing the wxCAPTION style because we won't need captions */
1686 /*  for subwindows/controls */
1687 #define wxCLIP_SIBLINGS         0x20000000
1688
1689 #define wxTRANSPARENT_WINDOW    0x00100000
1690
1691 /*  Add this style to a panel to get tab traversal working outside of dialogs */
1692 /*  (on by default for wxPanel, wxDialog, wxScrolledWindow) */
1693 #define wxTAB_TRAVERSAL         0x00080000
1694
1695 /*  Add this style if the control wants to get all keyboard messages (under */
1696 /*  Windows, it won't normally get the dialog navigation key events) */
1697 #define wxWANTS_CHARS           0x00040000
1698
1699 /*  Make window retained (Motif only, see src/generic/scrolwing.cpp)
1700  *  This is non-zero only under wxMotif, to avoid a clash with wxPOPUP_WINDOW
1701  *  on other platforms
1702  */
1703
1704 #ifdef __WXMOTIF__
1705 #define wxRETAINED              0x00020000
1706 #else
1707 #define wxRETAINED              0x00000000
1708 #endif
1709 #define wxBACKINGSTORE          wxRETAINED
1710
1711 /*  set this flag to create a special popup window: it will be always shown on */
1712 /*  top of other windows, will capture the mouse and will be dismissed when the */
1713 /*  mouse is clicked outside of it or if it loses focus in any other way */
1714 #define wxPOPUP_WINDOW          0x00020000
1715
1716 /*  force a full repaint when the window is resized (instead of repainting just */
1717 /*  the invalidated area) */
1718 #define wxFULL_REPAINT_ON_RESIZE 0x00010000
1719
1720 /*  obsolete: now this is the default behaviour */
1721 /*  */
1722 /*  don't invalidate the whole window (resulting in a PAINT event) when the */
1723 /*  window is resized (currently, makes sense for wxMSW only) */
1724 #define wxNO_FULL_REPAINT_ON_RESIZE 0
1725
1726 /* A mask which can be used to filter (out) all wxWindow-specific styles.
1727  */
1728 #define wxWINDOW_STYLE_MASK     \
1729     (wxVSCROLL|wxHSCROLL|wxBORDER_MASK|wxALWAYS_SHOW_SB|wxCLIP_CHILDREN| \
1730      wxCLIP_SIBLINGS|wxTRANSPARENT_WINDOW|wxTAB_TRAVERSAL|wxWANTS_CHARS| \
1731      wxRETAINED|wxPOPUP_WINDOW|wxFULL_REPAINT_ON_RESIZE)
1732
1733 /*
1734  * Extra window style flags (use wxWS_EX prefix to make it clear that they
1735  * should be passed to wxWindow::SetExtraStyle(), not SetWindowStyle())
1736  */
1737
1738 /*  by default, TransferDataTo/FromWindow() only work on direct children of the */
1739 /*  window (compatible behaviour), set this flag to make them recursively */
1740 /*  descend into all subwindows */
1741 #define wxWS_EX_VALIDATE_RECURSIVELY    0x00000001
1742
1743 /*  wxCommandEvents and the objects of the derived classes are forwarded to the */
1744 /*  parent window and so on recursively by default. Using this flag for the */
1745 /*  given window allows to block this propagation at this window, i.e. prevent */
1746 /*  the events from being propagated further upwards. The dialogs have this */
1747 /*  flag on by default. */
1748 #define wxWS_EX_BLOCK_EVENTS            0x00000002
1749
1750 /*  don't use this window as an implicit parent for the other windows: this must */
1751 /*  be used with transient windows as otherwise there is the risk of creating a */
1752 /*  dialog/frame with this window as a parent which would lead to a crash if the */
1753 /*  parent is destroyed before the child */
1754 #define wxWS_EX_TRANSIENT               0x00000004
1755
1756 /*  don't paint the window background, we'll assume it will */
1757 /*  be done by a theming engine. This is not yet used but could */
1758 /*  possibly be made to work in the future, at least on Windows */
1759 #define wxWS_EX_THEMED_BACKGROUND       0x00000008
1760
1761 /*  this window should always process idle events */
1762 #define wxWS_EX_PROCESS_IDLE            0x00000010
1763
1764 /*  this window should always process UI update events */
1765 #define wxWS_EX_PROCESS_UI_UPDATES      0x00000020
1766
1767 /*  Draw the window in a metal theme on Mac */
1768 #define wxFRAME_EX_METAL                0x00000040
1769 #define wxDIALOG_EX_METAL               0x00000040
1770
1771 /*  Use this style to add a context-sensitive help to the window (currently for */
1772 /*  Win32 only and it doesn't work if wxMINIMIZE_BOX or wxMAXIMIZE_BOX are used) */
1773 #define wxWS_EX_CONTEXTHELP             0x00000080
1774
1775 /* synonyms for wxWS_EX_CONTEXTHELP for compatibility */
1776 #define wxFRAME_EX_CONTEXTHELP          wxWS_EX_CONTEXTHELP
1777 #define wxDIALOG_EX_CONTEXTHELP         wxWS_EX_CONTEXTHELP
1778
1779 /*  Create a window which is attachable to another top level window */
1780 #define wxFRAME_DRAWER          0x0020
1781
1782 /*
1783  * MDI parent frame style flags
1784  * Can overlap with some of the above.
1785  */
1786
1787 #define wxFRAME_NO_WINDOW_MENU  0x0100
1788
1789 /*
1790  * wxMenuBar style flags
1791  */
1792 /*  use native docking */
1793 #define wxMB_DOCKABLE       0x0001
1794
1795 /*
1796  * wxMenu style flags
1797  */
1798 #define wxMENU_TEAROFF      0x0001
1799
1800 /*
1801  * Apply to all panel items
1802  */
1803 #define wxCOLOURED          0x0800
1804 #define wxFIXED_LENGTH      0x0400
1805
1806 /*
1807  * Styles for wxListBox
1808  */
1809 #define wxLB_SORT           0x0010
1810 #define wxLB_SINGLE         0x0020
1811 #define wxLB_MULTIPLE       0x0040
1812 #define wxLB_EXTENDED       0x0080
1813 /*  wxLB_OWNERDRAW is Windows-only */
1814 #define wxLB_NEEDED_SB      0x0000
1815 #define wxLB_OWNERDRAW      0x0100
1816 #define wxLB_ALWAYS_SB      0x0200
1817 #define wxLB_NO_SB          0x0400
1818 #define wxLB_HSCROLL        wxHSCROLL
1819 /*  always show an entire number of rows */
1820 #define wxLB_INT_HEIGHT     0x0800
1821
1822 #if WXWIN_COMPATIBILITY_2_6
1823     /*  deprecated synonyms */
1824     #define wxPROCESS_ENTER   0x0400  /*  wxTE_PROCESS_ENTER */
1825     #define wxPASSWORD        0x0800  /*  wxTE_PASSWORD */
1826 #endif
1827
1828 /*
1829  * wxComboBox style flags
1830  */
1831 #define wxCB_SIMPLE         0x0004
1832 #define wxCB_SORT           0x0008
1833 #define wxCB_READONLY       0x0010
1834 #define wxCB_DROPDOWN       0x0020
1835
1836 /*
1837  * wxRadioBox style flags
1838  */
1839 /*  should we number the items from left to right or from top to bottom in a 2d */
1840 /*  radiobox? */
1841 #define wxRA_LEFTTORIGHT    0x0001
1842 #define wxRA_TOPTOBOTTOM    0x0002
1843
1844 /*  New, more intuitive names to specify majorDim argument */
1845 #define wxRA_SPECIFY_COLS   wxHORIZONTAL
1846 #define wxRA_SPECIFY_ROWS   wxVERTICAL
1847
1848 /*  Old names for compatibility */
1849 #define wxRA_HORIZONTAL     wxHORIZONTAL
1850 #define wxRA_VERTICAL       wxVERTICAL
1851 #define wxRA_USE_CHECKBOX   0x0010 /* alternative native subcontrols (wxPalmOS) */
1852
1853 /*
1854  * wxRadioButton style flag
1855  */
1856 #define wxRB_GROUP          0x0004
1857 #define wxRB_SINGLE         0x0008
1858 #define wxRB_USE_CHECKBOX   0x0010 /* alternative native control (wxPalmOS) */
1859
1860 /*
1861  * wxScrollBar flags
1862  */
1863 #define wxSB_HORIZONTAL      wxHORIZONTAL
1864 #define wxSB_VERTICAL        wxVERTICAL
1865
1866 /*
1867  * wxSpinButton flags.
1868  * Note that a wxSpinCtrl is sometimes defined as a wxTextCtrl, and so the
1869  * flags shouldn't overlap with wxTextCtrl flags that can be used for a single
1870  * line controls (currently we reuse wxTE_CHARWRAP and wxTE_RICH2 neither of
1871  * which makes sense for them).
1872  */
1873 #define wxSP_HORIZONTAL       wxHORIZONTAL /*  4 */
1874 #define wxSP_VERTICAL         wxVERTICAL   /*  8 */
1875 #define wxSP_ARROW_KEYS       0x4000
1876 #define wxSP_WRAP             0x8000
1877
1878 /*
1879  * wxTabCtrl flags
1880  */
1881 #define wxTC_RIGHTJUSTIFY     0x0010
1882 #define wxTC_FIXEDWIDTH       0x0020
1883 #define wxTC_TOP              0x0000    /*  default */
1884 #define wxTC_LEFT             0x0020
1885 #define wxTC_RIGHT            0x0040
1886 #define wxTC_BOTTOM           0x0080
1887 #define wxTC_MULTILINE        0x0200    /* == wxNB_MULTILINE */
1888 #define wxTC_OWNERDRAW        0x0400
1889
1890 /*
1891  * wxStaticBitmap flags
1892  */
1893 #define wxBI_EXPAND           wxEXPAND
1894
1895 /*
1896  * wxStaticLine flags
1897  */
1898 #define wxLI_HORIZONTAL         wxHORIZONTAL
1899 #define wxLI_VERTICAL           wxVERTICAL
1900
1901
1902 /*
1903  * extended dialog specifiers. these values are stored in a different
1904  * flag and thus do not overlap with other style flags. note that these
1905  * values do not correspond to the return values of the dialogs (for
1906  * those values, look at the wxID_XXX defines).
1907  */
1908
1909 /*  wxCENTRE already defined as  0x00000001 */
1910 #define wxYES                   0x00000002
1911 #define wxOK                    0x00000004
1912 #define wxNO                    0x00000008
1913 #define wxYES_NO                (wxYES | wxNO)
1914 #define wxCANCEL                0x00000010
1915 #define wxAPPLY                 0x00000020
1916 #define wxCLOSE                 0x00000040
1917
1918 #define wxOK_DEFAULT            0x00000000  /* has no effect (default) */
1919 #define wxYES_DEFAULT           0x00000000  /* has no effect (default) */
1920 #define wxNO_DEFAULT            0x00000080  /* only valid with wxYES_NO */
1921 #define wxCANCEL_DEFAULT        0x80000000  /* only valid with wxCANCEL */
1922
1923 #define wxICON_EXCLAMATION      0x00000100
1924 #define wxICON_HAND             0x00000200
1925 #define wxICON_WARNING          wxICON_EXCLAMATION
1926 #define wxICON_ERROR            wxICON_HAND
1927 #define wxICON_QUESTION         0x00000400
1928 #define wxICON_INFORMATION      0x00000800
1929 #define wxICON_STOP             wxICON_HAND
1930 #define wxICON_ASTERISK         wxICON_INFORMATION
1931
1932 #define  wxFORWARD              0x00001000
1933 #define  wxBACKWARD             0x00002000
1934 #define  wxRESET                0x00004000
1935 #define  wxHELP                 0x00008000
1936 #define  wxMORE                 0x00010000
1937 #define  wxSETUP                0x00020000
1938 #define wxICON_NONE             0x00040000
1939
1940 #define wxICON_MASK \
1941     (wxICON_EXCLAMATION|wxICON_HAND|wxICON_QUESTION|wxICON_INFORMATION|wxICON_NONE)
1942
1943 /*
1944  * Background styles. See wxWindow::SetBackgroundStyle
1945  */
1946 enum wxBackgroundStyle
1947 {
1948     // background is erased in the EVT_ERASE_BACKGROUND handler or using the
1949     // system default background if no such handler is defined (this is the
1950     // default style)
1951     wxBG_STYLE_ERASE,
1952
1953     // background is erased by the system, no EVT_ERASE_BACKGROUND event is
1954     // generated at all
1955     wxBG_STYLE_SYSTEM,
1956
1957     // background is erased in EVT_PAINT handler and not erased at all before
1958     // it, this should be used if the paint handler paints over the entire
1959     // window to avoid flicker
1960     wxBG_STYLE_PAINT,
1961
1962
1963     // this is a Mac-only style, don't use in portable code
1964     wxBG_STYLE_TRANSPARENT,
1965
1966     // this style is deprecated and doesn't do anything, don't use
1967     wxBG_STYLE_COLOUR,
1968
1969     // this style is deprecated and is synonymous with wxBG_STYLE_PAINT, use
1970     // the new name
1971     wxBG_STYLE_CUSTOM = wxBG_STYLE_PAINT
1972 };
1973
1974 /*
1975  * Key types used by (old style) lists and hashes.
1976  */
1977 enum wxKeyType
1978 {
1979     wxKEY_NONE,
1980     wxKEY_INTEGER,
1981     wxKEY_STRING
1982 };
1983
1984 /*  ---------------------------------------------------------------------------- */
1985 /*  standard IDs */
1986 /*  ---------------------------------------------------------------------------- */
1987
1988 /*  Standard menu IDs */
1989 enum wxStandardID
1990 {
1991     /*
1992        These ids delimit the range used by automatically-generated ids
1993        (i.e. those used when wxID_ANY is specified during construction).
1994      */
1995 #if defined(__WXMSW__) || wxUSE_AUTOID_MANAGEMENT
1996     /*
1997        On MSW the range is always restricted no matter if id management
1998        is used or not because the native window ids are limited to short
1999        range.  On other platforms the range is only restricted if id
2000        management is used so the reference count buffer won't be so big.
2001      */
2002     wxID_AUTO_LOWEST = -32000,
2003     wxID_AUTO_HIGHEST = -2000,
2004 #else
2005     wxID_AUTO_LOWEST = -1000000,
2006     wxID_AUTO_HIGHEST = -2000,
2007 #endif
2008
2009     /* no id matches this one when compared to it */
2010     wxID_NONE = -3,
2011
2012     /*  id for a separator line in the menu (invalid for normal item) */
2013     wxID_SEPARATOR = -2,
2014
2015     /* any id: means that we don't care about the id, whether when installing
2016      * an event handler or when creating a new window */
2017     wxID_ANY = -1,
2018
2019
2020     /* all predefined ids are between wxID_LOWEST and wxID_HIGHEST */
2021     wxID_LOWEST = 4999,
2022
2023     wxID_OPEN,
2024     wxID_CLOSE,
2025     wxID_NEW,
2026     wxID_SAVE,
2027     wxID_SAVEAS,
2028     wxID_REVERT,
2029     wxID_EXIT,
2030     wxID_UNDO,
2031     wxID_REDO,
2032     wxID_HELP,
2033     wxID_PRINT,
2034     wxID_PRINT_SETUP,
2035     wxID_PAGE_SETUP,
2036     wxID_PREVIEW,
2037     wxID_ABOUT,
2038     wxID_HELP_CONTENTS,
2039     wxID_HELP_INDEX,
2040     wxID_HELP_SEARCH,
2041     wxID_HELP_COMMANDS,
2042     wxID_HELP_PROCEDURES,
2043     wxID_HELP_CONTEXT,
2044     wxID_CLOSE_ALL,
2045     wxID_PREFERENCES,
2046
2047     wxID_EDIT = 5030,
2048     wxID_CUT,
2049     wxID_COPY,
2050     wxID_PASTE,
2051     wxID_CLEAR,
2052     wxID_FIND,
2053     wxID_DUPLICATE,
2054     wxID_SELECTALL,
2055     wxID_DELETE,
2056     wxID_REPLACE,
2057     wxID_REPLACE_ALL,
2058     wxID_PROPERTIES,
2059
2060     wxID_VIEW_DETAILS,
2061     wxID_VIEW_LARGEICONS,
2062     wxID_VIEW_SMALLICONS,
2063     wxID_VIEW_LIST,
2064     wxID_VIEW_SORTDATE,
2065     wxID_VIEW_SORTNAME,
2066     wxID_VIEW_SORTSIZE,
2067     wxID_VIEW_SORTTYPE,
2068
2069     wxID_FILE = 5050,
2070     wxID_FILE1,
2071     wxID_FILE2,
2072     wxID_FILE3,
2073     wxID_FILE4,
2074     wxID_FILE5,
2075     wxID_FILE6,
2076     wxID_FILE7,
2077     wxID_FILE8,
2078     wxID_FILE9,
2079
2080     /*  Standard button and menu IDs */
2081     wxID_OK = 5100,
2082     wxID_CANCEL,
2083     wxID_APPLY,
2084     wxID_YES,
2085     wxID_NO,
2086     wxID_STATIC,
2087     wxID_FORWARD,
2088     wxID_BACKWARD,
2089     wxID_DEFAULT,
2090     wxID_MORE,
2091     wxID_SETUP,
2092     wxID_RESET,
2093     wxID_CONTEXT_HELP,
2094     wxID_YESTOALL,
2095     wxID_NOTOALL,
2096     wxID_ABORT,
2097     wxID_RETRY,
2098     wxID_IGNORE,
2099     wxID_ADD,
2100     wxID_REMOVE,
2101
2102     wxID_UP,
2103     wxID_DOWN,
2104     wxID_HOME,
2105     wxID_REFRESH,
2106     wxID_STOP,
2107     wxID_INDEX,
2108
2109     wxID_BOLD,
2110     wxID_ITALIC,
2111     wxID_JUSTIFY_CENTER,
2112     wxID_JUSTIFY_FILL,
2113     wxID_JUSTIFY_RIGHT,
2114     wxID_JUSTIFY_LEFT,
2115     wxID_UNDERLINE,
2116     wxID_INDENT,
2117     wxID_UNINDENT,
2118     wxID_ZOOM_100,
2119     wxID_ZOOM_FIT,
2120     wxID_ZOOM_IN,
2121     wxID_ZOOM_OUT,
2122     wxID_UNDELETE,
2123     wxID_REVERT_TO_SAVED,
2124     wxID_CDROM,
2125     wxID_CONVERT,
2126     wxID_EXECUTE,
2127     wxID_FLOPPY,
2128     wxID_HARDDISK,
2129     wxID_BOTTOM,
2130     wxID_FIRST,
2131     wxID_LAST,
2132     wxID_TOP,
2133     wxID_INFO,
2134     wxID_JUMP_TO,
2135     wxID_NETWORK,
2136     wxID_SELECT_COLOR,
2137     wxID_SELECT_FONT,
2138     wxID_SORT_ASCENDING,
2139     wxID_SORT_DESCENDING,
2140     wxID_SPELL_CHECK,
2141     wxID_STRIKETHROUGH,
2142
2143     /*  System menu IDs (used by wxUniv): */
2144     wxID_SYSTEM_MENU = 5200,
2145     wxID_CLOSE_FRAME,
2146     wxID_MOVE_FRAME,
2147     wxID_RESIZE_FRAME,
2148     wxID_MAXIMIZE_FRAME,
2149     wxID_ICONIZE_FRAME,
2150     wxID_RESTORE_FRAME,
2151
2152     /* MDI window menu ids */
2153     wxID_MDI_WINDOW_FIRST = 5230,
2154     wxID_MDI_WINDOW_CASCADE = wxID_MDI_WINDOW_FIRST,
2155     wxID_MDI_WINDOW_TILE_HORZ,
2156     wxID_MDI_WINDOW_TILE_VERT,
2157     wxID_MDI_WINDOW_ARRANGE_ICONS,
2158     wxID_MDI_WINDOW_PREV,
2159     wxID_MDI_WINDOW_NEXT,
2160     wxID_MDI_WINDOW_LAST = wxID_MDI_WINDOW_NEXT,
2161
2162     /* OS X system menu ids */
2163     wxID_OSX_MENU_FIRST = 5250,
2164     wxID_OSX_HIDE = wxID_OSX_MENU_FIRST,
2165     wxID_OSX_HIDEOTHERS,
2166     wxID_OSX_SHOWALL,
2167     wxID_OSX_MENU_LAST = wxID_OSX_SHOWALL,
2168
2169     /*  IDs used by generic file dialog (13 consecutive starting from this value) */
2170     wxID_FILEDLGG = 5900,
2171
2172     /*  IDs used by generic file ctrl (4 consecutive starting from this value) */
2173     wxID_FILECTRL = 5950,
2174
2175     wxID_HIGHEST = 5999
2176 };
2177
2178 /*  ---------------------------------------------------------------------------- */
2179 /*  wxWindowID type (after wxID_XYZ enum, platform detection, and dlimpexp.h)    */
2180 /*  ---------------------------------------------------------------------------- */
2181
2182 /*  special care should be taken with this type under Windows where the real */
2183 /*  window id is unsigned, so we must always do the cast before comparing them */
2184 /*  (or else they would be always different!). Using wxGetWindowId() which does */
2185 /*  the cast itself is recommended. Note that this type can't be unsigned */
2186 /*  because wxID_ANY == -1 is a valid (and largely used) value for window id. */
2187 #if defined(__cplusplus) && wxUSE_GUI
2188     #include "wx/windowid.h"
2189 #endif
2190
2191 /*  ---------------------------------------------------------------------------- */
2192 /*  other constants */
2193 /*  ---------------------------------------------------------------------------- */
2194
2195 /*  menu and toolbar item kinds */
2196 enum wxItemKind
2197 {
2198     wxITEM_SEPARATOR = -1,
2199     wxITEM_NORMAL,
2200     wxITEM_CHECK,
2201     wxITEM_RADIO,
2202     wxITEM_DROPDOWN,
2203     wxITEM_MAX
2204 };
2205
2206 /*  hit test results */
2207 enum wxHitTest
2208 {
2209     wxHT_NOWHERE,
2210
2211     /*  scrollbar */
2212     wxHT_SCROLLBAR_FIRST = wxHT_NOWHERE,
2213     wxHT_SCROLLBAR_ARROW_LINE_1,    /*  left or upper arrow to scroll by line */
2214     wxHT_SCROLLBAR_ARROW_LINE_2,    /*  right or down */
2215     wxHT_SCROLLBAR_ARROW_PAGE_1,    /*  left or upper arrow to scroll by page */
2216     wxHT_SCROLLBAR_ARROW_PAGE_2,    /*  right or down */
2217     wxHT_SCROLLBAR_THUMB,           /*  on the thumb */
2218     wxHT_SCROLLBAR_BAR_1,           /*  bar to the left/above the thumb */
2219     wxHT_SCROLLBAR_BAR_2,           /*  bar to the right/below the thumb */
2220     wxHT_SCROLLBAR_LAST,
2221
2222     /*  window */
2223     wxHT_WINDOW_OUTSIDE,            /*  not in this window at all */
2224     wxHT_WINDOW_INSIDE,             /*  in the client area */
2225     wxHT_WINDOW_VERT_SCROLLBAR,     /*  on the vertical scrollbar */
2226     wxHT_WINDOW_HORZ_SCROLLBAR,     /*  on the horizontal scrollbar */
2227     wxHT_WINDOW_CORNER,             /*  on the corner between 2 scrollbars */
2228
2229     wxHT_MAX
2230 };
2231
2232 /*  ---------------------------------------------------------------------------- */
2233 /*  Possible SetSize flags */
2234 /*  ---------------------------------------------------------------------------- */
2235
2236 /*  Use internally-calculated width if -1 */
2237 #define wxSIZE_AUTO_WIDTH       0x0001
2238 /*  Use internally-calculated height if -1 */
2239 #define wxSIZE_AUTO_HEIGHT      0x0002
2240 /*  Use internally-calculated width and height if each is -1 */
2241 #define wxSIZE_AUTO             (wxSIZE_AUTO_WIDTH|wxSIZE_AUTO_HEIGHT)
2242 /*  Ignore missing (-1) dimensions (use existing). */
2243 /*  For readability only: test for wxSIZE_AUTO_WIDTH/HEIGHT in code. */
2244 #define wxSIZE_USE_EXISTING     0x0000
2245 /*  Allow -1 as a valid position */
2246 #define wxSIZE_ALLOW_MINUS_ONE  0x0004
2247 /*  Don't do parent client adjustments (for implementation only) */
2248 #define wxSIZE_NO_ADJUSTMENTS   0x0008
2249 /*  Change the window position even if it seems to be already correct */
2250 #define wxSIZE_FORCE            0x0010
2251 /*  Emit size event even if size didn't change */
2252 #define wxSIZE_FORCE_EVENT      0x0020
2253
2254 /*  ---------------------------------------------------------------------------- */
2255 /*  GDI descriptions */
2256 /*  ---------------------------------------------------------------------------- */
2257
2258 /*
2259     WARNING: the following styles are deprecated; use the
2260              wxFontFamily, wxFontStyle, wxFontWeight, wxBrushStyle,
2261              wxPenStyle, wxPenCap, wxPenJoin enum values instead!
2262 */
2263
2264 #if FUTURE_WXWIN_COMPATIBILITY_3_0
2265
2266 /* don't use any elements of this enum in the new code */
2267 enum wxDeprecatedGUIConstants
2268 {
2269     /*  Text font families */
2270     wxDEFAULT    = 70,
2271     wxDECORATIVE,
2272     wxROMAN,
2273     wxSCRIPT,
2274     wxSWISS,
2275     wxMODERN,
2276     wxTELETYPE,  /* @@@@ */
2277
2278     /*  Proportional or Fixed width fonts (not yet used) */
2279     wxVARIABLE   = 80,
2280     wxFIXED,
2281
2282     wxNORMAL     = 90,
2283     wxLIGHT,
2284     wxBOLD,
2285     /*  Also wxNORMAL for normal (non-italic text) */
2286     wxITALIC,
2287     wxSLANT,
2288
2289     /*  Pen styles */
2290     wxSOLID      =   100,
2291     wxDOT,
2292     wxLONG_DASH,
2293     wxSHORT_DASH,
2294     wxDOT_DASH,
2295     wxUSER_DASH,
2296
2297     wxTRANSPARENT,
2298
2299     /*  Brush & Pen Stippling. Note that a stippled pen cannot be dashed!! */
2300     /*  Note also that stippling a Pen IS meaningfull, because a Line is */
2301     wxSTIPPLE_MASK_OPAQUE, /* mask is used for blitting monochrome using text fore and back ground colors */
2302     wxSTIPPLE_MASK,        /* mask is used for masking areas in the stipple bitmap (TO DO) */
2303     /*  drawn with a Pen, and without any Brush -- and it can be stippled. */
2304     wxSTIPPLE =          110,
2305
2306     wxBDIAGONAL_HATCH,     /* In wxWidgets < 2.6 use WX_HATCH macro  */
2307     wxCROSSDIAG_HATCH,     /* to verify these wx*_HATCH are in style */
2308     wxFDIAGONAL_HATCH,     /* of wxBrush. In wxWidgets >= 2.6 use    */
2309     wxCROSS_HATCH,         /* wxBrush::IsHatch() instead.            */
2310     wxHORIZONTAL_HATCH,
2311     wxVERTICAL_HATCH,
2312     wxFIRST_HATCH = wxBDIAGONAL_HATCH,
2313     wxLAST_HATCH = wxVERTICAL_HATCH
2314 };
2315 #endif
2316
2317 /*  ToolPanel in wxFrame (VZ: unused?) */
2318 enum
2319 {
2320     wxTOOL_TOP = 1,
2321     wxTOOL_BOTTOM,
2322     wxTOOL_LEFT,
2323     wxTOOL_RIGHT
2324 };
2325
2326 /*  the values of the format constants should be the same as corresponding */
2327 /*  CF_XXX constants in Windows API */
2328 enum wxDataFormatId
2329 {
2330     wxDF_INVALID =          0,
2331     wxDF_TEXT =             1,  /* CF_TEXT */
2332     wxDF_BITMAP =           2,  /* CF_BITMAP */
2333     wxDF_METAFILE =         3,  /* CF_METAFILEPICT */
2334     wxDF_SYLK =             4,
2335     wxDF_DIF =              5,
2336     wxDF_TIFF =             6,
2337     wxDF_OEMTEXT =          7,  /* CF_OEMTEXT */
2338     wxDF_DIB =              8,  /* CF_DIB */
2339     wxDF_PALETTE =          9,
2340     wxDF_PENDATA =          10,
2341     wxDF_RIFF =             11,
2342     wxDF_WAVE =             12,
2343     wxDF_UNICODETEXT =      13,
2344     wxDF_ENHMETAFILE =      14,
2345     wxDF_FILENAME =         15, /* CF_HDROP */
2346     wxDF_LOCALE =           16,
2347     wxDF_PRIVATE =          20,
2348     wxDF_HTML =             30, /* Note: does not correspond to CF_ constant */
2349     wxDF_MAX
2350 };
2351
2352 /* Key codes */
2353 enum wxKeyCode
2354 {
2355     WXK_NONE    =    0,
2356
2357     WXK_BACK    =    8, // backspace
2358     WXK_TAB     =    9,
2359     WXK_RETURN  =    13,
2360     WXK_ESCAPE  =    27,
2361
2362     /* values from 33 to 126 are reserved for the standard ASCII characters */
2363
2364     WXK_SPACE   =    32,
2365     WXK_DELETE  =    127,
2366
2367     /* values from 128 to 255 are reserved for ASCII extended characters
2368        (note that there isn't a single fixed standard for the meaning
2369        of these values; avoid them in portable apps!) */
2370
2371     /* These are not compatible with unicode characters.
2372        If you want to get a unicode character from a key event, use
2373        wxKeyEvent::GetUnicodeKey                                    */
2374     WXK_START   = 300,
2375     WXK_LBUTTON,
2376     WXK_RBUTTON,
2377     WXK_CANCEL,
2378     WXK_MBUTTON,
2379     WXK_CLEAR,
2380     WXK_SHIFT,
2381     WXK_ALT,
2382     WXK_CONTROL,
2383     WXK_MENU,
2384     WXK_PAUSE,
2385     WXK_CAPITAL,
2386     WXK_END,
2387     WXK_HOME,
2388     WXK_LEFT,
2389     WXK_UP,
2390     WXK_RIGHT,
2391     WXK_DOWN,
2392     WXK_SELECT,
2393     WXK_PRINT,
2394     WXK_EXECUTE,
2395     WXK_SNAPSHOT,
2396     WXK_INSERT,
2397     WXK_HELP,
2398     WXK_NUMPAD0,
2399     WXK_NUMPAD1,
2400     WXK_NUMPAD2,
2401     WXK_NUMPAD3,
2402     WXK_NUMPAD4,
2403     WXK_NUMPAD5,
2404     WXK_NUMPAD6,
2405     WXK_NUMPAD7,
2406     WXK_NUMPAD8,
2407     WXK_NUMPAD9,
2408     WXK_MULTIPLY,
2409     WXK_ADD,
2410     WXK_SEPARATOR,
2411     WXK_SUBTRACT,
2412     WXK_DECIMAL,
2413     WXK_DIVIDE,
2414     WXK_F1,
2415     WXK_F2,
2416     WXK_F3,
2417     WXK_F4,
2418     WXK_F5,
2419     WXK_F6,
2420     WXK_F7,
2421     WXK_F8,
2422     WXK_F9,
2423     WXK_F10,
2424     WXK_F11,
2425     WXK_F12,
2426     WXK_F13,
2427     WXK_F14,
2428     WXK_F15,
2429     WXK_F16,
2430     WXK_F17,
2431     WXK_F18,
2432     WXK_F19,
2433     WXK_F20,
2434     WXK_F21,
2435     WXK_F22,
2436     WXK_F23,
2437     WXK_F24,
2438     WXK_NUMLOCK,
2439     WXK_SCROLL,
2440     WXK_PAGEUP,
2441     WXK_PAGEDOWN,
2442 #if WXWIN_COMPATIBILITY_2_6
2443     WXK_PRIOR = WXK_PAGEUP,
2444     WXK_NEXT  = WXK_PAGEDOWN,
2445 #endif
2446
2447     WXK_NUMPAD_SPACE,
2448     WXK_NUMPAD_TAB,
2449     WXK_NUMPAD_ENTER,
2450     WXK_NUMPAD_F1,
2451     WXK_NUMPAD_F2,
2452     WXK_NUMPAD_F3,
2453     WXK_NUMPAD_F4,
2454     WXK_NUMPAD_HOME,
2455     WXK_NUMPAD_LEFT,
2456     WXK_NUMPAD_UP,
2457     WXK_NUMPAD_RIGHT,
2458     WXK_NUMPAD_DOWN,
2459     WXK_NUMPAD_PAGEUP,
2460     WXK_NUMPAD_PAGEDOWN,
2461 #if WXWIN_COMPATIBILITY_2_6
2462     WXK_NUMPAD_PRIOR = WXK_NUMPAD_PAGEUP,
2463     WXK_NUMPAD_NEXT  = WXK_NUMPAD_PAGEDOWN,
2464 #endif
2465     WXK_NUMPAD_END,
2466     WXK_NUMPAD_BEGIN,
2467     WXK_NUMPAD_INSERT,
2468     WXK_NUMPAD_DELETE,
2469     WXK_NUMPAD_EQUAL,
2470     WXK_NUMPAD_MULTIPLY,
2471     WXK_NUMPAD_ADD,
2472     WXK_NUMPAD_SEPARATOR,
2473     WXK_NUMPAD_SUBTRACT,
2474     WXK_NUMPAD_DECIMAL,
2475     WXK_NUMPAD_DIVIDE,
2476
2477     WXK_WINDOWS_LEFT,
2478     WXK_WINDOWS_RIGHT,
2479     WXK_WINDOWS_MENU ,
2480     WXK_COMMAND,
2481
2482     /* Hardware-specific buttons */
2483     WXK_SPECIAL1 = 193,
2484     WXK_SPECIAL2,
2485     WXK_SPECIAL3,
2486     WXK_SPECIAL4,
2487     WXK_SPECIAL5,
2488     WXK_SPECIAL6,
2489     WXK_SPECIAL7,
2490     WXK_SPECIAL8,
2491     WXK_SPECIAL9,
2492     WXK_SPECIAL10,
2493     WXK_SPECIAL11,
2494     WXK_SPECIAL12,
2495     WXK_SPECIAL13,
2496     WXK_SPECIAL14,
2497     WXK_SPECIAL15,
2498     WXK_SPECIAL16,
2499     WXK_SPECIAL17,
2500     WXK_SPECIAL18,
2501     WXK_SPECIAL19,
2502     WXK_SPECIAL20
2503 };
2504
2505 /* This enum contains bit mask constants used in wxKeyEvent */
2506 enum wxKeyModifier
2507 {
2508     wxMOD_NONE      = 0x0000,
2509     wxMOD_ALT       = 0x0001,
2510     wxMOD_CONTROL   = 0x0002,
2511     wxMOD_ALTGR     = wxMOD_ALT | wxMOD_CONTROL,
2512     wxMOD_SHIFT     = 0x0004,
2513     wxMOD_META      = 0x0008,
2514     wxMOD_WIN       = wxMOD_META,
2515 #if defined(__WXMAC__) || defined(__WXCOCOA__)
2516     wxMOD_CMD       = wxMOD_META,
2517 #else
2518     wxMOD_CMD       = wxMOD_CONTROL,
2519 #endif
2520     wxMOD_ALL       = 0xffff
2521 };
2522
2523 /* Shortcut for easier dialog-unit-to-pixel conversion */
2524 #define wxDLG_UNIT(parent, pt) parent->ConvertDialogToPixels(pt)
2525
2526 /* Paper types */
2527 typedef enum
2528 {
2529     wxPAPER_NONE,               /*  Use specific dimensions */
2530     wxPAPER_LETTER,             /*  Letter, 8 1/2 by 11 inches */
2531     wxPAPER_LEGAL,              /*  Legal, 8 1/2 by 14 inches */
2532     wxPAPER_A4,                 /*  A4 Sheet, 210 by 297 millimeters */
2533     wxPAPER_CSHEET,             /*  C Sheet, 17 by 22 inches */
2534     wxPAPER_DSHEET,             /*  D Sheet, 22 by 34 inches */
2535     wxPAPER_ESHEET,             /*  E Sheet, 34 by 44 inches */
2536     wxPAPER_LETTERSMALL,        /*  Letter Small, 8 1/2 by 11 inches */
2537     wxPAPER_TABLOID,            /*  Tabloid, 11 by 17 inches */
2538     wxPAPER_LEDGER,             /*  Ledger, 17 by 11 inches */
2539     wxPAPER_STATEMENT,          /*  Statement, 5 1/2 by 8 1/2 inches */
2540     wxPAPER_EXECUTIVE,          /*  Executive, 7 1/4 by 10 1/2 inches */
2541     wxPAPER_A3,                 /*  A3 sheet, 297 by 420 millimeters */
2542     wxPAPER_A4SMALL,            /*  A4 small sheet, 210 by 297 millimeters */
2543     wxPAPER_A5,                 /*  A5 sheet, 148 by 210 millimeters */
2544     wxPAPER_B4,                 /*  B4 sheet, 250 by 354 millimeters */
2545     wxPAPER_B5,                 /*  B5 sheet, 182-by-257-millimeter paper */
2546     wxPAPER_FOLIO,              /*  Folio, 8-1/2-by-13-inch paper */
2547     wxPAPER_QUARTO,             /*  Quarto, 215-by-275-millimeter paper */
2548     wxPAPER_10X14,              /*  10-by-14-inch sheet */
2549     wxPAPER_11X17,              /*  11-by-17-inch sheet */
2550     wxPAPER_NOTE,               /*  Note, 8 1/2 by 11 inches */
2551     wxPAPER_ENV_9,              /*  #9 Envelope, 3 7/8 by 8 7/8 inches */
2552     wxPAPER_ENV_10,             /*  #10 Envelope, 4 1/8 by 9 1/2 inches */
2553     wxPAPER_ENV_11,             /*  #11 Envelope, 4 1/2 by 10 3/8 inches */
2554     wxPAPER_ENV_12,             /*  #12 Envelope, 4 3/4 by 11 inches */
2555     wxPAPER_ENV_14,             /*  #14 Envelope, 5 by 11 1/2 inches */
2556     wxPAPER_ENV_DL,             /*  DL Envelope, 110 by 220 millimeters */
2557     wxPAPER_ENV_C5,             /*  C5 Envelope, 162 by 229 millimeters */
2558     wxPAPER_ENV_C3,             /*  C3 Envelope, 324 by 458 millimeters */
2559     wxPAPER_ENV_C4,             /*  C4 Envelope, 229 by 324 millimeters */
2560     wxPAPER_ENV_C6,             /*  C6 Envelope, 114 by 162 millimeters */
2561     wxPAPER_ENV_C65,            /*  C65 Envelope, 114 by 229 millimeters */
2562     wxPAPER_ENV_B4,             /*  B4 Envelope, 250 by 353 millimeters */
2563     wxPAPER_ENV_B5,             /*  B5 Envelope, 176 by 250 millimeters */
2564     wxPAPER_ENV_B6,             /*  B6 Envelope, 176 by 125 millimeters */
2565     wxPAPER_ENV_ITALY,          /*  Italy Envelope, 110 by 230 millimeters */
2566     wxPAPER_ENV_MONARCH,        /*  Monarch Envelope, 3 7/8 by 7 1/2 inches */
2567     wxPAPER_ENV_PERSONAL,       /*  6 3/4 Envelope, 3 5/8 by 6 1/2 inches */
2568     wxPAPER_FANFOLD_US,         /*  US Std Fanfold, 14 7/8 by 11 inches */
2569     wxPAPER_FANFOLD_STD_GERMAN, /*  German Std Fanfold, 8 1/2 by 12 inches */
2570     wxPAPER_FANFOLD_LGL_GERMAN, /*  German Legal Fanfold, 8 1/2 by 13 inches */
2571
2572     wxPAPER_ISO_B4,             /*  B4 (ISO) 250 x 353 mm */
2573     wxPAPER_JAPANESE_POSTCARD,  /*  Japanese Postcard 100 x 148 mm */
2574     wxPAPER_9X11,               /*  9 x 11 in */
2575     wxPAPER_10X11,              /*  10 x 11 in */
2576     wxPAPER_15X11,              /*  15 x 11 in */
2577     wxPAPER_ENV_INVITE,         /*  Envelope Invite 220 x 220 mm */
2578     wxPAPER_LETTER_EXTRA,       /*  Letter Extra 9 \275 x 12 in */
2579     wxPAPER_LEGAL_EXTRA,        /*  Legal Extra 9 \275 x 15 in */
2580     wxPAPER_TABLOID_EXTRA,      /*  Tabloid Extra 11.69 x 18 in */
2581     wxPAPER_A4_EXTRA,           /*  A4 Extra 9.27 x 12.69 in */
2582     wxPAPER_LETTER_TRANSVERSE,  /*  Letter Transverse 8 \275 x 11 in */
2583     wxPAPER_A4_TRANSVERSE,      /*  A4 Transverse 210 x 297 mm */
2584     wxPAPER_LETTER_EXTRA_TRANSVERSE, /*  Letter Extra Transverse 9\275 x 12 in */
2585     wxPAPER_A_PLUS,             /*  SuperA/SuperA/A4 227 x 356 mm */
2586     wxPAPER_B_PLUS,             /*  SuperB/SuperB/A3 305 x 487 mm */
2587     wxPAPER_LETTER_PLUS,        /*  Letter Plus 8.5 x 12.69 in */
2588     wxPAPER_A4_PLUS,            /*  A4 Plus 210 x 330 mm */
2589     wxPAPER_A5_TRANSVERSE,      /*  A5 Transverse 148 x 210 mm */
2590     wxPAPER_B5_TRANSVERSE,      /*  B5 (JIS) Transverse 182 x 257 mm */
2591     wxPAPER_A3_EXTRA,           /*  A3 Extra 322 x 445 mm */
2592     wxPAPER_A5_EXTRA,           /*  A5 Extra 174 x 235 mm */
2593     wxPAPER_B5_EXTRA,           /*  B5 (ISO) Extra 201 x 276 mm */
2594     wxPAPER_A2,                 /*  A2 420 x 594 mm */
2595     wxPAPER_A3_TRANSVERSE,      /*  A3 Transverse 297 x 420 mm */
2596     wxPAPER_A3_EXTRA_TRANSVERSE, /*  A3 Extra Transverse 322 x 445 mm */
2597
2598     wxPAPER_DBL_JAPANESE_POSTCARD,/* Japanese Double Postcard 200 x 148 mm */
2599     wxPAPER_A6,                 /* A6 105 x 148 mm */
2600     wxPAPER_JENV_KAKU2,         /* Japanese Envelope Kaku #2 */
2601     wxPAPER_JENV_KAKU3,         /* Japanese Envelope Kaku #3 */
2602     wxPAPER_JENV_CHOU3,         /* Japanese Envelope Chou #3 */
2603     wxPAPER_JENV_CHOU4,         /* Japanese Envelope Chou #4 */
2604     wxPAPER_LETTER_ROTATED,     /* Letter Rotated 11 x 8 1/2 in */
2605     wxPAPER_A3_ROTATED,         /* A3 Rotated 420 x 297 mm */
2606     wxPAPER_A4_ROTATED,         /* A4 Rotated 297 x 210 mm */
2607     wxPAPER_A5_ROTATED,         /* A5 Rotated 210 x 148 mm */
2608     wxPAPER_B4_JIS_ROTATED,     /* B4 (JIS) Rotated 364 x 257 mm */
2609     wxPAPER_B5_JIS_ROTATED,     /* B5 (JIS) Rotated 257 x 182 mm */
2610     wxPAPER_JAPANESE_POSTCARD_ROTATED,/* Japanese Postcard Rotated 148 x 100 mm */
2611     wxPAPER_DBL_JAPANESE_POSTCARD_ROTATED,/* Double Japanese Postcard Rotated 148 x 200 mm */
2612     wxPAPER_A6_ROTATED,         /* A6 Rotated 148 x 105 mm */
2613     wxPAPER_JENV_KAKU2_ROTATED, /* Japanese Envelope Kaku #2 Rotated */
2614     wxPAPER_JENV_KAKU3_ROTATED, /* Japanese Envelope Kaku #3 Rotated */
2615     wxPAPER_JENV_CHOU3_ROTATED, /* Japanese Envelope Chou #3 Rotated */
2616     wxPAPER_JENV_CHOU4_ROTATED, /* Japanese Envelope Chou #4 Rotated */
2617     wxPAPER_B6_JIS,             /* B6 (JIS) 128 x 182 mm */
2618     wxPAPER_B6_JIS_ROTATED,     /* B6 (JIS) Rotated 182 x 128 mm */
2619     wxPAPER_12X11,              /* 12 x 11 in */
2620     wxPAPER_JENV_YOU4,          /* Japanese Envelope You #4 */
2621     wxPAPER_JENV_YOU4_ROTATED,  /* Japanese Envelope You #4 Rotated */
2622     wxPAPER_P16K,               /* PRC 16K 146 x 215 mm */
2623     wxPAPER_P32K,               /* PRC 32K 97 x 151 mm */
2624     wxPAPER_P32KBIG,            /* PRC 32K(Big) 97 x 151 mm */
2625     wxPAPER_PENV_1,             /* PRC Envelope #1 102 x 165 mm */
2626     wxPAPER_PENV_2,             /* PRC Envelope #2 102 x 176 mm */
2627     wxPAPER_PENV_3,             /* PRC Envelope #3 125 x 176 mm */
2628     wxPAPER_PENV_4,             /* PRC Envelope #4 110 x 208 mm */
2629     wxPAPER_PENV_5,             /* PRC Envelope #5 110 x 220 mm */
2630     wxPAPER_PENV_6,             /* PRC Envelope #6 120 x 230 mm */
2631     wxPAPER_PENV_7,             /* PRC Envelope #7 160 x 230 mm */
2632     wxPAPER_PENV_8,             /* PRC Envelope #8 120 x 309 mm */
2633     wxPAPER_PENV_9,             /* PRC Envelope #9 229 x 324 mm */
2634     wxPAPER_PENV_10,            /* PRC Envelope #10 324 x 458 mm */
2635     wxPAPER_P16K_ROTATED,       /* PRC 16K Rotated */
2636     wxPAPER_P32K_ROTATED,       /* PRC 32K Rotated */
2637     wxPAPER_P32KBIG_ROTATED,    /* PRC 32K(Big) Rotated */
2638     wxPAPER_PENV_1_ROTATED,     /* PRC Envelope #1 Rotated 165 x 102 mm */
2639     wxPAPER_PENV_2_ROTATED,     /* PRC Envelope #2 Rotated 176 x 102 mm */
2640     wxPAPER_PENV_3_ROTATED,     /* PRC Envelope #3 Rotated 176 x 125 mm */
2641     wxPAPER_PENV_4_ROTATED,     /* PRC Envelope #4 Rotated 208 x 110 mm */
2642     wxPAPER_PENV_5_ROTATED,     /* PRC Envelope #5 Rotated 220 x 110 mm */
2643     wxPAPER_PENV_6_ROTATED,     /* PRC Envelope #6 Rotated 230 x 120 mm */
2644     wxPAPER_PENV_7_ROTATED,     /* PRC Envelope #7 Rotated 230 x 160 mm */
2645     wxPAPER_PENV_8_ROTATED,     /* PRC Envelope #8 Rotated 309 x 120 mm */
2646     wxPAPER_PENV_9_ROTATED,     /* PRC Envelope #9 Rotated 324 x 229 mm */
2647     wxPAPER_PENV_10_ROTATED,    /* PRC Envelope #10 Rotated 458 x 324 m */
2648     wxPAPER_A0,                 /* A0 Sheet 841 x 1189 mm */
2649     wxPAPER_A1                  /* A1 Sheet 594 x 841 mm */
2650 } wxPaperSize;
2651
2652 /* Printing orientation */
2653 enum wxPrintOrientation
2654 {
2655    wxPORTRAIT = 1,
2656    wxLANDSCAPE
2657 };
2658
2659 /* Duplex printing modes
2660  */
2661
2662 enum wxDuplexMode
2663 {
2664     wxDUPLEX_SIMPLEX, /*  Non-duplex */
2665     wxDUPLEX_HORIZONTAL,
2666     wxDUPLEX_VERTICAL
2667 };
2668
2669 /* Print quality.
2670  */
2671
2672 #define wxPRINT_QUALITY_HIGH    -1
2673 #define wxPRINT_QUALITY_MEDIUM  -2
2674 #define wxPRINT_QUALITY_LOW     -3
2675 #define wxPRINT_QUALITY_DRAFT   -4
2676
2677 typedef int wxPrintQuality;
2678
2679 /* Print mode (currently PostScript only)
2680  */
2681
2682 enum wxPrintMode
2683 {
2684     wxPRINT_MODE_NONE =    0,
2685     wxPRINT_MODE_PREVIEW = 1,   /*  Preview in external application */
2686     wxPRINT_MODE_FILE =    2,   /*  Print to file */
2687     wxPRINT_MODE_PRINTER = 3,   /*  Send to printer */
2688     wxPRINT_MODE_STREAM =  4    /*  Send postscript data into a stream */
2689 };
2690
2691 /*  ---------------------------------------------------------------------------- */
2692 /*  UpdateWindowUI flags */
2693 /*  ---------------------------------------------------------------------------- */
2694
2695 enum wxUpdateUI
2696 {
2697     wxUPDATE_UI_NONE          = 0x0000,
2698     wxUPDATE_UI_RECURSE       = 0x0001,
2699     wxUPDATE_UI_FROMIDLE      = 0x0002 /*  Invoked from On(Internal)Idle */
2700 };
2701
2702
2703 /* ---------------------------------------------------------------------------- */
2704 /* wxList types */
2705 /* ---------------------------------------------------------------------------- */
2706
2707 /* type of compare function for list sort operation (as in 'qsort'): it should
2708    return a negative value, 0 or positive value if the first element is less
2709    than, equal or greater than the second */
2710
2711 typedef int (* LINKAGEMODE wxSortCompareFunction)(const void *elem1, const void *elem2);
2712
2713 /* wxList iterator function */
2714 typedef int (* LINKAGEMODE wxListIterateFunction)(void *current);
2715
2716
2717 /*  ---------------------------------------------------------------------------- */
2718 /*  miscellaneous */
2719 /*  ---------------------------------------------------------------------------- */
2720
2721 /*  define this macro if font handling is done using the X font names */
2722 #if (defined(__WXGTK__) && !defined(__WXGTK20__)) || defined(__X__)
2723     #define _WX_X_FONTLIKE
2724 #endif
2725
2726 /*  macro to specify "All Files" on different platforms */
2727 #if defined(__WXMSW__) || defined(__WXPM__)
2728 #   define wxALL_FILES_PATTERN   wxT("*.*")
2729 #   define wxALL_FILES           gettext_noop("All files (*.*)|*.*")
2730 #else
2731 #   define wxALL_FILES_PATTERN   wxT("*")
2732 #   define wxALL_FILES           gettext_noop("All files (*)|*")
2733 #endif
2734
2735 #if defined(__CYGWIN__) && defined(__WXMSW__)
2736 #   if wxUSE_STL || defined(wxUSE_STD_STRING)
2737          /*
2738             NASTY HACK because the gethostname in sys/unistd.h which the gnu
2739             stl includes and wx builds with by default clash with each other
2740             (windows version 2nd param is int, sys/unistd.h version is unsigned
2741             int).
2742           */
2743 #        define gethostname gethostnameHACK
2744 #        include <unistd.h>
2745 #        undef gethostname
2746 #   endif
2747 #endif
2748
2749 /*  --------------------------------------------------------------------------- */
2750 /*  macros that enable wxWidgets apps to be compiled in absence of the */
2751 /*  sytem headers, although some platform specific types are used in the */
2752 /*  platform specific (implementation) parts of the headers */
2753 /*  --------------------------------------------------------------------------- */
2754
2755 #ifdef __WXMAC__
2756
2757 #define WX_OPAQUE_TYPE( name ) struct wxOpaque##name
2758
2759 typedef void*       WXHBITMAP;
2760 typedef void*       WXHCURSOR;
2761 typedef void*       WXRECTPTR;
2762 typedef void*       WXPOINTPTR;
2763 typedef void*       WXHWND;
2764 typedef void*       WXEVENTREF;
2765 typedef void*       WXEVENTHANDLERREF;
2766 typedef void*       WXEVENTHANDLERCALLREF;
2767 typedef void*       WXAPPLEEVENTREF;
2768
2769 typedef unsigned int    WXUINT;
2770 typedef unsigned long   WXDWORD;
2771 typedef unsigned short  WXWORD;
2772
2773 typedef WX_OPAQUE_TYPE(PicHandle ) * WXHMETAFILE ;
2774 #if wxOSX_USE_CARBON
2775 typedef struct OpaqueControlRef* WXWidget ;
2776 typedef struct OpaqueWindowPtr* WXWindow ;
2777 typedef struct __AGLPixelFormatRec   *WXGLPixelFormat;
2778 typedef struct __AGLContextRec       *WXGLContext;
2779 #endif
2780
2781 typedef void*       WXDisplay;
2782
2783 /*
2784  * core frameworks
2785  */
2786
2787 typedef const void * CFTypeRef;
2788
2789 // typedef const struct __CFString * CFStringRef;
2790
2791 #define DECLARE_WXOSX_OPAQUE_CFREF( name ) typedef struct __##name* name##Ref;
2792 #define DECLARE_WXOSX_OPAQUE_CONST_CFREF( name ) typedef const struct __##name* name##Ref;
2793
2794 DECLARE_WXOSX_OPAQUE_CONST_CFREF( CFString )
2795 typedef struct __CFString * CFMutableStringRef;
2796
2797 DECLARE_WXOSX_OPAQUE_CFREF( CFRunLoopSource )
2798 DECLARE_WXOSX_OPAQUE_CONST_CFREF( CTFont )
2799 DECLARE_WXOSX_OPAQUE_CONST_CFREF( CTFontDescriptor )
2800
2801 #define DECLARE_WXOSX_OPAQUE_CGREF( name ) typedef struct name* name##Ref;
2802
2803 DECLARE_WXOSX_OPAQUE_CGREF( CGColor )
2804 DECLARE_WXOSX_OPAQUE_CGREF( CGImage )
2805 DECLARE_WXOSX_OPAQUE_CGREF( CGContext )
2806 DECLARE_WXOSX_OPAQUE_CGREF( CGFont )
2807
2808 typedef CGColorRef    WXCOLORREF;
2809 typedef CGImageRef    WXCGIMAGEREF;
2810 typedef CGContextRef  WXHDC;
2811
2812 /*
2813  * carbon
2814  */
2815
2816 typedef const struct __HIShape * HIShapeRef;
2817 typedef struct __HIShape * HIMutableShapeRef;
2818
2819 #define DECLARE_WXMAC_OPAQUE_REF( name ) typedef struct Opaque##name* name;
2820
2821 DECLARE_WXMAC_OPAQUE_REF( PasteboardRef )
2822 DECLARE_WXMAC_OPAQUE_REF( IconRef )
2823 DECLARE_WXMAC_OPAQUE_REF( MenuRef )
2824
2825 typedef IconRef WXHICON ;
2826 typedef HIShapeRef WXHRGN;
2827 #if wxOSX_USE_CARBON
2828 typedef MenuRef WXHMENU;
2829 #endif
2830
2831 #endif
2832
2833 #if defined( __WXCOCOA__ ) || defined(__WXMAC__)
2834
2835 /* Definitions of 32-bit/64-bit types
2836  * These are typedef'd exactly the same way in newer OS X headers so
2837  * redefinition when real headers are included should not be a problem.  If
2838  * it is, the types are being defined wrongly here.
2839  * The purpose of these types is so they can be used from public wx headers.
2840  * and also because the older (pre-Leopard) headers don't define them.
2841  */
2842
2843 /* NOTE: We don't pollute namespace with CGFLOAT_MIN/MAX/IS_DOUBLE macros
2844  * since they are unlikely to be needed in a public header.
2845  */
2846 #if defined(__LP64__) && __LP64__
2847     typedef double CGFloat;
2848 #else
2849     typedef float CGFloat;
2850 #endif
2851
2852 #if (defined(__LP64__) && __LP64__) || (defined(NS_BUILD_32_LIKE_64) && NS_BUILD_32_LIKE_64)
2853 typedef long NSInteger;
2854 typedef unsigned long NSUInteger;
2855 #else
2856 typedef int NSInteger;
2857 typedef unsigned int NSUInteger;
2858 #endif
2859
2860 /* Objective-C type declarations.
2861  * These are to be used in public headers in lieu of NSSomething* because
2862  * Objective-C class names are not available in C/C++ code.
2863  */
2864
2865 /*  NOTE: This ought to work with other compilers too, but I'm being cautious */
2866 #if (defined(__GNUC__) && defined(__APPLE__)) || defined(__MWERKS__)
2867 /* It's desirable to have type safety for Objective-C(++) code as it does
2868 at least catch typos of method names among other things.  However, it
2869 is not possible to declare an Objective-C class from plain old C or C++
2870 code.  Furthermore, because of C++ name mangling, the type name must
2871 be the same for both C++ and Objective-C++ code.  Therefore, we define
2872 what should be a pointer to an Objective-C class as a pointer to a plain
2873 old C struct with the same name.  Unfortunately, because the compiler
2874 does not see a struct as an Objective-C class we cannot declare it
2875 as a struct in Objective-C(++) mode.
2876 */
2877 #if defined(__OBJC__)
2878 #define DECLARE_WXCOCOA_OBJC_CLASS(klass) \
2879 @class klass; \
2880 typedef klass *WX_##klass
2881 #else /*  not defined(__OBJC__) */
2882 #define DECLARE_WXCOCOA_OBJC_CLASS(klass) \
2883 typedef struct klass *WX_##klass
2884 #endif /*  defined(__OBJC__) */
2885
2886 #else /*  not Apple's GNU or CodeWarrior */
2887 #warning "Objective-C types will not be checked by the compiler."
2888 /*  NOTE: typedef struct objc_object *id; */
2889 /*  IOW, we're declaring these using the id type without using that name, */
2890 /*  since "id" is used extensively not only within wxWidgets itself, but */
2891 /*  also in wxWidgets application code.  The following works fine when */
2892 /*  compiling C(++) code, and works without typesafety for Obj-C(++) code */
2893 #define DECLARE_WXCOCOA_OBJC_CLASS(klass) \
2894 typedef struct objc_object *WX_##klass
2895
2896 #endif /*  (defined(__GNUC__) && defined(__APPLE__)) || defined(__MWERKS__) */
2897
2898 DECLARE_WXCOCOA_OBJC_CLASS(NSApplication);
2899 DECLARE_WXCOCOA_OBJC_CLASS(NSBitmapImageRep);
2900 DECLARE_WXCOCOA_OBJC_CLASS(NSBox);
2901 DECLARE_WXCOCOA_OBJC_CLASS(NSButton);
2902 DECLARE_WXCOCOA_OBJC_CLASS(NSColor);
2903 DECLARE_WXCOCOA_OBJC_CLASS(NSColorPanel);
2904 DECLARE_WXCOCOA_OBJC_CLASS(NSControl);
2905 DECLARE_WXCOCOA_OBJC_CLASS(NSCursor);
2906 DECLARE_WXCOCOA_OBJC_CLASS(NSEvent);
2907 DECLARE_WXCOCOA_OBJC_CLASS(NSFont);
2908 DECLARE_WXCOCOA_OBJC_CLASS(NSFontDescriptor);
2909 DECLARE_WXCOCOA_OBJC_CLASS(NSFontPanel);
2910 DECLARE_WXCOCOA_OBJC_CLASS(NSImage);
2911 DECLARE_WXCOCOA_OBJC_CLASS(NSLayoutManager);
2912 DECLARE_WXCOCOA_OBJC_CLASS(NSMenu);
2913 DECLARE_WXCOCOA_OBJC_CLASS(NSMenuExtra);
2914 DECLARE_WXCOCOA_OBJC_CLASS(NSMenuItem);
2915 DECLARE_WXCOCOA_OBJC_CLASS(NSMutableArray);
2916 DECLARE_WXCOCOA_OBJC_CLASS(NSNotification);
2917 DECLARE_WXCOCOA_OBJC_CLASS(NSObject);
2918 DECLARE_WXCOCOA_OBJC_CLASS(NSPanel);
2919 DECLARE_WXCOCOA_OBJC_CLASS(NSScrollView);
2920 DECLARE_WXCOCOA_OBJC_CLASS(NSSound);
2921 DECLARE_WXCOCOA_OBJC_CLASS(NSStatusItem);
2922 DECLARE_WXCOCOA_OBJC_CLASS(NSTableColumn);
2923 DECLARE_WXCOCOA_OBJC_CLASS(NSTableView);
2924 DECLARE_WXCOCOA_OBJC_CLASS(NSTextContainer);
2925 DECLARE_WXCOCOA_OBJC_CLASS(NSTextField);
2926 DECLARE_WXCOCOA_OBJC_CLASS(NSTextStorage);
2927 DECLARE_WXCOCOA_OBJC_CLASS(NSThread);
2928 DECLARE_WXCOCOA_OBJC_CLASS(NSWindow);
2929 DECLARE_WXCOCOA_OBJC_CLASS(NSView);
2930 DECLARE_WXCOCOA_OBJC_CLASS(NSOpenGLContext);
2931 DECLARE_WXCOCOA_OBJC_CLASS(NSOpenGLPixelFormat);
2932 DECLARE_WXCOCOA_OBJC_CLASS( NSPrintInfo );
2933 #ifndef __WXMAC__
2934 typedef WX_NSView WXWidget; /*  wxWidgets BASE definition */
2935 #endif
2936 #endif /*  __WXCOCOA__  || ( __WXMAC__ &__DARWIN__)*/
2937
2938 #ifdef __WXMAC__
2939
2940 DECLARE_WXCOCOA_OBJC_CLASS(NSString);
2941
2942 #if wxOSX_USE_COCOA
2943
2944 typedef WX_NSWindow WXWindow;
2945 typedef WX_NSView WXWidget;
2946 typedef WX_NSMenu WXHMENU;
2947 typedef WX_NSOpenGLPixelFormat WXGLPixelFormat;
2948 typedef WX_NSOpenGLContext WXGLContext;
2949
2950 #elif wxOSX_USE_IPHONE
2951
2952 DECLARE_WXCOCOA_OBJC_CLASS(UIWindow);
2953 DECLARE_WXCOCOA_OBJC_CLASS(UIView);
2954 DECLARE_WXCOCOA_OBJC_CLASS(UIFont);
2955 DECLARE_WXCOCOA_OBJC_CLASS(UIImage);
2956 DECLARE_WXCOCOA_OBJC_CLASS(UIEvent);
2957 DECLARE_WXCOCOA_OBJC_CLASS(NSSet);
2958 DECLARE_WXCOCOA_OBJC_CLASS(EAGLContext);
2959
2960 typedef WX_UIWindow WXWindow;
2961 typedef WX_UIView WXWidget;
2962 typedef WX_EAGLContext WXGLContext;
2963 typedef WX_NSString* WXGLPixelFormat;
2964
2965 #endif
2966
2967 #endif // __WXMAC__
2968
2969 #if defined(__WXPALMOS__)
2970
2971 typedef void *          WXHWND;
2972 typedef void *          WXHANDLE;
2973 typedef void *          WXHICON;
2974 typedef void *          WXHFONT;
2975 typedef void *          WXHMENU;
2976 typedef void *          WXHPEN;
2977 typedef void *          WXHBRUSH;
2978 typedef void *          WXHPALETTE;
2979 typedef void *          WXHCURSOR;
2980 typedef void *          WXHRGN;
2981 typedef void *          WXHACCEL;
2982 typedef void *          WXHINSTANCE;
2983 typedef void *          WXHBITMAP;
2984 typedef void *          WXHIMAGELIST;
2985 typedef void *          WXHGLOBAL;
2986 typedef void *          WXHDC;
2987 typedef unsigned int    WXUINT;
2988 typedef unsigned long   WXDWORD;
2989 typedef unsigned short  WXWORD;
2990
2991 typedef unsigned long   WXCOLORREF;
2992 typedef struct tagMSG   WXMSG;
2993
2994 typedef WXHWND          WXWINHANDLE; /* WinHandle of PalmOS */
2995 typedef WXWINHANDLE     WXWidget;
2996
2997 typedef void *          WXFORMPTR;
2998 typedef void *          WXEVENTPTR;
2999 typedef void *          WXRECTANGLEPTR;
3000
3001 #endif /* __WXPALMOS__ */
3002
3003
3004 /* ABX: check __WIN32__ instead of __WXMSW__ for the same MSWBase in any Win32 port */
3005 #if defined(__WIN32__)
3006
3007 /*  Stand-ins for Windows types to avoid #including all of windows.h */
3008
3009 #ifndef NO_STRICT
3010     #define WX_MSW_DECLARE_HANDLE(type) typedef struct type##__ * WX##type
3011 #else
3012     #define WX_MSW_DECLARE_HANDLE(type) typedef void * WX##type
3013 #endif
3014
3015 typedef void* WXHANDLE;
3016 WX_MSW_DECLARE_HANDLE(HWND);
3017 WX_MSW_DECLARE_HANDLE(HICON);
3018 WX_MSW_DECLARE_HANDLE(HFONT);
3019 WX_MSW_DECLARE_HANDLE(HMENU);
3020 WX_MSW_DECLARE_HANDLE(HPEN);
3021 WX_MSW_DECLARE_HANDLE(HBRUSH);
3022 WX_MSW_DECLARE_HANDLE(HPALETTE);
3023 WX_MSW_DECLARE_HANDLE(HCURSOR);
3024 WX_MSW_DECLARE_HANDLE(HRGN);
3025 WX_MSW_DECLARE_HANDLE(RECTPTR);
3026 WX_MSW_DECLARE_HANDLE(HACCEL);
3027 WX_MSW_DECLARE_HANDLE(HINSTANCE);
3028 WX_MSW_DECLARE_HANDLE(HBITMAP);
3029 WX_MSW_DECLARE_HANDLE(HIMAGELIST);
3030 WX_MSW_DECLARE_HANDLE(HGLOBAL);
3031 WX_MSW_DECLARE_HANDLE(HDC);
3032 typedef WXHINSTANCE WXHMODULE;
3033
3034 #undef WX_MSW_DECLARE_HANDLE
3035
3036 typedef unsigned int    WXUINT;
3037 typedef unsigned long   WXDWORD;
3038 typedef unsigned short  WXWORD;
3039
3040 typedef unsigned long   WXCOLORREF;
3041 typedef void *          WXRGNDATA;
3042 typedef struct tagMSG   WXMSG;
3043 typedef void *          WXHCONV;
3044 typedef void *          WXHKEY;
3045 typedef void *          WXHTREEITEM;
3046
3047 typedef void *          WXDRAWITEMSTRUCT;
3048 typedef void *          WXMEASUREITEMSTRUCT;
3049 typedef void *          WXLPCREATESTRUCT;
3050
3051 typedef WXHWND          WXWidget;
3052
3053 #ifdef __WIN64__
3054 typedef unsigned __int64   WXWPARAM;
3055 typedef __int64            WXLPARAM;
3056 typedef __int64            WXLRESULT;
3057 #else
3058 typedef wxW64 unsigned int WXWPARAM;
3059 typedef wxW64 long         WXLPARAM;
3060 typedef wxW64 long         WXLRESULT;
3061 #endif
3062
3063 #if defined(__GNUWIN32__) || defined(__WXMICROWIN__)
3064 typedef int             (*WXFARPROC)();
3065 #else
3066 typedef int             (__stdcall *WXFARPROC)();
3067 #endif
3068 #endif /*  __WIN32__ */
3069
3070
3071 #if defined(__OS2__)
3072 typedef unsigned long   DWORD;
3073 typedef unsigned short  WORD;
3074 #endif
3075
3076 #if defined(__WXPM__) || defined(__EMX__)
3077 #ifdef __WXPM__
3078 /*  Stand-ins for OS/2 types, to avoid #including all of os2.h */
3079 typedef unsigned long   WXHWND;
3080 typedef unsigned long   WXHANDLE;
3081 typedef unsigned long   WXHICON;
3082 typedef unsigned long   WXHFONT;
3083 typedef unsigned long   WXHMENU;
3084 typedef unsigned long   WXHPEN;
3085 typedef unsigned long   WXHBRUSH;
3086 typedef unsigned long   WXHPALETTE;
3087 typedef unsigned long   WXHCURSOR;
3088 typedef unsigned long   WXHRGN;
3089 typedef unsigned long   WXHACCEL;
3090 typedef unsigned long   WXHINSTANCE;
3091 typedef unsigned long   WXHMODULE;
3092 typedef unsigned long   WXHBITMAP;
3093 typedef unsigned long   WXHDC;
3094 typedef unsigned int    WXUINT;
3095 typedef unsigned long   WXDWORD;
3096 typedef unsigned short  WXWORD;
3097
3098 typedef unsigned long   WXCOLORREF;
3099 typedef void *          WXMSG;
3100 typedef unsigned long   WXHTREEITEM;
3101
3102 typedef void *          WXDRAWITEMSTRUCT;
3103 typedef void *          WXMEASUREITEMSTRUCT;
3104 typedef void *          WXLPCREATESTRUCT;
3105
3106 typedef WXHWND          WXWidget;
3107 #endif
3108 #ifdef __EMX__
3109 /* Need a well-known type for WXFARPROC
3110    below. MPARAM is typedef'ed too late. */
3111 #define WXWPARAM        void *
3112 #define WXLPARAM        void *
3113 #else
3114 #define WXWPARAM        MPARAM
3115 #define WXLPARAM        MPARAM
3116 #endif
3117 #define RECT            RECTL
3118 #define LOGFONT         FATTRS
3119 #define LOWORD          SHORT1FROMMP
3120 #define HIWORD          SHORT2FROMMP
3121
3122 typedef unsigned long   WXMPARAM;
3123 typedef unsigned long   WXMSGID;
3124 typedef void*           WXRESULT;
3125 /* typedef int             (*WXFARPROC)(); */
3126 /*  some windows handles not defined by PM */
3127 typedef unsigned long   HANDLE;
3128 typedef unsigned long   HICON;
3129 typedef unsigned long   HFONT;
3130 typedef unsigned long   HMENU;
3131 typedef unsigned long   HPEN;
3132 typedef unsigned long   HBRUSH;
3133 typedef unsigned long   HPALETTE;
3134 typedef unsigned long   HCURSOR;
3135 typedef unsigned long   HINSTANCE;
3136 typedef unsigned long   HIMAGELIST;
3137 typedef unsigned long   HGLOBAL;
3138 #endif /*  WXPM || EMX */
3139
3140 #if defined (__WXPM__)
3141 /*  WIN32 graphics types for OS/2 GPI */
3142
3143 /*  RGB under OS2 is more like a PALETTEENTRY struct under Windows so we need a real RGB def */
3144 #define OS2RGB(r,g,b) ((DWORD)((unsigned char)(b) | ((unsigned char)(g) << 8)) | ((unsigned char)(r) << 16))
3145
3146 typedef unsigned long COLORREF;
3147 #define GetRValue(rgb) ((unsigned char)((rgb) >> 16))
3148 #define GetGValue(rgb) ((unsigned char)(((unsigned short)(rgb)) >> 8))
3149 #define GetBValue(rgb) ((unsigned char)(rgb))
3150 #define PALETTEINDEX(i) ((COLORREF)(0x01000000 | (DWORD)(WORD)(i)))
3151 #define PALETTERGB(r,g,b) (0x02000000 | OS2RGB(r,g,b))
3152 /*  OS2's RGB/RGB2 is backwards from this */
3153 typedef struct tagPALETTEENTRY
3154 {
3155     char bRed;
3156     char bGreen;
3157     char bBlue;
3158     char bFlags;
3159 } PALETTEENTRY;
3160 typedef struct tagLOGPALETTE
3161 {
3162     WORD palVersion;
3163     WORD palNumentries;
3164     WORD PALETTEENTRY[1];
3165 } LOGPALETTE;
3166
3167 #if (defined(__VISAGECPP__) && (__IBMCPP__ < 400)) || defined (__WATCOMC__)
3168     /*  VA 3.0 for some reason needs base data types when typedefing a proc proto??? */
3169 typedef void* (_System *WXFARPROC)(unsigned long, unsigned long, void*, void*);
3170 #else
3171 #if defined(__EMX__) && !defined(_System)
3172 #define _System
3173 #endif
3174 typedef WXRESULT (_System *WXFARPROC)(WXHWND, WXMSGID, WXWPARAM, WXLPARAM);
3175 #endif
3176
3177 #endif /* __WXPM__ */
3178
3179
3180 #if defined(__WXMOTIF__) || defined(__WXX11__)
3181 /* Stand-ins for X/Xt/Motif types */
3182 typedef void*           WXWindow;
3183 typedef void*           WXWidget;
3184 typedef void*           WXAppContext;
3185 typedef void*           WXColormap;
3186 typedef void*           WXColor;
3187 typedef void            WXDisplay;
3188 typedef void            WXEvent;
3189 typedef void*           WXCursor;
3190 typedef void*           WXPixmap;
3191 typedef void*           WXFontStructPtr;
3192 typedef void*           WXGC;
3193 typedef void*           WXRegion;
3194 typedef void*           WXFont;
3195 typedef void*           WXImage;
3196 typedef void*           WXFontList;
3197 typedef void*           WXFontSet;
3198 typedef void*           WXRendition;
3199 typedef void*           WXRenderTable;
3200 typedef void*           WXFontType; /* either a XmFontList or XmRenderTable */
3201 typedef void*           WXString;
3202
3203 typedef unsigned long   Atom;  /* this might fail on a few architectures */
3204 typedef long            WXPixel; /* safety catch in src/motif/colour.cpp */
3205
3206 #endif /*  Motif */
3207
3208 #ifdef __WXGTK__
3209
3210 /* Stand-ins for GLIB types */
3211 typedef char           gchar;
3212 typedef signed char    gint8;
3213 typedef int            gint;
3214 typedef unsigned       guint;
3215 typedef unsigned long  gulong;
3216 typedef void*          gpointer;
3217 typedef struct _GSList GSList;
3218
3219 /* Stand-ins for GDK types */
3220 typedef struct _GdkColor        GdkColor;
3221 typedef struct _GdkColormap     GdkColormap;
3222 typedef struct _GdkFont         GdkFont;
3223 typedef struct _GdkGC           GdkGC;
3224 typedef struct _GdkVisual       GdkVisual;
3225
3226 #ifdef __WXGTK20__
3227 typedef struct _GdkAtom        *GdkAtom;
3228 typedef struct _GdkDrawable     GdkWindow;
3229 typedef struct _GdkDrawable     GdkBitmap;
3230 typedef struct _GdkDrawable     GdkPixmap;
3231 #else /*  GTK+ 1.2 */
3232 typedef gulong                  GdkAtom;
3233 typedef struct _GdkWindow       GdkWindow;
3234 typedef struct _GdkWindow       GdkBitmap;
3235 typedef struct _GdkWindow       GdkPixmap;
3236 #endif /*  GTK+ 1.2/2.0 */
3237
3238 typedef struct _GdkCursor       GdkCursor;
3239 typedef struct _GdkRegion       GdkRegion;
3240 typedef struct _GdkDragContext  GdkDragContext;
3241
3242 #ifdef HAVE_XIM
3243 typedef struct _GdkIC           GdkIC;
3244 typedef struct _GdkICAttr       GdkICAttr;
3245 #endif
3246
3247 /* Stand-ins for GTK types */
3248 typedef struct _GtkWidget         GtkWidget;
3249 typedef struct _GtkRcStyle        GtkRcStyle;
3250 typedef struct _GtkAdjustment     GtkAdjustment;
3251 typedef struct _GtkList           GtkList;
3252 typedef struct _GtkToolbar        GtkToolbar;
3253 typedef struct _GtkTooltips       GtkTooltips;
3254 typedef struct _GtkNotebook       GtkNotebook;
3255 typedef struct _GtkNotebookPage   GtkNotebookPage;
3256 typedef struct _GtkAccelGroup     GtkAccelGroup;
3257 typedef struct _GtkItemFactory    GtkItemFactory;
3258 typedef struct _GtkSelectionData  GtkSelectionData;
3259 typedef struct _GtkTextBuffer     GtkTextBuffer;
3260 typedef struct _GtkRange          GtkRange;
3261 typedef struct _GtkCellRenderer   GtkCellRenderer;
3262
3263 typedef GtkWidget *WXWidget;
3264
3265 #ifndef __WXGTK20__
3266 #define GTK_OBJECT_GET_CLASS(object) (GTK_OBJECT(object)->klass)
3267 #define GTK_CLASS_TYPE(klass) ((klass)->type)
3268 #endif
3269
3270 #endif /*  __WXGTK__ */
3271
3272 #if defined(__WXGTK20__) || (defined(__WXX11__) && wxUSE_UNICODE)
3273 #define wxUSE_PANGO 1
3274 #else
3275 #define wxUSE_PANGO 0
3276 #endif
3277
3278 #if wxUSE_PANGO
3279 /* Stand-ins for Pango types */
3280 typedef struct _PangoContext         PangoContext;
3281 typedef struct _PangoLayout          PangoLayout;
3282 typedef struct _PangoFontDescription PangoFontDescription;
3283 #endif
3284
3285 #ifdef __WXMGL__
3286 typedef struct window_t *WXWidget;
3287 #endif /*  MGL */
3288
3289 #ifdef __WXDFB__
3290 /* DirectFB doesn't have the concept of non-TLW window, so use
3291    something arbitrary */
3292 typedef const void* WXWidget;
3293 #endif /*  DFB */
3294
3295 /*  This is required because of clashing macros in windows.h, which may be */
3296 /*  included before or after wxWidgets classes, and therefore must be */
3297 /*  disabled here before any significant wxWidgets headers are included. */
3298 #ifdef __cplusplus
3299 #ifdef __WXMSW__
3300 #include "wx/msw/winundef.h"
3301 #endif /* __WXMSW__ */
3302 #endif /* __cplusplus */
3303
3304
3305 /*  include the feature test macros */
3306 #include "wx/features.h"
3307
3308 /*  --------------------------------------------------------------------------- */
3309 /*  macros to define a class without copy ctor nor assignment operator */
3310 /*  --------------------------------------------------------------------------- */
3311
3312 #define wxDECLARE_NO_COPY_CLASS(classname)      \
3313     private:                                    \
3314         classname(const classname&);            \
3315         classname& operator=(const classname&)
3316
3317 #define wxDECLARE_NO_COPY_TEMPLATE_CLASS(classname, arg)  \
3318     private:                                              \
3319         classname(const classname<arg>&);                 \
3320         classname& operator=(const classname<arg>&)
3321
3322 #define wxDECLARE_NO_COPY_TEMPLATE_CLASS_2(classname, arg1, arg2) \
3323     private:                                                      \
3324         classname(const classname<arg1, arg2>&);                  \
3325         classname& operator=(const classname<arg1, arg2>&)
3326
3327 #define wxDECLARE_NO_ASSIGN_CLASS(classname)    \
3328     private:                                    \
3329         classname& operator=(const classname&)
3330
3331 // deprecated variants _not_ requiring a semicolon after them
3332 #define DECLARE_NO_COPY_CLASS(classname) \
3333     wxDECLARE_NO_COPY_CLASS(classname);
3334 #define DECLARE_NO_COPY_TEMPLATE_CLASS(classname, arg) \
3335     wxDECLARE_NO_COPY_TEMPLATE_CLASS(classname, arg);
3336 #define DECLARE_NO_ASSIGN_CLASS(classname) \
3337     wxDECLARE_NO_ASSIGN_CLASS(classname);
3338
3339 /*  --------------------------------------------------------------------------- */
3340 /*  If a manifest is being automatically generated, add common controls 6 to it */
3341 /*  --------------------------------------------------------------------------- */
3342
3343 #if (!defined wxUSE_NO_MANIFEST || wxUSE_NO_MANIFEST == 0 ) && \
3344     ( defined _MSC_FULL_VER && _MSC_FULL_VER >= 140040130 )
3345
3346 #define WX_CC_MANIFEST(cpu)                     \
3347     "/manifestdependency:\"type='win32'         \
3348      name='Microsoft.Windows.Common-Controls'   \
3349      version='6.0.0.0'                          \
3350      processorArchitecture='"cpu"'              \
3351      publicKeyToken='6595b64144ccf1df'          \
3352      language='*'\""
3353
3354 #if defined _M_IX86
3355     #pragma comment(linker, WX_CC_MANIFEST("x86"))
3356 #elif defined _M_X64
3357     #pragma comment(linker, WX_CC_MANIFEST("amd64"))
3358 #elif defined _M_IA64
3359     #pragma comment(linker, WX_CC_MANIFEST("ia64"))
3360 #else
3361     #pragma comment(linker, WX_CC_MANIFEST("*"))
3362 #endif
3363
3364 #endif /* !wxUSE_NO_MANIFEST && _MSC_FULL_VER >= 140040130 */
3365
3366 #endif
3367     /*  _WX_DEFS_H_ */