]>
git.saurik.com Git - wxWidgets.git/blob - include/wx/defs.h
f84200020c3ff87565619f9c586c09d47be4e4d2
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__)
51 #elif defined(__WXMSW__) || defined(__WINDOWS_386__) || defined(__NT__) || defined(__MSDOS__)
57 // wxWindows checks for WIN32, not __WIN32__
58 #if ((defined(WIN32) || defined(__NT__)) && !defined(__WIN32__))
66 #if !defined(__WIN95__) && (WINVER >= 0x0400)
70 // Make sure the environment is set correctly
71 #if defined(__WXMSW__) && defined(__X__)
72 # error "Target can't be both X and Windows"
73 #elif !defined(__WXMOTIF__) && !defined(__WXMSW__) && !defined(__WXGTK__) && !defined(__MAC__) && !defined(__X__)
74 #error "No Target! Use -D[__WXMOTIF__|__WXGTK__|__WXMSW__|__MAC__]"
77 #if defined(__WXMOTIF__) || defined(__WXGTK__)
79 // Bool is now obsolete, use bool instead
88 #elif defined(__WXMSW__)
99 // Add more tests here for compilers that don't already define bool.
100 #if ( defined(_MSC_VER) && (_MSC_VER <= 1000) ) || (defined(__BORLANDC__) && (__BORLANDC__ < 0x500))
101 typedef unsigned int bool;
104 #if ( defined(_MSC_VER) && (_MSC_VER <= 800) ) || defined(__GNUWIN32__)
105 #define byte unsigned char
108 typedef short int WXTYPE
;
109 typedef int wxWindowID
;
111 // Macro to cut down on compiler warnings.
112 #if REMOVE_UNUSED_ARG
113 #define WXUNUSED(identifier) /* identifier */
114 #else // stupid, broken compiler
115 #define WXUNUSED(identifier) identifier
119 * Making or using wxWindows as a Windows DLL
127 # define WXDLLEXPORT __export
128 # define WXDLLEXPORT_DATA(type) type __export
129 # define WXDLLEXPORT_CTORFN __export
130 # elif defined(WXUSINGDLL)
131 # define WXDLLEXPORT __import
132 # define WXDLLEXPORT_DATA(type) type __import
133 # define WXDLLEXPORT_CTORFN
136 # define WXDLLEXPORT_DATA(type) type
137 # define WXDLLEXPORT_CTORFN
143 # define WXDLLEXPORT __declspec( dllexport )
144 # define WXDLLEXPORT_DATA(type) __declspec( dllexport ) type
145 # define WXDLLEXPORT_CTORFN __declspec( dllexport )
146 # elif defined(WXUSINGDLL)
147 # define WXDLLEXPORT __declspec( dllimport )
148 # define WXDLLEXPORT_DATA(type) __declspec( dllimport ) type
149 # define WXDLLEXPORT_CTORFN
152 # define WXDLLEXPORT_DATA(type) type
153 # define WXDLLEXPORT_CTORFN
161 # define WXDLLEXPORT_DATA(type) type
162 # define WXDLLEXPORT_CTORFN
165 // For ostream, istream ofstream
166 #if defined(__BORLANDC__) && defined( _RTLDLL )
167 # define WXDLLIMPORT __import
172 class WXDLLEXPORT wxObject
;
173 class WXDLLEXPORT wxEvent
;
175 // Vadim's types - check whether we need them all
177 /// the type for various indexes (string, arrays, ...)
178 typedef unsigned int uint
;
180 /// extended boolean type: { yes, no, may be }
181 typedef signed int EBool
;
183 /// with TRUE and FALSE is a possible value for a "3-state" boolean var
185 /** symbolic constant used by all Find()-like functions returning positive
186 integer on success as failure indicator */
187 #define NOT_FOUND (-1)
188 /** useful for Windows programmers: makes somewhat more clear all these
189 zeroes being passed to Windows APIs */
190 #define RESERVED (NULL)
192 // ----------------------------------------------------------------------------
194 // ----------------------------------------------------------------------------
196 /// Standard error codes
199 /// invalid parameter (in broad sense)
201 /// no more data (iteration functions usually return this)
203 /// user cancelled the operation
205 /// no error (the only non negative error code)
209 // ----------------------------------------------------------------------------
210 /** @name Very common macros */
211 // ----------------------------------------------------------------------------
213 /// delete pointer if it is not NULL and NULL it afterwards
214 // (checking that it's !NULL before passing it to delete is just a
215 // a question of style, because delete will do it itself anyhow, but it might
216 // be considered as an error by some overzealous debugging implementations of
217 // the library, so we do it ourselves)
218 #define wxDELETE(p) if ( (p) != NULL ) { delete (p); p = NULL; }
220 // delete an array and NULL it (see comments above)
221 #define wxDELETEA(p) if ( (p) != NULL ) { delete [] (p); p = NULL; }
223 /// size of statically declared array
224 #define WXSIZEOF(array) (sizeof(array)/sizeof(array[0]))
226 // ----------------------------------------------------------------------------
227 // compiler and OS identification
228 // ----------------------------------------------------------------------------
231 #if defined(__HPUX__) || defined(____SVR4____) || defined(__LINUX__)
237 #ifndef __UNIX__ // Windows
242 #if defined(_MSC_VER)
244 #elif defined(__BCPLUSPLUS__) && !defined(__BORLANDC__)
246 #elif defined(__WATCOMC__)
247 //#define __WATCOMC__
248 #elif defined(__SC__)
249 #define __SYMANTECC__
254 #if defined(__UNIX__)
255 #define FILE_PATH_SEPARATOR ('/')
256 #elif defined(__WXMSW__)
257 #define FILE_PATH_SEPARATOR ('\\')
259 #error "don't know path separator for this platform"
262 // ----------------------------------------------------------------------------
263 // compiler specific settings
264 // ----------------------------------------------------------------------------
266 // to allow compiling with warning level 4 under Microsoft Visual C++ some
267 // warnings just must be disabled
269 #pragma warning(disable: 4514) // unreferenced inline func has been removed
271 you might be tempted to disable this one also: triggered by CHECK and FAIL
272 macros in debug.h, but it's, overall, is a rather useful one, so I leave it
273 and will try to find some way to disable this warning just for CHECK/FAIL.
276 #pragma warning(disable: 4127) // conditional expression is constant
280 // Callback function type definition
281 typedef void (*wxFunction
) (wxObject
&, wxEvent
&);
284 * Window style flags.
285 * Values are chosen so they can be |'ed in a bit list.
286 * Some styles are used across more than one group,
287 * so the values mustn't clash with others in the group.
288 * Otherwise, numbers can be reused across groups.
291 * Window (cross-group) styles now take up the first half
292 * of the flag, and control-specific styles the
298 * Window (Frame/dialog/subwindow/panel item) style flags
300 #define wxVSCROLL 0x80000000
301 #define wxHSCROLL 0x40000000
302 #define wxCAPTION 0x20000000
305 #define wxDOUBLE_BORDER 0x10000000
306 #define wxSUNKEN_BORDER 0x08000000
307 #define wxRAISED_BORDER 0x04000000
308 #define wxBORDER 0x02000000
309 #define wxSIMPLE_BORDER 0x02000000
310 #define wxSTATIC_BORDER 0x01000000
311 #define wxTRANSPARENT_WINDOW 0x00100000
312 #define wxNO_BORDER 0x00200000
314 #define wxUSER_COLOURS 0x00800000
315 // Override CTL3D etc. control colour processing to
316 // allow own background colour
317 // OBSOLETE - use wxNO_3D instead
318 #define wxNO_3D 0x00800000
319 // Override CTL3D or native 3D styles for children
320 #define wxCLIP_CHILDREN 0x00400000
321 // Clip children when painting, which reduces flicker in
322 // e.g. frames and splitter windows, but can't be used in
323 // a panel where a static box must be 'transparent' (panel
324 // paints the background for it)
326 // Add this style to a panel to get tab traversal working
327 // outside of dialogs.
328 #define wxTAB_TRAVERSAL 0x00080000
331 #define wxHORIZONTAL 0x01
332 #define wxVERTICAL 0x02
333 #define wxBOTH (wxVERTICAL|wxHORIZONTAL)
334 #define wxCENTER_FRAME 0x04 /* centering into frame rather than screen */
337 * Frame/dialog style flags
339 #define wxSTAY_ON_TOP 0x8000
340 #define wxICONIZE 0x4000
341 #define wxMINIMIZE wxICONIZE
342 #define wxMAXIMIZE 0x2000
343 #define wxTHICK_FRAME 0x1000
344 #define wxSYSTEM_MENU 0x0800
345 #define wxMINIMIZE_BOX 0x0400
346 #define wxMAXIMIZE_BOX 0x0200
347 #define wxTINY_CAPTION_HORIZ 0x0100
348 #define wxTINY_CAPTION_VERT 0x0080
349 #define wxRESIZE_BOX wxMAXIMIZE_BOX
350 #define wxRESIZE_BORDER 0x0040
351 #define wxDIALOG_MODAL 0x0020
352 #define wxDIALOG_MODELESS 0x0000
354 #define wxDEFAULT_FRAME_STYLE (wxRESIZE_BORDER | wxMINIMIZE_BOX | wxMAXIMIZE_BOX | wxTHICK_FRAME | wxSYSTEM_MENU | wxCAPTION | wxCLIP_CHILDREN)
356 #if WXWIN_COMPATIBILITY
357 #define wxDEFAULT_FRAME wxDEFAULT_FRAME_STYLE
360 #define wxDEFAULT_DIALOG_STYLE (wxSYSTEM_MENU|wxCAPTION|wxTHICK_FRAME)
363 * Subwindow style flags
365 #define wxRETAINED 0x0001
366 #define wxBACKINGSTORE wxRETAINED
367 // wxCanvas or wxPanel can optionally have a thick frame under MS Windows.
368 // #define wxTHICK_FRAME 0x1000
371 * wxToolBar style flags
374 #define wxTB_3DBUTTONS 0x8000
375 #define wxTB_HORIZONTAL 0x0002
376 #define wxTB_VERTICAL 0x0004
377 // Flatbar/Coolbar under Win98
378 #define wxTB_FLAT 0x0008
381 * Apply to all panel items
384 #define wxCOLOURED 0x0800
385 // Alignment for panel item labels: replaces characters with zeros
386 // when creating label, so spaces can be included in string for alignment.
387 #define wxFIXED_LENGTH 0x0400
388 #define wxALIGN_LEFT 0x0000
389 #define wxALIGN_CENTER 0x0100
390 #define wxALIGN_CENTRE 0x0100
391 #define wxALIGN_RIGHT 0x0200
394 * Styles for wxListBox
397 // In wxListBox style flag
398 #define wxSB_MASK 0x0008
399 #define wxNEEDED_SB 0x0000
400 #define wxALWAYS_SB 0x0008
402 // New naming convention
403 #define wxLB_NEEDED_SB wxNEEDED_SB
404 #define wxLB_ALWAYS_SB wxALWAYS_SB
405 #define wxLB_SORT 0x0010
406 // These duplicate the styles in the Multiple argument
407 #define wxLB_SINGLE 0x0000
408 #define wxLB_MULTIPLE 0x0040
409 #define wxLB_EXTENDED 0x0080
410 // wxLB_OWNERDRAW is Windows-only
411 #define wxLB_OWNERDRAW 0x0100
412 #define wxLB_HSCROLL wxHSCROLL
415 * wxTextCtrl style flags
417 #define wxPROCESS_ENTER 0x0004
418 #define wxPASSWORD 0x0008
419 #define wxTE_PROCESS_ENTER wxPROCESS_ENTER
420 #define wxTE_PASSWORD wxPASSWORD
421 #define wxTE_READONLY 0x0010
422 #define wxTE_MULTILINE 0x0020
424 // TODO For backward compatibility, need wxOLD_READONLY
425 #define wxREADONLY wxTE_READONLY
428 // #define wxTE_RICHTEXT 0x0020
431 * wxComboBox style flags
433 #define wxCB_SIMPLE 0x0004
434 #define wxCB_DROPDOWN 0x0000
435 #define wxCB_SORT 0x0008
436 #define wxCB_READONLY wxREADONLY
439 * wxRadioBox/wxRadioButton style flags
441 #define wxRA_HORIZONTAL wxHORIZONTAL
442 #define wxRA_VERTICAL wxVERTICAL
443 #define wxRB_GROUP 0x0004
448 #define wxGA_PROGRESSBAR 0x0004
449 #define wxGA_HORIZONTAL wxHORIZONTAL
450 #define wxGA_VERTICAL wxVERTICAL
456 #define wxSL_HORIZONTAL wxHORIZONTAL
457 #define wxSL_VERTICAL wxVERTICAL
458 // The next one is obsolete - use scroll events instead
459 #define wxSL_NOTIFY_DRAG 0x0000
460 #define wxSL_AUTOTICKS 0x0008
461 // #define wxSL_MANUALTICKS 0x0010
462 #define wxSL_LABELS 0x0020
463 #define wxSL_LEFT 0x0040
464 #define wxSL_TOP 0x0080
465 #define wxSL_RIGHT 0x0100
466 #define wxSL_BOTTOM 0x0200
467 #define wxSL_BOTH 0x0400
468 #define wxSL_SELRANGE 0x0800
474 #define wxSB_HORIZONTAL wxHORIZONTAL
475 #define wxSB_VERTICAL wxVERTICAL
481 #define wxBU_AUTODRAW 0x0004
482 #define wxBU_NOAUTODRAW 0x0000
488 #define wxTR_HAS_BUTTONS 0x0004
489 #define wxTR_EDIT_LABELS 0x0008
490 #define wxTR_LINES_AT_ROOT 0x0010
496 #define wxLC_ICON 0x0004
497 #define wxLC_SMALL_ICON 0x0008
498 #define wxLC_LIST 0x0010
499 #define wxLC_REPORT 0x0020
500 #define wxLC_ALIGN_TOP 0x0040
501 #define wxLC_ALIGN_LEFT 0x0080
502 #define wxLC_AUTOARRANGE 0x0100
503 #define wxLC_USER_TEXT 0x0200
504 #define wxLC_EDIT_LABELS 0x0400
505 #define wxLC_NO_HEADER 0x0800
506 #define wxLC_NO_SORT_HEADER 0x1000
507 #define wxLC_SINGLE_SEL 0x2000
508 #define wxLC_SORT_ASCENDING 0x4000
509 #define wxLC_SORT_DESCENDING 0x8000
511 #define wxLC_MASK_TYPE (wxLC_ICON | wxLC_SMALL_ICON | wxLC_LIST | wxLC_REPORT)
512 #define wxLC_MASK_ALIGN (wxLC_ALIGN_TOP | wxLC_ALIGN_LEFT)
513 #define wxLC_MASK_SORT (wxLC_SORT_ASCENDING | wxLC_SORT_DESCENDING)
515 // Omitted because (a) too much detail (b) not enough style flags
516 // #define wxLC_NO_SCROLL
517 // #define wxLC_NO_LABEL_WRAP
518 // #define wxLC_OWNERDRAW_FIXED
519 // #define wxLC_SHOW_SEL_ALWAYS
525 #define wxSP_VERTICAL 0x0004
526 #define wxSP_HORIZONTAL 0x0008
527 #define wxSP_ARROW_KEYS 0x0010
528 #define wxSP_WRAP 0x0020
531 * wxSplitterWnd flags
534 #define wxSP_NOBORDER 0x0000
535 #define wxSP_3D 0x0004
536 #define wxSP_BORDER 0x0008
542 #define wxTAB_MULTILINE 0x0000
543 #define wxTAB_RIGHTJUSTIFY 0x0004
544 #define wxTAB_FIXEDWIDTH 0x0008
545 #define wxTAB_OWNERDRAW 0x0010
547 // Sorry, I changed my mind about these names...
548 #define wxTC_MULTILINE 0x0000
549 #define wxTC_RIGHTJUSTIFY 0x0004
550 #define wxTC_FIXEDWIDTH 0x0008
551 #define wxTC_OWNERDRAW 0x0010
554 * wxStatusBar95 flags
557 #define wxST_SIZEGRIP 0x0002
564 // Text font families
571 wxTELETYPE
, /* @@@@ */
573 // Proportional or Fixed width fonts (not yet used)
580 // Also wxNORMAL for normal (non-italic text)
594 // Brush & Pen Stippling. Note that a stippled pen cannot be dashed!!
595 // Note also that stippling a Pen IS meaningfull, because a Line is
596 // drawn with a Pen, and without any Brush -- and it can be stippled.
604 #define IS_HATCH(s) ((s)>=wxBDIAGONAL_HATCH && (s)<=wxVERTICAL_HATCH)
619 wxXOR
, // src XOR dst
621 wxOR_REVERSE
, // src OR (NOT dst)
622 wxAND_REVERSE
,// src AND (NOT dst)
624 wxAND
, // src AND dst
625 wxAND_INVERT
, // (NOT src) AND dst
627 wxNOR
, // (NOT src) AND (NOT dst)
628 wxEQUIV
, // (NOT src) XOR dst
629 wxSRC_INVERT
, // (NOT src)
630 wxOR_INVERT
, // (NOT src) OR dst
631 wxNAND
, // (NOT src) OR (NOT dst)
634 wxSRC_OR
, // source _bitmap_ OR destination
635 wxSRC_AND
// source _bitmap_ AND destination
639 #define wxFLOOD_SURFACE 1
640 #define wxFLOOD_BORDER 2
642 // Polygon filling mode
643 #define wxODDEVEN_RULE 1
644 #define wxWINDING_RULE 2
646 // ToolPanel in wxFrame
648 #define wxTOOL_BOTTOM 2
649 #define wxTOOL_LEFT 3
650 #define wxTOOL_RIGHT 4
652 // Dialog specifiers/return values
655 #define wxYES_NO 0x0002
656 #define wxCANCEL 0x0004
660 #define wxICON_EXCLAMATION 0x0020
661 #define wxICON_HAND 0x0040
662 #define wxICON_QUESTION 0x0080
663 #define wxICON_INFORMATION 0x0100
665 #define wxICON_STOP wxICON_HAND
666 #define wxICON_ASTERISK wxICON_INFORMATION
667 #define wxICON_MASK (0x0020|0x0040|0x0080|0x0100)
669 #define wxCENTRE 0x0200
670 #define wxCENTER wxCENTRE
672 // Possible SetSize flags
674 // Use internally-calculated width if -1
675 #define wxSIZE_AUTO_WIDTH 0x0001
676 // Use internally-calculated height if -1
677 #define wxSIZE_AUTO_HEIGHT 0x0002
678 // Use internally-calculated width and height if each is -1
679 #define wxSIZE_AUTO (wxSIZE_AUTO_WIDTH|wxSIZE_AUTO_HEIGHT)
680 // Ignore missing (-1) dimensions (use existing).
681 // For readability only: test for wxSIZE_AUTO_WIDTH/HEIGHT in code.
682 #define wxSIZE_USE_EXISTING 0x0000
683 // Allow -1 as a valid position
684 #define wxSIZE_ALLOW_MINUS_ONE 0x0004
685 // Don't do parent client adjustments (for implementation only)
686 #define wxSIZE_NO_ADJUSTMENTS 0x0008
689 // Data format for drag & drop and clipboard operations
690 // numbers as per winuser.h
694 wxDF_TEXT
= 1, /* CF_TEXT */
695 wxDF_BITMAP
= 2, /* CF_BITMAP */
696 wxDF_METAFILE
= 3, /* CF_METAFILEPICT */
697 wxDF_DIB
= 8, /* CF_DIB */
698 wxDF_OEMTEXT
= 7, /* CF_OEMTEXT */
699 wxDF_FILENAME
= 15 /* CF_HDROP */
704 enum _Virtual_keycodes
{
723 WXK_PRIOR
, // Page up
724 WXK_NEXT
, // Page down
783 // Colours - see wx_gdi.cc for database
785 // OS mnemonics -- Identify the running OS (useful for Windows)
786 // [Not all platforms are currently available or supported]
789 wxXVIEW_X
, // Sun's XView OpenLOOK toolkit
790 wxMOTIF_X
, // OSF Motif 1.x.x
791 wxCOSE_X
, // OSF Common Desktop Environment
792 wxNEXTSTEP
, // NeXTStep
793 wxMACINTOSH
, // Apple System 7
795 wxOS2_PM
, // OS/2 Workplace
796 wxWINDOWS
, // Windows or WfW
797 wxPENWINDOWS
, // Windows for Pen Computing
798 wxWINDOWS_NT
, // Windows NT
799 wxWIN32S
, // Windows 32S API
800 wxWIN95
, // Windows 95
801 wxWIN386
// Watcom 32-bit supervisor modus
807 #define wxLANDSCAPE 2
810 // Standard menu identifiers
811 #define wxID_OPEN 5000
812 #define wxID_CLOSE 5001
813 #define wxID_NEW 5002
814 #define wxID_SAVE 5003
815 #define wxID_SAVEAS 5004
816 #define wxID_REVERT 5005
817 #define wxID_EXIT 5006
818 #define wxID_UNDO 5007
819 #define wxID_REDO 5008
820 #define wxID_HELP 5009
821 #define wxID_PRINT 5010
822 #define wxID_PRINT_SETUP 5011
823 #define wxID_PREVIEW 5012
824 #define wxID_ABOUT 5013
825 #define wxID_HELP_CONTENTS 5014
826 #define wxID_HELP_COMMANDS 5015
827 #define wxID_HELP_PROCEDURES 5016
828 #define wxID_HELP_CONTEXT 5017
830 #define wxID_CUT 5030
831 #define wxID_COPY 5031
832 #define wxID_PASTE 5032
833 #define wxID_CLEAR 5033
834 #define wxID_FIND 5034
836 #define wxID_FILE1 5050
837 #define wxID_FILE2 5051
838 #define wxID_FILE3 5052
839 #define wxID_FILE4 5053
840 #define wxID_FILE5 5054
841 #define wxID_FILE6 5055
842 #define wxID_FILE7 5056
843 #define wxID_FILE8 5057
844 #define wxID_FILE9 5058
847 #define wxID_CANCEL 5101
848 #define wxID_APPLY 5102
849 #define wxID_YES 5103
851 #define wxID_STATIC 5105
854 // Stand-ins for Windows types, to avoid
855 // #including all of windows.h
857 typedef unsigned long WXHWND
;
858 typedef unsigned long WXHANDLE
;
859 typedef unsigned long WXHICON
;
860 typedef unsigned long WXHFONT
;
861 typedef unsigned long WXHMENU
;
862 typedef unsigned long WXHPEN
;
863 typedef unsigned long WXHBRUSH
;
864 typedef unsigned long WXHPALETTE
;
865 typedef unsigned long WXHCURSOR
;
866 typedef unsigned long WXHRGN
;
867 typedef unsigned long WXHACCEL
;
868 typedef unsigned long WXHINSTANCE
;
869 typedef unsigned long WXHBITMAP
;
870 typedef unsigned long WXHIMAGELIST
;
871 typedef unsigned long WXHGLOBAL
;
872 typedef unsigned long WXHDC
;
873 typedef unsigned int WXUINT
;
874 typedef unsigned long WXDWORD
;
875 typedef unsigned short WXWORD
;
876 typedef unsigned int WXWPARAM
;
877 typedef long WXLPARAM
;
878 typedef unsigned long WXCOLORREF
;
879 typedef void * WXRGNDATA
;
880 typedef void * WXMSG
;
881 typedef unsigned long WXHCONV
;
882 typedef void * WXDRAWITEMSTRUCT
;
883 typedef void * WXMEASUREITEMSTRUCT
;
884 typedef void * WXLPCREATESTRUCT
;
885 typedef int (*WXFARPROC
)();