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