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 %pythonAppend %feature("pythonappend")
44 #define %pythonPrepend %feature("pythonprepend")
45 #define %kwargs %feature("kwargs")
46 #define %nokwargs %feature("nokwargs")
49 //#define %shadow %insert("shadow")
53 #define %pythoncode %insert("python")
59 // Given the name of a wxChar (or wxString) constant in C++, make
60 // a static wxString for wxPython, and also let SWIG wrap it.
61 %define MAKE_CONST_WXSTRING(strname)
62 %{ static const wxString wxPy##strname(wx##strname); %}
64 %name(strname) const wxString wxPy##strname;
68 %define MAKE_CONST_WXSTRING2(strname, val)
69 %{ static const wxString wxPy##strname(val); %}
71 %name(strname) const wxString wxPy##strname;
75 %define MAKE_CONST_WXSTRING_NOSWIG(strname)
76 %{ static const wxString wxPy##strname(wx##strname); %}
79 // Generate code in the module init for the event types, since they may not be
80 // initialized yet when they are used in the static swig_const_table.
81 %typemap(consttab) wxEventType; // TODO: how to prevent code inserted into the consttab?
82 %typemap(constcode) wxEventType "PyDict_SetItemString(d, \"$symname\", PyInt_FromLong($value));";
86 //----------------------------------------------------------------------
87 // Macros for the docstring and autodoc features of SWIG. These will
88 // help make the code look more readable, and pretty, as well as help
89 // reduce typing in some cases.
91 // Set the docsring for the given full or partial declaration
93 %define DocStr(decl, docstr, details)
94 %feature("docstring") decl docstr details;
97 %define DocStr(decl, docstr, details)
98 %feature("docstring") decl docstr;
103 // Set the autodoc string for a full or partial declaration
104 %define DocA(decl, astr)
105 %feature("autodoc") decl astr;
109 // Set both the autodoc and docstring for a full or partial declaration
111 %define DocAStr(decl, astr, docstr, details)
112 %feature("autodoc") decl astr;
113 %feature("docstring") decl docstr details
116 %define DocAStr(decl, astr, docstr, details)
117 %feature("autodoc") decl astr;
118 %feature("docstring") decl docstr
125 // Set the docstring for a decl and then define the decl too. Must use the
126 // full declaration of the item.
128 %define DocDeclStr(type, decl, docstr, details)
129 %feature("docstring") decl docstr details;
133 %define DocDeclStr(type, decl, docstr, details)
134 %feature("docstring") decl docstr;
141 // As above, but also give the decl a new %name
143 %define DocDeclStrName(type, decl, docstr, details, newname)
144 %feature("docstring") decl docstr details;
145 %name(newname) type decl
148 %define DocDeclStrName(type, decl, docstr, details, newname)
149 %feature("docstring") decl docstr;
150 %name(newname) type decl
155 // Set the autodoc string for a decl and then define the decl too. Must use the
156 // full declaration of the item.
157 %define DocDeclA(type, decl, astr)
158 %feature("autodoc") decl astr;
162 // As above, but also give the decl a new %name
163 %define DocDeclAName(type, decl, astr, newname)
164 %feature("autodoc") decl astr;
165 %name(newname) type decl
170 // Set the autodoc and the docstring for a decl and then define the decl too.
171 // Must use the full declaration of the item.
173 %define DocDeclAStr(type, decl, astr, details, docstr)
174 %feature("autodoc") decl astr;
175 %feature("docstring") decl docstr details;
179 %define DocDeclAStr(type, decl, astr, details, docstr)
180 %feature("autodoc") decl astr;
181 %feature("docstring") decl docstr;
187 // As above, but also give the decl a new %name
189 %define DocDeclAStrName(type, decl, astr, docstr, details, newname)
190 %feature("autodoc") decl astr;
191 %feature("docstring") decl docstr details;
192 %name(newname) type decl
195 %define DocDeclAStrName(type, decl, astr, docstr, details, newname)
196 %feature("autodoc") decl astr;
197 %feature("docstring") decl docstr;
198 %name(newname) type decl
204 // Set the docstring for a constructor decl and then define the decl too.
205 // Must use the full declaration of the item.
207 %define DocCtorStr(decl, docstr, details)
208 %feature("docstring") decl docstr details;
212 %define DocCtorStr(decl, docstr, details)
213 %feature("docstring") decl docstr;
219 // As above, but also give the decl a new %name
221 %define DocCtorStrName(decl, docstr, details, newname)
222 %feature("docstring") decl docstr details;
226 %define DocCtorStrName(decl, docstr, details, newname)
227 %feature("docstring") decl docstr;
234 // Set the autodoc string for a constructor decl and then define the decl too.
235 // Must use the full declaration of the item.
236 %define DocCtorA(decl, astr)
237 %feature("autodoc") decl astr;
241 // As above, but also give the decl a new %name
242 %define DocCtorAName(decl, astr, newname)
243 %feature("autodoc") decl astr;
249 // Set the autodoc and the docstring for a constructor decl and then define
250 // the decl too. Must use the full declaration of the item.
252 %define DocCtorAStr(decl, astr, docstr, details)
253 %feature("autodoc") decl astr;
254 %feature("docstring") decl docstr details;
258 %define DocCtorAStr(decl, astr, docstr, details)
259 %feature("autodoc") decl astr;
260 %feature("docstring") decl docstr;
267 // As above, but also give the decl a new %name
269 %define DocCtorAStrName(decl, astr, docstr, details, newname)
270 %feature("autodoc") decl astr;
271 %feature("docstring") decl docstr details;
275 %define DocCtorAStrName(decl, astr, docstr, details, newname)
276 %feature("autodoc") decl astr;
277 %feature("docstring") decl docstr;
286 %#---------------------------------------------------------------------------
290 //---------------------------------------------------------------------------
291 // Forward declarations and %renames for some classes, so the autodoc strings
292 // will be able to use the right types even when the real class declaration is
293 // not in the module being processed.
295 #ifdef BUILDING_RENAMERS
296 #define FORWARD_DECLARE(wxName, Name)
298 %define FORWARD_DECLARE(wxName, Name)
299 %rename(Name) wxName;
304 FORWARD_DECLARE(wxString, String);
305 FORWARD_DECLARE(wxBitmap, Bitmap);
306 FORWARD_DECLARE(wxDateTime, DateTime);
307 FORWARD_DECLARE(wxInputStream, InputStream);
308 FORWARD_DECLARE(wxDC, DC);
309 FORWARD_DECLARE(wxCursor, Cursor);
310 FORWARD_DECLARE(wxRegion, Region);
311 FORWARD_DECLARE(wxColour, Colour);
312 FORWARD_DECLARE(wxFont, Font);
313 FORWARD_DECLARE(wxCaret, Caret);
314 FORWARD_DECLARE(wxToolTip, ToolTip);
315 FORWARD_DECLARE(wxPyDropTarget, DropTarget);
316 FORWARD_DECLARE(wxImageList, ImageList);
317 FORWARD_DECLARE(wxMemoryDC, MemoryDC);
318 FORWARD_DECLARE(wxHtmlTagHandler, HtmlTagHandler);
319 FORWARD_DECLARE(wxConfigBase, ConfigBase);
320 FORWARD_DECLARE(wxIcon, Icon);
323 //---------------------------------------------------------------------------
325 // General numeric #define's and etc. Making them all enums makes SWIG use the
326 // real macro when making the Python Int
344 wxTRANSPARENT_WINDOW,
444 wxSIZE_ALLOW_MINUS_ONE,
447 wxPRINT_QUALITY_HIGH,
448 wxPRINT_QUALITY_MEDIUM,
450 wxPRINT_QUALITY_DRAFT,
472 wxID_HELP_PROCEDURES,
491 wxID_VIEW_LARGEICONS,
492 wxID_VIEW_SMALLICONS,
555 wxNO_FULL_REPAINT_ON_RESIZE,
556 wxFULL_REPAINT_ON_RESIZE,
561 wxWS_EX_VALIDATE_RECURSIVELY,
562 wxWS_EX_BLOCK_EVENTS,
565 wxWS_EX_THEMED_BACKGROUND,
566 wxWS_EX_PROCESS_IDLE,
567 wxWS_EX_PROCESS_UI_UPDATES,
570 // Mapping modes (as per Windows)
583 // It looks like wxTabCtrl may rise from the dead. Uncomment these if
584 // it gets an implementation for all platforms...
585 // wxTC_RIGHTJUSTIFY,
598 #define wxDEFAULT_STATUSBAR_STYLE wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE
600 #define wxDEFAULT_STATUSBAR_STYLE wxST_SIZEGRIP
605 enum wxGeometryCentre
640 wxALIGN_CENTER_HORIZONTAL,
641 wxALIGN_CENTRE_HORIZONTAL,
646 wxALIGN_CENTER_VERTICAL,
647 wxALIGN_CENTRE_VERTICAL,
720 wxXOR, // src XOR dst
722 wxOR_REVERSE, // src OR (NOT dst)
723 wxAND_REVERSE,// src AND (NOT dst)
725 wxAND, // src AND dst
726 wxAND_INVERT, // (NOT src) AND dst
728 wxNOR, // (NOT src) AND (NOT dst)
729 wxEQUIV, // (NOT src) XOR dst
730 wxSRC_INVERT, // (NOT src)
731 wxOR_INVERT, // (NOT src) OR dst
732 wxNAND, // (NOT src) OR (NOT dst)
735 // wxSRC_OR, // source _bitmap_ OR destination
736 // wxSRC_AND // source _bitmap_ AND destination
759 WXK_PRIOR, /* Page up */
760 WXK_NEXT, /* Page down */
841 WXK_NUMPAD_SEPARATOR,
855 wxPAPER_NONE, // Use specific dimensions
856 wxPAPER_LETTER, // Letter, 8 1/2 by 11 inches
857 wxPAPER_LEGAL, // Legal, 8 1/2 by 14 inches
858 wxPAPER_A4, // A4 Sheet, 210 by 297 millimeters
859 wxPAPER_CSHEET, // C Sheet, 17 by 22 inches
860 wxPAPER_DSHEET, // D Sheet, 22 by 34 inches
861 wxPAPER_ESHEET, // E Sheet, 34 by 44 inches
862 wxPAPER_LETTERSMALL, // Letter Small, 8 1/2 by 11 inches
863 wxPAPER_TABLOID, // Tabloid, 11 by 17 inches
864 wxPAPER_LEDGER, // Ledger, 17 by 11 inches
865 wxPAPER_STATEMENT, // Statement, 5 1/2 by 8 1/2 inches
866 wxPAPER_EXECUTIVE, // Executive, 7 1/4 by 10 1/2 inches
867 wxPAPER_A3, // A3 sheet, 297 by 420 millimeters
868 wxPAPER_A4SMALL, // A4 small sheet, 210 by 297 millimeters
869 wxPAPER_A5, // A5 sheet, 148 by 210 millimeters
870 wxPAPER_B4, // B4 sheet, 250 by 354 millimeters
871 wxPAPER_B5, // B5 sheet, 182-by-257-millimeter paper
872 wxPAPER_FOLIO, // Folio, 8-1/2-by-13-inch paper
873 wxPAPER_QUARTO, // Quarto, 215-by-275-millimeter paper
874 wxPAPER_10X14, // 10-by-14-inch sheet
875 wxPAPER_11X17, // 11-by-17-inch sheet
876 wxPAPER_NOTE, // Note, 8 1/2 by 11 inches
877 wxPAPER_ENV_9, // #9 Envelope, 3 7/8 by 8 7/8 inches
878 wxPAPER_ENV_10, // #10 Envelope, 4 1/8 by 9 1/2 inches
879 wxPAPER_ENV_11, // #11 Envelope, 4 1/2 by 10 3/8 inches
880 wxPAPER_ENV_12, // #12 Envelope, 4 3/4 by 11 inches
881 wxPAPER_ENV_14, // #14 Envelope, 5 by 11 1/2 inches
882 wxPAPER_ENV_DL, // DL Envelope, 110 by 220 millimeters
883 wxPAPER_ENV_C5, // C5 Envelope, 162 by 229 millimeters
884 wxPAPER_ENV_C3, // C3 Envelope, 324 by 458 millimeters
885 wxPAPER_ENV_C4, // C4 Envelope, 229 by 324 millimeters
886 wxPAPER_ENV_C6, // C6 Envelope, 114 by 162 millimeters
887 wxPAPER_ENV_C65, // C65 Envelope, 114 by 229 millimeters
888 wxPAPER_ENV_B4, // B4 Envelope, 250 by 353 millimeters
889 wxPAPER_ENV_B5, // B5 Envelope, 176 by 250 millimeters
890 wxPAPER_ENV_B6, // B6 Envelope, 176 by 125 millimeters
891 wxPAPER_ENV_ITALY, // Italy Envelope, 110 by 230 millimeters
892 wxPAPER_ENV_MONARCH, // Monarch Envelope, 3 7/8 by 7 1/2 inches
893 wxPAPER_ENV_PERSONAL, // 6 3/4 Envelope, 3 5/8 by 6 1/2 inches
894 wxPAPER_FANFOLD_US, // US Std Fanfold, 14 7/8 by 11 inches
895 wxPAPER_FANFOLD_STD_GERMAN, // German Std Fanfold, 8 1/2 by 12 inches
896 wxPAPER_FANFOLD_LGL_GERMAN, // German Legal Fanfold, 8 1/2 by 13 inches
898 wxPAPER_ISO_B4, // B4 (ISO) 250 x 353 mm
899 wxPAPER_JAPANESE_POSTCARD, // Japanese Postcard 100 x 148 mm
900 wxPAPER_9X11, // 9 x 11 in
901 wxPAPER_10X11, // 10 x 11 in
902 wxPAPER_15X11, // 15 x 11 in
903 wxPAPER_ENV_INVITE, // Envelope Invite 220 x 220 mm
904 wxPAPER_LETTER_EXTRA, // Letter Extra 9 \275 x 12 in
905 wxPAPER_LEGAL_EXTRA, // Legal Extra 9 \275 x 15 in
906 wxPAPER_TABLOID_EXTRA, // Tabloid Extra 11.69 x 18 in
907 wxPAPER_A4_EXTRA, // A4 Extra 9.27 x 12.69 in
908 wxPAPER_LETTER_TRANSVERSE, // Letter Transverse 8 \275 x 11 in
909 wxPAPER_A4_TRANSVERSE, // A4 Transverse 210 x 297 mm
910 wxPAPER_LETTER_EXTRA_TRANSVERSE, // Letter Extra Transverse 9\275 x 12 in
911 wxPAPER_A_PLUS, // SuperA/SuperA/A4 227 x 356 mm
912 wxPAPER_B_PLUS, // SuperB/SuperB/A3 305 x 487 mm
913 wxPAPER_LETTER_PLUS, // Letter Plus 8.5 x 12.69 in
914 wxPAPER_A4_PLUS, // A4 Plus 210 x 330 mm
915 wxPAPER_A5_TRANSVERSE, // A5 Transverse 148 x 210 mm
916 wxPAPER_B5_TRANSVERSE, // B5 (JIS) Transverse 182 x 257 mm
917 wxPAPER_A3_EXTRA, // A3 Extra 322 x 445 mm
918 wxPAPER_A5_EXTRA, // A5 Extra 174 x 235 mm
919 wxPAPER_B5_EXTRA, // B5 (ISO) Extra 201 x 276 mm
920 wxPAPER_A2, // A2 420 x 594 mm
921 wxPAPER_A3_TRANSVERSE, // A3 Transverse 297 x 420 mm
922 wxPAPER_A3_EXTRA_TRANSVERSE // A3 Extra Transverse 322 x 445 mm
927 wxDUPLEX_SIMPLEX, // Non-duplex
934 // menu and toolbar item kinds
950 wxHT_SCROLLBAR_FIRST = wxHT_NOWHERE,
951 wxHT_SCROLLBAR_ARROW_LINE_1, // left or upper arrow to scroll by line
952 wxHT_SCROLLBAR_ARROW_LINE_2, // right or down
953 wxHT_SCROLLBAR_ARROW_PAGE_1, // left or upper arrow to scroll by page
954 wxHT_SCROLLBAR_ARROW_PAGE_2, // right or down
955 wxHT_SCROLLBAR_THUMB, // on the thumb
956 wxHT_SCROLLBAR_BAR_1, // bar to the left/above the thumb
957 wxHT_SCROLLBAR_BAR_2, // bar to the right/below the thumb
961 wxHT_WINDOW_OUTSIDE, // not in this window at all
962 wxHT_WINDOW_INSIDE, // in the client area
963 wxHT_WINDOW_VERT_SCROLLBAR, // on the vertical scrollbar
964 wxHT_WINDOW_HORZ_SCROLLBAR, // on the horizontal scrollbar
965 wxHT_WINDOW_CORNER, // on the corner between 2 scrollbars
973 enum wxHotkeyModifier
981 #define wxEVT_HOTKEY 9999
985 enum wxHotkeyModifier
997 wxUPDATE_UI_NONE = 0x0000,
998 wxUPDATE_UI_RECURSE = 0x0001,
999 wxUPDATE_UI_FROMIDLE = 0x0002 // Invoked from On(Internal)Idle
1004 //---------------------------------------------------------------------------