]>
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 // ----------------------------------------------------------------------------
234 // compiler and OS identification
235 // ----------------------------------------------------------------------------
238 #if defined(__HPUX__) || defined(____SVR4____) || defined(__LINUX__) || defined(__sgi )
244 #ifndef __UNIX__ // Windows
245 #if defined(_MSC_VER)
247 #elif defined(__BCPLUSPLUS__) && !defined(__BORLANDC__)
249 #elif defined(__WATCOMC__)
250 //#define __WATCOMC__
251 #elif defined(__SC__)
252 #define __SYMANTECC__
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_3D instead
313 #define wxNO_3D 0x00800000
314 // Override CTL3D or native 3D styles for children
315 #define wxCLIP_CHILDREN 0x00400000
316 // Clip children when painting, which reduces flicker in
317 // e.g. frames and splitter windows, but can't be used in
318 // a panel where a static box must be 'transparent' (panel
319 // paints the background for it)
321 // Add this style to a panel to get tab traversal working
322 // outside of dialogs.
323 #define wxTAB_TRAVERSAL 0x00080000
326 #define wxHORIZONTAL 0x01
327 #define wxVERTICAL 0x02
328 #define wxBOTH (wxVERTICAL|wxHORIZONTAL)
329 #define wxCENTER_FRAME 0x04 /* centering into frame rather than screen */
332 * Frame/dialog style flags
334 #define wxSTAY_ON_TOP 0x8000
335 #define wxICONIZE 0x4000
336 #define wxMINIMIZE wxICONIZE
337 #define wxMAXIMIZE 0x2000
338 #define wxTHICK_FRAME 0x1000
339 #define wxSYSTEM_MENU 0x0800
340 #define wxMINIMIZE_BOX 0x0400
341 #define wxMAXIMIZE_BOX 0x0200
342 #define wxTINY_CAPTION_HORIZ 0x0100
343 #define wxTINY_CAPTION_VERT 0x0080
344 #define wxRESIZE_BOX wxMAXIMIZE_BOX
345 #define wxRESIZE_BORDER 0x0040
346 #define wxDIALOG_MODAL 0x0020
347 #define wxDIALOG_MODELESS 0x0000
349 #define wxDEFAULT_FRAME_STYLE (wxRESIZE_BORDER | wxMINIMIZE_BOX | wxMAXIMIZE_BOX | wxTHICK_FRAME | wxSYSTEM_MENU | wxCAPTION | wxCLIP_CHILDREN)
351 #if WXWIN_COMPATIBILITY
352 #define wxDEFAULT_FRAME wxDEFAULT_FRAME_STYLE
355 #define wxDEFAULT_DIALOG_STYLE (wxSYSTEM_MENU|wxCAPTION|wxTHICK_FRAME)
358 * Subwindow style flags
360 #define wxRETAINED 0x0001
361 #define wxBACKINGSTORE wxRETAINED
362 // wxCanvas or wxPanel can optionally have a thick frame under MS Windows.
363 // #define wxTHICK_FRAME 0x1000
366 * wxToolBar style flags
369 #define wxTB_3DBUTTONS 0x8000
370 #define wxTB_HORIZONTAL 0x0002
371 #define wxTB_VERTICAL 0x0004
372 // Flatbar/Coolbar under Win98
373 #define wxTB_FLAT 0x0008
376 * Apply to all panel items
379 #define wxCOLOURED 0x0800
380 // Alignment for panel item labels: replaces characters with zeros
381 // when creating label, so spaces can be included in string for alignment.
382 #define wxFIXED_LENGTH 0x0400
383 #define wxALIGN_LEFT 0x0000
384 #define wxALIGN_CENTER 0x0100
385 #define wxALIGN_CENTRE 0x0100
386 #define wxALIGN_RIGHT 0x0200
389 * Styles for wxListBox
392 #define wxLB_SORT 0x0010
393 #define wxLB_SINGLE 0x0020
394 #define wxLB_MULTIPLE 0x0040
395 #define wxLB_EXTENDED 0x0080
396 // wxLB_OWNERDRAW is Windows-only
397 #define wxLB_OWNERDRAW 0x0100
398 #define wxLB_NEEDED_SB 0x0200
399 #define wxLB_ALWAYS_SB 0x0400
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
413 #define wxTE_RICHTEXT 0x0020
416 * wxComboBox style flags
418 #define wxCB_SIMPLE 0x0004
419 #define wxCB_SORT 0x0008
420 #define wxCB_READONLY 0x0010
421 #define wxCB_DROPDOWN 0x0020
424 * wxRadioBox/wxRadioButton style flags
426 #define wxRA_HORIZONTAL wxHORIZONTAL
427 #define wxRA_VERTICAL wxVERTICAL
428 #define wxRB_GROUP 0x0004
433 #define wxGA_PROGRESSBAR 0x0004
434 #define wxGA_HORIZONTAL wxHORIZONTAL
435 #define wxGA_VERTICAL wxVERTICAL
441 #define wxSL_HORIZONTAL wxHORIZONTAL
442 #define wxSL_VERTICAL wxVERTICAL
443 // The next one is obsolete - use scroll events instead
444 #define wxSL_NOTIFY_DRAG 0x0000
445 #define wxSL_AUTOTICKS 0x0008
446 // #define wxSL_MANUALTICKS 0x0010
447 #define wxSL_LABELS 0x0020
448 #define wxSL_LEFT 0x0040
449 #define wxSL_TOP 0x0080
450 #define wxSL_RIGHT 0x0100
451 #define wxSL_BOTTOM 0x0200
452 #define wxSL_BOTH 0x0400
453 #define wxSL_SELRANGE 0x0800
459 #define wxSB_HORIZONTAL wxHORIZONTAL
460 #define wxSB_VERTICAL wxVERTICAL
466 #define wxBU_AUTODRAW 0x0004
467 #define wxBU_NOAUTODRAW 0x0000
473 #define wxTR_HAS_BUTTONS 0x0004
474 #define wxTR_EDIT_LABELS 0x0008
475 #define wxTR_LINES_AT_ROOT 0x0010
481 #define wxLC_ICON 0x0004
482 #define wxLC_SMALL_ICON 0x0008
483 #define wxLC_LIST 0x0010
484 #define wxLC_REPORT 0x0020
485 #define wxLC_ALIGN_TOP 0x0040
486 #define wxLC_ALIGN_LEFT 0x0080
487 #define wxLC_AUTOARRANGE 0x0100
488 #define wxLC_USER_TEXT 0x0200
489 #define wxLC_EDIT_LABELS 0x0400
490 #define wxLC_NO_HEADER 0x0800
491 #define wxLC_NO_SORT_HEADER 0x1000
492 #define wxLC_SINGLE_SEL 0x2000
493 #define wxLC_SORT_ASCENDING 0x4000
494 #define wxLC_SORT_DESCENDING 0x8000
496 #define wxLC_MASK_TYPE (wxLC_ICON | wxLC_SMALL_ICON | wxLC_LIST | wxLC_REPORT)
497 #define wxLC_MASK_ALIGN (wxLC_ALIGN_TOP | wxLC_ALIGN_LEFT)
498 #define wxLC_MASK_SORT (wxLC_SORT_ASCENDING | wxLC_SORT_DESCENDING)
500 // Omitted because (a) too much detail (b) not enough style flags
501 // #define wxLC_NO_SCROLL
502 // #define wxLC_NO_LABEL_WRAP
503 // #define wxLC_OWNERDRAW_FIXED
504 // #define wxLC_SHOW_SEL_ALWAYS
510 #define wxSP_VERTICAL 0x0004
511 #define wxSP_HORIZONTAL 0x0008
512 #define wxSP_ARROW_KEYS 0x0010
513 #define wxSP_WRAP 0x0020
516 * wxSplitterWnd flags
519 #define wxSP_NOBORDER 0x0000
520 #define wxSP_3D 0x0004
521 #define wxSP_BORDER 0x0008
527 #define wxTAB_MULTILINE 0x0000
528 #define wxTAB_RIGHTJUSTIFY 0x0004
529 #define wxTAB_FIXEDWIDTH 0x0008
530 #define wxTAB_OWNERDRAW 0x0010
532 // Sorry, I changed my mind about these names...
533 #define wxTC_MULTILINE 0x0000
534 #define wxTC_RIGHTJUSTIFY 0x0004
535 #define wxTC_FIXEDWIDTH 0x0008
536 #define wxTC_OWNERDRAW 0x0010
539 * wxStatusBar95 flags
542 #define wxST_SIZEGRIP 0x0002
549 // Text font families
556 wxTELETYPE
, /* @@@@ */
558 // Proportional or Fixed width fonts (not yet used)
565 // Also wxNORMAL for normal (non-italic text)
579 // Brush & Pen Stippling. Note that a stippled pen cannot be dashed!!
580 // Note also that stippling a Pen IS meaningfull, because a Line is
581 // drawn with a Pen, and without any Brush -- and it can be stippled.
589 #define IS_HATCH(s) ((s)>=wxBDIAGONAL_HATCH && (s)<=wxVERTICAL_HATCH)
604 wxXOR
, // src XOR dst
606 wxOR_REVERSE
, // src OR (NOT dst)
607 wxAND_REVERSE
,// src AND (NOT dst)
609 wxAND
, // src AND dst
610 wxAND_INVERT
, // (NOT src) AND dst
612 wxNOR
, // (NOT src) AND (NOT dst)
613 wxEQUIV
, // (NOT src) XOR dst
614 wxSRC_INVERT
, // (NOT src)
615 wxOR_INVERT
, // (NOT src) OR dst
616 wxNAND
, // (NOT src) OR (NOT dst)
619 wxSRC_OR
, // source _bitmap_ OR destination
620 wxSRC_AND
// source _bitmap_ AND destination
624 #define wxFLOOD_SURFACE 1
625 #define wxFLOOD_BORDER 2
627 // Polygon filling mode
628 #define wxODDEVEN_RULE 1
629 #define wxWINDING_RULE 2
631 // ToolPanel in wxFrame
633 #define wxTOOL_BOTTOM 2
634 #define wxTOOL_LEFT 3
635 #define wxTOOL_RIGHT 4
637 // Dialog specifiers/return values
640 #define wxYES_NO 0x0002
641 #define wxCANCEL 0x0004
645 #define wxICON_EXCLAMATION 0x0020
646 #define wxICON_HAND 0x0040
647 #define wxICON_QUESTION 0x0080
648 #define wxICON_INFORMATION 0x0100
650 #define wxICON_STOP wxICON_HAND
651 #define wxICON_ASTERISK wxICON_INFORMATION
652 #define wxICON_MASK (0x0020|0x0040|0x0080|0x0100)
654 #define wxCENTRE 0x0200
655 #define wxCENTER wxCENTRE
657 // Possible SetSize flags
659 // Use internally-calculated width if -1
660 #define wxSIZE_AUTO_WIDTH 0x0001
661 // Use internally-calculated height if -1
662 #define wxSIZE_AUTO_HEIGHT 0x0002
663 // Use internally-calculated width and height if each is -1
664 #define wxSIZE_AUTO (wxSIZE_AUTO_WIDTH|wxSIZE_AUTO_HEIGHT)
665 // Ignore missing (-1) dimensions (use existing).
666 // For readability only: test for wxSIZE_AUTO_WIDTH/HEIGHT in code.
667 #define wxSIZE_USE_EXISTING 0x0000
668 // Allow -1 as a valid position
669 #define wxSIZE_ALLOW_MINUS_ONE 0x0004
670 // Don't do parent client adjustments (for implementation only)
671 #define wxSIZE_NO_ADJUSTMENTS 0x0008
674 // Data format for drag & drop and clipboard operations
675 // numbers as per winuser.h
679 wxDF_TEXT
= 1, /* CF_TEXT */
680 wxDF_BITMAP
= 2, /* CF_BITMAP */
681 wxDF_METAFILE
= 3, /* CF_METAFILEPICT */
682 wxDF_DIB
= 8, /* CF_DIB */
683 wxDF_OEMTEXT
= 7, /* CF_OEMTEXT */
684 wxDF_FILENAME
= 15 /* CF_HDROP */
708 WXK_PRIOR
, // Page up
709 WXK_NEXT
, // Page down
768 // Colours - see wx_gdi.cc for database
770 // OS mnemonics -- Identify the running OS (useful for Windows)
771 // [Not all platforms are currently available or supported]
774 wxCURSES
, // Text-only CURSES
775 wxXVIEW_X
, // Sun's XView OpenLOOK toolkit
776 wxMOTIF_X
, // OSF Motif 1.x.x
777 wxCOSE_X
, // OSF Common Desktop Environment
778 wxNEXTSTEP
, // NeXTStep
779 wxMACINTOSH
, // Apple System 7
783 wxOS2_PM
, // OS/2 Workplace
784 wxWINDOWS
, // Windows or WfW
785 wxPENWINDOWS
, // Windows for Pen Computing
786 wxWINDOWS_NT
, // Windows NT
787 wxWIN32S
, // Windows 32S API
788 wxWIN95
, // Windows 95
789 wxWIN386
// Watcom 32-bit supervisor modus
795 #define wxLANDSCAPE 2
798 // Standard menu identifiers
799 #define wxID_OPEN 5000
800 #define wxID_CLOSE 5001
801 #define wxID_NEW 5002
802 #define wxID_SAVE 5003
803 #define wxID_SAVEAS 5004
804 #define wxID_REVERT 5005
805 #define wxID_EXIT 5006
806 #define wxID_UNDO 5007
807 #define wxID_REDO 5008
808 #define wxID_HELP 5009
809 #define wxID_PRINT 5010
810 #define wxID_PRINT_SETUP 5011
811 #define wxID_PREVIEW 5012
812 #define wxID_ABOUT 5013
813 #define wxID_HELP_CONTENTS 5014
814 #define wxID_HELP_COMMANDS 5015
815 #define wxID_HELP_PROCEDURES 5016
816 #define wxID_HELP_CONTEXT 5017
818 #define wxID_CUT 5030
819 #define wxID_COPY 5031
820 #define wxID_PASTE 5032
821 #define wxID_CLEAR 5033
822 #define wxID_FIND 5034
824 #define wxID_FILE1 5050
825 #define wxID_FILE2 5051
826 #define wxID_FILE3 5052
827 #define wxID_FILE4 5053
828 #define wxID_FILE5 5054
829 #define wxID_FILE6 5055
830 #define wxID_FILE7 5056
831 #define wxID_FILE8 5057
832 #define wxID_FILE9 5058
835 #define wxID_CANCEL 5101
836 #define wxID_APPLY 5102
837 #define wxID_YES 5103
839 #define wxID_STATIC 5105
842 // Stand-ins for Windows types, to avoid
843 // #including all of windows.h
845 typedef unsigned long WXHWND
;
846 typedef unsigned long WXHANDLE
;
847 typedef unsigned long WXHICON
;
848 typedef unsigned long WXHFONT
;
849 typedef unsigned long WXHMENU
;
850 typedef unsigned long WXHPEN
;
851 typedef unsigned long WXHBRUSH
;
852 typedef unsigned long WXHPALETTE
;
853 typedef unsigned long WXHCURSOR
;
854 typedef unsigned long WXHRGN
;
855 typedef unsigned long WXHACCEL
;
856 typedef unsigned long WXHINSTANCE
;
857 typedef unsigned long WXHBITMAP
;
858 typedef unsigned long WXHIMAGELIST
;
859 typedef unsigned long WXHGLOBAL
;
860 typedef unsigned long WXHDC
;
861 typedef unsigned int WXUINT
;
862 typedef unsigned long WXDWORD
;
863 typedef unsigned short WXWORD
;
864 typedef unsigned int WXWPARAM
;
865 typedef long WXLPARAM
;
866 typedef unsigned long WXCOLORREF
;
867 typedef void * WXRGNDATA
;
868 typedef void * WXMSG
;
869 typedef unsigned long WXHCONV
;
870 typedef unsigned long WXHKEY
;
871 typedef void * WXDRAWITEMSTRUCT
;
872 typedef void * WXMEASUREITEMSTRUCT
;
873 typedef void * WXLPCREATESTRUCT
;
875 typedef int (*WXFARPROC
)();
877 typedef int (__stdcall
*WXFARPROC
)();