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
19 //---------------------------------------------------------------------------
20 // Tell SWIG to wrap all the wrappers with our thread protection by default
23 PyThreadState* __tstate = wxPyBeginAllowThreads();
25 wxPyEndAllowThreads(__tstate);
26 if (PyErr_Occurred()) SWIG_fail;
30 // This one can be used to add a check for an existing wxApp before the real
31 // work is done. An exception is raised if there isn't one.
32 %define MustHaveApp(name)
34 if (!wxPyCheckForApp()) SWIG_fail;
35 PyThreadState* __tstate = wxPyBeginAllowThreads();
37 wxPyEndAllowThreads(__tstate);
38 if (PyErr_Occurred()) SWIG_fail;
44 //---------------------------------------------------------------------------
45 // some type definitions to simplify things for SWIG
47 typedef int wxEventType;
48 typedef unsigned int size_t;
49 typedef unsigned int time_t;
50 typedef unsigned char byte;
51 typedef unsigned long wxUIntPtr;
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")
66 #define %noautodoc %feature("noautodoc")
70 //#define %shadow %insert("shadow")
74 #define %pythoncode %insert("python")
80 // Given the name of a wxChar (or wxString) constant in C++, make
81 // a static wxString for wxPython, and also let SWIG wrap it.
82 %define MAKE_CONST_WXSTRING(strname)
83 %{ static const wxString wxPy##strname(wx##strname); %}
85 %name(strname) const wxString wxPy##strname;
89 %define MAKE_CONST_WXSTRING2(strname, val)
90 %{ static const wxString wxPy##strname(val); %}
92 %name(strname) const wxString wxPy##strname;
96 %define MAKE_CONST_WXSTRING_NOSWIG(strname)
97 %{ static const wxString wxPy##strname(wx##strname); %}
100 // Generate code in the module init for the event types, since they may not be
101 // initialized yet when they are used in the static swig_const_table.
102 %typemap(consttab) wxEventType; // TODO: how to prevent code inserted into the consttab?
103 %typemap(constcode) wxEventType "PyDict_SetItemString(d, \"$symname\", PyInt_FromLong($value));";
107 //----------------------------------------------------------------------
108 // Macros for the docstring and autodoc features of SWIG. These will
109 // help make the code look more readable, and pretty, as well as help
110 // reduce typing in some cases.
112 // Set the docsring for the given full or partial declaration
114 %define DocStr(decl, docstr, details)
115 %feature("docstring") decl docstr details;
118 %define DocStr(decl, docstr, details)
119 %feature("docstring") decl docstr;
124 // Set the autodoc string for a full or partial declaration
125 %define DocA(decl, astr)
126 %feature("autodoc") decl astr;
130 // Set both the autodoc and docstring for a full or partial declaration
132 %define DocAStr(decl, astr, docstr, details)
133 %feature("autodoc") decl astr;
134 %feature("docstring") decl docstr details
137 %define DocAStr(decl, astr, docstr, details)
138 %feature("autodoc") decl astr;
139 %feature("docstring") decl docstr
146 // Set the docstring for a decl and then define the decl too. Must use the
147 // full declaration of the item.
149 %define DocDeclStr(type, decl, docstr, details)
150 %feature("docstring") decl docstr details;
154 %define DocDeclStr(type, decl, docstr, details)
155 %feature("docstring") decl docstr;
162 // As above, but also give the decl a new %name
164 %define DocDeclStrName(type, decl, docstr, details, newname)
165 %feature("docstring") decl docstr details;
166 %name(newname) type decl
169 %define DocDeclStrName(type, decl, docstr, details, newname)
170 %feature("docstring") decl docstr;
171 %name(newname) type decl
176 // Set the autodoc string for a decl and then define the decl too. Must use the
177 // full declaration of the item.
178 %define DocDeclA(type, decl, astr)
179 %feature("autodoc") decl astr;
183 // As above, but also give the decl a new %name
184 %define DocDeclAName(type, decl, astr, newname)
185 %feature("autodoc") decl astr;
186 %name(newname) type decl
191 // Set the autodoc and the docstring for a decl and then define the decl too.
192 // Must use the full declaration of the item.
194 %define DocDeclAStr(type, decl, astr, docstr, details)
195 %feature("autodoc") decl astr;
196 %feature("docstring") decl docstr details;
200 %define DocDeclAStr(type, decl, astr, docstr, details)
201 %feature("autodoc") decl astr;
202 %feature("docstring") decl docstr;
208 // As above, but also give the decl a new %name
210 %define DocDeclAStrName(type, decl, astr, docstr, details, newname)
211 %feature("autodoc") decl astr;
212 %feature("docstring") decl docstr details;
213 %name(newname) type decl
216 %define DocDeclAStrName(type, decl, astr, docstr, details, newname)
217 %feature("autodoc") decl astr;
218 %feature("docstring") decl docstr;
219 %name(newname) type decl
225 // Set the docstring for a constructor decl and then define the decl too.
226 // Must use the full declaration of the item.
228 %define DocCtorStr(decl, docstr, details)
229 %feature("docstring") decl docstr details;
233 %define DocCtorStr(decl, docstr, details)
234 %feature("docstring") decl docstr;
240 // As above, but also give the decl a new %name
242 %define DocCtorStrName(decl, docstr, details, newname)
243 %feature("docstring") decl docstr details;
247 %define DocCtorStrName(decl, docstr, details, newname)
248 %feature("docstring") decl docstr;
255 // Set the autodoc string for a constructor decl and then define the decl too.
256 // Must use the full declaration of the item.
257 %define DocCtorA(decl, astr)
258 %feature("autodoc") decl astr;
262 // As above, but also give the decl a new %name
263 %define DocCtorAName(decl, astr, newname)
264 %feature("autodoc") decl astr;
270 // Set the autodoc and the docstring for a constructor decl and then define
271 // the decl too. Must use the full declaration of the item.
273 %define DocCtorAStr(decl, astr, docstr, details)
274 %feature("autodoc") decl astr;
275 %feature("docstring") decl docstr details;
279 %define DocCtorAStr(decl, astr, docstr, details)
280 %feature("autodoc") decl astr;
281 %feature("docstring") decl docstr;
288 // As above, but also give the decl a new %name
290 %define DocCtorAStrName(decl, astr, docstr, details, newname)
291 %feature("autodoc") decl astr;
292 %feature("docstring") decl docstr details;
296 %define DocCtorAStrName(decl, astr, docstr, details, newname)
297 %feature("autodoc") decl astr;
298 %feature("docstring") decl docstr;
307 %#---------------------------------------------------------------------------
311 //---------------------------------------------------------------------------
312 // Forward declarations and %renames for some classes, so the autodoc strings
313 // will be able to use the right types even when the real class declaration is
314 // not in the module being processed or seen by %import's.
316 #ifdef BUILDING_RENAMERS
317 #define FORWARD_DECLARE(wxName, Name)
319 %define FORWARD_DECLARE(wxName, Name)
320 %rename(Name) wxName;
325 FORWARD_DECLARE(wxString, String);
326 FORWARD_DECLARE(wxBitmap, Bitmap);
327 FORWARD_DECLARE(wxDateTime, DateTime);
328 FORWARD_DECLARE(wxInputStream, InputStream);
329 FORWARD_DECLARE(wxDC, DC);
330 FORWARD_DECLARE(wxCursor, Cursor);
331 FORWARD_DECLARE(wxRegion, Region);
332 FORWARD_DECLARE(wxColour, Colour);
333 FORWARD_DECLARE(wxFont, Font);
334 FORWARD_DECLARE(wxCaret, Caret);
335 FORWARD_DECLARE(wxToolTip, ToolTip);
336 FORWARD_DECLARE(wxPyDropTarget, DropTarget);
337 FORWARD_DECLARE(wxImageList, ImageList);
338 FORWARD_DECLARE(wxMemoryDC, MemoryDC);
339 FORWARD_DECLARE(wxHtmlTagHandler, HtmlTagHandler);
340 FORWARD_DECLARE(wxConfigBase, ConfigBase);
341 FORWARD_DECLARE(wxIcon, Icon);
342 FORWARD_DECLARE(wxStaticBox, StaticBox);
345 //---------------------------------------------------------------------------
347 // General numeric #define's and etc. Making them all enums makes SWIG use the
348 // real macro when making the Python Int
366 wxTRANSPARENT_WINDOW,
466 wxSIZE_ALLOW_MINUS_ONE,
469 wxPRINT_QUALITY_HIGH,
470 wxPRINT_QUALITY_MEDIUM,
472 wxPRINT_QUALITY_DRAFT,
494 wxID_HELP_PROCEDURES,
513 wxID_VIEW_LARGEICONS,
514 wxID_VIEW_SMALLICONS,
574 wxID_REVERT_TO_SAVED,
603 wxNO_FULL_REPAINT_ON_RESIZE,
604 wxFULL_REPAINT_ON_RESIZE,
609 wxWS_EX_VALIDATE_RECURSIVELY,
610 wxWS_EX_BLOCK_EVENTS,
613 wxWS_EX_THEMED_BACKGROUND,
614 wxWS_EX_PROCESS_IDLE,
615 wxWS_EX_PROCESS_UI_UPDATES,
618 // Mapping modes (as per Windows)
631 // It looks like wxTabCtrl may rise from the dead. Uncomment these if
632 // it gets an implementation for all platforms...
633 // wxTC_RIGHTJUSTIFY,
646 #define wxDEFAULT_STATUSBAR_STYLE wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE
648 #define wxDEFAULT_STATUSBAR_STYLE wxST_SIZEGRIP
653 enum wxGeometryCentre
688 wxALIGN_CENTER_HORIZONTAL,
689 wxALIGN_CENTRE_HORIZONTAL,
694 wxALIGN_CENTER_VERTICAL,
695 wxALIGN_CENTRE_VERTICAL,
729 enum wxBackgroundStyle
776 wxXOR, // src XOR dst
778 wxOR_REVERSE, // src OR (NOT dst)
779 wxAND_REVERSE,// src AND (NOT dst)
781 wxAND, // src AND dst
782 wxAND_INVERT, // (NOT src) AND dst
784 wxNOR, // (NOT src) AND (NOT dst)
785 wxEQUIV, // (NOT src) XOR dst
786 wxSRC_INVERT, // (NOT src)
787 wxOR_INVERT, // (NOT src) OR dst
788 wxNAND, // (NOT src) OR (NOT dst)
791 // wxSRC_OR, // source _bitmap_ OR destination
792 // wxSRC_AND // source _bitmap_ AND destination
815 WXK_PRIOR, /* Page up */
816 WXK_NEXT, /* Page down */
897 WXK_NUMPAD_SEPARATOR,
911 wxPAPER_NONE, // Use specific dimensions
912 wxPAPER_LETTER, // Letter, 8 1/2 by 11 inches
913 wxPAPER_LEGAL, // Legal, 8 1/2 by 14 inches
914 wxPAPER_A4, // A4 Sheet, 210 by 297 millimeters
915 wxPAPER_CSHEET, // C Sheet, 17 by 22 inches
916 wxPAPER_DSHEET, // D Sheet, 22 by 34 inches
917 wxPAPER_ESHEET, // E Sheet, 34 by 44 inches
918 wxPAPER_LETTERSMALL, // Letter Small, 8 1/2 by 11 inches
919 wxPAPER_TABLOID, // Tabloid, 11 by 17 inches
920 wxPAPER_LEDGER, // Ledger, 17 by 11 inches
921 wxPAPER_STATEMENT, // Statement, 5 1/2 by 8 1/2 inches
922 wxPAPER_EXECUTIVE, // Executive, 7 1/4 by 10 1/2 inches
923 wxPAPER_A3, // A3 sheet, 297 by 420 millimeters
924 wxPAPER_A4SMALL, // A4 small sheet, 210 by 297 millimeters
925 wxPAPER_A5, // A5 sheet, 148 by 210 millimeters
926 wxPAPER_B4, // B4 sheet, 250 by 354 millimeters
927 wxPAPER_B5, // B5 sheet, 182-by-257-millimeter paper
928 wxPAPER_FOLIO, // Folio, 8-1/2-by-13-inch paper
929 wxPAPER_QUARTO, // Quarto, 215-by-275-millimeter paper
930 wxPAPER_10X14, // 10-by-14-inch sheet
931 wxPAPER_11X17, // 11-by-17-inch sheet
932 wxPAPER_NOTE, // Note, 8 1/2 by 11 inches
933 wxPAPER_ENV_9, // #9 Envelope, 3 7/8 by 8 7/8 inches
934 wxPAPER_ENV_10, // #10 Envelope, 4 1/8 by 9 1/2 inches
935 wxPAPER_ENV_11, // #11 Envelope, 4 1/2 by 10 3/8 inches
936 wxPAPER_ENV_12, // #12 Envelope, 4 3/4 by 11 inches
937 wxPAPER_ENV_14, // #14 Envelope, 5 by 11 1/2 inches
938 wxPAPER_ENV_DL, // DL Envelope, 110 by 220 millimeters
939 wxPAPER_ENV_C5, // C5 Envelope, 162 by 229 millimeters
940 wxPAPER_ENV_C3, // C3 Envelope, 324 by 458 millimeters
941 wxPAPER_ENV_C4, // C4 Envelope, 229 by 324 millimeters
942 wxPAPER_ENV_C6, // C6 Envelope, 114 by 162 millimeters
943 wxPAPER_ENV_C65, // C65 Envelope, 114 by 229 millimeters
944 wxPAPER_ENV_B4, // B4 Envelope, 250 by 353 millimeters
945 wxPAPER_ENV_B5, // B5 Envelope, 176 by 250 millimeters
946 wxPAPER_ENV_B6, // B6 Envelope, 176 by 125 millimeters
947 wxPAPER_ENV_ITALY, // Italy Envelope, 110 by 230 millimeters
948 wxPAPER_ENV_MONARCH, // Monarch Envelope, 3 7/8 by 7 1/2 inches
949 wxPAPER_ENV_PERSONAL, // 6 3/4 Envelope, 3 5/8 by 6 1/2 inches
950 wxPAPER_FANFOLD_US, // US Std Fanfold, 14 7/8 by 11 inches
951 wxPAPER_FANFOLD_STD_GERMAN, // German Std Fanfold, 8 1/2 by 12 inches
952 wxPAPER_FANFOLD_LGL_GERMAN, // German Legal Fanfold, 8 1/2 by 13 inches
954 wxPAPER_ISO_B4, // B4 (ISO) 250 x 353 mm
955 wxPAPER_JAPANESE_POSTCARD, // Japanese Postcard 100 x 148 mm
956 wxPAPER_9X11, // 9 x 11 in
957 wxPAPER_10X11, // 10 x 11 in
958 wxPAPER_15X11, // 15 x 11 in
959 wxPAPER_ENV_INVITE, // Envelope Invite 220 x 220 mm
960 wxPAPER_LETTER_EXTRA, // Letter Extra 9 \275 x 12 in
961 wxPAPER_LEGAL_EXTRA, // Legal Extra 9 \275 x 15 in
962 wxPAPER_TABLOID_EXTRA, // Tabloid Extra 11.69 x 18 in
963 wxPAPER_A4_EXTRA, // A4 Extra 9.27 x 12.69 in
964 wxPAPER_LETTER_TRANSVERSE, // Letter Transverse 8 \275 x 11 in
965 wxPAPER_A4_TRANSVERSE, // A4 Transverse 210 x 297 mm
966 wxPAPER_LETTER_EXTRA_TRANSVERSE, // Letter Extra Transverse 9\275 x 12 in
967 wxPAPER_A_PLUS, // SuperA/SuperA/A4 227 x 356 mm
968 wxPAPER_B_PLUS, // SuperB/SuperB/A3 305 x 487 mm
969 wxPAPER_LETTER_PLUS, // Letter Plus 8.5 x 12.69 in
970 wxPAPER_A4_PLUS, // A4 Plus 210 x 330 mm
971 wxPAPER_A5_TRANSVERSE, // A5 Transverse 148 x 210 mm
972 wxPAPER_B5_TRANSVERSE, // B5 (JIS) Transverse 182 x 257 mm
973 wxPAPER_A3_EXTRA, // A3 Extra 322 x 445 mm
974 wxPAPER_A5_EXTRA, // A5 Extra 174 x 235 mm
975 wxPAPER_B5_EXTRA, // B5 (ISO) Extra 201 x 276 mm
976 wxPAPER_A2, // A2 420 x 594 mm
977 wxPAPER_A3_TRANSVERSE, // A3 Transverse 297 x 420 mm
978 wxPAPER_A3_EXTRA_TRANSVERSE // A3 Extra Transverse 322 x 445 mm
983 wxDUPLEX_SIMPLEX, // Non-duplex
990 // menu and toolbar item kinds
1006 wxHT_SCROLLBAR_FIRST = wxHT_NOWHERE,
1007 wxHT_SCROLLBAR_ARROW_LINE_1, // left or upper arrow to scroll by line
1008 wxHT_SCROLLBAR_ARROW_LINE_2, // right or down
1009 wxHT_SCROLLBAR_ARROW_PAGE_1, // left or upper arrow to scroll by page
1010 wxHT_SCROLLBAR_ARROW_PAGE_2, // right or down
1011 wxHT_SCROLLBAR_THUMB, // on the thumb
1012 wxHT_SCROLLBAR_BAR_1, // bar to the left/above the thumb
1013 wxHT_SCROLLBAR_BAR_2, // bar to the right/below the thumb
1014 wxHT_SCROLLBAR_LAST,
1017 wxHT_WINDOW_OUTSIDE, // not in this window at all
1018 wxHT_WINDOW_INSIDE, // in the client area
1019 wxHT_WINDOW_VERT_SCROLLBAR, // on the vertical scrollbar
1020 wxHT_WINDOW_HORZ_SCROLLBAR, // on the horizontal scrollbar
1021 wxHT_WINDOW_CORNER, // on the corner between 2 scrollbars
1029 enum wxHotkeyModifier
1037 #define wxEVT_HOTKEY 9999
1041 enum wxHotkeyModifier
1053 wxUPDATE_UI_NONE = 0x0000,
1054 wxUPDATE_UI_RECURSE = 0x0001,
1055 wxUPDATE_UI_FROMIDLE = 0x0002 // Invoked from On(Internal)Idle
1060 //---------------------------------------------------------------------------