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