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