]>
git.saurik.com Git - wxWidgets.git/blob - include/wx/defs.h
1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Declarations/definitions common to all wx source files
4 // Author: Julian Smart and others
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
16 #pragma interface "defs.h"
30 #include "wx/version.h"
32 // Helps SGI compilation, apparently
35 #define __need_wchar_t
37 /* Note I use the term __SGI_CC__ for both cc and CC, its not a good idea to
38 * mix gcc and cc/CC, the name mangling is different */
43 // Eliminate double/float warnings
45 # pragma warning(disable:4244)
49 //////////////////////////////////////////////////////////////////////////////////
50 // Currently Only MS-Windows/NT, XView and Motif are supported
52 #if defined(__HPUX__) && !defined(__WXMOTIF__)
55 #if defined(__WXMOTIF__)
59 // wxWindows checks for WIN32, not __WIN32__
60 #if ((defined(WIN32) || defined(__NT__)) && !defined(__WIN32__) && !defined(__WXSTUBS__))
68 #if !defined(__WIN95__) && (WINVER >= 0x0400)
72 // Make sure the environment is set correctly
73 #if defined(__WXMSW__) && defined(__X__)
74 # error "Target can't be both X and Windows"
75 #elif !defined(__WXMOTIF__) && !defined(__WXMSW__) && !defined(__WXGTK__) && \
76 !defined(__WXMAC__) && !defined(__X__) && !defined(__WXQT__) && !defined(__WXSTUBS__)
77 #error "No Target! Use -D[__WXMOTIF__|__WXGTK__|__WXMSW__|__WXMAC__|__WXQT__|__WXSTUBS__]"
80 #if defined(__WXMOTIF__) || defined(__WXGTK__) || defined(__WXQT__) || defined(__WXSTUBS__)
82 // Bool is now obsolete, use bool instead
91 #elif defined(__WXMSW__)
102 // Add more tests here for compilers that don't already define bool.
103 #if ( defined(_MSC_VER) && (_MSC_VER <= 1000) ) || (defined(__BORLANDC__) && (__BORLANDC__ < 0x500))
104 typedef unsigned int bool;
107 #if ( defined(_MSC_VER) && (_MSC_VER <= 800) ) || defined(__GNUWIN32__)
108 #define byte unsigned char
111 typedef short int WXTYPE
;
112 typedef int wxWindowID
;
114 // Macro to cut down on compiler warnings.
115 #if REMOVE_UNUSED_ARG
116 #define WXUNUSED(identifier) /* identifier */
117 #else // stupid, broken compiler
118 #define WXUNUSED(identifier) identifier
122 * Making or using wxWindows as a Windows DLL
130 # define WXDLLEXPORT __export
131 # define WXDLLEXPORT_DATA(type) type __export
132 # define WXDLLEXPORT_CTORFN __export
133 # elif defined(WXUSINGDLL)
134 # define WXDLLEXPORT __import
135 # define WXDLLEXPORT_DATA(type) type __import
136 # define WXDLLEXPORT_CTORFN
139 # define WXDLLEXPORT_DATA(type) type
140 # define WXDLLEXPORT_CTORFN
146 # define WXDLLEXPORT __declspec( dllexport )
147 # define WXDLLEXPORT_DATA(type) __declspec( dllexport ) type
148 # define WXDLLEXPORT_CTORFN __declspec( dllexport )
149 # elif defined(WXUSINGDLL)
150 # define WXDLLEXPORT __declspec( dllimport )
151 # define WXDLLEXPORT_DATA(type) __declspec( dllimport ) type
152 # define WXDLLEXPORT_CTORFN
155 # define WXDLLEXPORT_DATA(type) type
156 # define WXDLLEXPORT_CTORFN
164 # define WXDLLEXPORT_DATA(type) type
165 # define WXDLLEXPORT_CTORFN
168 // For ostream, istream ofstream
169 #if defined(__BORLANDC__) && defined( _RTLDLL )
170 # define WXDLLIMPORT __import
175 class WXDLLEXPORT wxObject
;
176 class WXDLLEXPORT wxEvent
;
178 /** symbolic constant used by all Find()-like functions returning positive
179 integer on success as failure indicator */
180 #define NOT_FOUND (-1)
182 // ----------------------------------------------------------------------------
184 // ----------------------------------------------------------------------------
186 /// Standard error codes
189 /// invalid parameter (in broad sense)
191 /// no more data (iteration functions usually return this)
193 /// user cancelled the operation
195 /// no error (the only non negative error code)
199 // ----------------------------------------------------------------------------
200 /** @name Very common macros */
201 // ----------------------------------------------------------------------------
203 /// delete pointer if it is not NULL and NULL it afterwards
204 // (checking that it's !NULL before passing it to delete is just a
205 // a question of style, because delete will do it itself anyhow, but it might
206 // be considered as an error by some overzealous debugging implementations of
207 // the library, so we do it ourselves)
208 #if defined(__SGI_CC__)
209 // Okay this is bad styling, but the native SGI compiler is very picky, it
210 // wont let you compare/assign between a NULL (void *) and another pointer
211 // type. To be really clean we'd need to pass in another argument, the type
213 // Also note the use of 0L, this would allow future possible 64bit support
214 // (as yet untested) by ensuring that we zero all the bits in a pointer
215 // (which is always the same length as a long (at least with the LP64 standard)
217 #define wxDELETE(p) if ( (p) ) { delete (p); p = 0L; }
219 #define wxDELETE(p) if ( (p) != NULL ) { delete p; p = NULL; }
220 #endif /* __SGI__CC__ */
222 // delete an array and NULL it (see comments above)
223 #if defined(__SGI_CC__)
224 // see above comment.
225 #define wxDELETEA(p) if ( (p) ) { delete [] (p); p = 0L; }
227 #define wxDELETEA(p) if ( ((void *) (p)) != NULL ) { delete [] p; p = NULL; }
228 #endif /* __SGI__CC__ */
230 /// size of statically declared array
231 #define WXSIZEOF(array) (sizeof(array)/sizeof(array[0]))
233 // Use of these suppresses some compiler warnings
234 WXDLLEXPORT_DATA(extern const bool) wxTrue
;
235 WXDLLEXPORT_DATA(extern const bool) wxFalse
;
237 // ----------------------------------------------------------------------------
238 // compiler and OS identification
239 // ----------------------------------------------------------------------------
242 #if defined(__HPUX__) || defined(____SVR4____) || defined(__LINUX__) || defined(__sgi )
248 #ifndef __UNIX__ // Windows
249 #if defined(_MSC_VER)
251 #elif defined(__BCPLUSPLUS__) && !defined(__BORLANDC__)
253 #elif defined(__WATCOMC__)
254 //#define __WATCOMC__
255 #elif defined(__SC__)
256 #define __SYMANTECC__
261 // ----------------------------------------------------------------------------
262 // compiler specific settings
263 // ----------------------------------------------------------------------------
265 // to allow compiling with warning level 4 under Microsoft Visual C++ some
266 // warnings just must be disabled
268 #pragma warning(disable: 4514) // unreferenced inline func has been removed
270 you might be tempted to disable this one also: triggered by CHECK and FAIL
271 macros in debug.h, but it's, overall, is a rather useful one, so I leave it
272 and will try to find some way to disable this warning just for CHECK/FAIL.
275 #pragma warning(disable: 4127) // conditional expression is constant
279 // Callback function type definition
280 typedef void (*wxFunction
) (wxObject
&, wxEvent
&);
283 * Window style flags.
284 * Values are chosen so they can be |'ed in a bit list.
285 * Some styles are used across more than one group,
286 * so the values mustn't clash with others in the group.
287 * Otherwise, numbers can be reused across groups.
290 * Window (cross-group) styles now take up the first half
291 * of the flag, and control-specific styles the
297 * Window (Frame/dialog/subwindow/panel item) style flags
299 #define wxVSCROLL 0x80000000
300 #define wxHSCROLL 0x40000000
301 #define wxCAPTION 0x20000000
304 #define wxDOUBLE_BORDER 0x10000000
305 #define wxSUNKEN_BORDER 0x08000000
306 #define wxRAISED_BORDER 0x04000000
307 #define wxBORDER 0x02000000
308 #define wxSIMPLE_BORDER 0x02000000
309 #define wxSTATIC_BORDER 0x01000000
310 #define wxTRANSPARENT_WINDOW 0x00100000
311 #define wxNO_BORDER 0x00200000
313 #define wxUSER_COLOURS 0x00800000
314 // Override CTL3D etc. control colour processing to
315 // allow own background colour
316 // OBSOLETE - use wxNO_3D instead
317 #define wxNO_3D 0x00800000
318 // Override CTL3D or native 3D styles for children
319 #define wxCLIP_CHILDREN 0x00400000
320 // Clip children when painting, which reduces flicker in
321 // e.g. frames and splitter windows, but can't be used in
322 // a panel where a static box must be 'transparent' (panel
323 // paints the background for it)
325 // Add this style to a panel to get tab traversal working
326 // outside of dialogs.
327 #define wxTAB_TRAVERSAL 0x00080000
330 #define wxHORIZONTAL 0x01
331 #define wxVERTICAL 0x02
332 #define wxBOTH (wxVERTICAL|wxHORIZONTAL)
333 #define wxCENTER_FRAME 0x04 /* centering into frame rather than screen */
336 * Frame/dialog style flags
338 #define wxSTAY_ON_TOP 0x8000
339 #define wxICONIZE 0x4000
340 #define wxMINIMIZE wxICONIZE
341 #define wxMAXIMIZE 0x2000
342 #define wxTHICK_FRAME 0x1000
343 #define wxSYSTEM_MENU 0x0800
344 #define wxMINIMIZE_BOX 0x0400
345 #define wxMAXIMIZE_BOX 0x0200
346 #define wxTINY_CAPTION_HORIZ 0x0100
347 #define wxTINY_CAPTION_VERT 0x0080
348 #define wxRESIZE_BOX wxMAXIMIZE_BOX
349 #define wxRESIZE_BORDER 0x0040
350 #define wxDIALOG_MODAL 0x0020
351 #define wxDIALOG_MODELESS 0x0000
353 #define wxDEFAULT_FRAME_STYLE (wxRESIZE_BORDER | wxMINIMIZE_BOX | wxMAXIMIZE_BOX | wxTHICK_FRAME | wxSYSTEM_MENU | wxCAPTION | wxCLIP_CHILDREN)
355 #if WXWIN_COMPATIBILITY
356 #define wxDEFAULT_FRAME wxDEFAULT_FRAME_STYLE
359 #define wxDEFAULT_DIALOG_STYLE (wxSYSTEM_MENU|wxCAPTION|wxTHICK_FRAME)
362 * Subwindow style flags
364 #define wxRETAINED 0x0001
365 #define wxBACKINGSTORE wxRETAINED
366 // wxCanvas or wxPanel can optionally have a thick frame under MS Windows.
367 // #define wxTHICK_FRAME 0x1000
370 * wxToolBar style flags
373 #define wxTB_3DBUTTONS 0x8000
374 #define wxTB_HORIZONTAL 0x0002
375 #define wxTB_VERTICAL 0x0004
376 // Flatbar/Coolbar under Win98
377 #define wxTB_FLAT 0x0008
380 * Apply to all panel items
383 #define wxCOLOURED 0x0800
384 // Alignment for panel item labels: replaces characters with zeros
385 // when creating label, so spaces can be included in string for alignment.
386 #define wxFIXED_LENGTH 0x0400
387 #define wxALIGN_LEFT 0x0000
388 #define wxALIGN_CENTER 0x0100
389 #define wxALIGN_CENTRE 0x0100
390 #define wxALIGN_RIGHT 0x0200
393 * Styles for wxListBox
396 #define wxLB_SORT 0x0010
397 #define wxLB_SINGLE 0x0020
398 #define wxLB_MULTIPLE 0x0040
399 #define wxLB_EXTENDED 0x0080
400 // wxLB_OWNERDRAW is Windows-only
401 #define wxLB_OWNERDRAW 0x0100
402 #define wxLB_NEEDED_SB 0x0200
403 #define wxLB_ALWAYS_SB 0x0400
404 #define wxLB_HSCROLL wxHSCROLL
407 * wxTextCtrl style flags
409 #define wxPROCESS_ENTER 0x0004
410 #define wxPASSWORD 0x0008
411 #define wxTE_PROCESS_ENTER wxPROCESS_ENTER
412 #define wxTE_PASSWORD wxPASSWORD
413 #define wxTE_READONLY 0x0010
414 #define wxTE_MULTILINE 0x0020
417 #define wxTE_RICHTEXT 0x0020
420 * wxComboBox style flags
422 #define wxCB_SIMPLE 0x0004
423 #define wxCB_SORT 0x0008
424 #define wxCB_READONLY 0x0010
425 #define wxCB_DROPDOWN 0x0020
428 * wxRadioBox/wxRadioButton style flags
430 #define wxRA_HORIZONTAL wxHORIZONTAL
431 #define wxRA_VERTICAL wxVERTICAL
432 #define wxRB_GROUP 0x0004
437 #define wxGA_PROGRESSBAR 0x0004
438 #define wxGA_HORIZONTAL wxHORIZONTAL
439 #define wxGA_VERTICAL wxVERTICAL
445 #define wxSL_HORIZONTAL wxHORIZONTAL
446 #define wxSL_VERTICAL wxVERTICAL
447 // The next one is obsolete - use scroll events instead
448 #define wxSL_NOTIFY_DRAG 0x0000
449 #define wxSL_AUTOTICKS 0x0008
450 // #define wxSL_MANUALTICKS 0x0010
451 #define wxSL_LABELS 0x0020
452 #define wxSL_LEFT 0x0040
453 #define wxSL_TOP 0x0080
454 #define wxSL_RIGHT 0x0100
455 #define wxSL_BOTTOM 0x0200
456 #define wxSL_BOTH 0x0400
457 #define wxSL_SELRANGE 0x0800
463 #define wxSB_HORIZONTAL wxHORIZONTAL
464 #define wxSB_VERTICAL wxVERTICAL
470 #define wxBU_AUTODRAW 0x0004
471 #define wxBU_NOAUTODRAW 0x0000
477 #define wxTR_HAS_BUTTONS 0x0004
478 #define wxTR_EDIT_LABELS 0x0008
479 #define wxTR_LINES_AT_ROOT 0x0010
485 #define wxLC_ICON 0x0004
486 #define wxLC_SMALL_ICON 0x0008
487 #define wxLC_LIST 0x0010
488 #define wxLC_REPORT 0x0020
489 #define wxLC_ALIGN_TOP 0x0040
490 #define wxLC_ALIGN_LEFT 0x0080
491 #define wxLC_AUTOARRANGE 0x0100
492 #define wxLC_USER_TEXT 0x0200
493 #define wxLC_EDIT_LABELS 0x0400
494 #define wxLC_NO_HEADER 0x0800
495 #define wxLC_NO_SORT_HEADER 0x1000
496 #define wxLC_SINGLE_SEL 0x2000
497 #define wxLC_SORT_ASCENDING 0x4000
498 #define wxLC_SORT_DESCENDING 0x8000
500 #define wxLC_MASK_TYPE (wxLC_ICON | wxLC_SMALL_ICON | wxLC_LIST | wxLC_REPORT)
501 #define wxLC_MASK_ALIGN (wxLC_ALIGN_TOP | wxLC_ALIGN_LEFT)
502 #define wxLC_MASK_SORT (wxLC_SORT_ASCENDING | wxLC_SORT_DESCENDING)
504 // Omitted because (a) too much detail (b) not enough style flags
505 // #define wxLC_NO_SCROLL
506 // #define wxLC_NO_LABEL_WRAP
507 // #define wxLC_OWNERDRAW_FIXED
508 // #define wxLC_SHOW_SEL_ALWAYS
514 #define wxSP_VERTICAL 0x0004
515 #define wxSP_HORIZONTAL 0x0008
516 #define wxSP_ARROW_KEYS 0x0010
517 #define wxSP_WRAP 0x0020
520 * wxSplitterWnd flags
523 #define wxSP_NOBORDER 0x0000
524 #define wxSP_3D 0x0004
525 #define wxSP_BORDER 0x0008
531 #define wxTAB_MULTILINE 0x0000
532 #define wxTAB_RIGHTJUSTIFY 0x0004
533 #define wxTAB_FIXEDWIDTH 0x0008
534 #define wxTAB_OWNERDRAW 0x0010
536 // Sorry, I changed my mind about these names...
537 #define wxTC_MULTILINE 0x0000
538 #define wxTC_RIGHTJUSTIFY 0x0004
539 #define wxTC_FIXEDWIDTH 0x0008
540 #define wxTC_OWNERDRAW 0x0010
543 * wxStatusBar95 flags
546 #define wxST_SIZEGRIP 0x0002
553 // Text font families
560 wxTELETYPE
, /* @@@@ */
562 // Proportional or Fixed width fonts (not yet used)
569 // Also wxNORMAL for normal (non-italic text)
583 // Brush & Pen Stippling. Note that a stippled pen cannot be dashed!!
584 // Note also that stippling a Pen IS meaningfull, because a Line is
585 // drawn with a Pen, and without any Brush -- and it can be stippled.
593 #define IS_HATCH(s) ((s)>=wxBDIAGONAL_HATCH && (s)<=wxVERTICAL_HATCH)
608 wxXOR
, // src XOR dst
610 wxOR_REVERSE
, // src OR (NOT dst)
611 wxAND_REVERSE
,// src AND (NOT dst)
613 wxAND
, // src AND dst
614 wxAND_INVERT
, // (NOT src) AND dst
616 wxNOR
, // (NOT src) AND (NOT dst)
617 wxEQUIV
, // (NOT src) XOR dst
618 wxSRC_INVERT
, // (NOT src)
619 wxOR_INVERT
, // (NOT src) OR dst
620 wxNAND
, // (NOT src) OR (NOT dst)
623 wxSRC_OR
, // source _bitmap_ OR destination
624 wxSRC_AND
// source _bitmap_ AND destination
628 #define wxFLOOD_SURFACE 1
629 #define wxFLOOD_BORDER 2
631 // Polygon filling mode
632 #define wxODDEVEN_RULE 1
633 #define wxWINDING_RULE 2
635 // ToolPanel in wxFrame
637 #define wxTOOL_BOTTOM 2
638 #define wxTOOL_LEFT 3
639 #define wxTOOL_RIGHT 4
641 // Dialog specifiers/return values
644 #define wxYES_NO 0x0002
645 #define wxCANCEL 0x0004
649 #define wxICON_EXCLAMATION 0x0020
650 #define wxICON_HAND 0x0040
651 #define wxICON_QUESTION 0x0080
652 #define wxICON_INFORMATION 0x0100
654 #define wxICON_STOP wxICON_HAND
655 #define wxICON_ASTERISK wxICON_INFORMATION
656 #define wxICON_MASK (0x0020|0x0040|0x0080|0x0100)
658 #define wxCENTRE 0x0200
659 #define wxCENTER wxCENTRE
661 // Possible SetSize flags
663 // Use internally-calculated width if -1
664 #define wxSIZE_AUTO_WIDTH 0x0001
665 // Use internally-calculated height if -1
666 #define wxSIZE_AUTO_HEIGHT 0x0002
667 // Use internally-calculated width and height if each is -1
668 #define wxSIZE_AUTO (wxSIZE_AUTO_WIDTH|wxSIZE_AUTO_HEIGHT)
669 // Ignore missing (-1) dimensions (use existing).
670 // For readability only: test for wxSIZE_AUTO_WIDTH/HEIGHT in code.
671 #define wxSIZE_USE_EXISTING 0x0000
672 // Allow -1 as a valid position
673 #define wxSIZE_ALLOW_MINUS_ONE 0x0004
674 // Don't do parent client adjustments (for implementation only)
675 #define wxSIZE_NO_ADJUSTMENTS 0x0008
678 // Data format for drag & drop and clipboard operations
679 // numbers as per winuser.h
683 wxDF_TEXT
= 1, /* CF_TEXT */
684 wxDF_BITMAP
= 2, /* CF_BITMAP */
685 wxDF_METAFILE
= 3, /* CF_METAFILEPICT */
686 wxDF_DIB
= 8, /* CF_DIB */
687 wxDF_OEMTEXT
= 7, /* CF_OEMTEXT */
688 wxDF_FILENAME
= 15 /* CF_HDROP */
712 WXK_PRIOR
, // Page up
713 WXK_NEXT
, // Page down
772 // Colours - see wx_gdi.cc for database
774 // OS mnemonics -- Identify the running OS (useful for Windows)
775 // [Not all platforms are currently available or supported]
778 wxCURSES
, // Text-only CURSES
779 wxXVIEW_X
, // Sun's XView OpenLOOK toolkit
780 wxMOTIF_X
, // OSF Motif 1.x.x
781 wxCOSE_X
, // OSF Common Desktop Environment
782 wxNEXTSTEP
, // NeXTStep
783 wxMACINTOSH
, // Apple System 7
787 wxOS2_PM
, // OS/2 Workplace
788 wxWINDOWS
, // Windows or WfW
789 wxPENWINDOWS
, // Windows for Pen Computing
790 wxWINDOWS_NT
, // Windows NT
791 wxWIN32S
, // Windows 32S API
792 wxWIN95
, // Windows 95
793 wxWIN386
// Watcom 32-bit supervisor modus
799 #define wxLANDSCAPE 2
802 // Standard menu identifiers
803 #define wxID_OPEN 5000
804 #define wxID_CLOSE 5001
805 #define wxID_NEW 5002
806 #define wxID_SAVE 5003
807 #define wxID_SAVEAS 5004
808 #define wxID_REVERT 5005
809 #define wxID_EXIT 5006
810 #define wxID_UNDO 5007
811 #define wxID_REDO 5008
812 #define wxID_HELP 5009
813 #define wxID_PRINT 5010
814 #define wxID_PRINT_SETUP 5011
815 #define wxID_PREVIEW 5012
816 #define wxID_ABOUT 5013
817 #define wxID_HELP_CONTENTS 5014
818 #define wxID_HELP_COMMANDS 5015
819 #define wxID_HELP_PROCEDURES 5016
820 #define wxID_HELP_CONTEXT 5017
822 #define wxID_CUT 5030
823 #define wxID_COPY 5031
824 #define wxID_PASTE 5032
825 #define wxID_CLEAR 5033
826 #define wxID_FIND 5034
827 #define wxID_DUPLICATE 5035
829 #define wxID_FILE1 5050
830 #define wxID_FILE2 5051
831 #define wxID_FILE3 5052
832 #define wxID_FILE4 5053
833 #define wxID_FILE5 5054
834 #define wxID_FILE6 5055
835 #define wxID_FILE7 5056
836 #define wxID_FILE8 5057
837 #define wxID_FILE9 5058
840 #define wxID_CANCEL 5101
841 #define wxID_APPLY 5102
842 #define wxID_YES 5103
844 #define wxID_STATIC 5105
847 // Stand-ins for Windows types, to avoid
848 // #including all of windows.h
850 typedef unsigned long WXHWND
;
851 typedef unsigned long WXHANDLE
;
852 typedef unsigned long WXHICON
;
853 typedef unsigned long WXHFONT
;
854 typedef unsigned long WXHMENU
;
855 typedef unsigned long WXHPEN
;
856 typedef unsigned long WXHBRUSH
;
857 typedef unsigned long WXHPALETTE
;
858 typedef unsigned long WXHCURSOR
;
859 typedef unsigned long WXHRGN
;
860 typedef unsigned long WXHACCEL
;
861 typedef unsigned long WXHINSTANCE
;
862 typedef unsigned long WXHBITMAP
;
863 typedef unsigned long WXHIMAGELIST
;
864 typedef unsigned long WXHGLOBAL
;
865 typedef unsigned long WXHDC
;
866 typedef unsigned int WXUINT
;
867 typedef unsigned long WXDWORD
;
868 typedef unsigned short WXWORD
;
869 typedef unsigned int WXWPARAM
;
870 typedef long WXLPARAM
;
871 typedef unsigned long WXCOLORREF
;
872 typedef void * WXRGNDATA
;
873 typedef void * WXMSG
;
874 typedef unsigned long WXHCONV
;
875 typedef unsigned long WXHKEY
;
876 typedef void * WXDRAWITEMSTRUCT
;
877 typedef void * WXMEASUREITEMSTRUCT
;
878 typedef void * WXLPCREATESTRUCT
;
880 typedef int (*WXFARPROC
)();
882 typedef int (__stdcall
*WXFARPROC
)();
888 // Stand-ins for X/Xt/Motif types
889 typedef void* WXWindow
;
890 typedef void* WXWidget
;
891 typedef void* WXAppContext
;
892 typedef void* WXMainColormap
;
893 typedef void WXDisplay
;
894 typedef void WXEvent
;