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