]>
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 /** symbolic constant used by all Find()-like functions returning positive
173 integer on success as failure indicator */
174 #define NOT_FOUND (-1)
176 // ----------------------------------------------------------------------------
178 // ----------------------------------------------------------------------------
180 /// Standard error codes
183 /// invalid parameter (in broad sense)
185 /// no more data (iteration functions usually return this)
187 /// user cancelled the operation
189 /// no error (the only non negative error code)
193 // ----------------------------------------------------------------------------
194 /** @name Very common macros */
195 // ----------------------------------------------------------------------------
197 /// delete pointer if it is not NULL and NULL it afterwards
198 // (checking that it's !NULL before passing it to delete is just a
199 // a question of style, because delete will do it itself anyhow, but it might
200 // be considered as an error by some overzealous debugging implementations of
201 // the library, so we do it ourselves)
202 #define wxDELETE(p) if ( (p) != NULL ) { delete (p); p = NULL; }
204 // delete an array and NULL it (see comments above)
205 #define wxDELETEA(p) if ( (p) != NULL ) { delete [] (p); p = NULL; }
207 /// size of statically declared array
208 #define WXSIZEOF(array) (sizeof(array)/sizeof(array[0]))
210 // ----------------------------------------------------------------------------
211 // compiler and OS identification
212 // ----------------------------------------------------------------------------
215 #if defined(__HPUX__) || defined(____SVR4____) || defined(__LINUX__)
221 #ifndef __UNIX__ // Windows
222 #if defined(_MSC_VER)
224 #elif defined(__BCPLUSPLUS__) && !defined(__BORLANDC__)
226 #elif defined(__WATCOMC__)
227 //#define __WATCOMC__
228 #elif defined(__SC__)
229 #define __SYMANTECC__
234 // ----------------------------------------------------------------------------
235 // compiler specific settings
236 // ----------------------------------------------------------------------------
238 // to allow compiling with warning level 4 under Microsoft Visual C++ some
239 // warnings just must be disabled
241 #pragma warning(disable: 4514) // unreferenced inline func has been removed
243 you might be tempted to disable this one also: triggered by CHECK and FAIL
244 macros in debug.h, but it's, overall, is a rather useful one, so I leave it
245 and will try to find some way to disable this warning just for CHECK/FAIL.
248 #pragma warning(disable: 4127) // conditional expression is constant
252 // Callback function type definition
253 typedef void (*wxFunction
) (wxObject
&, wxEvent
&);
256 * Window style flags.
257 * Values are chosen so they can be |'ed in a bit list.
258 * Some styles are used across more than one group,
259 * so the values mustn't clash with others in the group.
260 * Otherwise, numbers can be reused across groups.
263 * Window (cross-group) styles now take up the first half
264 * of the flag, and control-specific styles the
270 * Window (Frame/dialog/subwindow/panel item) style flags
272 #define wxVSCROLL 0x80000000
273 #define wxHSCROLL 0x40000000
274 #define wxCAPTION 0x20000000
277 #define wxDOUBLE_BORDER 0x10000000
278 #define wxSUNKEN_BORDER 0x08000000
279 #define wxRAISED_BORDER 0x04000000
280 #define wxBORDER 0x02000000
281 #define wxSIMPLE_BORDER 0x02000000
282 #define wxSTATIC_BORDER 0x01000000
283 #define wxTRANSPARENT_WINDOW 0x00100000
284 #define wxNO_BORDER 0x00200000
286 #define wxUSER_COLOURS 0x00800000
287 // Override CTL3D etc. control colour processing to
288 // allow own background colour
289 // OBSOLETE - use wxNO_3D instead
290 #define wxNO_3D 0x00800000
291 // Override CTL3D or native 3D styles for children
292 #define wxCLIP_CHILDREN 0x00400000
293 // Clip children when painting, which reduces flicker in
294 // e.g. frames and splitter windows, but can't be used in
295 // a panel where a static box must be 'transparent' (panel
296 // paints the background for it)
298 // Add this style to a panel to get tab traversal working
299 // outside of dialogs.
300 #define wxTAB_TRAVERSAL 0x00080000
303 #define wxHORIZONTAL 0x01
304 #define wxVERTICAL 0x02
305 #define wxBOTH (wxVERTICAL|wxHORIZONTAL)
306 #define wxCENTER_FRAME 0x04 /* centering into frame rather than screen */
309 * Frame/dialog style flags
311 #define wxSTAY_ON_TOP 0x8000
312 #define wxICONIZE 0x4000
313 #define wxMINIMIZE wxICONIZE
314 #define wxMAXIMIZE 0x2000
315 #define wxTHICK_FRAME 0x1000
316 #define wxSYSTEM_MENU 0x0800
317 #define wxMINIMIZE_BOX 0x0400
318 #define wxMAXIMIZE_BOX 0x0200
319 #define wxTINY_CAPTION_HORIZ 0x0100
320 #define wxTINY_CAPTION_VERT 0x0080
321 #define wxRESIZE_BOX wxMAXIMIZE_BOX
322 #define wxRESIZE_BORDER 0x0040
323 #define wxDIALOG_MODAL 0x0020
324 #define wxDIALOG_MODELESS 0x0000
326 #define wxDEFAULT_FRAME_STYLE (wxRESIZE_BORDER | wxMINIMIZE_BOX | wxMAXIMIZE_BOX | wxTHICK_FRAME | wxSYSTEM_MENU | wxCAPTION | wxCLIP_CHILDREN)
328 #if WXWIN_COMPATIBILITY
329 #define wxDEFAULT_FRAME wxDEFAULT_FRAME_STYLE
332 #define wxDEFAULT_DIALOG_STYLE (wxSYSTEM_MENU|wxCAPTION|wxTHICK_FRAME)
335 * Subwindow style flags
337 #define wxRETAINED 0x0001
338 #define wxBACKINGSTORE wxRETAINED
339 // wxCanvas or wxPanel can optionally have a thick frame under MS Windows.
340 // #define wxTHICK_FRAME 0x1000
343 * wxToolBar style flags
346 #define wxTB_3DBUTTONS 0x8000
347 #define wxTB_HORIZONTAL 0x0002
348 #define wxTB_VERTICAL 0x0004
349 // Flatbar/Coolbar under Win98
350 #define wxTB_FLAT 0x0008
353 * Apply to all panel items
356 #define wxCOLOURED 0x0800
357 // Alignment for panel item labels: replaces characters with zeros
358 // when creating label, so spaces can be included in string for alignment.
359 #define wxFIXED_LENGTH 0x0400
360 #define wxALIGN_LEFT 0x0000
361 #define wxALIGN_CENTER 0x0100
362 #define wxALIGN_CENTRE 0x0100
363 #define wxALIGN_RIGHT 0x0200
366 * Styles for wxListBox
369 #define wxLB_SORT 0x0010
370 #define wxLB_SINGLE 0x0020
371 #define wxLB_MULTIPLE 0x0040
372 #define wxLB_EXTENDED 0x0080
373 // wxLB_OWNERDRAW is Windows-only
374 #define wxLB_OWNERDRAW 0x0100
375 #define wxLB_NEEDED_SB 0x0200
376 #define wxLB_ALWAYS_SB 0x0400
377 #define wxLB_HSCROLL wxHSCROLL
380 * wxTextCtrl style flags
382 #define wxPROCESS_ENTER 0x0004
383 #define wxPASSWORD 0x0008
384 #define wxTE_PROCESS_ENTER wxPROCESS_ENTER
385 #define wxTE_PASSWORD wxPASSWORD
386 #define wxTE_READONLY 0x0010
387 #define wxTE_MULTILINE 0x0020
390 #define wxTE_RICHTEXT 0x0020
393 * wxComboBox style flags
395 #define wxCB_SIMPLE 0x0004
396 #define wxCB_SORT 0x0008
397 #define wxCB_READONLY 0x0010
398 #define wxCB_DROPDOWN 0x0020
401 * wxRadioBox/wxRadioButton style flags
403 #define wxRA_HORIZONTAL wxHORIZONTAL
404 #define wxRA_VERTICAL wxVERTICAL
405 #define wxRB_GROUP 0x0004
410 #define wxGA_PROGRESSBAR 0x0004
411 #define wxGA_HORIZONTAL wxHORIZONTAL
412 #define wxGA_VERTICAL wxVERTICAL
418 #define wxSL_HORIZONTAL wxHORIZONTAL
419 #define wxSL_VERTICAL wxVERTICAL
420 // The next one is obsolete - use scroll events instead
421 #define wxSL_NOTIFY_DRAG 0x0000
422 #define wxSL_AUTOTICKS 0x0008
423 // #define wxSL_MANUALTICKS 0x0010
424 #define wxSL_LABELS 0x0020
425 #define wxSL_LEFT 0x0040
426 #define wxSL_TOP 0x0080
427 #define wxSL_RIGHT 0x0100
428 #define wxSL_BOTTOM 0x0200
429 #define wxSL_BOTH 0x0400
430 #define wxSL_SELRANGE 0x0800
436 #define wxSB_HORIZONTAL wxHORIZONTAL
437 #define wxSB_VERTICAL wxVERTICAL
443 #define wxBU_AUTODRAW 0x0004
444 #define wxBU_NOAUTODRAW 0x0000
450 #define wxTR_HAS_BUTTONS 0x0004
451 #define wxTR_EDIT_LABELS 0x0008
452 #define wxTR_LINES_AT_ROOT 0x0010
458 #define wxLC_ICON 0x0004
459 #define wxLC_SMALL_ICON 0x0008
460 #define wxLC_LIST 0x0010
461 #define wxLC_REPORT 0x0020
462 #define wxLC_ALIGN_TOP 0x0040
463 #define wxLC_ALIGN_LEFT 0x0080
464 #define wxLC_AUTOARRANGE 0x0100
465 #define wxLC_USER_TEXT 0x0200
466 #define wxLC_EDIT_LABELS 0x0400
467 #define wxLC_NO_HEADER 0x0800
468 #define wxLC_NO_SORT_HEADER 0x1000
469 #define wxLC_SINGLE_SEL 0x2000
470 #define wxLC_SORT_ASCENDING 0x4000
471 #define wxLC_SORT_DESCENDING 0x8000
473 #define wxLC_MASK_TYPE (wxLC_ICON | wxLC_SMALL_ICON | wxLC_LIST | wxLC_REPORT)
474 #define wxLC_MASK_ALIGN (wxLC_ALIGN_TOP | wxLC_ALIGN_LEFT)
475 #define wxLC_MASK_SORT (wxLC_SORT_ASCENDING | wxLC_SORT_DESCENDING)
477 // Omitted because (a) too much detail (b) not enough style flags
478 // #define wxLC_NO_SCROLL
479 // #define wxLC_NO_LABEL_WRAP
480 // #define wxLC_OWNERDRAW_FIXED
481 // #define wxLC_SHOW_SEL_ALWAYS
487 #define wxSP_VERTICAL 0x0004
488 #define wxSP_HORIZONTAL 0x0008
489 #define wxSP_ARROW_KEYS 0x0010
490 #define wxSP_WRAP 0x0020
493 * wxSplitterWnd flags
496 #define wxSP_NOBORDER 0x0000
497 #define wxSP_3D 0x0004
498 #define wxSP_BORDER 0x0008
504 #define wxTAB_MULTILINE 0x0000
505 #define wxTAB_RIGHTJUSTIFY 0x0004
506 #define wxTAB_FIXEDWIDTH 0x0008
507 #define wxTAB_OWNERDRAW 0x0010
509 // Sorry, I changed my mind about these names...
510 #define wxTC_MULTILINE 0x0000
511 #define wxTC_RIGHTJUSTIFY 0x0004
512 #define wxTC_FIXEDWIDTH 0x0008
513 #define wxTC_OWNERDRAW 0x0010
516 * wxStatusBar95 flags
519 #define wxST_SIZEGRIP 0x0002
526 // Text font families
533 wxTELETYPE
, /* @@@@ */
535 // Proportional or Fixed width fonts (not yet used)
542 // Also wxNORMAL for normal (non-italic text)
556 // Brush & Pen Stippling. Note that a stippled pen cannot be dashed!!
557 // Note also that stippling a Pen IS meaningfull, because a Line is
558 // drawn with a Pen, and without any Brush -- and it can be stippled.
566 #define IS_HATCH(s) ((s)>=wxBDIAGONAL_HATCH && (s)<=wxVERTICAL_HATCH)
581 wxXOR
, // src XOR dst
583 wxOR_REVERSE
, // src OR (NOT dst)
584 wxAND_REVERSE
,// src AND (NOT dst)
586 wxAND
, // src AND dst
587 wxAND_INVERT
, // (NOT src) AND dst
589 wxNOR
, // (NOT src) AND (NOT dst)
590 wxEQUIV
, // (NOT src) XOR dst
591 wxSRC_INVERT
, // (NOT src)
592 wxOR_INVERT
, // (NOT src) OR dst
593 wxNAND
, // (NOT src) OR (NOT dst)
596 wxSRC_OR
, // source _bitmap_ OR destination
597 wxSRC_AND
// source _bitmap_ AND destination
601 #define wxFLOOD_SURFACE 1
602 #define wxFLOOD_BORDER 2
604 // Polygon filling mode
605 #define wxODDEVEN_RULE 1
606 #define wxWINDING_RULE 2
608 // ToolPanel in wxFrame
610 #define wxTOOL_BOTTOM 2
611 #define wxTOOL_LEFT 3
612 #define wxTOOL_RIGHT 4
614 // Dialog specifiers/return values
617 #define wxYES_NO 0x0002
618 #define wxCANCEL 0x0004
622 #define wxICON_EXCLAMATION 0x0020
623 #define wxICON_HAND 0x0040
624 #define wxICON_QUESTION 0x0080
625 #define wxICON_INFORMATION 0x0100
627 #define wxICON_STOP wxICON_HAND
628 #define wxICON_ASTERISK wxICON_INFORMATION
629 #define wxICON_MASK (0x0020|0x0040|0x0080|0x0100)
631 #define wxCENTRE 0x0200
632 #define wxCENTER wxCENTRE
634 // Possible SetSize flags
636 // Use internally-calculated width if -1
637 #define wxSIZE_AUTO_WIDTH 0x0001
638 // Use internally-calculated height if -1
639 #define wxSIZE_AUTO_HEIGHT 0x0002
640 // Use internally-calculated width and height if each is -1
641 #define wxSIZE_AUTO (wxSIZE_AUTO_WIDTH|wxSIZE_AUTO_HEIGHT)
642 // Ignore missing (-1) dimensions (use existing).
643 // For readability only: test for wxSIZE_AUTO_WIDTH/HEIGHT in code.
644 #define wxSIZE_USE_EXISTING 0x0000
645 // Allow -1 as a valid position
646 #define wxSIZE_ALLOW_MINUS_ONE 0x0004
647 // Don't do parent client adjustments (for implementation only)
648 #define wxSIZE_NO_ADJUSTMENTS 0x0008
651 // Data format for drag & drop and clipboard operations
652 // numbers as per winuser.h
656 wxDF_TEXT
= 1, /* CF_TEXT */
657 wxDF_BITMAP
= 2, /* CF_BITMAP */
658 wxDF_METAFILE
= 3, /* CF_METAFILEPICT */
659 wxDF_DIB
= 8, /* CF_DIB */
660 wxDF_OEMTEXT
= 7, /* CF_OEMTEXT */
661 wxDF_FILENAME
= 15 /* CF_HDROP */
666 enum _Virtual_keycodes
{
685 WXK_PRIOR
, // Page up
686 WXK_NEXT
, // Page down
745 // Colours - see wx_gdi.cc for database
747 // OS mnemonics -- Identify the running OS (useful for Windows)
748 // [Not all platforms are currently available or supported]
751 wxCURSES
, // Text-only CURSES
752 wxXVIEW_X
, // Sun's XView OpenLOOK toolkit
753 wxMOTIF_X
, // OSF Motif 1.x.x
754 wxCOSE_X
, // OSF Common Desktop Environment
755 wxNEXTSTEP
, // NeXTStep
756 wxMACINTOSH
, // Apple System 7
760 wxOS2_PM
, // OS/2 Workplace
761 wxWINDOWS
, // Windows or WfW
762 wxPENWINDOWS
, // Windows for Pen Computing
763 wxWINDOWS_NT
, // Windows NT
764 wxWIN32S
, // Windows 32S API
765 wxWIN95
, // Windows 95
766 wxWIN386
// Watcom 32-bit supervisor modus
772 #define wxLANDSCAPE 2
775 // Standard menu identifiers
776 #define wxID_OPEN 5000
777 #define wxID_CLOSE 5001
778 #define wxID_NEW 5002
779 #define wxID_SAVE 5003
780 #define wxID_SAVEAS 5004
781 #define wxID_REVERT 5005
782 #define wxID_EXIT 5006
783 #define wxID_UNDO 5007
784 #define wxID_REDO 5008
785 #define wxID_HELP 5009
786 #define wxID_PRINT 5010
787 #define wxID_PRINT_SETUP 5011
788 #define wxID_PREVIEW 5012
789 #define wxID_ABOUT 5013
790 #define wxID_HELP_CONTENTS 5014
791 #define wxID_HELP_COMMANDS 5015
792 #define wxID_HELP_PROCEDURES 5016
793 #define wxID_HELP_CONTEXT 5017
795 #define wxID_CUT 5030
796 #define wxID_COPY 5031
797 #define wxID_PASTE 5032
798 #define wxID_CLEAR 5033
799 #define wxID_FIND 5034
801 #define wxID_FILE1 5050
802 #define wxID_FILE2 5051
803 #define wxID_FILE3 5052
804 #define wxID_FILE4 5053
805 #define wxID_FILE5 5054
806 #define wxID_FILE6 5055
807 #define wxID_FILE7 5056
808 #define wxID_FILE8 5057
809 #define wxID_FILE9 5058
812 #define wxID_CANCEL 5101
813 #define wxID_APPLY 5102
814 #define wxID_YES 5103
816 #define wxID_STATIC 5105
819 // Stand-ins for Windows types, to avoid
820 // #including all of windows.h
822 typedef unsigned long WXHWND
;
823 typedef unsigned long WXHANDLE
;
824 typedef unsigned long WXHICON
;
825 typedef unsigned long WXHFONT
;
826 typedef unsigned long WXHMENU
;
827 typedef unsigned long WXHPEN
;
828 typedef unsigned long WXHBRUSH
;
829 typedef unsigned long WXHPALETTE
;
830 typedef unsigned long WXHCURSOR
;
831 typedef unsigned long WXHRGN
;
832 typedef unsigned long WXHACCEL
;
833 typedef unsigned long WXHINSTANCE
;
834 typedef unsigned long WXHBITMAP
;
835 typedef unsigned long WXHIMAGELIST
;
836 typedef unsigned long WXHGLOBAL
;
837 typedef unsigned long WXHDC
;
838 typedef unsigned int WXUINT
;
839 typedef unsigned long WXDWORD
;
840 typedef unsigned short WXWORD
;
841 typedef unsigned int WXWPARAM
;
842 typedef long WXLPARAM
;
843 typedef unsigned long WXCOLORREF
;
844 typedef void * WXRGNDATA
;
845 typedef void * WXMSG
;
846 typedef unsigned long WXHCONV
;
847 typedef void * WXDRAWITEMSTRUCT
;
848 typedef void * WXMEASUREITEMSTRUCT
;
849 typedef void * WXLPCREATESTRUCT
;
851 typedef int (*WXFARPROC
)();
853 typedef int (__stdcall
*WXFARPROC
)();