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