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