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