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