1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: interface of global functions
4 // Author: wxWidgets team
6 // Licence: wxWindows licence
7 /////////////////////////////////////////////////////////////////////////////
10 // ----------------------------------------------------------------------------
12 // ----------------------------------------------------------------------------
24 A generic orientation value.
28 wxHORIZONTAL
= 0x0004,
32 A mask value to indicate both vertical and horizontal orientations.
34 wxBOTH
= wxVERTICAL
| wxHORIZONTAL
,
36 /// A synonim for @c wxBOTH.
37 wxORIENTATION_MASK
= wxBOTH
41 A generic direction value.
58 wxALL
= (wxUP
| wxDOWN
| wxRIGHT
| wxLEFT
),
60 /** A mask to extract direction from the combination of flags. */
61 wxDIRECTION_MASK
= wxALL
65 Generic alignment values. Can be combined together.
70 A value different from any valid alignment value.
72 Note that you shouldn't use 0 for this as it's the value of (valid)
73 alignments wxALIGN_LEFT and wxALIGN_TOP.
80 wxALIGN_CENTER_HORIZONTAL
= 0x0100,
81 wxALIGN_CENTRE_HORIZONTAL
= wxALIGN_CENTER_HORIZONTAL
,
82 wxALIGN_LEFT
= wxALIGN_NOT
,
83 wxALIGN_TOP
= wxALIGN_NOT
,
84 wxALIGN_RIGHT
= 0x0200,
85 wxALIGN_BOTTOM
= 0x0400,
86 wxALIGN_CENTER_VERTICAL
= 0x0800,
87 wxALIGN_CENTRE_VERTICAL
= wxALIGN_CENTER_VERTICAL
,
89 wxALIGN_CENTER
= (wxALIGN_CENTER_HORIZONTAL
| wxALIGN_CENTER_VERTICAL
),
90 wxALIGN_CENTRE
= wxALIGN_CENTER
,
92 /** A mask to extract alignment from the combination of flags. */
97 Miscellaneous flags for wxSizer items.
101 wxFIXED_MINSIZE
= 0x8000,
102 wxRESERVE_SPACE_EVEN_IF_HIDDEN
= 0x0002,
104 /* a mask to extract wxSizerFlagBits from combination of flags */
105 wxSIZER_FLAG_BITS_MASK
= 0x8002
109 Generic stretch values.
113 wxSTRETCH_NOT
= 0x0000,
118 wxTILE
= wxSHAPED
| wxFIXED_MINSIZE
,
120 /* a mask to extract stretch from the combination of flags */
121 wxSTRETCH_MASK
= 0x7000 /* sans wxTILE */
125 Border flags for wxWindow.
130 This is different from wxBORDER_NONE as by default the controls do have
133 wxBORDER_DEFAULT
= 0,
135 wxBORDER_NONE
= 0x00200000,
136 wxBORDER_STATIC
= 0x01000000,
137 wxBORDER_SIMPLE
= 0x02000000,
138 wxBORDER_RAISED
= 0x04000000,
139 wxBORDER_SUNKEN
= 0x08000000,
140 wxBORDER_DOUBLE
= 0x10000000, /* deprecated */
141 wxBORDER_THEME
= wxBORDER_DOUBLE
,
143 /* a mask to extract border style from the combination of flags */
144 wxBORDER_MASK
= 0x1f200000
151 @see wxWindow::SetBackgroundStyle()
153 enum wxBackgroundStyle
156 Default background style value indicating that the background may be
157 erased in the user-defined EVT_ERASE_BACKGROUND handler.
159 If no such handler is defined (or if it skips the event), the effect of
160 this style is the same as wxBG_STYLE_SYSTEM. If an empty handler (@em
161 not skipping the event) is defined, the effect is the same as
162 wxBG_STYLE_PAINT, i.e. the background is not erased at all until
163 EVT_PAINT handler is executed.
165 This is the only background style value for which erase background
166 events are generated at all.
171 Use the default background, as determined by the system or the current
174 If the window has been assigned a non-default background colour, it
175 will be used for erasing its background. Otherwise the default
176 background (which might be a gradient or a pattern) will be used.
178 EVT_ERASE_BACKGROUND event will not be generated at all for windows
184 Indicates that the background is only erased in the user-defined
187 Using this style avoids flicker which would result from redrawing the
188 background twice if the EVT_PAINT handler entirely overwrites it. It
189 must not be used however if the paint handler leaves any parts of the
190 window unpainted as their contents is then undetermined. Only use it if
191 you repaint the whole window in your handler.
193 EVT_ERASE_BACKGROUND event will not be generated at all for windows
206 This id delimits the lower bound of the range used by automatically-generated ids
207 (i.e. those used when wxID_ANY is specified during construction).
212 This id delimits the upper bound of the range used by automatically-generated ids
213 (i.e. those used when wxID_ANY is specified during construction).
218 No id matches this one when compared to it.
223 Id for a separator line in the menu (invalid for normal item).
228 Any id: means that we don't care about the id, whether when installing
229 an event handler or when creating a new window.
254 wxID_HELP_PROCEDURES
,
273 wxID_VIEW_LARGEICONS
,
274 wxID_VIEW_SMALLICONS
,
292 /** Standard button and menu IDs */
335 wxID_REVERT_TO_SAVED
,
351 wxID_SORT_DESCENDING
,
355 /** System menu IDs (used by wxUniv): */
356 wxID_SYSTEM_MENU
= 5200,
364 /** MDI window menu ids */
365 wxID_MDI_WINDOW_FIRST
= 5230,
366 wxID_MDI_WINDOW_CASCADE
= wxID_MDI_WINDOW_FIRST
,
367 wxID_MDI_WINDOW_TILE_HORZ
,
368 wxID_MDI_WINDOW_TILE_VERT
,
369 wxID_MDI_WINDOW_ARRANGE_ICONS
,
370 wxID_MDI_WINDOW_PREV
,
371 wxID_MDI_WINDOW_NEXT
,
372 wxID_MDI_WINDOW_LAST
= wxID_MDI_WINDOW_NEXT
,
374 /** IDs used by generic file dialog (13 consecutive starting from this value) */
375 wxID_FILEDLGG
= 5900,
377 /** IDs used by generic file ctrl (4 consecutive starting from this value) */
378 wxID_FILECTRL
= 5950,
384 Item kinds for use with wxMenu, wxMenuItem, and wxToolBar.
386 @see wxMenu::Append(), wxMenuItem::wxMenuItem(), wxToolBar::AddTool()
390 wxITEM_SEPARATOR
= -1,
393 Normal tool button / menu item.
395 @see wxToolBar::AddTool(), wxMenu::AppendItem().
400 Check (or toggle) tool button / menu item.
402 @see wxToolBar::AddCheckTool(), wxMenu::AppendCheckItem().
407 Radio tool button / menu item.
409 @see wxToolBar::AddRadioTool(), wxMenu::AppendRadioItem().
414 Normal tool button with a dropdown arrow next to it. Clicking the
415 dropdown arrow sends a @c wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED event and may
416 also display the menu previously associated with the item with
417 wxToolBar::SetDropdownMenu(). Currently this type of tools is supported
426 Generic hit test results.
433 wxHT_SCROLLBAR_FIRST
= wxHT_NOWHERE
,
434 wxHT_SCROLLBAR_ARROW_LINE_1
, /**< left or upper arrow to scroll by line */
435 wxHT_SCROLLBAR_ARROW_LINE_2
, /**< right or down */
436 wxHT_SCROLLBAR_ARROW_PAGE_1
, /**< left or upper arrow to scroll by page */
437 wxHT_SCROLLBAR_ARROW_PAGE_2
, /**< right or down */
438 wxHT_SCROLLBAR_THUMB
, /**< on the thumb */
439 wxHT_SCROLLBAR_BAR_1
, /**< bar to the left/above the thumb */
440 wxHT_SCROLLBAR_BAR_2
, /**< bar to the right/below the thumb */
444 wxHT_WINDOW_OUTSIDE
, /**< not in this window at all */
445 wxHT_WINDOW_INSIDE
, /**< in the client area */
446 wxHT_WINDOW_VERT_SCROLLBAR
, /**< on the vertical scrollbar */
447 wxHT_WINDOW_HORZ_SCROLLBAR
, /**< on the horizontal scrollbar */
448 wxHT_WINDOW_CORNER
, /**< on the corner between 2 scrollbars */
454 Data format IDs used by wxDataFormat.
459 wxDF_TEXT
= 1, /* CF_TEXT */
460 wxDF_BITMAP
= 2, /* CF_BITMAP */
461 wxDF_METAFILE
= 3, /* CF_METAFILEPICT */
465 wxDF_OEMTEXT
= 7, /* CF_OEMTEXT */
466 wxDF_DIB
= 8, /* CF_DIB */
471 wxDF_UNICODETEXT
= 13,
472 wxDF_ENHMETAFILE
= 14,
473 wxDF_FILENAME
= 15, /* CF_HDROP */
476 wxDF_HTML
= 30, /* Note: does not correspond to CF_ constant */
481 Virtual keycodes used by wxKeyEvent and some other wxWidgets functions.
483 Note that the range @c 33 - @c 126 is reserved for the standard ASCII
484 characters and that the range @c 128 - @c 255 is reserved for the
485 extended ASCII characters (which are not really standard and thus should
486 be avoid in portable apps!).
490 WXK_BACK
= 8, //!< Backspace.
499 These are, by design, not compatible with unicode characters.
500 If you want to get a unicode character from a key event, use
501 wxKeyEvent::GetUnicodeKey instead.
593 WXK_NUMPAD_SEPARATOR
,
598 /** The following key codes are only generated under Windows currently */
604 /** Hardware-specific buttons */
628 This enum contains bit mask constants used in wxKeyEvent.
634 wxMOD_CONTROL
= 0x0002,
635 wxMOD_ALTGR
= wxMOD_ALT
| wxMOD_CONTROL
,
636 wxMOD_SHIFT
= 0x0004,
638 wxMOD_WIN
= wxMOD_META
,
641 Notice that @c wxMOD_CMD should be used instead of @c wxMOD_CONTROL
642 in portable code to account for the fact that although
643 @c Control modifier exists under Mac OS, it is not used for the same
644 purpose as under Windows or Unix there while the special Mac-specific
645 @c Command modifier is used in exactly the same way.
647 wxMOD_CMD
= wxMOD_META
,
652 Paper size types for use with the printing framework.
654 @see overview_printing, wxPrintData::SetPaperId()
658 wxPAPER_NONE
, ///< Use specific dimensions
659 wxPAPER_LETTER
, ///< Letter, 8 1/2 by 11 inches
660 wxPAPER_LEGAL
, ///< Legal, 8 1/2 by 14 inches
661 wxPAPER_A4
, ///< A4 Sheet, 210 by 297 millimeters
662 wxPAPER_CSHEET
, ///< C Sheet, 17 by 22 inches
663 wxPAPER_DSHEET
, ///< D Sheet, 22 by 34 inches
664 wxPAPER_ESHEET
, ///< E Sheet, 34 by 44 inches
665 wxPAPER_LETTERSMALL
, ///< Letter Small, 8 1/2 by 11 inches
666 wxPAPER_TABLOID
, ///< Tabloid, 11 by 17 inches
667 wxPAPER_LEDGER
, ///< Ledger, 17 by 11 inches
668 wxPAPER_STATEMENT
, ///< Statement, 5 1/2 by 8 1/2 inches
669 wxPAPER_EXECUTIVE
, ///< Executive, 7 1/4 by 10 1/2 inches
670 wxPAPER_A3
, ///< A3 sheet, 297 by 420 millimeters
671 wxPAPER_A4SMALL
, ///< A4 small sheet, 210 by 297 millimeters
672 wxPAPER_A5
, ///< A5 sheet, 148 by 210 millimeters
673 wxPAPER_B4
, ///< B4 sheet, 250 by 354 millimeters
674 wxPAPER_B5
, ///< B5 sheet, 182-by-257-millimeter paper
675 wxPAPER_FOLIO
, ///< Folio, 8-1/2-by-13-inch paper
676 wxPAPER_QUARTO
, ///< Quarto, 215-by-275-millimeter paper
677 wxPAPER_10X14
, ///< 10-by-14-inch sheet
678 wxPAPER_11X17
, ///< 11-by-17-inch sheet
679 wxPAPER_NOTE
, ///< Note, 8 1/2 by 11 inches
680 wxPAPER_ENV_9
, ///< #9 Envelope, 3 7/8 by 8 7/8 inches
681 wxPAPER_ENV_10
, ///< #10 Envelope, 4 1/8 by 9 1/2 inches
682 wxPAPER_ENV_11
, ///< #11 Envelope, 4 1/2 by 10 3/8 inches
683 wxPAPER_ENV_12
, ///< #12 Envelope, 4 3/4 by 11 inches
684 wxPAPER_ENV_14
, ///< #14 Envelope, 5 by 11 1/2 inches
685 wxPAPER_ENV_DL
, ///< DL Envelope, 110 by 220 millimeters
686 wxPAPER_ENV_C5
, ///< C5 Envelope, 162 by 229 millimeters
687 wxPAPER_ENV_C3
, ///< C3 Envelope, 324 by 458 millimeters
688 wxPAPER_ENV_C4
, ///< C4 Envelope, 229 by 324 millimeters
689 wxPAPER_ENV_C6
, ///< C6 Envelope, 114 by 162 millimeters
690 wxPAPER_ENV_C65
, ///< C65 Envelope, 114 by 229 millimeters
691 wxPAPER_ENV_B4
, ///< B4 Envelope, 250 by 353 millimeters
692 wxPAPER_ENV_B5
, ///< B5 Envelope, 176 by 250 millimeters
693 wxPAPER_ENV_B6
, ///< B6 Envelope, 176 by 125 millimeters
694 wxPAPER_ENV_ITALY
, ///< Italy Envelope, 110 by 230 millimeters
695 wxPAPER_ENV_MONARCH
, ///< Monarch Envelope, 3 7/8 by 7 1/2 inches
696 wxPAPER_ENV_PERSONAL
, ///< 6 3/4 Envelope, 3 5/8 by 6 1/2 inches
697 wxPAPER_FANFOLD_US
, ///< US Std Fanfold, 14 7/8 by 11 inches
698 wxPAPER_FANFOLD_STD_GERMAN
, ///< German Std Fanfold, 8 1/2 by 12 inches
699 wxPAPER_FANFOLD_LGL_GERMAN
, ///< German Legal Fanfold, 8 1/2 by 13 inches
703 wxPAPER_ISO_B4
, ///< B4 (ISO) 250 x 353 mm
704 wxPAPER_JAPANESE_POSTCARD
, ///< Japanese Postcard 100 x 148 mm
705 wxPAPER_9X11
, ///< 9 x 11 in
706 wxPAPER_10X11
, ///< 10 x 11 in
707 wxPAPER_15X11
, ///< 15 x 11 in
708 wxPAPER_ENV_INVITE
, ///< Envelope Invite 220 x 220 mm
709 wxPAPER_LETTER_EXTRA
, ///< Letter Extra 9.5 x 12 in
710 wxPAPER_LEGAL_EXTRA
, ///< Legal Extra 9.5 x 15 in
711 wxPAPER_TABLOID_EXTRA
, ///< Tabloid Extra 11.69 x 18 in
712 wxPAPER_A4_EXTRA
, ///< A4 Extra 9.27 x 12.69 in
713 wxPAPER_LETTER_TRANSVERSE
, ///< Letter Transverse 8.5 x 11 in
714 wxPAPER_A4_TRANSVERSE
, ///< A4 Transverse 210 x 297 mm
715 wxPAPER_LETTER_EXTRA_TRANSVERSE
, ///< Letter Extra Transverse 9.5 x 12 in
716 wxPAPER_A_PLUS
, ///< SuperA/SuperA/A4 227 x 356 mm
717 wxPAPER_B_PLUS
, ///< SuperB/SuperB/A3 305 x 487 mm
718 wxPAPER_LETTER_PLUS
, ///< Letter Plus 8.5 x 12.69 in
719 wxPAPER_A4_PLUS
, ///< A4 Plus 210 x 330 mm
720 wxPAPER_A5_TRANSVERSE
, ///< A5 Transverse 148 x 210 mm
721 wxPAPER_B5_TRANSVERSE
, ///< B5 (JIS) Transverse 182 x 257 mm
722 wxPAPER_A3_EXTRA
, ///< A3 Extra 322 x 445 mm
723 wxPAPER_A5_EXTRA
, ///< A5 Extra 174 x 235 mm
724 wxPAPER_B5_EXTRA
, ///< B5 (ISO) Extra 201 x 276 mm
725 wxPAPER_A2
, ///< A2 420 x 594 mm
726 wxPAPER_A3_TRANSVERSE
, ///< A3 Transverse 297 x 420 mm
727 wxPAPER_A3_EXTRA_TRANSVERSE
, ///< A3 Extra Transverse 322 x 445 mm
729 wxPAPER_DBL_JAPANESE_POSTCARD
, ///< Japanese Double Postcard 200 x 148 mm
730 wxPAPER_A6
, ///< A6 105 x 148 mm
731 wxPAPER_JENV_KAKU2
, ///< Japanese Envelope Kaku #2
732 wxPAPER_JENV_KAKU3
, ///< Japanese Envelope Kaku #3
733 wxPAPER_JENV_CHOU3
, ///< Japanese Envelope Chou #3
734 wxPAPER_JENV_CHOU4
, ///< Japanese Envelope Chou #4
735 wxPAPER_LETTER_ROTATED
, ///< Letter Rotated 11 x 8 1/2 in
736 wxPAPER_A3_ROTATED
, ///< A3 Rotated 420 x 297 mm
737 wxPAPER_A4_ROTATED
, ///< A4 Rotated 297 x 210 mm
738 wxPAPER_A5_ROTATED
, ///< A5 Rotated 210 x 148 mm
739 wxPAPER_B4_JIS_ROTATED
, ///< B4 (JIS) Rotated 364 x 257 mm
740 wxPAPER_B5_JIS_ROTATED
, ///< B5 (JIS) Rotated 257 x 182 mm
741 wxPAPER_JAPANESE_POSTCARD_ROTATED
, ///< Japanese Postcard Rotated 148 x 100 mm
742 wxPAPER_DBL_JAPANESE_POSTCARD_ROTATED
, ///< Double Japanese Postcard Rotated 148 x 200 mm
743 wxPAPER_A6_ROTATED
, ///< A6 Rotated 148 x 105 mm
744 wxPAPER_JENV_KAKU2_ROTATED
, ///< Japanese Envelope Kaku #2 Rotated
745 wxPAPER_JENV_KAKU3_ROTATED
, ///< Japanese Envelope Kaku #3 Rotated
746 wxPAPER_JENV_CHOU3_ROTATED
, ///< Japanese Envelope Chou #3 Rotated
747 wxPAPER_JENV_CHOU4_ROTATED
, ///< Japanese Envelope Chou #4 Rotated
748 wxPAPER_B6_JIS
, ///< B6 (JIS) 128 x 182 mm
749 wxPAPER_B6_JIS_ROTATED
, ///< B6 (JIS) Rotated 182 x 128 mm
750 wxPAPER_12X11
, ///< 12 x 11 in
751 wxPAPER_JENV_YOU4
, ///< Japanese Envelope You #4
752 wxPAPER_JENV_YOU4_ROTATED
, ///< Japanese Envelope You #4 Rotated
753 wxPAPER_P16K
, ///< PRC 16K 146 x 215 mm
754 wxPAPER_P32K
, ///< PRC 32K 97 x 151 mm
755 wxPAPER_P32KBIG
, ///< PRC 32K(Big) 97 x 151 mm
756 wxPAPER_PENV_1
, ///< PRC Envelope #1 102 x 165 mm
757 wxPAPER_PENV_2
, ///< PRC Envelope #2 102 x 176 mm
758 wxPAPER_PENV_3
, ///< PRC Envelope #3 125 x 176 mm
759 wxPAPER_PENV_4
, ///< PRC Envelope #4 110 x 208 mm
760 wxPAPER_PENV_5
, ///< PRC Envelope #5 110 x 220 mm
761 wxPAPER_PENV_6
, ///< PRC Envelope #6 120 x 230 mm
762 wxPAPER_PENV_7
, ///< PRC Envelope #7 160 x 230 mm
763 wxPAPER_PENV_8
, ///< PRC Envelope #8 120 x 309 mm
764 wxPAPER_PENV_9
, ///< PRC Envelope #9 229 x 324 mm
765 wxPAPER_PENV_10
, ///< PRC Envelope #10 324 x 458 mm
766 wxPAPER_P16K_ROTATED
, ///< PRC 16K Rotated
767 wxPAPER_P32K_ROTATED
, ///< PRC 32K Rotated
768 wxPAPER_P32KBIG_ROTATED
, ///< PRC 32K(Big) Rotated
769 wxPAPER_PENV_1_ROTATED
, ///< PRC Envelope #1 Rotated 165 x 102 mm
770 wxPAPER_PENV_2_ROTATED
, ///< PRC Envelope #2 Rotated 176 x 102 mm
771 wxPAPER_PENV_3_ROTATED
, ///< PRC Envelope #3 Rotated 176 x 125 mm
772 wxPAPER_PENV_4_ROTATED
, ///< PRC Envelope #4 Rotated 208 x 110 mm
773 wxPAPER_PENV_5_ROTATED
, ///< PRC Envelope #5 Rotated 220 x 110 mm
774 wxPAPER_PENV_6_ROTATED
, ///< PRC Envelope #6 Rotated 230 x 120 mm
775 wxPAPER_PENV_7_ROTATED
, ///< PRC Envelope #7 Rotated 230 x 160 mm
776 wxPAPER_PENV_8_ROTATED
, ///< PRC Envelope #8 Rotated 309 x 120 mm
777 wxPAPER_PENV_9_ROTATED
, ///< PRC Envelope #9 Rotated 324 x 229 mm
778 wxPAPER_PENV_10_ROTATED
///< PRC Envelope #10 Rotated 458 x 324 m
785 enum wxPrintOrientation
792 Duplex printing modes.
796 wxDUPLEX_SIMPLEX
, /**< Non-duplex */
802 Print mode (currently PostScript only).
806 wxPRINT_MODE_NONE
= 0,
807 wxPRINT_MODE_PREVIEW
= 1, /**< Preview in external application */
808 wxPRINT_MODE_FILE
= 2, /**< Print to file */
809 wxPRINT_MODE_PRINTER
= 3, /**< Send to printer */
810 wxPRINT_MODE_STREAM
= 4 /**< Send postscript data into a stream */
814 Flags which can be used in wxWindow::UpdateWindowUI().
820 wxUPDATE_UI_FROMIDLE
/**< Invoked from On(Internal)Idle */
824 // ----------------------------------------------------------------------------
826 // ----------------------------------------------------------------------------
829 C99-like sized MIN/MAX constants for all integer types.
831 For each @c n in the set 8, 16, 32, 64 we define @c wxINTn_MIN, @c
832 wxINTn_MAX and @c wxUINTc_MAX (@c wxUINTc_MIN is always 0 and so is not
836 #define wxINT8_MIN CHAR_MIN
837 #define wxINT8_MAX CHAR_MAX
838 #define wxUINT8_MAX UCHAR_MAX
840 #define wxINT16_MIN SHRT_MIN
841 #define wxINT16_MAX SHRT_MAX
842 #define wxUINT16_MAX USHRT_MAX
844 #define wxINT32_MIN INT_MIN-or-LONG_MIN
845 #define wxINT32_MAX INT_MAX-or-LONG_MAX
846 #define wxUINT32_MAX UINT_MAX-or-LONG_MAX
848 #define wxINT64_MIN LLONG_MIN
849 #define wxINT64_MAX LLONG_MAX
850 #define wxUINT64_MAX ULLONG_MAX
853 // ----------------------------------------------------------------------------
855 // ----------------------------------------------------------------------------
857 /** The type for screen and DC coordinates. */
860 /** A special value meaning "use default coordinate". */
861 wxCoord wxDefaultCoord
= -1;
864 /** 8 bit type (the mapping is more complex than a simple @c typedef and is not shown here). */
865 typedef signed char wxInt8
;
866 typedef unsigned char wxUint8
;
867 typedef wxUint8 wxByte
;
871 /** 16 bit type (the mapping is more complex than a simple @c typedef and is not shown here). */
872 typedef signed short wxInt16
;
873 typedef unsigned short wxUint16
;
874 typedef wxUint16 wxWord
;
875 typedef wxUint16 wxChar16
;
879 /** 32 bit type (the mapping is more complex than a simple @c typedef and is not shown here). */
881 typedef unsigned int wxUint32
;
882 typedef wxUint32 wxDword
;
883 typedef wxUint32 wxChar32
;
887 /** 64 bit type (the mapping is more complex than a simple @c typedef and is not shown here). */
888 typedef wxLongLong_t wxInt64
;
889 typedef wxULongLong_t wxUint64
;
894 Signed and unsigned integral types big enough to contain all of @c long,
895 @c size_t and @c void*.
896 (The mapping is more complex than a simple @c typedef and is not shown here).
898 typedef ssize_t wxIntPtr
;
899 typedef size_t wxUIntPtr
;
904 32 bit IEEE float ( 1 sign, 8 exponent bits, 23 fraction bits ).
905 (The mapping is more complex than a simple @c typedef and is not shown here).
907 typedef float wxFloat32
;
911 64 bit IEEE float ( 1 sign, 11 exponent bits, 52 fraction bits ).
912 (The mapping is more complex than a simple @c typedef and is not shown here).
914 typedef double wxFloat64
;
917 Native fastest representation that has at least wxFloat64 precision, so use
918 the IEEE types for storage, and this for calculations.
919 (The mapping is more complex than a simple @c typedef and is not shown here).
921 typedef double wxDouble
;
925 // ----------------------------------------------------------------------------
927 // ----------------------------------------------------------------------------
930 /** @addtogroup group_funcmacro_byteorder */
934 This macro will swap the bytes of the @a value variable from little endian
935 to big endian or vice versa unconditionally, i.e. independently of the
940 #define wxINT32_SWAP_ALWAYS( wxInt32_value )
941 #define wxUINT32_SWAP_ALWAYS( wxUint32_value )
942 #define wxINT16_SWAP_ALWAYS( wxInt16_value )
943 #define wxUINT16_SWAP_ALWAYS( wxUint16_value )
947 /** @addtogroup group_funcmacro_byteorder */
951 This macro will swap the bytes of the @a value variable from little endian
952 to big endian or vice versa if the program is compiled on a big-endian
953 architecture (such as Sun work stations). If the program has been compiled
954 on a little-endian architecture, the value will be unchanged.
956 Use these macros to read data from and write data to a file that stores
957 data in little-endian (for example Intel i386) format.
961 #define wxINT32_SWAP_ON_BE( wxInt32_value )
962 #define wxUINT32_SWAP_ON_BE( wxUint32_value )
963 #define wxINT16_SWAP_ON_BE( wxInt16_value )
964 #define wxUINT16_SWAP_ON_BE( wxUint16_value )
968 /** @addtogroup group_funcmacro_byteorder */
972 This macro will swap the bytes of the @a value variable from little endian
973 to big endian or vice versa if the program is compiled on a little-endian
974 architecture (such as Intel PCs). If the program has been compiled on a
975 big-endian architecture, the value will be unchanged.
977 Use these macros to read data from and write data to a file that stores
978 data in big-endian format.
982 #define wxINT32_SWAP_ON_LE( wxInt32_value )
983 #define wxUINT32_SWAP_ON_LE( wxUint32_value )
984 #define wxINT16_SWAP_ON_LE( wxInt16_value )
985 #define wxUINT16_SWAP_ON_LE( wxUint16_value )
991 /** @addtogroup group_funcmacro_misc */
995 This macro can be used in a class declaration to disable the generation of
996 default assignment operator.
998 Some classes have a well-defined copy constructor but cannot have an
999 assignment operator, typically because they can't be modified once created.
1000 In such case, this macro can be used to disable the automatic assignment
1001 operator generation.
1003 @see wxDECLARE_NO_COPY_CLASS()
1005 #define wxDECLARE_NO_ASSIGN_CLASS(classname)
1008 This macro can be used in a class declaration to disable the generation of
1009 default copy ctor and assignment operator.
1011 Some classes don't have a well-defined copying semantics. In this case the
1012 standard C++ convention is to not allow copying them. One way of achieving
1013 it is to use this macro which simply defines a private copy constructor and
1014 assignment operator.
1016 Beware that simply not defining copy constructor and assignment operator is
1017 @em not enough as the compiler would provide its own automatically-generated
1018 versions of them -- hence the usefulness of this macro.
1029 // widgets can't be copied
1030 wxDECLARE_NO_COPY_CLASS(FooWidget);
1034 Notice that a semicolon must be used after this macro and that it changes
1035 the access specifier to private internally so it is better to use it at the
1036 end of the class declaration.
1038 @see wxDECLARE_NO_ASSIGN_CLASS(), wxDECLARE_NO_COPY_TEMPLATE_CLASS()
1040 #define wxDECLARE_NO_COPY_CLASS(classname)
1043 Analog of wxDECLARE_NO_COPY_CLASS() for template classes.
1045 This macro can be used for template classes (with a single template
1046 parameter) for the same purpose as wxDECLARE_NO_COPY_CLASS() is used with the
1047 non-template classes.
1049 @param classname The name of the template class.
1050 @param arg The name of the template parameter.
1052 @see wxDECLARE_NO_COPY_TEMPLATE_CLASS_2
1054 #define wxDECLARE_NO_COPY_TEMPLATE_CLASS(classname, arg)
1057 Analog of wxDECLARE_NO_COPY_TEMPLATE_CLASS() for templates with 2
1060 This macro can be used for template classes with two template
1061 parameters for the same purpose as wxDECLARE_NO_COPY_CLASS() is used with
1062 the non-template classes.
1064 @param classname The name of the template class.
1065 @param arg1 The name of the first template parameter.
1066 @param arg2 The name of the second template parameter.
1068 @see wxDECLARE_NO_COPY_TEMPLATE_CLASS
1070 #define wxDECLARE_NO_COPY_TEMPLATE_CLASS_2(classname, arg1, arg2)
1073 A function which deletes and nulls the pointer.
1075 This function uses operator delete to free the pointer and also sets it to
1076 @NULL. Notice that this does @em not work for arrays, use wxDELETEA() for
1080 MyClass *ptr = new MyClass;
1088 template <typename T
> wxDELETE(T
*& ptr
);
1091 A function which deletes and nulls the pointer.
1093 This function uses vector operator delete (@c delete[]) to free the array
1094 pointer and also sets it to @NULL. Notice that this does @em not work for
1095 non-array pointers, use wxDELETE() for them.
1098 MyClass *array = new MyClass[17];
1108 template <typename T
> wxDELETEA(T
*& array
);
1111 This macro can be used around a function declaration to generate warnings
1112 indicating that this function is deprecated (i.e. obsolete and planned to
1113 be removed in the future) when it is used. Only Visual C++ 7 and higher and
1114 g++ compilers currently support this functionality.
1119 // old function, use wxString version instead
1120 wxDEPRECATED( void wxGetSomething(char *buf, size_t len) );
1123 wxString wxGetSomething();
1128 #define wxDEPRECATED(function)
1131 This is a special version of wxDEPRECATED() macro which only does something
1132 when the deprecated function is used from the code outside wxWidgets itself
1133 but doesn't generate warnings when it is used from wxWidgets.
1135 It is used with the virtual functions which are called by the library
1136 itself -- even if such function is deprecated the library still has to call
1137 it to ensure that the existing code overriding it continues to work, but
1138 the use of this macro ensures that a deprecation warning will be generated
1139 if this function is used from the user code or, in case of Visual C++, even
1140 when it is simply overridden.
1144 #define wxDEPRECATED_BUT_USED_INTERNALLY(function)
1147 This macro is similar to wxDEPRECATED() but can be used to not only declare
1148 the function @a function as deprecated but to also provide its (inline)
1149 implementation @a body.
1151 It can be used as following:
1157 // OldMethod() is deprecated, use NewMethod() instead
1159 wxDEPRECATED_INLINE( void OldMethod(), NewMethod(); )
1165 #define wxDEPRECATED_INLINE(func, body)
1168 A helper macro allowing to easily define a simple deprecated accessor.
1170 Compared to wxDEPRECATED_INLINE() it saves a @c return statement and,
1171 especially, a strangely looking semicolon inside a macro.
1178 int GetValue() const { return m_value; }
1180 // this one is deprecated because it was erroneously non-const
1181 wxDEPRECATED_ACCESSOR( int GetValue(), m_value )
1188 #define wxDEPRECATED_ACCESSOR(func, what)
1191 Combination of wxDEPRECATED_BUT_USED_INTERNALLY() and wxDEPRECATED_INLINE().
1193 This macro should be used for deprecated functions called by the library
1194 itself (usually for backwards compatibility reasons) and which are defined
1199 #define wxDEPRECATED_BUT_USED_INTERNALLY_INLINE(func, body)
1202 @c wxEXPLICIT is a macro which expands to the C++ @c explicit keyword if
1203 the compiler supports it or nothing otherwise. Thus, it can be used even in
1204 the code which might have to be compiled with an old compiler without
1205 support for this language feature but still take advantage of it when it is
1213 GNU C++ compiler gives a warning for any class whose destructor is private
1214 unless it has a friend. This warning may sometimes be useful but it doesn't
1215 make sense for reference counted class which always delete themselves
1216 (hence destructor should be private) but don't necessarily have any
1217 friends, so this macro is provided to disable the warning in such case. The
1218 @a name parameter should be the name of the class but is only used to
1219 construct a unique friend class name internally.
1221 Example of using the macro:
1227 RefCounted() { m_nRef = 1; }
1228 void IncRef() { m_nRef++ ; }
1229 void DecRef() { if ( !--m_nRef ) delete this; }
1234 wxSUPPRESS_GCC_PRIVATE_DTOR(RefCounted)
1238 Notice that there should be no semicolon after this macro.
1242 #define wxSUPPRESS_GCC_PRIVATE_DTOR_WARNING(name)
1245 Swaps the contents of two variables.
1247 This is similar to std::swap() but can be used even on the platforms where
1248 the standard C++ library is not available (if you don't target such
1249 platforms, please use std::swap() instead).
1251 The function relies on type T being copy constructible and assignable.
1258 wxASSERT( x == 4 && y == 3 );
1261 template <typename T
> wxSwap(T
& first
, T
& second
);
1264 This macro is the same as the standard C99 @c va_copy for the compilers
1265 which support it or its replacement for those that don't. It must be used
1266 to preserve the value of a @c va_list object if you need to use it after
1267 passing it to another function because it can be modified by the latter.
1269 As with @c va_start, each call to @c wxVaCopy must have a matching
1274 void wxVaCopy(va_list argptrDst
, va_list argptrSrc
);