1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Definitions and stuff
9 // Copyright: (c) 1998 by Total Control Software
10 // Licence: wxWindows license
11 /////////////////////////////////////////////////////////////////////////////
14 // Globally turn on the autodoc feature
15 %feature("autodoc", "1"); // 0 == no param types, 1 == show param types
18 //---------------------------------------------------------------------------
19 // some type definitions to simplify things for SWIG
21 // typedef int wxWindowID;
22 // typedef int wxCoord;
23 // typedef int wxInt32;
24 // typedef unsigned int wxUint32;
25 typedef int wxEventType;
26 typedef unsigned int size_t;
27 typedef unsigned int time_t;
28 typedef unsigned char byte;
30 #define wxWindowID int
33 #define wxUint32 unsigned int
34 //#define wxEventType int
35 //#define size_t unsigned int
36 //#define time_t unsigned int
37 //#define byte unsigned char
40 //----------------------------------------------------------------------
41 // Various SWIG macros and such
43 #define %addtofunc %feature("addtofunc")
44 #define %kwargs %feature("kwargs")
45 #define %nokwargs %feature("nokwargs")
48 #define %shadow %insert("shadow")
52 #define %pythoncode %insert("python")
58 // Given the name of a wxChar (or wxString) constant in C++, make
59 // a static wxString for wxPython, and also let SWIG wrap it.
60 %define MAKE_CONST_WXSTRING(strname)
61 %{ static const wxString wxPy##strname(wx##strname); %}
63 %name(strname) const wxString wxPy##strname;
67 %define MAKE_CONST_WXSTRING2(strname, val)
68 %{ static const wxString wxPy##strname(val); %}
70 %name(strname) const wxString wxPy##strname;
74 %define MAKE_CONST_WXSTRING_NOSWIG(strname)
75 %{ static const wxString wxPy##strname(wx##strname); %}
78 // Generate code in the module init for the event types, since they may not be
79 // initialized yet when they are used in the static swig_const_table.
80 %typemap(consttab) wxEventType; // TODO: how to prevent code inserted into the consttab?
81 %typemap(constcode) wxEventType "PyDict_SetItemString(d, \"$symname\", PyInt_FromLong($value));";
85 // Macros for the docstring and autodoc features of SWIG.
87 // Set the docsring for the given full or partial declaration
88 %define DocStr(decl, docstr)
89 %feature("docstring") decl docstr;
90 //%feature("refdoc") decl "";
93 // Set the autodoc string for a full or partial declaration
94 %define DocA(decl, astr)
95 %feature("autodoc") decl astr;
98 // Set both the autodoc and docstring for a full or partial declaration
99 %define DocAStr(decl, astr, docstr)
100 %feature("autodoc") decl astr;
101 %feature("docstring") decl docstr
104 // Set the detailed reference docs for full or partial declaration
105 #define DocRef(decl, str) %feature("docref") decl str
110 // Set the docstring for a decl and then define the decl too. Must use the
111 // full declaration of the item.
112 %define DocDeclStr(type, decl, docstr)
113 %feature("docstring") decl docstr;
117 // As above, but also give the decl a new %name
118 %define DocDeclStrName(type, decl, docstr, newname)
119 %feature("docstring") decl docstr;
120 %name(newname) type decl
124 // Set the autodoc string for a decl and then define the decl too. Must use the
125 // full declaration of the item.
126 %define DocDeclA(type, decl, astr)
127 %feature("autodoc") decl astr;
131 // As above, but also give the decl a new %name
132 %define DocDeclAName(type, decl, astr, newname)
133 %feature("autodoc") decl astr;
134 %name(newname) type decl
139 // Set the autodoc and the docstring for a decl and then define the decl too.
140 // Must use the full declaration of the item.
141 %define DocDeclAStr(type, decl, astr, docstr)
142 %feature("autodoc") decl astr;
143 %feature("docstring") decl docstr;
147 // As above, but also give the decl a new %name
148 %define DocDeclAStrName(type, decl, astr, docstr, newname)
149 %feature("autodoc") decl astr;
150 %feature("docstring") decl docstr;
151 %name(newname) type decl
157 // Set the docstring for a constructor decl and then define the decl too.
158 // Must use the full declaration of the item.
159 %define DocCtorStr(decl, docstr)
160 %feature("docstring") decl docstr;
164 // As above, but also give the decl a new %name
165 %define DocCtorStrName(decl, docstr, newname)
166 %feature("docstring") decl docstr;
171 // Set the autodoc string for a decl and then define the decl too. Must use the
172 // full declaration of the item.
173 %define DocCtorA(decl, astr)
174 %feature("autodoc") decl astr;
178 // As above, but also give the decl a new %name
179 %define DocCtorAname(decl, astr, newname)
180 %feature("autodoc") decl astr;
186 // Set the autodoc and the docstring for a decl and then define the decl too.
187 // Must use the full declaration of the item.
188 %define DocCtorAStr(decl, astr, docstr)
189 %feature("autodoc") decl astr;
190 %feature("docstring") decl docstr;
194 // As above, but also give the decl a new %name
195 %define DocCtorAStrName(decl, astr, docstr, newname)
196 %feature("autodoc") decl astr;
197 %feature("docstring") decl docstr;
202 // A placeholder for the detailed reference docs.
203 %define RefDoc(decl, docstr)
204 %feature("refdoc") decl docstr;
210 %#---------------------------------------------------------------------------
214 //---------------------------------------------------------------------------
215 // Forward declarations and %renames for some classes, so the autodoc strings
216 // will be able to use the right types even when the real class declaration is
217 // not in the module being processed.
219 #ifdef BUILDING_RENAMERS
220 #define FORWARD_DECLARE(wxName, Name)
222 %define FORWARD_DECLARE(wxName, Name)
223 %rename(Name) wxName;
228 FORWARD_DECLARE(wxString, String);
229 FORWARD_DECLARE(wxBitmap, Bitmap);
230 FORWARD_DECLARE(wxDateTime, DateTime);
231 FORWARD_DECLARE(wxInputStream, InputStream);
232 FORWARD_DECLARE(wxDC, DC);
233 FORWARD_DECLARE(wxCursor, Cursor);
234 FORWARD_DECLARE(wxRegion, Region);
235 FORWARD_DECLARE(wxColour, Colour);
236 FORWARD_DECLARE(wxFont, Font);
237 FORWARD_DECLARE(wxCaret, Caret);
238 FORWARD_DECLARE(wxToolTip, ToolTip);
239 FORWARD_DECLARE(wxPyDropTarget, PyDropTarget);
240 FORWARD_DECLARE(wxImageList, ImageList);
241 FORWARD_DECLARE(wxMemoryDC, MemoryDC);
242 FORWARD_DECLARE(wxHtmlTagHandler, HtmlTagHandler);
243 FORWARD_DECLARE(wxConfigBase, ConfigBase);
244 FORWARD_DECLARE(wxIcon, Icon);
247 //---------------------------------------------------------------------------
249 // General numeric #define's and etc. Making them all enums makes SWIG use the
250 // real macro when making the Python Int
268 wxTRANSPARENT_WINDOW,
289 wxTINY_CAPTION_HORIZ,
296 wxDEFAULT_FRAME_STYLE,
297 wxDEFAULT_DIALOG_STYLE,
300 wxFRAME_FLOAT_ON_PARENT,
301 wxFRAME_NO_WINDOW_MENU,
393 wxSIZE_ALLOW_MINUS_ONE,
396 wxPRINT_QUALITY_HIGH,
397 wxPRINT_QUALITY_MEDIUM,
399 wxPRINT_QUALITY_DRAFT,
421 wxID_HELP_PROCEDURES,
440 wxID_VIEW_LARGEICONS,
441 wxID_VIEW_SMALLICONS,
504 wxNO_FULL_REPAINT_ON_RESIZE,
505 wxFULL_REPAINT_ON_RESIZE,
510 wxWS_EX_VALIDATE_RECURSIVELY,
511 wxWS_EX_BLOCK_EVENTS,
514 wxWS_EX_THEMED_BACKGROUND,
515 wxWS_EX_PROCESS_IDLE,
516 wxWS_EX_PROCESS_UI_UPDATES,
519 // Mapping modes (as per Windows)
532 // It looks like wxTabCtrl may rise from the dead. Uncomment these if
533 // it gets an implementation for all platforms...
534 // wxTC_RIGHTJUSTIFY,
547 enum wxGeometryCentre
582 wxALIGN_CENTER_HORIZONTAL,
583 wxALIGN_CENTRE_HORIZONTAL,
588 wxALIGN_CENTER_VERTICAL,
589 wxALIGN_CENTRE_VERTICAL,
661 wxXOR, // src XOR dst
663 wxOR_REVERSE, // src OR (NOT dst)
664 wxAND_REVERSE,// src AND (NOT dst)
666 wxAND, // src AND dst
667 wxAND_INVERT, // (NOT src) AND dst
669 wxNOR, // (NOT src) AND (NOT dst)
670 wxEQUIV, // (NOT src) XOR dst
671 wxSRC_INVERT, // (NOT src)
672 wxOR_INVERT, // (NOT src) OR dst
673 wxNAND, // (NOT src) OR (NOT dst)
676 // wxSRC_OR, // source _bitmap_ OR destination
677 // wxSRC_AND // source _bitmap_ AND destination
700 WXK_PRIOR, /* Page up */
701 WXK_NEXT, /* Page down */
782 WXK_NUMPAD_SEPARATOR,
796 wxPAPER_NONE, // Use specific dimensions
797 wxPAPER_LETTER, // Letter, 8 1/2 by 11 inches
798 wxPAPER_LEGAL, // Legal, 8 1/2 by 14 inches
799 wxPAPER_A4, // A4 Sheet, 210 by 297 millimeters
800 wxPAPER_CSHEET, // C Sheet, 17 by 22 inches
801 wxPAPER_DSHEET, // D Sheet, 22 by 34 inches
802 wxPAPER_ESHEET, // E Sheet, 34 by 44 inches
803 wxPAPER_LETTERSMALL, // Letter Small, 8 1/2 by 11 inches
804 wxPAPER_TABLOID, // Tabloid, 11 by 17 inches
805 wxPAPER_LEDGER, // Ledger, 17 by 11 inches
806 wxPAPER_STATEMENT, // Statement, 5 1/2 by 8 1/2 inches
807 wxPAPER_EXECUTIVE, // Executive, 7 1/4 by 10 1/2 inches
808 wxPAPER_A3, // A3 sheet, 297 by 420 millimeters
809 wxPAPER_A4SMALL, // A4 small sheet, 210 by 297 millimeters
810 wxPAPER_A5, // A5 sheet, 148 by 210 millimeters
811 wxPAPER_B4, // B4 sheet, 250 by 354 millimeters
812 wxPAPER_B5, // B5 sheet, 182-by-257-millimeter paper
813 wxPAPER_FOLIO, // Folio, 8-1/2-by-13-inch paper
814 wxPAPER_QUARTO, // Quarto, 215-by-275-millimeter paper
815 wxPAPER_10X14, // 10-by-14-inch sheet
816 wxPAPER_11X17, // 11-by-17-inch sheet
817 wxPAPER_NOTE, // Note, 8 1/2 by 11 inches
818 wxPAPER_ENV_9, // #9 Envelope, 3 7/8 by 8 7/8 inches
819 wxPAPER_ENV_10, // #10 Envelope, 4 1/8 by 9 1/2 inches
820 wxPAPER_ENV_11, // #11 Envelope, 4 1/2 by 10 3/8 inches
821 wxPAPER_ENV_12, // #12 Envelope, 4 3/4 by 11 inches
822 wxPAPER_ENV_14, // #14 Envelope, 5 by 11 1/2 inches
823 wxPAPER_ENV_DL, // DL Envelope, 110 by 220 millimeters
824 wxPAPER_ENV_C5, // C5 Envelope, 162 by 229 millimeters
825 wxPAPER_ENV_C3, // C3 Envelope, 324 by 458 millimeters
826 wxPAPER_ENV_C4, // C4 Envelope, 229 by 324 millimeters
827 wxPAPER_ENV_C6, // C6 Envelope, 114 by 162 millimeters
828 wxPAPER_ENV_C65, // C65 Envelope, 114 by 229 millimeters
829 wxPAPER_ENV_B4, // B4 Envelope, 250 by 353 millimeters
830 wxPAPER_ENV_B5, // B5 Envelope, 176 by 250 millimeters
831 wxPAPER_ENV_B6, // B6 Envelope, 176 by 125 millimeters
832 wxPAPER_ENV_ITALY, // Italy Envelope, 110 by 230 millimeters
833 wxPAPER_ENV_MONARCH, // Monarch Envelope, 3 7/8 by 7 1/2 inches
834 wxPAPER_ENV_PERSONAL, // 6 3/4 Envelope, 3 5/8 by 6 1/2 inches
835 wxPAPER_FANFOLD_US, // US Std Fanfold, 14 7/8 by 11 inches
836 wxPAPER_FANFOLD_STD_GERMAN, // German Std Fanfold, 8 1/2 by 12 inches
837 wxPAPER_FANFOLD_LGL_GERMAN, // German Legal Fanfold, 8 1/2 by 13 inches
839 wxPAPER_ISO_B4, // B4 (ISO) 250 x 353 mm
840 wxPAPER_JAPANESE_POSTCARD, // Japanese Postcard 100 x 148 mm
841 wxPAPER_9X11, // 9 x 11 in
842 wxPAPER_10X11, // 10 x 11 in
843 wxPAPER_15X11, // 15 x 11 in
844 wxPAPER_ENV_INVITE, // Envelope Invite 220 x 220 mm
845 wxPAPER_LETTER_EXTRA, // Letter Extra 9 \275 x 12 in
846 wxPAPER_LEGAL_EXTRA, // Legal Extra 9 \275 x 15 in
847 wxPAPER_TABLOID_EXTRA, // Tabloid Extra 11.69 x 18 in
848 wxPAPER_A4_EXTRA, // A4 Extra 9.27 x 12.69 in
849 wxPAPER_LETTER_TRANSVERSE, // Letter Transverse 8 \275 x 11 in
850 wxPAPER_A4_TRANSVERSE, // A4 Transverse 210 x 297 mm
851 wxPAPER_LETTER_EXTRA_TRANSVERSE, // Letter Extra Transverse 9\275 x 12 in
852 wxPAPER_A_PLUS, // SuperA/SuperA/A4 227 x 356 mm
853 wxPAPER_B_PLUS, // SuperB/SuperB/A3 305 x 487 mm
854 wxPAPER_LETTER_PLUS, // Letter Plus 8.5 x 12.69 in
855 wxPAPER_A4_PLUS, // A4 Plus 210 x 330 mm
856 wxPAPER_A5_TRANSVERSE, // A5 Transverse 148 x 210 mm
857 wxPAPER_B5_TRANSVERSE, // B5 (JIS) Transverse 182 x 257 mm
858 wxPAPER_A3_EXTRA, // A3 Extra 322 x 445 mm
859 wxPAPER_A5_EXTRA, // A5 Extra 174 x 235 mm
860 wxPAPER_B5_EXTRA, // B5 (ISO) Extra 201 x 276 mm
861 wxPAPER_A2, // A2 420 x 594 mm
862 wxPAPER_A3_TRANSVERSE, // A3 Transverse 297 x 420 mm
863 wxPAPER_A3_EXTRA_TRANSVERSE // A3 Extra Transverse 322 x 445 mm
868 wxDUPLEX_SIMPLEX, // Non-duplex
875 // menu and toolbar item kinds
891 wxHT_SCROLLBAR_FIRST = wxHT_NOWHERE,
892 wxHT_SCROLLBAR_ARROW_LINE_1, // left or upper arrow to scroll by line
893 wxHT_SCROLLBAR_ARROW_LINE_2, // right or down
894 wxHT_SCROLLBAR_ARROW_PAGE_1, // left or upper arrow to scroll by page
895 wxHT_SCROLLBAR_ARROW_PAGE_2, // right or down
896 wxHT_SCROLLBAR_THUMB, // on the thumb
897 wxHT_SCROLLBAR_BAR_1, // bar to the left/above the thumb
898 wxHT_SCROLLBAR_BAR_2, // bar to the right/below the thumb
902 wxHT_WINDOW_OUTSIDE, // not in this window at all
903 wxHT_WINDOW_INSIDE, // in the client area
904 wxHT_WINDOW_VERT_SCROLLBAR, // on the vertical scrollbar
905 wxHT_WINDOW_HORZ_SCROLLBAR, // on the horizontal scrollbar
906 wxHT_WINDOW_CORNER, // on the corner between 2 scrollbars
914 enum wxHotkeyModifier
922 #define wxEVT_HOTKEY 9999
926 enum wxHotkeyModifier
938 wxUPDATE_UI_NONE = 0x0000,
939 wxUPDATE_UI_RECURSE = 0x0001,
940 wxUPDATE_UI_FROMIDLE = 0x0002 // Invoked from On(Internal)Idle
945 //---------------------------------------------------------------------------