]>
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
33 #if defined(__SGI__) && defined(__GNUG__)
34 #define __need_wchar_t
37 // Eliminate double/float warnings
39 # pragma warning(disable:4244)
43 //////////////////////////////////////////////////////////////////////////////////
44 // Currently Only MS-Windows/NT, XView and Motif are supported
46 #if defined(__HPUX__) && !defined(__WXMOTIF__)
49 #if defined(__WXMOTIF__)
53 // wxWindows checks for WIN32, not __WIN32__
54 #if ((defined(WIN32) || defined(__NT__)) && !defined(__WIN32__) && !defined(__WXSTUBS__))
62 #if !defined(__WIN95__) && (WINVER >= 0x0400)
66 // Make sure the environment is set correctly
67 #if defined(__WXMSW__) && defined(__X__)
68 # error "Target can't be both X and Windows"
69 #elif !defined(__WXMOTIF__) && !defined(__WXMSW__) && !defined(__WXGTK__) && \
70 !defined(__WXMAC__) && !defined(__X__) && !defined(__WXQT__) && !defined(__WXSTUBS__)
71 #error "No Target! Use -D[__WXMOTIF__|__WXGTK__|__WXMSW__|__WXMAC__|__WXQT__|__WXSTUBS__]"
74 #if defined(__WXMOTIF__) || defined(__WXGTK__) || defined(__WXQT__) || defined(__WXSTUBS__)
76 // Bool is now obsolete, use bool instead
85 #elif defined(__WXMSW__)
96 // Add more tests here for compilers that don't already define bool.
97 #if ( defined(_MSC_VER) && (_MSC_VER <= 1000) ) || (defined(__BORLANDC__) && (__BORLANDC__ < 0x500))
98 typedef unsigned int bool;
101 #if ( defined(_MSC_VER) && (_MSC_VER <= 800) ) || defined(__GNUWIN32__)
102 #define byte unsigned char
105 typedef short int WXTYPE
;
106 typedef int wxWindowID
;
108 // Macro to cut down on compiler warnings.
109 #if REMOVE_UNUSED_ARG
110 #define WXUNUSED(identifier) /* identifier */
111 #else // stupid, broken compiler
112 #define WXUNUSED(identifier) identifier
116 * Making or using wxWindows as a Windows DLL
124 # define WXDLLEXPORT __export
125 # define WXDLLEXPORT_DATA(type) type __export
126 # define WXDLLEXPORT_CTORFN __export
127 # elif defined(WXUSINGDLL)
128 # define WXDLLEXPORT __import
129 # define WXDLLEXPORT_DATA(type) type __import
130 # define WXDLLEXPORT_CTORFN
133 # define WXDLLEXPORT_DATA(type) type
134 # define WXDLLEXPORT_CTORFN
140 # define WXDLLEXPORT __declspec( dllexport )
141 # define WXDLLEXPORT_DATA(type) __declspec( dllexport ) type
142 # define WXDLLEXPORT_CTORFN __declspec( dllexport )
143 # elif defined(WXUSINGDLL)
144 # define WXDLLEXPORT __declspec( dllimport )
145 # define WXDLLEXPORT_DATA(type) __declspec( dllimport ) type
146 # define WXDLLEXPORT_CTORFN
149 # define WXDLLEXPORT_DATA(type) type
150 # define WXDLLEXPORT_CTORFN
158 # define WXDLLEXPORT_DATA(type) type
159 # define WXDLLEXPORT_CTORFN
162 // For ostream, istream ofstream
163 #if defined(__BORLANDC__) && defined( _RTLDLL )
164 # define WXDLLIMPORT __import
169 class WXDLLEXPORT wxObject
;
170 class WXDLLEXPORT wxEvent
;
172 // Vadim's types - check whether we need them all
174 /// the type for various indexes (string, arrays, ...)
175 typedef unsigned int uint
;
177 /// extended boolean type: { yes, no, may be }
178 typedef signed int EBool
;
180 /// with TRUE and FALSE is a possible value for a "3-state" boolean var
182 /** symbolic constant used by all Find()-like functions returning positive
183 integer on success as failure indicator */
184 #define NOT_FOUND (-1)
185 /** useful for Windows programmers: makes somewhat more clear all these
186 zeroes being passed to Windows APIs */
187 #define RESERVED (NULL)
189 // ----------------------------------------------------------------------------
191 // ----------------------------------------------------------------------------
193 /// Standard error codes
196 /// invalid parameter (in broad sense)
198 /// no more data (iteration functions usually return this)
200 /// user cancelled the operation
202 /// no error (the only non negative error code)
206 // ----------------------------------------------------------------------------
207 /** @name Very common macros */
208 // ----------------------------------------------------------------------------
210 /// delete pointer if it is not NULL and NULL it afterwards
211 // (checking that it's !NULL before passing it to delete is just a
212 // a question of style, because delete will do it itself anyhow, but it might
213 // be considered as an error by some overzealous debugging implementations of
214 // the library, so we do it ourselves)
215 #define wxDELETE(p) if ( (p) != NULL ) { delete (p); p = NULL; }
217 // delete an array and NULL it (see comments above)
218 #define wxDELETEA(p) if ( (p) != NULL ) { delete [] (p); p = NULL; }
220 /// size of statically declared array
221 #define WXSIZEOF(array) (sizeof(array)/sizeof(array[0]))
223 // ----------------------------------------------------------------------------
224 // compiler and OS identification
225 // ----------------------------------------------------------------------------
228 #if defined(__HPUX__) || defined(____SVR4____) || defined(__LINUX__)
234 #ifndef __UNIX__ // Windows
235 #if defined(_MSC_VER)
237 #elif defined(__BCPLUSPLUS__) && !defined(__BORLANDC__)
239 #elif defined(__WATCOMC__)
240 //#define __WATCOMC__
241 #elif defined(__SC__)
242 #define __SYMANTECC__
247 #if defined(__UNIX__)
248 #define FILE_PATH_SEPARATOR ('/')
249 #elif defined(__WXMSW__)
250 #define FILE_PATH_SEPARATOR ('\\')
252 #define FILE_PATH_SEPARATOR ('/')
255 // ----------------------------------------------------------------------------
256 // compiler specific settings
257 // ----------------------------------------------------------------------------
259 // to allow compiling with warning level 4 under Microsoft Visual C++ some
260 // warnings just must be disabled
262 #pragma warning(disable: 4514) // unreferenced inline func has been removed
264 you might be tempted to disable this one also: triggered by CHECK and FAIL
265 macros in debug.h, but it's, overall, is a rather useful one, so I leave it
266 and will try to find some way to disable this warning just for CHECK/FAIL.
269 #pragma warning(disable: 4127) // conditional expression is constant
273 // Callback function type definition
274 typedef void (*wxFunction
) (wxObject
&, wxEvent
&);
277 * Window style flags.
278 * Values are chosen so they can be |'ed in a bit list.
279 * Some styles are used across more than one group,
280 * so the values mustn't clash with others in the group.
281 * Otherwise, numbers can be reused across groups.
284 * Window (cross-group) styles now take up the first half
285 * of the flag, and control-specific styles the
291 * Window (Frame/dialog/subwindow/panel item) style flags
293 #define wxVSCROLL 0x80000000
294 #define wxHSCROLL 0x40000000
295 #define wxCAPTION 0x20000000
298 #define wxDOUBLE_BORDER 0x10000000
299 #define wxSUNKEN_BORDER 0x08000000
300 #define wxRAISED_BORDER 0x04000000
301 #define wxBORDER 0x02000000
302 #define wxSIMPLE_BORDER 0x02000000
303 #define wxSTATIC_BORDER 0x01000000
304 #define wxTRANSPARENT_WINDOW 0x00100000
305 #define wxNO_BORDER 0x00200000
307 #define wxUSER_COLOURS 0x00800000
308 // Override CTL3D etc. control colour processing to
309 // allow own background colour
310 // OBSOLETE - use wxNO_3D instead
311 #define wxNO_3D 0x00800000
312 // Override CTL3D or native 3D styles for children
313 #define wxCLIP_CHILDREN 0x00400000
314 // Clip children when painting, which reduces flicker in
315 // e.g. frames and splitter windows, but can't be used in
316 // a panel where a static box must be 'transparent' (panel
317 // paints the background for it)
319 // Add this style to a panel to get tab traversal working
320 // outside of dialogs.
321 #define wxTAB_TRAVERSAL 0x00080000
324 #define wxHORIZONTAL 0x01
325 #define wxVERTICAL 0x02
326 #define wxBOTH (wxVERTICAL|wxHORIZONTAL)
327 #define wxCENTER_FRAME 0x04 /* centering into frame rather than screen */
330 * Frame/dialog style flags
332 #define wxSTAY_ON_TOP 0x8000
333 #define wxICONIZE 0x4000
334 #define wxMINIMIZE wxICONIZE
335 #define wxMAXIMIZE 0x2000
336 #define wxTHICK_FRAME 0x1000
337 #define wxSYSTEM_MENU 0x0800
338 #define wxMINIMIZE_BOX 0x0400
339 #define wxMAXIMIZE_BOX 0x0200
340 #define wxTINY_CAPTION_HORIZ 0x0100
341 #define wxTINY_CAPTION_VERT 0x0080
342 #define wxRESIZE_BOX wxMAXIMIZE_BOX
343 #define wxRESIZE_BORDER 0x0040
344 #define wxDIALOG_MODAL 0x0020
345 #define wxDIALOG_MODELESS 0x0000
347 #define wxDEFAULT_FRAME_STYLE (wxRESIZE_BORDER | wxMINIMIZE_BOX | wxMAXIMIZE_BOX | wxTHICK_FRAME | wxSYSTEM_MENU | wxCAPTION | wxCLIP_CHILDREN)
349 #if WXWIN_COMPATIBILITY
350 #define wxDEFAULT_FRAME wxDEFAULT_FRAME_STYLE
353 #define wxDEFAULT_DIALOG_STYLE (wxSYSTEM_MENU|wxCAPTION|wxTHICK_FRAME)
356 * Subwindow style flags
358 #define wxRETAINED 0x0001
359 #define wxBACKINGSTORE wxRETAINED
360 // wxCanvas or wxPanel can optionally have a thick frame under MS Windows.
361 // #define wxTHICK_FRAME 0x1000
364 * wxToolBar style flags
367 #define wxTB_3DBUTTONS 0x8000
368 #define wxTB_HORIZONTAL 0x0002
369 #define wxTB_VERTICAL 0x0004
370 // Flatbar/Coolbar under Win98
371 #define wxTB_FLAT 0x0008
374 * Apply to all panel items
377 #define wxCOLOURED 0x0800
378 // Alignment for panel item labels: replaces characters with zeros
379 // when creating label, so spaces can be included in string for alignment.
380 #define wxFIXED_LENGTH 0x0400
381 #define wxALIGN_LEFT 0x0000
382 #define wxALIGN_CENTER 0x0100
383 #define wxALIGN_CENTRE 0x0100
384 #define wxALIGN_RIGHT 0x0200
387 * Styles for wxListBox
390 #define wxLB_SORT 0x0010
391 #define wxLB_SINGLE 0x0020
392 #define wxLB_MULTIPLE 0x0040
393 #define wxLB_EXTENDED 0x0080
394 // wxLB_OWNERDRAW is Windows-only
395 #define wxLB_OWNERDRAW 0x0100
396 #define wxLB_NEEDED_SB 0x0200
397 #define wxLB_ALWAYS_SB 0x0400
398 #define wxLB_HSCROLL wxHSCROLL
401 * wxTextCtrl style flags
403 #define wxPROCESS_ENTER 0x0004
404 #define wxPASSWORD 0x0008
405 #define wxTE_PROCESS_ENTER wxPROCESS_ENTER
406 #define wxTE_PASSWORD wxPASSWORD
407 #define wxTE_READONLY 0x0010
408 #define wxTE_MULTILINE 0x0020
411 #define wxTE_RICHTEXT 0x0020
414 * wxComboBox style flags
416 #define wxCB_SIMPLE 0x0004
417 #define wxCB_SORT 0x0008
418 #define wxCB_READONLY 0x0010
419 #define wxCB_DROPDOWN 0x0020
422 * wxRadioBox/wxRadioButton style flags
424 #define wxRA_HORIZONTAL wxHORIZONTAL
425 #define wxRA_VERTICAL wxVERTICAL
426 #define wxRB_GROUP 0x0004
431 #define wxGA_PROGRESSBAR 0x0004
432 #define wxGA_HORIZONTAL wxHORIZONTAL
433 #define wxGA_VERTICAL wxVERTICAL
439 #define wxSL_HORIZONTAL wxHORIZONTAL
440 #define wxSL_VERTICAL wxVERTICAL
441 // The next one is obsolete - use scroll events instead
442 #define wxSL_NOTIFY_DRAG 0x0000
443 #define wxSL_AUTOTICKS 0x0008
444 // #define wxSL_MANUALTICKS 0x0010
445 #define wxSL_LABELS 0x0020
446 #define wxSL_LEFT 0x0040
447 #define wxSL_TOP 0x0080
448 #define wxSL_RIGHT 0x0100
449 #define wxSL_BOTTOM 0x0200
450 #define wxSL_BOTH 0x0400
451 #define wxSL_SELRANGE 0x0800
457 #define wxSB_HORIZONTAL wxHORIZONTAL
458 #define wxSB_VERTICAL wxVERTICAL
464 #define wxBU_AUTODRAW 0x0004
465 #define wxBU_NOAUTODRAW 0x0000
471 #define wxTR_HAS_BUTTONS 0x0004
472 #define wxTR_EDIT_LABELS 0x0008
473 #define wxTR_LINES_AT_ROOT 0x0010
479 #define wxLC_ICON 0x0004
480 #define wxLC_SMALL_ICON 0x0008
481 #define wxLC_LIST 0x0010
482 #define wxLC_REPORT 0x0020
483 #define wxLC_ALIGN_TOP 0x0040
484 #define wxLC_ALIGN_LEFT 0x0080
485 #define wxLC_AUTOARRANGE 0x0100
486 #define wxLC_USER_TEXT 0x0200
487 #define wxLC_EDIT_LABELS 0x0400
488 #define wxLC_NO_HEADER 0x0800
489 #define wxLC_NO_SORT_HEADER 0x1000
490 #define wxLC_SINGLE_SEL 0x2000
491 #define wxLC_SORT_ASCENDING 0x4000
492 #define wxLC_SORT_DESCENDING 0x8000
494 #define wxLC_MASK_TYPE (wxLC_ICON | wxLC_SMALL_ICON | wxLC_LIST | wxLC_REPORT)
495 #define wxLC_MASK_ALIGN (wxLC_ALIGN_TOP | wxLC_ALIGN_LEFT)
496 #define wxLC_MASK_SORT (wxLC_SORT_ASCENDING | wxLC_SORT_DESCENDING)
498 // Omitted because (a) too much detail (b) not enough style flags
499 // #define wxLC_NO_SCROLL
500 // #define wxLC_NO_LABEL_WRAP
501 // #define wxLC_OWNERDRAW_FIXED
502 // #define wxLC_SHOW_SEL_ALWAYS
508 #define wxSP_VERTICAL 0x0004
509 #define wxSP_HORIZONTAL 0x0008
510 #define wxSP_ARROW_KEYS 0x0010
511 #define wxSP_WRAP 0x0020
514 * wxSplitterWnd flags
517 #define wxSP_NOBORDER 0x0000
518 #define wxSP_3D 0x0004
519 #define wxSP_BORDER 0x0008
525 #define wxTAB_MULTILINE 0x0000
526 #define wxTAB_RIGHTJUSTIFY 0x0004
527 #define wxTAB_FIXEDWIDTH 0x0008
528 #define wxTAB_OWNERDRAW 0x0010
530 // Sorry, I changed my mind about these names...
531 #define wxTC_MULTILINE 0x0000
532 #define wxTC_RIGHTJUSTIFY 0x0004
533 #define wxTC_FIXEDWIDTH 0x0008
534 #define wxTC_OWNERDRAW 0x0010
537 * wxStatusBar95 flags
540 #define wxST_SIZEGRIP 0x0002
547 // Text font families
554 wxTELETYPE
, /* @@@@ */
556 // Proportional or Fixed width fonts (not yet used)
563 // Also wxNORMAL for normal (non-italic text)
577 // Brush & Pen Stippling. Note that a stippled pen cannot be dashed!!
578 // Note also that stippling a Pen IS meaningfull, because a Line is
579 // drawn with a Pen, and without any Brush -- and it can be stippled.
587 #define IS_HATCH(s) ((s)>=wxBDIAGONAL_HATCH && (s)<=wxVERTICAL_HATCH)
602 wxXOR
, // src XOR dst
604 wxOR_REVERSE
, // src OR (NOT dst)
605 wxAND_REVERSE
,// src AND (NOT dst)
607 wxAND
, // src AND dst
608 wxAND_INVERT
, // (NOT src) AND dst
610 wxNOR
, // (NOT src) AND (NOT dst)
611 wxEQUIV
, // (NOT src) XOR dst
612 wxSRC_INVERT
, // (NOT src)
613 wxOR_INVERT
, // (NOT src) OR dst
614 wxNAND
, // (NOT src) OR (NOT dst)
617 wxSRC_OR
, // source _bitmap_ OR destination
618 wxSRC_AND
// source _bitmap_ AND destination
622 #define wxFLOOD_SURFACE 1
623 #define wxFLOOD_BORDER 2
625 // Polygon filling mode
626 #define wxODDEVEN_RULE 1
627 #define wxWINDING_RULE 2
629 // ToolPanel in wxFrame
631 #define wxTOOL_BOTTOM 2
632 #define wxTOOL_LEFT 3
633 #define wxTOOL_RIGHT 4
635 // Dialog specifiers/return values
638 #define wxYES_NO 0x0002
639 #define wxCANCEL 0x0004
643 #define wxICON_EXCLAMATION 0x0020
644 #define wxICON_HAND 0x0040
645 #define wxICON_QUESTION 0x0080
646 #define wxICON_INFORMATION 0x0100
648 #define wxICON_STOP wxICON_HAND
649 #define wxICON_ASTERISK wxICON_INFORMATION
650 #define wxICON_MASK (0x0020|0x0040|0x0080|0x0100)
652 #define wxCENTRE 0x0200
653 #define wxCENTER wxCENTRE
655 // Possible SetSize flags
657 // Use internally-calculated width if -1
658 #define wxSIZE_AUTO_WIDTH 0x0001
659 // Use internally-calculated height if -1
660 #define wxSIZE_AUTO_HEIGHT 0x0002
661 // Use internally-calculated width and height if each is -1
662 #define wxSIZE_AUTO (wxSIZE_AUTO_WIDTH|wxSIZE_AUTO_HEIGHT)
663 // Ignore missing (-1) dimensions (use existing).
664 // For readability only: test for wxSIZE_AUTO_WIDTH/HEIGHT in code.
665 #define wxSIZE_USE_EXISTING 0x0000
666 // Allow -1 as a valid position
667 #define wxSIZE_ALLOW_MINUS_ONE 0x0004
668 // Don't do parent client adjustments (for implementation only)
669 #define wxSIZE_NO_ADJUSTMENTS 0x0008
672 // Data format for drag & drop and clipboard operations
673 // numbers as per winuser.h
677 wxDF_TEXT
= 1, /* CF_TEXT */
678 wxDF_BITMAP
= 2, /* CF_BITMAP */
679 wxDF_METAFILE
= 3, /* CF_METAFILEPICT */
680 wxDF_DIB
= 8, /* CF_DIB */
681 wxDF_OEMTEXT
= 7, /* CF_OEMTEXT */
682 wxDF_FILENAME
= 15 /* CF_HDROP */
687 enum _Virtual_keycodes
{
706 WXK_PRIOR
, // Page up
707 WXK_NEXT
, // Page down
766 // Colours - see wx_gdi.cc for database
768 // OS mnemonics -- Identify the running OS (useful for Windows)
769 // [Not all platforms are currently available or supported]
772 wxCURSES
, // Text-only CURSES
773 wxXVIEW_X
, // Sun's XView OpenLOOK toolkit
774 wxMOTIF_X
, // OSF Motif 1.x.x
775 wxCOSE_X
, // OSF Common Desktop Environment
776 wxNEXTSTEP
, // NeXTStep
777 wxMACINTOSH
, // Apple System 7
781 wxOS2_PM
, // OS/2 Workplace
782 wxWINDOWS
, // Windows or WfW
783 wxPENWINDOWS
, // Windows for Pen Computing
784 wxWINDOWS_NT
, // Windows NT
785 wxWIN32S
, // Windows 32S API
786 wxWIN95
, // Windows 95
787 wxWIN386
// Watcom 32-bit supervisor modus
793 #define wxLANDSCAPE 2
796 // Standard menu identifiers
797 #define wxID_OPEN 5000
798 #define wxID_CLOSE 5001
799 #define wxID_NEW 5002
800 #define wxID_SAVE 5003
801 #define wxID_SAVEAS 5004
802 #define wxID_REVERT 5005
803 #define wxID_EXIT 5006
804 #define wxID_UNDO 5007
805 #define wxID_REDO 5008
806 #define wxID_HELP 5009
807 #define wxID_PRINT 5010
808 #define wxID_PRINT_SETUP 5011
809 #define wxID_PREVIEW 5012
810 #define wxID_ABOUT 5013
811 #define wxID_HELP_CONTENTS 5014
812 #define wxID_HELP_COMMANDS 5015
813 #define wxID_HELP_PROCEDURES 5016
814 #define wxID_HELP_CONTEXT 5017
816 #define wxID_CUT 5030
817 #define wxID_COPY 5031
818 #define wxID_PASTE 5032
819 #define wxID_CLEAR 5033
820 #define wxID_FIND 5034
822 #define wxID_FILE1 5050
823 #define wxID_FILE2 5051
824 #define wxID_FILE3 5052
825 #define wxID_FILE4 5053
826 #define wxID_FILE5 5054
827 #define wxID_FILE6 5055
828 #define wxID_FILE7 5056
829 #define wxID_FILE8 5057
830 #define wxID_FILE9 5058
833 #define wxID_CANCEL 5101
834 #define wxID_APPLY 5102
835 #define wxID_YES 5103
837 #define wxID_STATIC 5105
840 // Stand-ins for Windows types, to avoid
841 // #including all of windows.h
843 typedef unsigned long WXHWND
;
844 typedef unsigned long WXHANDLE
;
845 typedef unsigned long WXHICON
;
846 typedef unsigned long WXHFONT
;
847 typedef unsigned long WXHMENU
;
848 typedef unsigned long WXHPEN
;
849 typedef unsigned long WXHBRUSH
;
850 typedef unsigned long WXHPALETTE
;
851 typedef unsigned long WXHCURSOR
;
852 typedef unsigned long WXHRGN
;
853 typedef unsigned long WXHACCEL
;
854 typedef unsigned long WXHINSTANCE
;
855 typedef unsigned long WXHBITMAP
;
856 typedef unsigned long WXHIMAGELIST
;
857 typedef unsigned long WXHGLOBAL
;
858 typedef unsigned long WXHDC
;
859 typedef unsigned int WXUINT
;
860 typedef unsigned long WXDWORD
;
861 typedef unsigned short WXWORD
;
862 typedef unsigned int WXWPARAM
;
863 typedef long WXLPARAM
;
864 typedef unsigned long WXCOLORREF
;
865 typedef void * WXRGNDATA
;
866 typedef void * WXMSG
;
867 typedef unsigned long WXHCONV
;
868 typedef void * WXDRAWITEMSTRUCT
;
869 typedef void * WXMEASUREITEMSTRUCT
;
870 typedef void * WXLPCREATESTRUCT
;
872 typedef int (*WXFARPROC
)();
874 typedef int (__stdcall
*WXFARPROC
)();