1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Definitions and stuff
9 // Copyright: (c) 1998 by Total Control Software
10 // Licence: wxWindows license
11 /////////////////////////////////////////////////////////////////////////////
14 //---------------------------------------------------------------------------
15 // Globally turn on the autodoc feature
17 %feature("autodoc", "1"); // 0 == no param types, 1 == show param types
20 //---------------------------------------------------------------------------
21 // Tell SWIG to wrap all the wrappers with our thread protection by default
24 PyThreadState* __tstate = wxPyBeginAllowThreads();
26 wxPyEndAllowThreads(__tstate);
27 if (PyErr_Occurred()) SWIG_fail;
31 // This one can be used to add a check for an existing wxApp before the real
32 // work is done. An exception is raised if there isn't one.
33 %define MustHaveApp(name)
35 if (!wxPyCheckForApp()) SWIG_fail;
36 PyThreadState* __tstate = wxPyBeginAllowThreads();
38 wxPyEndAllowThreads(__tstate);
39 if (PyErr_Occurred()) SWIG_fail;
45 //---------------------------------------------------------------------------
46 // some type definitions to simplify things for SWIG
48 typedef int wxEventType;
49 typedef unsigned int size_t;
50 typedef unsigned int time_t;
51 typedef unsigned char byte;
53 #define wxWindowID int
56 #define wxUint32 unsigned int
59 //----------------------------------------------------------------------
60 // Various SWIG macros and such
62 #define %pythonAppend %feature("pythonappend")
63 #define %pythonPrepend %feature("pythonprepend")
64 #define %kwargs %feature("kwargs")
65 #define %nokwargs %feature("nokwargs")
68 //#define %shadow %insert("shadow")
72 #define %pythoncode %insert("python")
78 // Given the name of a wxChar (or wxString) constant in C++, make
79 // a static wxString for wxPython, and also let SWIG wrap it.
80 %define MAKE_CONST_WXSTRING(strname)
81 %{ static const wxString wxPy##strname(wx##strname); %}
83 %name(strname) const wxString wxPy##strname;
87 %define MAKE_CONST_WXSTRING2(strname, val)
88 %{ static const wxString wxPy##strname(val); %}
90 %name(strname) const wxString wxPy##strname;
94 %define MAKE_CONST_WXSTRING_NOSWIG(strname)
95 %{ static const wxString wxPy##strname(wx##strname); %}
98 // Generate code in the module init for the event types, since they may not be
99 // initialized yet when they are used in the static swig_const_table.
100 %typemap(consttab) wxEventType; // TODO: how to prevent code inserted into the consttab?
101 %typemap(constcode) wxEventType "PyDict_SetItemString(d, \"$symname\", PyInt_FromLong($value));";
105 //----------------------------------------------------------------------
106 // Macros for the docstring and autodoc features of SWIG. These will
107 // help make the code look more readable, and pretty, as well as help
108 // reduce typing in some cases.
110 // Set the docsring for the given full or partial declaration
112 %define DocStr(decl, docstr, details)
113 %feature("docstring") decl docstr details;
116 %define DocStr(decl, docstr, details)
117 %feature("docstring") decl docstr;
122 // Set the autodoc string for a full or partial declaration
123 %define DocA(decl, astr)
124 %feature("autodoc") decl astr;
128 // Set both the autodoc and docstring for a full or partial declaration
130 %define DocAStr(decl, astr, docstr, details)
131 %feature("autodoc") decl astr;
132 %feature("docstring") decl docstr details
135 %define DocAStr(decl, astr, docstr, details)
136 %feature("autodoc") decl astr;
137 %feature("docstring") decl docstr
144 // Set the docstring for a decl and then define the decl too. Must use the
145 // full declaration of the item.
147 %define DocDeclStr(type, decl, docstr, details)
148 %feature("docstring") decl docstr details;
152 %define DocDeclStr(type, decl, docstr, details)
153 %feature("docstring") decl docstr;
160 // As above, but also give the decl a new %name
162 %define DocDeclStrName(type, decl, docstr, details, newname)
163 %feature("docstring") decl docstr details;
164 %name(newname) type decl
167 %define DocDeclStrName(type, decl, docstr, details, newname)
168 %feature("docstring") decl docstr;
169 %name(newname) type decl
174 // Set the autodoc string for a decl and then define the decl too. Must use the
175 // full declaration of the item.
176 %define DocDeclA(type, decl, astr)
177 %feature("autodoc") decl astr;
181 // As above, but also give the decl a new %name
182 %define DocDeclAName(type, decl, astr, newname)
183 %feature("autodoc") decl astr;
184 %name(newname) type decl
189 // Set the autodoc and the docstring for a decl and then define the decl too.
190 // Must use the full declaration of the item.
192 %define DocDeclAStr(type, decl, astr, details, docstr)
193 %feature("autodoc") decl astr;
194 %feature("docstring") decl docstr details;
198 %define DocDeclAStr(type, decl, astr, details, docstr)
199 %feature("autodoc") decl astr;
200 %feature("docstring") decl docstr;
206 // As above, but also give the decl a new %name
208 %define DocDeclAStrName(type, decl, astr, docstr, details, newname)
209 %feature("autodoc") decl astr;
210 %feature("docstring") decl docstr details;
211 %name(newname) type decl
214 %define DocDeclAStrName(type, decl, astr, docstr, details, newname)
215 %feature("autodoc") decl astr;
216 %feature("docstring") decl docstr;
217 %name(newname) type decl
223 // Set the docstring for a constructor decl and then define the decl too.
224 // Must use the full declaration of the item.
226 %define DocCtorStr(decl, docstr, details)
227 %feature("docstring") decl docstr details;
231 %define DocCtorStr(decl, docstr, details)
232 %feature("docstring") decl docstr;
238 // As above, but also give the decl a new %name
240 %define DocCtorStrName(decl, docstr, details, newname)
241 %feature("docstring") decl docstr details;
245 %define DocCtorStrName(decl, docstr, details, newname)
246 %feature("docstring") decl docstr;
253 // Set the autodoc string for a constructor decl and then define the decl too.
254 // Must use the full declaration of the item.
255 %define DocCtorA(decl, astr)
256 %feature("autodoc") decl astr;
260 // As above, but also give the decl a new %name
261 %define DocCtorAName(decl, astr, newname)
262 %feature("autodoc") decl astr;
268 // Set the autodoc and the docstring for a constructor decl and then define
269 // the decl too. Must use the full declaration of the item.
271 %define DocCtorAStr(decl, astr, docstr, details)
272 %feature("autodoc") decl astr;
273 %feature("docstring") decl docstr details;
277 %define DocCtorAStr(decl, astr, docstr, details)
278 %feature("autodoc") decl astr;
279 %feature("docstring") decl docstr;
286 // As above, but also give the decl a new %name
288 %define DocCtorAStrName(decl, astr, docstr, details, newname)
289 %feature("autodoc") decl astr;
290 %feature("docstring") decl docstr details;
294 %define DocCtorAStrName(decl, astr, docstr, details, newname)
295 %feature("autodoc") decl astr;
296 %feature("docstring") decl docstr;
305 %#---------------------------------------------------------------------------
309 //---------------------------------------------------------------------------
310 // Forward declarations and %renames for some classes, so the autodoc strings
311 // will be able to use the right types even when the real class declaration is
312 // not in the module being processed.
314 #ifdef BUILDING_RENAMERS
315 #define FORWARD_DECLARE(wxName, Name)
317 %define FORWARD_DECLARE(wxName, Name)
318 %rename(Name) wxName;
323 FORWARD_DECLARE(wxString, String);
324 FORWARD_DECLARE(wxBitmap, Bitmap);
325 FORWARD_DECLARE(wxDateTime, DateTime);
326 FORWARD_DECLARE(wxInputStream, InputStream);
327 FORWARD_DECLARE(wxDC, DC);
328 FORWARD_DECLARE(wxCursor, Cursor);
329 FORWARD_DECLARE(wxRegion, Region);
330 FORWARD_DECLARE(wxColour, Colour);
331 FORWARD_DECLARE(wxFont, Font);
332 FORWARD_DECLARE(wxCaret, Caret);
333 FORWARD_DECLARE(wxToolTip, ToolTip);
334 FORWARD_DECLARE(wxPyDropTarget, DropTarget);
335 FORWARD_DECLARE(wxImageList, ImageList);
336 FORWARD_DECLARE(wxMemoryDC, MemoryDC);
337 FORWARD_DECLARE(wxHtmlTagHandler, HtmlTagHandler);
338 FORWARD_DECLARE(wxConfigBase, ConfigBase);
339 FORWARD_DECLARE(wxIcon, Icon);
342 //---------------------------------------------------------------------------
344 // General numeric #define's and etc. Making them all enums makes SWIG use the
345 // real macro when making the Python Int
363 wxTRANSPARENT_WINDOW,
463 wxSIZE_ALLOW_MINUS_ONE,
466 wxPRINT_QUALITY_HIGH,
467 wxPRINT_QUALITY_MEDIUM,
469 wxPRINT_QUALITY_DRAFT,
491 wxID_HELP_PROCEDURES,
510 wxID_VIEW_LARGEICONS,
511 wxID_VIEW_SMALLICONS,
574 wxNO_FULL_REPAINT_ON_RESIZE,
575 wxFULL_REPAINT_ON_RESIZE,
580 wxWS_EX_VALIDATE_RECURSIVELY,
581 wxWS_EX_BLOCK_EVENTS,
584 wxWS_EX_THEMED_BACKGROUND,
585 wxWS_EX_PROCESS_IDLE,
586 wxWS_EX_PROCESS_UI_UPDATES,
589 // Mapping modes (as per Windows)
602 // It looks like wxTabCtrl may rise from the dead. Uncomment these if
603 // it gets an implementation for all platforms...
604 // wxTC_RIGHTJUSTIFY,
617 #define wxDEFAULT_STATUSBAR_STYLE wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE
619 #define wxDEFAULT_STATUSBAR_STYLE wxST_SIZEGRIP
624 enum wxGeometryCentre
659 wxALIGN_CENTER_HORIZONTAL,
660 wxALIGN_CENTRE_HORIZONTAL,
665 wxALIGN_CENTER_VERTICAL,
666 wxALIGN_CENTRE_VERTICAL,
739 wxXOR, // src XOR dst
741 wxOR_REVERSE, // src OR (NOT dst)
742 wxAND_REVERSE,// src AND (NOT dst)
744 wxAND, // src AND dst
745 wxAND_INVERT, // (NOT src) AND dst
747 wxNOR, // (NOT src) AND (NOT dst)
748 wxEQUIV, // (NOT src) XOR dst
749 wxSRC_INVERT, // (NOT src)
750 wxOR_INVERT, // (NOT src) OR dst
751 wxNAND, // (NOT src) OR (NOT dst)
754 // wxSRC_OR, // source _bitmap_ OR destination
755 // wxSRC_AND // source _bitmap_ AND destination
778 WXK_PRIOR, /* Page up */
779 WXK_NEXT, /* Page down */
860 WXK_NUMPAD_SEPARATOR,
874 wxPAPER_NONE, // Use specific dimensions
875 wxPAPER_LETTER, // Letter, 8 1/2 by 11 inches
876 wxPAPER_LEGAL, // Legal, 8 1/2 by 14 inches
877 wxPAPER_A4, // A4 Sheet, 210 by 297 millimeters
878 wxPAPER_CSHEET, // C Sheet, 17 by 22 inches
879 wxPAPER_DSHEET, // D Sheet, 22 by 34 inches
880 wxPAPER_ESHEET, // E Sheet, 34 by 44 inches
881 wxPAPER_LETTERSMALL, // Letter Small, 8 1/2 by 11 inches
882 wxPAPER_TABLOID, // Tabloid, 11 by 17 inches
883 wxPAPER_LEDGER, // Ledger, 17 by 11 inches
884 wxPAPER_STATEMENT, // Statement, 5 1/2 by 8 1/2 inches
885 wxPAPER_EXECUTIVE, // Executive, 7 1/4 by 10 1/2 inches
886 wxPAPER_A3, // A3 sheet, 297 by 420 millimeters
887 wxPAPER_A4SMALL, // A4 small sheet, 210 by 297 millimeters
888 wxPAPER_A5, // A5 sheet, 148 by 210 millimeters
889 wxPAPER_B4, // B4 sheet, 250 by 354 millimeters
890 wxPAPER_B5, // B5 sheet, 182-by-257-millimeter paper
891 wxPAPER_FOLIO, // Folio, 8-1/2-by-13-inch paper
892 wxPAPER_QUARTO, // Quarto, 215-by-275-millimeter paper
893 wxPAPER_10X14, // 10-by-14-inch sheet
894 wxPAPER_11X17, // 11-by-17-inch sheet
895 wxPAPER_NOTE, // Note, 8 1/2 by 11 inches
896 wxPAPER_ENV_9, // #9 Envelope, 3 7/8 by 8 7/8 inches
897 wxPAPER_ENV_10, // #10 Envelope, 4 1/8 by 9 1/2 inches
898 wxPAPER_ENV_11, // #11 Envelope, 4 1/2 by 10 3/8 inches
899 wxPAPER_ENV_12, // #12 Envelope, 4 3/4 by 11 inches
900 wxPAPER_ENV_14, // #14 Envelope, 5 by 11 1/2 inches
901 wxPAPER_ENV_DL, // DL Envelope, 110 by 220 millimeters
902 wxPAPER_ENV_C5, // C5 Envelope, 162 by 229 millimeters
903 wxPAPER_ENV_C3, // C3 Envelope, 324 by 458 millimeters
904 wxPAPER_ENV_C4, // C4 Envelope, 229 by 324 millimeters
905 wxPAPER_ENV_C6, // C6 Envelope, 114 by 162 millimeters
906 wxPAPER_ENV_C65, // C65 Envelope, 114 by 229 millimeters
907 wxPAPER_ENV_B4, // B4 Envelope, 250 by 353 millimeters
908 wxPAPER_ENV_B5, // B5 Envelope, 176 by 250 millimeters
909 wxPAPER_ENV_B6, // B6 Envelope, 176 by 125 millimeters
910 wxPAPER_ENV_ITALY, // Italy Envelope, 110 by 230 millimeters
911 wxPAPER_ENV_MONARCH, // Monarch Envelope, 3 7/8 by 7 1/2 inches
912 wxPAPER_ENV_PERSONAL, // 6 3/4 Envelope, 3 5/8 by 6 1/2 inches
913 wxPAPER_FANFOLD_US, // US Std Fanfold, 14 7/8 by 11 inches
914 wxPAPER_FANFOLD_STD_GERMAN, // German Std Fanfold, 8 1/2 by 12 inches
915 wxPAPER_FANFOLD_LGL_GERMAN, // German Legal Fanfold, 8 1/2 by 13 inches
917 wxPAPER_ISO_B4, // B4 (ISO) 250 x 353 mm
918 wxPAPER_JAPANESE_POSTCARD, // Japanese Postcard 100 x 148 mm
919 wxPAPER_9X11, // 9 x 11 in
920 wxPAPER_10X11, // 10 x 11 in
921 wxPAPER_15X11, // 15 x 11 in
922 wxPAPER_ENV_INVITE, // Envelope Invite 220 x 220 mm
923 wxPAPER_LETTER_EXTRA, // Letter Extra 9 \275 x 12 in
924 wxPAPER_LEGAL_EXTRA, // Legal Extra 9 \275 x 15 in
925 wxPAPER_TABLOID_EXTRA, // Tabloid Extra 11.69 x 18 in
926 wxPAPER_A4_EXTRA, // A4 Extra 9.27 x 12.69 in
927 wxPAPER_LETTER_TRANSVERSE, // Letter Transverse 8 \275 x 11 in
928 wxPAPER_A4_TRANSVERSE, // A4 Transverse 210 x 297 mm
929 wxPAPER_LETTER_EXTRA_TRANSVERSE, // Letter Extra Transverse 9\275 x 12 in
930 wxPAPER_A_PLUS, // SuperA/SuperA/A4 227 x 356 mm
931 wxPAPER_B_PLUS, // SuperB/SuperB/A3 305 x 487 mm
932 wxPAPER_LETTER_PLUS, // Letter Plus 8.5 x 12.69 in
933 wxPAPER_A4_PLUS, // A4 Plus 210 x 330 mm
934 wxPAPER_A5_TRANSVERSE, // A5 Transverse 148 x 210 mm
935 wxPAPER_B5_TRANSVERSE, // B5 (JIS) Transverse 182 x 257 mm
936 wxPAPER_A3_EXTRA, // A3 Extra 322 x 445 mm
937 wxPAPER_A5_EXTRA, // A5 Extra 174 x 235 mm
938 wxPAPER_B5_EXTRA, // B5 (ISO) Extra 201 x 276 mm
939 wxPAPER_A2, // A2 420 x 594 mm
940 wxPAPER_A3_TRANSVERSE, // A3 Transverse 297 x 420 mm
941 wxPAPER_A3_EXTRA_TRANSVERSE // A3 Extra Transverse 322 x 445 mm
946 wxDUPLEX_SIMPLEX, // Non-duplex
953 // menu and toolbar item kinds
969 wxHT_SCROLLBAR_FIRST = wxHT_NOWHERE,
970 wxHT_SCROLLBAR_ARROW_LINE_1, // left or upper arrow to scroll by line
971 wxHT_SCROLLBAR_ARROW_LINE_2, // right or down
972 wxHT_SCROLLBAR_ARROW_PAGE_1, // left or upper arrow to scroll by page
973 wxHT_SCROLLBAR_ARROW_PAGE_2, // right or down
974 wxHT_SCROLLBAR_THUMB, // on the thumb
975 wxHT_SCROLLBAR_BAR_1, // bar to the left/above the thumb
976 wxHT_SCROLLBAR_BAR_2, // bar to the right/below the thumb
980 wxHT_WINDOW_OUTSIDE, // not in this window at all
981 wxHT_WINDOW_INSIDE, // in the client area
982 wxHT_WINDOW_VERT_SCROLLBAR, // on the vertical scrollbar
983 wxHT_WINDOW_HORZ_SCROLLBAR, // on the horizontal scrollbar
984 wxHT_WINDOW_CORNER, // on the corner between 2 scrollbars
992 enum wxHotkeyModifier
1000 #define wxEVT_HOTKEY 9999
1004 enum wxHotkeyModifier
1016 wxUPDATE_UI_NONE = 0x0000,
1017 wxUPDATE_UI_RECURSE = 0x0001,
1018 wxUPDATE_UI_FROMIDLE = 0x0002 // Invoked from On(Internal)Idle
1023 //---------------------------------------------------------------------------