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