]>
git.saurik.com Git - wxWidgets.git/blob - include/wx/defs.h
20ef4490298b15d05b0d3b010aa710b70f0a53b4
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(__MOTIF__)
49 #if defined(__MOTIF__)
51 #elif defined(__WINDOWS__) || 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(__WINDOWS__) && defined(__X__)
72 # error "Target can't be both X and Windows"
73 #elif !defined(__MOTIF__) && !defined(__WINDOWS__) && !defined(__GTK__) && !defined(__MAC__) && !defined(__X__)
74 #error "No Target! Use -D[__MOTIF__|__GTK__|__WINDOWS__|__MAC__]"
77 #if defined(__MOTIF__) || defined(__GTK__)
79 // Bool is now obsolete, use bool instead
88 #elif defined(__WINDOWS__)
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
214 #define DELETEP(p) if ( (p) != NULL ) delete (p)
215 /// delete array pointer if it is not NULL
216 #define DELETEA(p) if ( (p) != NULL ) delete [] (p)
218 /// size of statically declared array
219 #define WXSIZEOF(array) (sizeof(array)/sizeof(array[0]))
221 // ----------------------------------------------------------------------------
222 // compiler and OS identification
223 // ----------------------------------------------------------------------------
226 #if defined(__HPUX__) || defined(____SVR4____) || defined(__LINUX__)
232 #ifndef __UNIX__ // Windows
237 #if defined(_MSC_VER)
239 #elif defined(__BCPLUSPLUS__) && !defined(__BORLANDC__)
241 #elif defined(__WATCOMC__)
242 //#define __WATCOMC__
243 #elif defined(__SC__)
244 #define __SYMANTECC__
249 #if defined(__UNIX__)
250 #define FILE_PATH_SEPARATOR ('/')
251 #elif defined(__WINDOWS__)
252 #define FILE_PATH_SEPARATOR ('\\')
254 #error "don't know path separator for this platform"
257 // ----------------------------------------------------------------------------
258 // compiler specific settings
259 // ----------------------------------------------------------------------------
261 // to allow compiling with warning level 4 under Microsoft Visual C++ some
262 // warnings just must be disabled
264 #pragma warning(disable: 4514) // unreferenced inline func has been removed
266 you might be tempted to disable this one also: triggered by CHECK and FAIL
267 macros in debug.h, but it's, overall, is a rather useful one, so I leave it
268 and will try to find some way to disable this warning just for CHECK/FAIL.
271 #pragma warning(disable: 4127) // conditional expression is constant
275 // Callback function type definition
276 typedef void (*wxFunction
) (wxObject
&, wxEvent
&);
279 * Window style flags.
280 * Values are chosen so they can be |'ed in a bit list.
281 * Some styles are used across more than one group,
282 * so the values mustn't clash with others in the group.
283 * Otherwise, numbers can be reused across groups.
286 * Window (cross-group) styles now take up the first half
287 * of the flag, and control-specific styles the
293 * Window (Frame/dialog/subwindow/panel item) style flags
295 #define wxVSCROLL 0x80000000
296 #define wxHSCROLL 0x40000000
297 #define wxCAPTION 0x20000000
300 #define wxDOUBLE_BORDER 0x10000000
301 #define wxSUNKEN_BORDER 0x08000000
302 #define wxRAISED_BORDER 0x04000000
303 #define wxBORDER 0x02000000
304 #define wxSIMPLE_BORDER 0x02000000
305 #define wxSTATIC_BORDER 0x01000000
306 #define wxTRANSPARENT_WINDOW 0x00100000
307 #define wxNO_BORDER 0x00200000
309 #define wxUSER_COLOURS 0x00800000
310 // Override CTL3D etc. control colour processing to
311 // allow own background colour
312 // OBSOLETE - use wxNO_CTL3D instead
313 #define wxNO_3D 0x00800000
314 // Override CTL3D or native 3D styles for children
315 #define wxOVERRIDE_KEY_TRANSLATIONS 0x00400000
316 // TODO: do we need this??? (Motif only)
318 // Add this style to a panel to get tab traversal working
319 // outside of dialogs.
320 #define wxTAB_TRAVERSAL 0x00080000
323 #define wxHORIZONTAL 0x01
324 #define wxVERTICAL 0x02
325 #define wxBOTH (wxVERTICAL|wxHORIZONTAL)
326 #define wxCENTER_FRAME 0x04 /* centering into frame rather than screen */
329 * Frame/dialog style flags
331 #define wxSTAY_ON_TOP 0x8000
332 #define wxICONIZE 0x4000
333 #define wxMINIMIZE wxICONIZE
334 #define wxMAXIMIZE 0x2000
335 #define wxTHICK_FRAME 0x1000
336 #define wxSYSTEM_MENU 0x0800
337 #define wxMINIMIZE_BOX 0x0400
338 #define wxMAXIMIZE_BOX 0x0200
339 #define wxTINY_CAPTION_HORIZ 0x0100
340 #define wxTINY_CAPTION_VERT 0x0080
341 #define wxRESIZE_BOX wxMAXIMIZE_BOX
342 #define wxRESIZE_BORDER 0x0040
343 #define wxDIALOG_MODAL 0x0020
344 #define wxDIALOG_MODELESS 0x0000
346 #define wxDEFAULT_FRAME_STYLE (wxRESIZE_BORDER | wxMINIMIZE_BOX | wxMAXIMIZE_BOX | wxTHICK_FRAME | wxSYSTEM_MENU | wxCAPTION)
348 #if WXWIN_COMPATIBILITY
349 #define wxDEFAULT_FRAME wxDEFAULT_FRAME_STYLE
352 #define wxDEFAULT_DIALOG_STYLE (wxSYSTEM_MENU|wxCAPTION|wxTHICK_FRAME)
355 * Subwindow style flags
357 #define wxRETAINED 0x0001
358 #define wxBACKINGSTORE wxRETAINED
359 // wxCanvas or wxPanel can optionally have a thick frame under MS Windows.
360 // #define wxTHICK_FRAME 0x1000
363 * wxToolBar style flags
366 #define wxTB_3DBUTTONS 0x8000
369 * Apply to all panel items
372 #define wxCOLOURED 0x0800
373 // Alignment for panel item labels: replaces characters with zeros
374 // when creating label, so spaces can be included in string for alignment.
375 #define wxFIXED_LENGTH 0x0400
376 #define wxALIGN_LEFT 0x0000
377 #define wxALIGN_CENTER 0x0100
378 #define wxALIGN_CENTRE 0x0100
379 #define wxALIGN_RIGHT 0x0200
382 * Styles for wxListBox
385 // In wxListBox style flag
386 #define wxSB_MASK 0x0008
387 #define wxNEEDED_SB 0x0000
388 #define wxALWAYS_SB 0x0008
390 // New naming convention
391 #define wxLB_NEEDED_SB wxNEEDED_SB
392 #define wxLB_ALWAYS_SB wxALWAYS_SB
393 #define wxLB_SORT 0x0010
394 // These duplicate the styles in the Multiple argument
395 #define wxLB_SINGLE 0x0000
396 #define wxLB_MULTIPLE 0x0040
397 #define wxLB_EXTENDED 0x0080
398 // wxLB_OWNERDRAW is Windows-only
399 #define wxLB_OWNERDRAW 0x0100
400 #define wxLB_HSCROLL wxHSCROLL
403 * wxTextCtrl style flags
405 #define wxPROCESS_ENTER 0x0004
406 #define wxPASSWORD 0x0008
407 #define wxTE_PROCESS_ENTER wxPROCESS_ENTER
408 #define wxTE_PASSWORD wxPASSWORD
409 #define wxTE_READONLY 0x0010
410 #define wxTE_MULTILINE 0x0020
412 // TODO For backward compatibility, need wxOLD_READONLY
413 #define wxREADONLY wxTE_READONLY
416 // #define wxTE_RICHTEXT 0x0020
419 * wxComboBox style flags
421 #define wxCB_SIMPLE 0x0004
422 #define wxCB_DROPDOWN 0x0000
423 #define wxCB_SORT 0x0008
424 #define wxCB_READONLY wxREADONLY
427 * wxRadioBox/wxRadioButton style flags
429 #define wxRA_HORIZONTAL wxHORIZONTAL
430 #define wxRA_VERTICAL wxVERTICAL
431 #define wxRB_GROUP 0x0004
436 #define wxGA_PROGRESSBAR 0x0004
437 #define wxGA_HORIZONTAL wxHORIZONTAL
438 #define wxGA_VERTICAL wxVERTICAL
444 #define wxSL_HORIZONTAL wxHORIZONTAL
445 #define wxSL_VERTICAL wxVERTICAL
446 // The next one is obsolete - use scroll events instead
447 #define wxSL_NOTIFY_DRAG 0x0000
448 #define wxSL_AUTOTICKS 0x0008
449 // #define wxSL_MANUALTICKS 0x0010
450 #define wxSL_LABELS 0x0020
451 #define wxSL_LEFT 0x0040
452 #define wxSL_TOP 0x0080
453 #define wxSL_RIGHT 0x0100
454 #define wxSL_BOTTOM 0x0200
455 #define wxSL_BOTH 0x0400
456 #define wxSL_SELRANGE 0x0800
462 #define wxSB_HORIZONTAL wxHORIZONTAL
463 #define wxSB_VERTICAL wxVERTICAL
469 #define wxBU_AUTODRAW 0x0004
470 #define wxBU_NOAUTODRAW 0x0000
476 #define wxTR_HAS_BUTTONS 0x0004
477 #define wxTR_EDIT_LABELS 0x0008
483 #define wxLC_ICON 0x0004
484 #define wxLC_SMALL_ICON 0x0008
485 #define wxLC_LIST 0x0010
486 #define wxLC_REPORT 0x0020
487 #define wxLC_ALIGN_TOP 0x0040
488 #define wxLC_ALIGN_LEFT 0x0080
489 #define wxLC_AUTOARRANGE 0x0100
490 #define wxLC_USER_TEXT 0x0200
491 #define wxLC_EDIT_LABELS 0x0400
492 #define wxLC_NO_HEADER 0x0800
493 #define wxLC_NO_SORT_HEADER 0x1000
494 #define wxLC_SINGLE_SEL 0x2000
495 #define wxLC_SORT_ASCENDING 0x4000
496 #define wxLC_SORT_DESCENDING 0x8000
498 #define wxLC_MASK_TYPE (wxLC_ICON | wxLC_SMALL_ICON | wxLC_LIST | wxLC_REPORT)
499 #define wxLC_MASK_ALIGN (wxLC_ALIGN_TOP | wxLC_ALIGN_LEFT)
500 #define wxLC_MASK_SORT (wxLC_SORT_ASCENDING | wxLC_SORT_DESCENDING)
502 // Omitted because (a) too much detail (b) not enough style flags
503 // #define wxLC_NO_SCROLL
504 // #define wxLC_NO_LABEL_WRAP
505 // #define wxLC_OWNERDRAW_FIXED
506 // #define wxLC_SHOW_SEL_ALWAYS
512 #define wxSP_VERTICAL 0x0004
513 #define wxSP_HORIZONTAL 0x0008
514 #define wxSP_ARROW_KEYS 0x0010
515 #define wxSP_WRAP 0x0020
518 * wxSplitterWnd flags
521 #define wxSP_NOBORDER 0x0000
522 #define wxSP_3D 0x0004
523 #define wxSP_BORDER 0x0008
529 #define wxTAB_MULTILINE 0x0000
530 #define wxTAB_RIGHTJUSTIFY 0x0004
531 #define wxTAB_FIXEDWIDTH 0x0008
532 #define wxTAB_OWNERDRAW 0x0010
535 * wxStatusBar95 flags
538 #define wxSB_SIZEGRIP 0x0002
545 // Text font families
552 wxTELETYPE
, /* @@@@ */
554 // Proportional or Fixed width fonts (not yet used)
561 // Also wxNORMAL for normal (non-italic text)
575 // Brush & Pen Stippling. Note that a stippled pen cannot be dashed!!
576 // Note also that stippling a Pen IS meaningfull, because a Line is
577 // drawn with a Pen, and without any Brush -- and it can be stippled.
585 #define IS_HATCH(s) ((s)>=wxBDIAGONAL_HATCH && (s)<=wxVERTICAL_HATCH)
600 wxXOR
, // src XOR dst
602 wxOR_REVERSE
, // src OR (NOT dst)
603 wxAND_REVERSE
,// src AND (NOT dst)
605 wxAND
, // src AND dst
606 wxAND_INVERT
, // (NOT src) AND dst
608 wxNOR
, // (NOT src) AND (NOT dst)
609 wxEQUIV
, // (NOT src) XOR dst
610 wxSRC_INVERT
, // (NOT src)
611 wxOR_INVERT
, // (NOT src) OR dst
612 wxNAND
, // (NOT src) OR (NOT dst)
615 wxSRC_OR
, // source _bitmap_ OR destination
616 wxSRC_AND
// source _bitmap_ AND destination
620 #define wxFLOOD_SURFACE 1
621 #define wxFLOOD_BORDER 2
623 // Polygon filling mode
624 #define wxODDEVEN_RULE 1
625 #define wxWINDING_RULE 2
627 // ToolPanel in wxFrame
629 #define wxTOOL_BOTTOM 2
630 #define wxTOOL_LEFT 3
631 #define wxTOOL_RIGHT 4
633 // Dialog specifiers/return values
636 #define wxYES_NO 0x0002
637 #define wxCANCEL 0x0004
641 #define wxICON_EXCLAMATION 0x0020
642 #define wxICON_HAND 0x0040
643 #define wxICON_QUESTION 0x0080
644 #define wxICON_INFORMATION 0x0100
646 #define wxICON_STOP wxICON_HAND
647 #define wxICON_ASTERISK wxICON_INFORMATION
648 #define wxICON_MASK (0x0020|0x0040|0x0080|0x0100)
650 #define wxCENTRE 0x0200
651 #define wxCENTER wxCENTRE
653 // Possible SetSize flags
655 // Use internally-calculated width if -1
656 #define wxSIZE_AUTO_WIDTH 1
657 // Use internally-calculated height if -1
658 #define wxSIZE_AUTO_HEIGHT 2
659 // Use internally-calculated width and height if each is -1
660 #define wxSIZE_AUTO 3
661 // Ignore missing (-1) dimensions (use existing).
662 // For readability only: test for wxSIZE_AUTO_WIDTH/HEIGHT in code.
663 #define wxSIZE_USE_EXISTING 0
664 // Allow -1 as a valid position
665 #define wxSIZE_ALLOW_MINUS_ONE 4
668 // Numbers as per winuser.h
669 # define wxCF_TEXT 1 /* CF_TEXT */
670 # define wxCF_BITMAP 2 /* CF_BITMAP */
671 # define wxCF_METAFILE 3 /* CF_METAFILEPICT */
672 # define wxCF_DIB 8 /* CF_DIB */
673 # define wxCF_OEMTEXT 7 /* CF_OEMTEXT */
676 enum _Virtual_keycodes
{
695 WXK_PRIOR
, // Page up
696 WXK_NEXT
, // Page down
755 // Colours - see wx_gdi.cc for database
757 // OS mnemonics -- Identify the running OS (useful for Windows)
758 // [Not all platforms are currently available or supported]
761 wxXVIEW_X
, // Sun's XView OpenLOOK toolkit
762 wxMOTIF_X
, // OSF Motif 1.x.x
763 wxCOSE_X
, // OSF Common Desktop Environment
764 wxNEXTSTEP
, // NeXTStep
765 wxMACINTOSH
, // Apple System 7
767 wxOS2_PM
, // OS/2 Workplace
768 wxWINDOWS
, // Windows or WfW
769 wxPENWINDOWS
, // Windows for Pen Computing
770 wxWINDOWS_NT
, // Windows NT
771 wxWIN32S
, // Windows 32S API
772 wxWIN95
, // Windows 95
773 wxWIN386
// Watcom 32-bit supervisor modus
779 #define wxLANDSCAPE 2
782 // Standard menu identifiers
783 #define wxID_OPEN 5000
784 #define wxID_CLOSE 5001
785 #define wxID_NEW 5002
786 #define wxID_SAVE 5003
787 #define wxID_SAVEAS 5004
788 #define wxID_REVERT 5005
789 #define wxID_EXIT 5006
790 #define wxID_UNDO 5007
791 #define wxID_REDO 5008
792 #define wxID_HELP 5009
793 #define wxID_PRINT 5010
794 #define wxID_PRINT_SETUP 5011
795 #define wxID_PREVIEW 5012
796 #define wxID_ABOUT 5013
797 #define wxID_HELP_CONTENTS 5014
798 #define wxID_HELP_COMMANDS 5015
799 #define wxID_HELP_PROCEDURES 5016
800 #define wxID_HELP_CONTEXT 5017
802 #define wxID_CUT 5030
803 #define wxID_COPY 5031
804 #define wxID_PASTE 5032
805 #define wxID_CLEAR 5033
806 #define wxID_FIND 5034
808 #define wxID_FILE1 5050
809 #define wxID_FILE2 5051
810 #define wxID_FILE3 5052
811 #define wxID_FILE4 5053
812 #define wxID_FILE5 5054
813 #define wxID_FILE6 5055
814 #define wxID_FILE7 5056
815 #define wxID_FILE8 5057
816 #define wxID_FILE9 5058
819 #define wxID_CANCEL 5101
820 #define wxID_APPLY 5102
821 #define wxID_YES 5103
825 // Stand-ins for Windows types, to avoid
826 // #including all of windows.h
828 typedef unsigned long WXHWND
;
829 typedef unsigned long WXHANDLE
;
830 typedef unsigned long WXHICON
;
831 typedef unsigned long WXHFONT
;
832 typedef unsigned long WXHMENU
;
833 typedef unsigned long WXHPEN
;
834 typedef unsigned long WXHBRUSH
;
835 typedef unsigned long WXHPALETTE
;
836 typedef unsigned long WXHCURSOR
;
837 typedef unsigned long WXHRGN
;
838 typedef unsigned long WXHINSTANCE
;
839 typedef unsigned long WXHBITMAP
;
840 typedef unsigned long WXHIMAGELIST
;
841 typedef unsigned long WXHGLOBAL
;
842 typedef unsigned long WXHDC
;
843 typedef unsigned int WXUINT
;
844 typedef unsigned long WXDWORD
;
845 typedef unsigned short WXWORD
;
846 typedef unsigned int WXWPARAM
;
847 typedef long WXLPARAM
;
848 typedef unsigned long WXCOLORREF
;
849 typedef void * WXRGN
;
850 typedef void * WXRGNDATA
;
851 typedef void * WXMSG
;
852 typedef unsigned long WXHCONV
;
853 typedef void * WXDRAWITEMSTRUCT
;
854 typedef void * WXMEASUREITEMSTRUCT
;
855 typedef void * WXLPCREATESTRUCT
;
856 typedef int (*WXFARPROC
)();