]>
Commit | Line | Data |
---|---|---|
bb0054cd RD |
1 | ///////////////////////////////////////////////////////////////////////////// |
2 | // Name: misc2.i | |
3 | // Purpose: Definitions of miscelaneous functions and classes that need | |
4 | // to know about wxWindow. (So they can't be in misc.i or an | |
5 | // import loop will happen.) | |
6 | // | |
7 | // Author: Robin Dunn | |
8 | // | |
9 | // Created: 18-June-1999 | |
10 | // RCS-ID: $Id$ | |
11 | // Copyright: (c) 1998 by Total Control Software | |
12 | // Licence: wxWindows license | |
13 | ///////////////////////////////////////////////////////////////////////////// | |
14 | ||
15 | %module misc2 | |
16 | ||
17 | %{ | |
18 | #include "helpers.h" | |
4152e8b9 | 19 | #include "pyistream.h" |
bb0054cd RD |
20 | #include <wx/resource.h> |
21 | #include <wx/tooltip.h> | |
f0261a72 RD |
22 | #include <wx/caret.h> |
23 | #include <wx/fontenum.h> | |
f6bcfd97 | 24 | #include <wx/tipdlg.h> |
c368d904 | 25 | #include <wx/process.h> |
493f1553 RD |
26 | |
27 | #if wxUSE_JOYSTICK || defined(__WXMSW__) | |
185d7c3e | 28 | #include <wx/joystick.h> |
4662be59 | 29 | #endif |
493f1553 RD |
30 | |
31 | #if wxUSE_WAVE || defined(__WXMSW__) | |
32 | #include <wx/wave.h> | |
33 | #endif | |
b37c7e1d RD |
34 | |
35 | #include <wx/mimetype.h> | |
bb0054cd RD |
36 | %} |
37 | ||
38 | //---------------------------------------------------------------------- | |
39 | ||
40 | %include typemaps.i | |
41 | %include my_typemaps.i | |
42 | ||
43 | // Import some definitions of other classes, etc. | |
44 | %import _defs.i | |
45 | %import windows.i | |
f0261a72 | 46 | %import misc.i |
06c0fba4 | 47 | %import gdi.i |
b1462dfa | 48 | %import events.i |
c368d904 | 49 | %import streams.i |
7dbce44a | 50 | %import utils.i |
06c0fba4 | 51 | |
b68dc582 | 52 | |
137b5242 RD |
53 | //---------------------------------------------------------------------- |
54 | ||
55 | %{ | |
56 | // Put some wx default wxChar* values into wxStrings. | |
57 | DECLARE_DEF_STRING(FileSelectorPromptStr); | |
58 | DECLARE_DEF_STRING(FileSelectorDefaultWildcardStr); | |
59 | ||
60 | static const wxString wxPyEmptyString(wxT("")); | |
61 | %} | |
62 | ||
06c0fba4 RD |
63 | //--------------------------------------------------------------------------- |
64 | // Dialog Functions | |
65 | ||
137b5242 RD |
66 | wxString wxFileSelector(const wxString& message = wxPyFileSelectorPromptStr, |
67 | const wxString& default_path = wxPyEmptyString, | |
68 | const wxString& default_filename = wxPyEmptyString, | |
69 | const wxString& default_extension = wxPyEmptyString, | |
70 | const wxString& wildcard = wxPyFileSelectorDefaultWildcardStr, | |
06c0fba4 RD |
71 | int flags = 0, |
72 | wxWindow *parent = NULL, | |
73 | int x = -1, int y = -1); | |
a541c325 RD |
74 | |
75 | // Ask for filename to load | |
137b5242 RD |
76 | wxString wxLoadFileSelector(const wxString& what, |
77 | const wxString& extension, | |
78 | const wxString& default_name = wxPyEmptyString, | |
a541c325 RD |
79 | wxWindow *parent = NULL); |
80 | ||
81 | // Ask for filename to save | |
137b5242 RD |
82 | wxString wxSaveFileSelector(const wxString& what, |
83 | const wxString& extension, | |
84 | const wxString& default_name = wxPyEmptyString, | |
a541c325 | 85 | wxWindow *parent = NULL); |
06c0fba4 RD |
86 | |
87 | wxString wxGetTextFromUser(const wxString& message, | |
137b5242 RD |
88 | const wxString& caption = wxPyEmptyString, |
89 | const wxString& default_value = wxPyEmptyString, | |
06c0fba4 RD |
90 | wxWindow *parent = NULL, |
91 | int x = -1, int y = -1, | |
92 | bool centre = TRUE); | |
93 | ||
1b62f00d | 94 | wxString wxGetPasswordFromUser(const wxString& message, |
137b5242 RD |
95 | const wxString& caption = wxPyEmptyString, |
96 | const wxString& default_value = wxPyEmptyString, | |
1b62f00d RD |
97 | wxWindow *parent = NULL); |
98 | ||
06c0fba4 RD |
99 | |
100 | // TODO: Need to custom wrap this one... | |
101 | // int wxGetMultipleChoice(char* message, char* caption, | |
eec92d76 | 102 | // int LCOUNT, char** choices, |
06c0fba4 RD |
103 | // int nsel, int *selection, |
104 | // wxWindow *parent = NULL, int x = -1, int y = -1, | |
105 | // bool centre = TRUE, int width=150, int height=200); | |
106 | ||
107 | ||
108 | wxString wxGetSingleChoice(const wxString& message, const wxString& caption, | |
eec92d76 | 109 | int LCOUNT, wxString* choices, |
06c0fba4 RD |
110 | wxWindow *parent = NULL, |
111 | int x = -1, int y = -1, | |
112 | bool centre = TRUE, | |
113 | int width=150, int height=200); | |
114 | ||
115 | int wxGetSingleChoiceIndex(const wxString& message, const wxString& caption, | |
eec92d76 | 116 | int LCOUNT, wxString* choices, |
06c0fba4 RD |
117 | wxWindow *parent = NULL, |
118 | int x = -1, int y = -1, | |
119 | bool centre = TRUE, | |
120 | int width=150, int height=200); | |
121 | ||
122 | ||
123 | int wxMessageBox(const wxString& message, | |
137b5242 | 124 | const wxString& caption = wxPyEmptyString, |
06c0fba4 RD |
125 | int style = wxOK | wxCENTRE, |
126 | wxWindow *parent = NULL, | |
127 | int x = -1, int y = -1); | |
128 | ||
129 | long wxGetNumberFromUser(const wxString& message, | |
130 | const wxString& prompt, | |
131 | const wxString& caption, | |
132 | long value, | |
133 | long min = 0, long max = 100, | |
134 | wxWindow *parent = NULL, | |
b68dc582 | 135 | const wxPoint& pos = wxDefaultPosition); |
06c0fba4 RD |
136 | |
137 | //--------------------------------------------------------------------------- | |
138 | // GDI Functions | |
139 | ||
140 | bool wxColourDisplay(); | |
1e7ecb7b | 141 | |
06c0fba4 | 142 | int wxDisplayDepth(); |
1e7ecb7b RD |
143 | int wxGetDisplayDepth(); |
144 | ||
ec5d7799 | 145 | void wxDisplaySize(int* OUTPUT, int* OUTPUT); |
1e7ecb7b | 146 | wxSize wxGetDisplaySize(); |
1b62f00d | 147 | |
ec5d7799 | 148 | void wxDisplaySizeMM(int* OUTPUT, int* OUTPUT); |
1e7ecb7b RD |
149 | wxSize wxGetDisplaySizeMM(); |
150 | ||
ec5d7799 RD |
151 | void wxClientDisplayRect(int *OUTPUT, int *OUTPUT, int *OUTPUT, int *OUTPUT); |
152 | wxRect wxGetClientDisplayRect(); | |
153 | ||
06c0fba4 | 154 | void wxSetCursor(wxCursor& cursor); |
bb0054cd RD |
155 | |
156 | //---------------------------------------------------------------------- | |
06c0fba4 | 157 | // Miscellaneous functions |
bb0054cd RD |
158 | |
159 | wxWindow * wxFindWindowByLabel(const wxString& label, wxWindow *parent=NULL); | |
160 | wxWindow * wxFindWindowByName(const wxString& name, wxWindow *parent=NULL); | |
161 | ||
06c0fba4 RD |
162 | void wxBeginBusyCursor(wxCursor *cursor = wxHOURGLASS_CURSOR); |
163 | wxWindow * wxGetActiveWindow(); | |
164 | ||
493f1553 RD |
165 | wxWindow* wxGenericFindWindowAtPoint(const wxPoint& pt); |
166 | wxWindow* wxFindWindowAtPoint(const wxPoint& pt); | |
4dfaa61e RD |
167 | |
168 | #ifdef __WXMSW__ | |
493f1553 | 169 | bool wxCheckForInterrupt(wxWindow *wnd); |
4dfaa61e RD |
170 | void wxFlushEvents(); |
171 | #endif | |
06c0fba4 RD |
172 | |
173 | //--------------------------------------------------------------------------- | |
174 | // Resource System | |
175 | ||
137b5242 | 176 | bool wxResourceAddIdentifier(char* name, int value); |
06c0fba4 | 177 | void wxResourceClear(void); |
137b5242 RD |
178 | wxBitmap wxResourceCreateBitmap(char* resource); |
179 | wxIcon wxResourceCreateIcon(char* resource); | |
180 | wxMenuBar * wxResourceCreateMenuBar(char* resource); | |
181 | int wxResourceGetIdentifier(char* name); | |
182 | bool wxResourceParseData(char* resource, wxResourceTable *table = NULL); | |
183 | bool wxResourceParseFile(char* filename, wxResourceTable *table = NULL); | |
184 | bool wxResourceParseString(char* resource, wxResourceTable *table = NULL); | |
bb0054cd | 185 | |
06c0fba4 RD |
186 | //--------------------------------------------------------------------------- |
187 | // System Settings | |
188 | ||
b5a5d647 RD |
189 | // possible values for wxSystemSettings::GetFont() parameter |
190 | // | |
191 | enum wxSystemFont | |
192 | { | |
193 | wxSYS_OEM_FIXED_FONT = 10, | |
06c0fba4 RD |
194 | wxSYS_ANSI_FIXED_FONT, |
195 | wxSYS_ANSI_VAR_FONT, | |
196 | wxSYS_SYSTEM_FONT, | |
197 | wxSYS_DEVICE_DEFAULT_FONT, | |
198 | wxSYS_DEFAULT_PALETTE, | |
199 | wxSYS_SYSTEM_FIXED_FONT, | |
b5a5d647 RD |
200 | wxSYS_DEFAULT_GUI_FONT |
201 | }; | |
06c0fba4 | 202 | |
b5a5d647 RD |
203 | // possible values for wxSystemSettings::GetColour() parameter |
204 | // | |
205 | enum wxSystemColour | |
206 | { | |
06c0fba4 RD |
207 | wxSYS_COLOUR_SCROLLBAR, |
208 | wxSYS_COLOUR_BACKGROUND, | |
c6c593e8 | 209 | wxSYS_COLOUR_DESKTOP = wxSYS_COLOUR_BACKGROUND, |
06c0fba4 RD |
210 | wxSYS_COLOUR_ACTIVECAPTION, |
211 | wxSYS_COLOUR_INACTIVECAPTION, | |
212 | wxSYS_COLOUR_MENU, | |
213 | wxSYS_COLOUR_WINDOW, | |
214 | wxSYS_COLOUR_WINDOWFRAME, | |
215 | wxSYS_COLOUR_MENUTEXT, | |
216 | wxSYS_COLOUR_WINDOWTEXT, | |
217 | wxSYS_COLOUR_CAPTIONTEXT, | |
218 | wxSYS_COLOUR_ACTIVEBORDER, | |
219 | wxSYS_COLOUR_INACTIVEBORDER, | |
220 | wxSYS_COLOUR_APPWORKSPACE, | |
221 | wxSYS_COLOUR_HIGHLIGHT, | |
222 | wxSYS_COLOUR_HIGHLIGHTTEXT, | |
223 | wxSYS_COLOUR_BTNFACE, | |
c6c593e8 | 224 | wxSYS_COLOUR_3DFACE = wxSYS_COLOUR_BTNFACE, |
06c0fba4 | 225 | wxSYS_COLOUR_BTNSHADOW, |
c6c593e8 | 226 | wxSYS_COLOUR_3DSHADOW = wxSYS_COLOUR_BTNSHADOW, |
06c0fba4 RD |
227 | wxSYS_COLOUR_GRAYTEXT, |
228 | wxSYS_COLOUR_BTNTEXT, | |
229 | wxSYS_COLOUR_INACTIVECAPTIONTEXT, | |
230 | wxSYS_COLOUR_BTNHIGHLIGHT, | |
c6c593e8 RD |
231 | wxSYS_COLOUR_BTNHILIGHT = wxSYS_COLOUR_BTNHIGHLIGHT, |
232 | wxSYS_COLOUR_3DHIGHLIGHT = wxSYS_COLOUR_BTNHIGHLIGHT, | |
233 | wxSYS_COLOUR_3DHILIGHT = wxSYS_COLOUR_BTNHIGHLIGHT, | |
06c0fba4 RD |
234 | wxSYS_COLOUR_3DDKSHADOW, |
235 | wxSYS_COLOUR_3DLIGHT, | |
236 | wxSYS_COLOUR_INFOTEXT, | |
237 | wxSYS_COLOUR_INFOBK, | |
b5a5d647 | 238 | wxSYS_COLOUR_LISTBOX, |
c6c593e8 RD |
239 | wxSYS_COLOUR_HOTLIGHT, |
240 | wxSYS_COLOUR_GRADIENTACTIVECAPTION, | |
241 | wxSYS_COLOUR_GRADIENTINACTIVECAPTION, | |
242 | wxSYS_COLOUR_MENUHILIGHT, | |
243 | wxSYS_COLOUR_MENUBAR, | |
b5a5d647 | 244 | |
c6c593e8 | 245 | wxSYS_COLOUR_MAX |
b5a5d647 | 246 | }; |
06c0fba4 | 247 | |
b5a5d647 RD |
248 | // possible values for wxSystemSettings::GetMetric() parameter |
249 | // | |
250 | enum wxSystemMetric | |
251 | { | |
252 | wxSYS_MOUSE_BUTTONS = 1, | |
06c0fba4 RD |
253 | wxSYS_BORDER_X, |
254 | wxSYS_BORDER_Y, | |
255 | wxSYS_CURSOR_X, | |
256 | wxSYS_CURSOR_Y, | |
257 | wxSYS_DCLICK_X, | |
258 | wxSYS_DCLICK_Y, | |
259 | wxSYS_DRAG_X, | |
260 | wxSYS_DRAG_Y, | |
261 | wxSYS_EDGE_X, | |
262 | wxSYS_EDGE_Y, | |
263 | wxSYS_HSCROLL_ARROW_X, | |
264 | wxSYS_HSCROLL_ARROW_Y, | |
265 | wxSYS_HTHUMB_X, | |
266 | wxSYS_ICON_X, | |
267 | wxSYS_ICON_Y, | |
268 | wxSYS_ICONSPACING_X, | |
269 | wxSYS_ICONSPACING_Y, | |
270 | wxSYS_WINDOWMIN_X, | |
271 | wxSYS_WINDOWMIN_Y, | |
272 | wxSYS_SCREEN_X, | |
273 | wxSYS_SCREEN_Y, | |
274 | wxSYS_FRAMESIZE_X, | |
275 | wxSYS_FRAMESIZE_Y, | |
276 | wxSYS_SMALLICON_X, | |
277 | wxSYS_SMALLICON_Y, | |
278 | wxSYS_HSCROLL_Y, | |
279 | wxSYS_VSCROLL_X, | |
280 | wxSYS_VSCROLL_ARROW_X, | |
281 | wxSYS_VSCROLL_ARROW_Y, | |
282 | wxSYS_VTHUMB_Y, | |
283 | wxSYS_CAPTION_Y, | |
284 | wxSYS_MENU_Y, | |
285 | wxSYS_NETWORK_PRESENT, | |
286 | wxSYS_PENWINDOWS_PRESENT, | |
287 | wxSYS_SHOW_SOUNDS, | |
b5a5d647 | 288 | wxSYS_SWAP_BUTTONS |
06c0fba4 RD |
289 | }; |
290 | ||
b5a5d647 RD |
291 | // possible values for wxSystemSettings::HasFeature() parameter |
292 | enum wxSystemFeature | |
293 | { | |
294 | wxSYS_CAN_DRAW_FRAME_DECORATIONS = 1, | |
295 | wxSYS_CAN_ICONIZE_FRAME | |
296 | }; | |
06c0fba4 RD |
297 | |
298 | ||
06c0fba4 | 299 | |
b5a5d647 RD |
300 | class wxSystemSettings { |
301 | public: | |
302 | // get a standard system colour | |
303 | static wxColour GetColour(wxSystemColour index); | |
304 | ||
305 | // get a standard system font | |
306 | static wxFont GetFont(wxSystemFont index); | |
307 | ||
308 | // get a system-dependent metric | |
309 | static int GetMetric(wxSystemMetric index); | |
310 | ||
311 | // return true if the port has certain feature | |
312 | static bool HasFeature(wxSystemFeature index); | |
313 | ||
b5a5d647 | 314 | }; |
06c0fba4 | 315 | |
06c0fba4 | 316 | |
bb0054cd RD |
317 | |
318 | //--------------------------------------------------------------------------- | |
319 | // wxToolTip | |
320 | ||
9416aa89 | 321 | class wxToolTip : public wxObject { |
bb0054cd RD |
322 | public: |
323 | wxToolTip(const wxString &tip); | |
324 | ||
325 | void SetTip(const wxString& tip); | |
326 | wxString GetTip(); | |
327 | // *** Not in the "public" interface void SetWindow(wxWindow *win); | |
328 | wxWindow *GetWindow(); | |
bb0054cd | 329 | |
edf2f43e RD |
330 | static void Enable(bool flag); |
331 | static void SetDelay(long milliseconds); | |
332 | }; | |
bb0054cd RD |
333 | |
334 | //---------------------------------------------------------------------- | |
f0261a72 RD |
335 | |
336 | class wxCaret { | |
337 | public: | |
338 | wxCaret(wxWindow* window, const wxSize& size); | |
339 | ~wxCaret(); | |
340 | ||
341 | bool IsOk(); | |
342 | bool IsVisible(); | |
343 | %name(GetPositionTuple)void GetPosition(int *OUTPUT, int *OUTPUT); | |
344 | wxPoint GetPosition(); | |
345 | %name(GetSizeTuple)void GetSize(int *OUTPUT, int *OUTPUT); | |
346 | wxSize GetSize(); | |
347 | wxWindow *GetWindow(); | |
348 | %name(MoveXY)void Move(int x, int y); | |
349 | void Move(const wxPoint& pt); | |
a1df7a95 RD |
350 | %name(SetSizeWH) void SetSize(int width, int height); |
351 | void SetSize(const wxSize& size); | |
f0261a72 RD |
352 | void Show(int show = TRUE); |
353 | void Hide(); | |
f0261a72 RD |
354 | }; |
355 | ||
356 | %inline %{ | |
357 | int wxCaret_GetBlinkTime() { | |
358 | return wxCaret::GetBlinkTime(); | |
359 | } | |
360 | ||
361 | void wxCaret_SetBlinkTime(int milliseconds) { | |
362 | wxCaret::SetBlinkTime(milliseconds); | |
363 | } | |
364 | %} | |
365 | ||
bb0054cd | 366 | //---------------------------------------------------------------------- |
f0261a72 RD |
367 | |
368 | %{ | |
369 | class wxPyFontEnumerator : public wxFontEnumerator { | |
370 | public: | |
371 | wxPyFontEnumerator() {} | |
372 | ~wxPyFontEnumerator() {} | |
373 | ||
b1462dfa | 374 | DEC_PYCALLBACK_BOOL_STRING(OnFacename); |
f0261a72 RD |
375 | DEC_PYCALLBACK_BOOL_STRINGSTRING(OnFontEncoding); |
376 | ||
377 | PYPRIVATE; | |
378 | }; | |
379 | ||
b1462dfa | 380 | IMP_PYCALLBACK_BOOL_STRING(wxPyFontEnumerator, wxFontEnumerator, OnFacename); |
f0261a72 RD |
381 | IMP_PYCALLBACK_BOOL_STRINGSTRING(wxPyFontEnumerator, wxFontEnumerator, OnFontEncoding); |
382 | ||
383 | %} | |
384 | ||
385 | %name(wxFontEnumerator) class wxPyFontEnumerator { | |
386 | public: | |
b1462dfa RD |
387 | wxPyFontEnumerator(); |
388 | ~wxPyFontEnumerator(); | |
8af26133 RD |
389 | void _setCallbackInfo(PyObject* self, PyObject* _class, bool incref); |
390 | %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxFontEnumerator, 0)" | |
f0261a72 | 391 | |
b1462dfa RD |
392 | bool EnumerateFacenames( |
393 | wxFontEncoding encoding = wxFONTENCODING_SYSTEM, // all | |
394 | bool fixedWidthOnly = FALSE); | |
137b5242 | 395 | bool EnumerateEncodings(const wxString& facename = wxPyEmptyString); |
65dd82cb RD |
396 | |
397 | //wxArrayString* GetEncodings(); | |
398 | //wxArrayString* GetFacenames(); | |
399 | %addmethods { | |
400 | PyObject* GetEncodings() { | |
401 | wxArrayString* arr = self->GetEncodings(); | |
8af26133 | 402 | return wxArrayString2PyList_helper(*arr); |
65dd82cb RD |
403 | } |
404 | ||
405 | PyObject* GetFacenames() { | |
406 | wxArrayString* arr = self->GetFacenames(); | |
8af26133 | 407 | return wxArrayString2PyList_helper(*arr); |
65dd82cb RD |
408 | } |
409 | } | |
f0261a72 | 410 | }; |
2abc0a0f RD |
411 | |
412 | //---------------------------------------------------------------------- | |
413 | ||
414 | class wxBusyCursor { | |
415 | public: | |
416 | wxBusyCursor(wxCursor* cursor = wxHOURGLASS_CURSOR); | |
417 | ~wxBusyCursor(); | |
418 | }; | |
419 | ||
b1462dfa | 420 | //---------------------------------------------------------------------- |
2abc0a0f | 421 | |
c368d904 RD |
422 | class wxWindowDisabler { |
423 | public: | |
424 | wxWindowDisabler(wxWindow *winToSkip = NULL); | |
425 | ~wxWindowDisabler(); | |
426 | }; | |
427 | ||
428 | //---------------------------------------------------------------------- | |
429 | ||
6e18ca6c | 430 | bool wxSafeYield(wxWindow* win=NULL); |
b1462dfa | 431 | void wxPostEvent(wxEvtHandler *dest, wxEvent& event); |
694759cf | 432 | void wxWakeUpIdle(); |
2abc0a0f | 433 | |
6e18ca6c | 434 | |
4662be59 | 435 | #ifdef __WXMSW__ |
6e18ca6c | 436 | void wxWakeUpMainThread(); |
4662be59 RD |
437 | #endif |
438 | ||
6e18ca6c RD |
439 | void wxMutexGuiEnter(); |
440 | void wxMutexGuiLeave(); | |
441 | ||
442 | ||
443 | class wxMutexGuiLocker { | |
444 | public: | |
445 | wxMutexGuiLocker(); | |
446 | ~wxMutexGuiLocker(); | |
447 | }; | |
448 | ||
449 | ||
450 | %inline %{ | |
451 | bool wxThread_IsMain() { | |
00ca6262 | 452 | #ifdef WXP_WITH_THREAD |
6e18ca6c | 453 | return wxThread::IsMain(); |
00ca6262 RD |
454 | #else |
455 | return TRUE; | |
456 | #endif | |
6e18ca6c RD |
457 | } |
458 | %} | |
c368d904 | 459 | |
2abc0a0f | 460 | //---------------------------------------------------------------------- |
f6bcfd97 BP |
461 | |
462 | ||
463 | class wxTipProvider | |
464 | { | |
465 | public: | |
466 | // wxTipProvider(size_t currentTip); **** Abstract base class | |
467 | ~wxTipProvider(); | |
468 | ||
469 | virtual wxString GetTip() = 0; | |
470 | size_t GetCurrentTip(); | |
471 | ||
472 | }; | |
473 | ||
474 | ||
475 | // The C++ version of wxPyTipProvider | |
476 | %{ | |
477 | class wxPyTipProvider : public wxTipProvider { | |
478 | public: | |
479 | wxPyTipProvider(size_t currentTip) | |
480 | : wxTipProvider(currentTip) {} | |
481 | ||
482 | DEC_PYCALLBACK_STRING__pure(GetTip); | |
483 | ||
484 | PYPRIVATE; | |
485 | }; | |
486 | ||
487 | IMP_PYCALLBACK_STRING__pure( wxPyTipProvider, wxTipProvider, GetTip); | |
488 | ||
489 | %} | |
490 | ||
491 | ||
492 | // Now let SWIG know about it | |
493 | class wxPyTipProvider : public wxTipProvider { | |
494 | public: | |
495 | wxPyTipProvider(size_t currentTip); | |
496 | }; | |
497 | ||
498 | ||
499 | ||
500 | bool wxShowTip(wxWindow *parent, wxTipProvider *tipProvider, bool showAtStartup = TRUE); | |
501 | %new wxTipProvider * wxCreateFileTipProvider(const wxString& filename, size_t currentTip); | |
502 | ||
503 | ||
504 | //---------------------------------------------------------------------- | |
505 | ||
506 | %{ | |
507 | #include <wx/generic/dragimgg.h> | |
f6bcfd97 BP |
508 | %} |
509 | ||
9416aa89 | 510 | %name (wxDragImage) class wxGenericDragImage : public wxObject |
f6bcfd97 BP |
511 | { |
512 | public: | |
513 | ||
514 | wxGenericDragImage(const wxBitmap& image, | |
10e07c70 | 515 | const wxCursor& cursor = wxNullCursor); |
cdf14688 RD |
516 | %name(wxDragIcon)wxGenericDragImage(const wxIcon& image, |
517 | const wxCursor& cursor = wxNullCursor); | |
518 | %name(wxDragString)wxGenericDragImage(const wxString& str, | |
519 | const wxCursor& cursor = wxNullCursor); | |
520 | %name(wxDragTreeItem)wxGenericDragImage(const wxTreeCtrl& treeCtrl, wxTreeItemId& id); | |
521 | %name(wxDragListItem)wxGenericDragImage(const wxListCtrl& listCtrl, long id); | |
522 | ||
f6bcfd97 BP |
523 | ~wxGenericDragImage(); |
524 | ||
10e07c70 | 525 | void SetBackingBitmap(wxBitmap* bitmap); |
f6bcfd97 BP |
526 | bool BeginDrag(const wxPoint& hotspot, wxWindow* window, |
527 | bool fullScreen = FALSE, wxRect* rect = NULL); | |
528 | ||
529 | %name(BeginDrag2) bool BeginDrag(const wxPoint& hotspot, wxWindow* window, | |
530 | wxWindow* fullScreenRect); | |
531 | ||
532 | bool EndDrag(); | |
533 | bool Move(const wxPoint& pt); | |
534 | bool Show(); | |
535 | bool Hide(); | |
536 | ||
537 | wxRect GetImageRect(const wxPoint& pos) const; | |
538 | bool RedrawImage(const wxPoint& oldPos, const wxPoint& newPos, | |
539 | bool eraseOld, bool drawNew); | |
540 | }; | |
541 | ||
542 | ||
f6bcfd97 BP |
543 | //---------------------------------------------------------------------- |
544 | ||
9416aa89 | 545 | class wxPyTimer : public wxObject { |
f6bcfd97 BP |
546 | public: |
547 | wxPyTimer(PyObject* notify); | |
548 | ~wxPyTimer(); | |
549 | int GetInterval(); | |
550 | bool IsOneShot(); | |
551 | bool IsRunning(); | |
552 | void SetOwner(wxEvtHandler *owner, int id = -1); | |
553 | void Start(int milliseconds=-1, int oneShot=FALSE); | |
554 | void Stop(); | |
555 | }; | |
556 | ||
b37c7e1d RD |
557 | |
558 | class wxStopWatch | |
559 | { | |
560 | public: | |
561 | // ctor starts the stop watch | |
562 | wxStopWatch(); | |
68320e40 | 563 | ~wxStopWatch(); |
b37c7e1d RD |
564 | void Start(long t = 0); |
565 | void Pause(); | |
566 | void Resume(); | |
567 | ||
568 | // get elapsed time since the last Start() or Pause() in milliseconds | |
569 | long Time() const; | |
570 | }; | |
571 | ||
572 | ||
f6bcfd97 BP |
573 | //---------------------------------------------------------------------- |
574 | //---------------------------------------------------------------------- | |
575 | ||
576 | ||
577 | enum | |
578 | { | |
579 | wxLOG_FatalError, // program can't continue, abort immediately | |
580 | wxLOG_Error, // a serious error, user must be informed about it | |
581 | wxLOG_Warning, // user is normally informed about it but may be ignored | |
582 | wxLOG_Message, // normal message (i.e. normal output of a non GUI app) | |
583 | wxLOG_Info, // informational message (a.k.a. 'Verbose') | |
584 | wxLOG_Status, // informational: might go to the status line of GUI app | |
585 | wxLOG_Debug, // never shown to the user, disabled in release mode | |
586 | wxLOG_Trace, // trace messages are also only enabled in debug mode | |
587 | wxLOG_Progress, // used for progress indicator (not yet) | |
588 | wxLOG_User = 100 // user defined levels start here | |
589 | }; | |
590 | ||
591 | ||
592 | class wxLog | |
593 | { | |
594 | public: | |
595 | wxLog(); | |
596 | ||
597 | static bool IsEnabled(); | |
598 | static bool EnableLogging(bool doIt = TRUE); | |
c8bc7bb8 | 599 | static void OnLog(wxLogLevel level, const wxString& szString, int t=0); |
f6bcfd97 BP |
600 | |
601 | virtual void Flush(); | |
602 | bool HasPendingMessages() const; | |
603 | ||
604 | static void FlushActive(); | |
605 | static wxLog *GetActiveTarget(); | |
606 | static wxLog *SetActiveTarget(wxLog *pLogger); | |
607 | ||
608 | static void Suspend(); | |
609 | static void Resume(); | |
610 | ||
611 | void SetVerbose(bool bVerbose = TRUE); | |
612 | ||
613 | static void DontCreateOnDemand(); | |
614 | static void SetTraceMask(wxTraceMask ulMask); | |
615 | static void AddTraceMask(const wxString& str); | |
616 | static void RemoveTraceMask(const wxString& str); | |
76bfdc78 RD |
617 | static void ClearTraceMasks(); |
618 | ||
137b5242 RD |
619 | static void SetTimestamp(const wxString& ts); |
620 | static const wxString& GetTimestamp(); | |
f6bcfd97 BP |
621 | |
622 | bool GetVerbose() const { return m_bVerbose; } | |
623 | ||
624 | static wxTraceMask GetTraceMask(); | |
c8bc7bb8 | 625 | static bool IsAllowedTraceMask(const wxString& mask); |
f6bcfd97 | 626 | |
76bfdc78 RD |
627 | // static void TimeStamp(wxString *str); |
628 | %addmethods { | |
629 | wxString TimeStamp() { | |
630 | wxString msg; | |
631 | wxLog::TimeStamp(&msg); | |
632 | return msg; | |
633 | } | |
634 | } | |
f6bcfd97 BP |
635 | }; |
636 | ||
637 | ||
638 | class wxLogStderr : public wxLog | |
639 | { | |
640 | public: | |
641 | wxLogStderr(/* TODO: FILE *fp = (FILE *) NULL*/); | |
642 | }; | |
643 | ||
644 | ||
645 | class wxLogTextCtrl : public wxLog | |
646 | { | |
647 | public: | |
648 | wxLogTextCtrl(wxTextCtrl *pTextCtrl); | |
649 | }; | |
650 | ||
651 | ||
652 | class wxLogGui : public wxLog | |
653 | { | |
654 | public: | |
655 | wxLogGui(); | |
656 | }; | |
657 | ||
658 | class wxLogWindow : public wxLog | |
659 | { | |
660 | public: | |
661 | wxLogWindow(wxFrame *pParent, // the parent frame (can be NULL) | |
c8bc7bb8 | 662 | const wxString& szTitle, // the title of the frame |
f6bcfd97 BP |
663 | bool bShow = TRUE, // show window immediately? |
664 | bool bPassToOld = TRUE); // pass log messages to the old target? | |
665 | ||
666 | void Show(bool bShow = TRUE); | |
667 | wxFrame *GetFrame() const; | |
668 | wxLog *GetOldLog() const; | |
669 | bool IsPassingMessages() const; | |
c8bc7bb8 | 670 | void PassMessages(bool bDoPass); |
f6bcfd97 BP |
671 | }; |
672 | ||
673 | ||
674 | class wxLogNull | |
675 | { | |
676 | public: | |
677 | wxLogNull(); | |
678 | ~wxLogNull(); | |
679 | }; | |
680 | ||
681 | ||
76bfdc78 RD |
682 | class wxLogChain : public wxLog |
683 | { | |
684 | public: | |
685 | wxLogChain(wxLog *logger); | |
686 | void SetLog(wxLog *logger); | |
687 | void PassMessages(bool bDoPass); | |
688 | bool IsPassingMessages(); | |
689 | wxLog *GetOldLog(); | |
690 | }; | |
691 | ||
692 | ||
f6bcfd97 | 693 | unsigned long wxSysErrorCode(); |
c8bc7bb8 RD |
694 | const wxString wxSysErrorMsg(unsigned long nErrCode = 0); |
695 | void wxLogFatalError(const wxString& szFormat); | |
696 | void wxLogError(const wxString& szFormat); | |
697 | void wxLogWarning(const wxString& szFormat); | |
698 | void wxLogMessage(const wxString& szFormat); | |
699 | void wxLogInfo(const wxString& szFormat); | |
700 | void wxLogVerbose(const wxString& szFormat); | |
701 | void wxLogStatus(const wxString& szFormat); | |
702 | %name(wxLogStatusFrame)void wxLogStatus(wxFrame *pFrame, const wxString& szFormat); | |
703 | void wxLogSysError(const wxString& szFormat); | |
f6bcfd97 BP |
704 | |
705 | ||
76bfdc78 RD |
706 | %{ |
707 | // A Log class that can be derived from in wxPython | |
708 | class wxPyLog : public wxLog { | |
709 | public: | |
710 | wxPyLog() : wxLog() {} | |
711 | ||
712 | virtual void DoLog(wxLogLevel level, const wxChar *szString, time_t t) { | |
713 | bool found; | |
4268f798 | 714 | wxPyBeginBlockThreads(); |
76bfdc78 | 715 | if ((found = wxPyCBH_findCallback(m_myInst, "DoLog"))) |
a541c325 RD |
716 | wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iOi)", level, |
717 | wx2PyString(szString), t)); | |
4268f798 | 718 | wxPyEndBlockThreads(); |
76bfdc78 RD |
719 | if (! found) |
720 | wxLog::DoLog(level, szString, t); | |
721 | } | |
722 | ||
723 | virtual void DoLogString(const wxChar *szString, time_t t) { | |
724 | bool found; | |
4268f798 | 725 | wxPyBeginBlockThreads(); |
76bfdc78 | 726 | if ((found = wxPyCBH_findCallback(m_myInst, "DoLogString"))) |
a541c325 RD |
727 | wxPyCBH_callCallback(m_myInst, Py_BuildValue("(Oi)", |
728 | wx2PyString(szString), t)); | |
4268f798 | 729 | wxPyEndBlockThreads(); |
76bfdc78 RD |
730 | if (! found) |
731 | wxLog::DoLogString(szString, t); | |
732 | } | |
733 | ||
734 | PYPRIVATE; | |
735 | }; | |
736 | %} | |
737 | ||
738 | // Now tell SWIG about it | |
739 | class wxPyLog : public wxLog { | |
740 | public: | |
741 | wxPyLog(); | |
0122b7e3 RD |
742 | void _setCallbackInfo(PyObject* self, PyObject* _class); |
743 | %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxPyLog)" | |
76bfdc78 RD |
744 | %addmethods { void Destroy() { delete self; } } |
745 | ||
746 | }; | |
747 | ||
c368d904 RD |
748 | |
749 | //---------------------------------------------------------------------- | |
750 | ||
1b62f00d RD |
751 | |
752 | enum { | |
753 | /* event type */ | |
754 | wxEVT_END_PROCESS | |
755 | }; | |
756 | ||
757 | ||
c368d904 RD |
758 | class wxProcessEvent : public wxEvent { |
759 | public: | |
760 | wxProcessEvent(int id = 0, int pid = 0, int exitcode = 0); | |
761 | int GetPid(); | |
762 | int GetExitCode(); | |
763 | int m_pid, m_exitcode; | |
764 | }; | |
765 | ||
766 | ||
767 | ||
768 | ||
769 | %{ // C++ version of wxProcess derived class | |
770 | ||
771 | class wxPyProcess : public wxProcess { | |
772 | public: | |
773 | wxPyProcess(wxEvtHandler *parent = NULL, int id = -1) | |
774 | : wxProcess(parent, id) | |
775 | {} | |
776 | ||
777 | DEC_PYCALLBACK_VOID_INTINT(OnTerminate); | |
778 | ||
779 | PYPRIVATE; | |
780 | }; | |
781 | ||
782 | IMP_PYCALLBACK_VOID_INTINT( wxPyProcess, wxProcess, OnTerminate); | |
19a97bd6 | 783 | |
c368d904 RD |
784 | %} |
785 | ||
786 | ||
787 | %name(wxProcess)class wxPyProcess : public wxEvtHandler { | |
788 | public: | |
789 | wxPyProcess(wxEvtHandler *parent = NULL, int id = -1); | |
790 | %addmethods { void Destroy() { delete self; } } | |
791 | ||
0122b7e3 RD |
792 | void _setCallbackInfo(PyObject* self, PyObject* _class); |
793 | %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxProcess)" | |
c368d904 RD |
794 | |
795 | void base_OnTerminate(int pid, int status); | |
796 | ||
797 | void Redirect(); | |
798 | bool IsRedirected(); | |
799 | void Detach(); | |
800 | ||
801 | wxInputStream *GetInputStream(); | |
802 | wxInputStream *GetErrorStream(); | |
803 | wxOutputStream *GetOutputStream(); | |
804 | ||
805 | void CloseOutput(); | |
806 | }; | |
807 | ||
808 | ||
b96c7a38 RD |
809 | enum { |
810 | wxEXEC_ASYNC = 0, // execute the process asynchronously | |
811 | wxEXEC_SYNC = 1, // synchronously | |
812 | wxEXEC_NOHIDE = 2 // under Windows, don't hide the child even if it's | |
813 | // IO is redirected (this is done by default) | |
814 | }; | |
815 | ||
c368d904 RD |
816 | |
817 | long wxExecute(const wxString& command, | |
b96c7a38 | 818 | int flags = wxEXEC_ASYNC, |
c368d904 RD |
819 | wxPyProcess *process = NULL); |
820 | ||
185d7c3e RD |
821 | //---------------------------------------------------------------------- |
822 | ||
493f1553 RD |
823 | %{ |
824 | #if !wxUSE_JOYSTICK && !defined(__WXMSW__) | |
825 | // A C++ stub class for wxJoystick for platforms that don't have it. | |
826 | class wxJoystick : public wxObject { | |
827 | public: | |
828 | wxJoystick(int joystick = wxJOYSTICK1) { | |
4268f798 | 829 | wxPyBeginBlockThreads(); |
493f1553 | 830 | PyErr_SetString(PyExc_NotImplementedError, "wxJoystick is not available on this platform."); |
4268f798 | 831 | wxPyEndBlockThreads(); |
493f1553 RD |
832 | } |
833 | wxPoint GetPosition() { return wxPoint(-1,-1); } | |
834 | int GetZPosition() { return -1; } | |
835 | int GetButtonState() { return -1; } | |
836 | int GetPOVPosition() { return -1; } | |
837 | int GetPOVCTSPosition() { return -1; } | |
838 | int GetRudderPosition() { return -1; } | |
839 | int GetUPosition() { return -1; } | |
840 | int GetVPosition() { return -1; } | |
841 | int GetMovementThreshold() { return -1; } | |
d56cebe7 | 842 | void SetMovementThreshold(int threshold) {} |
493f1553 RD |
843 | |
844 | bool IsOk(void) { return FALSE; } | |
845 | int GetNumberJoysticks() { return -1; } | |
846 | int GetManufacturerId() { return -1; } | |
847 | int GetProductId() { return -1; } | |
848 | wxString GetProductName() { return ""; } | |
849 | int GetXMin() { return -1; } | |
850 | int GetYMin() { return -1; } | |
851 | int GetZMin() { return -1; } | |
852 | int GetXMax() { return -1; } | |
853 | int GetYMax() { return -1; } | |
854 | int GetZMax() { return -1; } | |
855 | int GetNumberButtons() { return -1; } | |
856 | int GetNumberAxes() { return -1; } | |
857 | int GetMaxButtons() { return -1; } | |
858 | int GetMaxAxes() { return -1; } | |
859 | int GetPollingMin() { return -1; } | |
860 | int GetPollingMax() { return -1; } | |
861 | int GetRudderMin() { return -1; } | |
862 | int GetRudderMax() { return -1; } | |
863 | int GetUMin() { return -1; } | |
864 | int GetUMax() { return -1; } | |
865 | int GetVMin() { return -1; } | |
866 | int GetVMax() { return -1; } | |
867 | ||
868 | bool HasRudder() { return FALSE; } | |
869 | bool HasZ() { return FALSE; } | |
870 | bool HasU() { return FALSE; } | |
871 | bool HasV() { return FALSE; } | |
872 | bool HasPOV() { return FALSE; } | |
873 | bool HasPOV4Dir() { return FALSE; } | |
874 | bool HasPOVCTS() { return FALSE; } | |
875 | ||
876 | bool SetCapture(wxWindow* win, int pollingFreq = 0) { return FALSE; } | |
877 | bool ReleaseCapture() { return FALSE; } | |
878 | }; | |
879 | #endif | |
880 | %} | |
881 | ||
882 | ||
9416aa89 | 883 | class wxJoystick : public wxObject { |
185d7c3e RD |
884 | public: |
885 | wxJoystick(int joystick = wxJOYSTICK1); | |
ac346f50 RD |
886 | ~wxJoystick(); |
887 | ||
185d7c3e RD |
888 | wxPoint GetPosition(); |
889 | int GetZPosition(); | |
890 | int GetButtonState(); | |
891 | int GetPOVPosition(); | |
892 | int GetPOVCTSPosition(); | |
893 | int GetRudderPosition(); | |
894 | int GetUPosition(); | |
895 | int GetVPosition(); | |
896 | int GetMovementThreshold(); | |
897 | void SetMovementThreshold(int threshold) ; | |
898 | ||
899 | bool IsOk(void); | |
900 | int GetNumberJoysticks(); | |
901 | int GetManufacturerId(); | |
902 | int GetProductId(); | |
903 | wxString GetProductName(); | |
904 | int GetXMin(); | |
905 | int GetYMin(); | |
906 | int GetZMin(); | |
907 | int GetXMax(); | |
908 | int GetYMax(); | |
909 | int GetZMax(); | |
910 | int GetNumberButtons(); | |
911 | int GetNumberAxes(); | |
912 | int GetMaxButtons(); | |
913 | int GetMaxAxes(); | |
914 | int GetPollingMin(); | |
915 | int GetPollingMax(); | |
916 | int GetRudderMin(); | |
917 | int GetRudderMax(); | |
918 | int GetUMin(); | |
919 | int GetUMax(); | |
920 | int GetVMin(); | |
921 | int GetVMax(); | |
922 | ||
923 | bool HasRudder(); | |
924 | bool HasZ(); | |
925 | bool HasU(); | |
926 | bool HasV(); | |
927 | bool HasPOV(); | |
928 | bool HasPOV4Dir(); | |
929 | bool HasPOVCTS(); | |
930 | ||
931 | bool SetCapture(wxWindow* win, int pollingFreq = 0); | |
932 | bool ReleaseCapture(); | |
933 | }; | |
493f1553 RD |
934 | |
935 | //---------------------------------------------------------------------- | |
936 | ||
937 | %{ | |
0adbc166 | 938 | #if !wxUSE_WAVE |
493f1553 RD |
939 | // A C++ stub class for wxWave for platforms that don't have it. |
940 | class wxWave : public wxObject | |
941 | { | |
942 | public: | |
943 | wxWave(const wxString& fileName, bool isResource = FALSE) { | |
4268f798 | 944 | wxPyBeginBlockThreads(); |
493f1553 | 945 | PyErr_SetString(PyExc_NotImplementedError, "wxWave is not available on this platform."); |
4268f798 | 946 | wxPyEndBlockThreads(); |
493f1553 RD |
947 | } |
948 | wxWave(int size, const wxByte* data) { | |
4268f798 | 949 | wxPyBeginBlockThreads(); |
493f1553 | 950 | PyErr_SetString(PyExc_NotImplementedError, "wxWave is not available on this platform."); |
4268f798 | 951 | wxPyEndBlockThreads(); |
493f1553 RD |
952 | } |
953 | ||
954 | ~wxWave() {} | |
955 | ||
956 | bool IsOk() const { return FALSE; } | |
957 | bool Play(bool async = TRUE, bool looped = FALSE) const { return FALSE; } | |
958 | }; | |
959 | ||
2cd2fac8 | 960 | #endif |
493f1553 RD |
961 | %} |
962 | ||
963 | class wxWave : public wxObject | |
964 | { | |
965 | public: | |
966 | wxWave(const wxString& fileName, bool isResource = FALSE); | |
967 | ~wxWave(); | |
968 | ||
969 | bool IsOk() const; | |
970 | bool Play(bool async = TRUE, bool looped = FALSE) const; | |
971 | }; | |
972 | ||
973 | %new wxWave* wxWaveData(const wxString& data); | |
974 | %{ // Implementations of some alternate "constructors" | |
975 | wxWave* wxWaveData(const wxString& data) { | |
976 | return new wxWave(data.Len(), (wxByte*)data.c_str()); | |
977 | } | |
978 | %} | |
185d7c3e | 979 | |
4f3449b4 | 980 | |
b37c7e1d RD |
981 | //---------------------------------------------------------------------- |
982 | ||
983 | enum wxMailcapStyle | |
984 | { | |
985 | wxMAILCAP_STANDARD = 1, | |
986 | wxMAILCAP_NETSCAPE = 2, | |
987 | wxMAILCAP_KDE = 4, | |
988 | wxMAILCAP_GNOME = 8, | |
989 | ||
990 | wxMAILCAP_ALL = 15 | |
991 | }; | |
992 | ||
993 | ||
994 | ||
995 | class wxFileTypeInfo | |
996 | { | |
997 | public: | |
998 | // ctors | |
999 | // a normal item | |
137b5242 RD |
1000 | wxFileTypeInfo(const char* mimeType, |
1001 | const char* openCmd, | |
1002 | const char* printCmd, | |
1003 | const char* desc); | |
b37c7e1d RD |
1004 | |
1005 | ||
1006 | // the array elements correspond to the parameters of the ctor above in | |
1007 | // the same order | |
1008 | %name(wxFileTypeInfoSequence)wxFileTypeInfo(const wxArrayString& sArray); | |
1009 | ||
1010 | // invalid item - use this to terminate the array passed to | |
1011 | // wxMimeTypesManager::AddFallbacks | |
1012 | %name(wxNullFileTypeInfo)wxFileTypeInfo(); | |
1013 | ||
1014 | ||
1015 | // test if this object can be used | |
1016 | bool IsValid() const; | |
1017 | ||
1018 | // setters | |
1019 | // set the icon info | |
1020 | void SetIcon(const wxString& iconFile, int iconIndex = 0); | |
1021 | ||
1022 | // set the short desc | |
1023 | void SetShortDesc(const wxString& shortDesc); | |
1024 | ||
1025 | // accessors | |
1026 | // get the MIME type | |
1027 | const wxString& GetMimeType() const; | |
1028 | // get the open command | |
1029 | const wxString& GetOpenCommand() const; | |
1030 | // get the print command | |
1031 | const wxString& GetPrintCommand() const; | |
1032 | // get the short description (only used under Win32 so far) | |
1033 | const wxString& GetShortDesc() const; | |
1034 | // get the long, user visible description | |
1035 | const wxString& GetDescription() const; | |
1036 | ||
1037 | ||
1038 | // get the array of all extensions | |
1039 | //const wxArrayString& GetExtensions() const; | |
1040 | %addmethods { | |
1041 | PyObject* GetExtensions() { | |
1042 | wxArrayString& arr = (wxArrayString&)self->GetExtensions(); | |
1043 | return wxArrayString2PyList_helper(arr); | |
1044 | } | |
1045 | } | |
1046 | ||
1047 | int GetExtensionsCount() const; | |
1048 | ||
1049 | // get the icon info | |
1050 | const wxString& GetIconFile() const; | |
1051 | int GetIconIndex() const; | |
1052 | }; | |
1053 | ||
1054 | ||
1055 | ||
1056 | ||
1057 | class wxFileType | |
1058 | { | |
1059 | public: | |
1060 | ||
1061 | // TODO: Make a wxPyMessageParameters with virtual GetParamValue... | |
1062 | ||
1063 | // An object of this class must be passed to Get{Open|Print}Command. The | |
1064 | // default implementation is trivial and doesn't know anything at all about | |
1065 | // parameters, only filename and MIME type are used (so it's probably ok for | |
1066 | // Windows where %{param} is not used anyhow) | |
1067 | class MessageParameters | |
1068 | { | |
1069 | public: | |
1070 | // ctors | |
137b5242 RD |
1071 | MessageParameters(const wxString& filename=wxPyEmptyString, |
1072 | const wxString& mimetype=wxPyEmptyString); | |
b37c7e1d RD |
1073 | |
1074 | // accessors (called by GetOpenCommand) | |
1075 | // filename | |
1076 | const wxString& GetFileName() const; | |
1077 | // mime type | |
1078 | const wxString& GetMimeType() const;; | |
1079 | ||
1080 | // override this function in derived class | |
1081 | virtual wxString GetParamValue(const wxString& name) const; | |
1082 | ||
1083 | // virtual dtor as in any base class | |
1084 | virtual ~MessageParameters(); | |
1085 | }; | |
1086 | ||
1087 | ||
1088 | // ctor from static data | |
1089 | wxFileType(const wxFileTypeInfo& ftInfo); | |
1090 | ||
1091 | // return the MIME type for this file type | |
1092 | %addmethods { | |
1093 | PyObject* GetMimeType() { | |
1094 | wxString str; | |
c8bc7bb8 RD |
1095 | if (self->GetMimeType(&str)) { |
1096 | #if wxUSE_UNICODE | |
1097 | return PyUnicode_FromUnicode(str.c_str(), str.Len()); | |
1098 | #else | |
1099 | return PyString_FromStringAndSize(str.c_str(), str.Len()); | |
1100 | #endif | |
1101 | } | |
b37c7e1d RD |
1102 | else |
1103 | RETURN_NONE(); | |
1104 | } | |
1105 | PyObject* GetMimeTypes() { | |
1106 | wxArrayString arr; | |
1107 | if (self->GetMimeTypes(arr)) | |
1108 | return wxArrayString2PyList_helper(arr); | |
1109 | else | |
1110 | RETURN_NONE(); | |
1111 | } | |
1112 | } | |
1113 | ||
1114 | ||
1115 | // Get all extensions associated with this file type | |
1116 | %addmethods { | |
1117 | PyObject* GetExtensions() { | |
1118 | wxArrayString arr; | |
1119 | if (self->GetExtensions(arr)) | |
1120 | return wxArrayString2PyList_helper(arr); | |
1121 | else | |
1122 | RETURN_NONE(); | |
1123 | } | |
1124 | } | |
1125 | ||
1126 | ||
1127 | %addmethods { | |
1128 | // Get the icon corresponding to this file type | |
1129 | %new wxIcon* GetIcon() { | |
1130 | wxIcon icon; | |
1131 | if (self->GetIcon(&icon)) | |
1132 | return new wxIcon(icon); | |
1133 | else | |
1134 | return NULL; | |
1135 | } | |
1136 | ||
1137 | // Get the icon corresponding to this file type, the name of the file | |
1138 | // where this icon resides, and its index in this file if applicable. | |
1139 | PyObject* GetIconInfo() { | |
1140 | wxIcon icon; | |
1141 | wxString iconFile; | |
1142 | int iconIndex; | |
1143 | if (self->GetIcon(&icon, &iconFile, &iconIndex)) { | |
4268f798 | 1144 | wxPyBeginBlockThreads(); |
b37c7e1d RD |
1145 | PyObject* tuple = PyTuple_New(3); |
1146 | PyTuple_SetItem(tuple, 0, wxPyConstructObject(new wxIcon(icon), | |
1147 | "wxIcon", TRUE)); | |
c8bc7bb8 RD |
1148 | #if wxUSE_UNICODE |
1149 | PyTuple_SetItem(tuple, 1, PyUnicode_FromUnicode(iconFile.c_str(), iconFile.Len())); | |
1150 | #else | |
1151 | PyTuple_SetItem(tuple, 1, PyString_FromStringAndSize(iconFile.c_str(), iconFile.Len())); | |
1152 | #endif | |
b37c7e1d | 1153 | PyTuple_SetItem(tuple, 2, PyInt_FromLong(iconIndex)); |
4268f798 | 1154 | wxPyEndBlockThreads(); |
b37c7e1d RD |
1155 | return tuple; |
1156 | } | |
1157 | else | |
1158 | RETURN_NONE(); | |
1159 | } | |
1160 | } | |
1161 | ||
1162 | %addmethods { | |
1163 | // get a brief file type description ("*.txt" => "text document") | |
1164 | PyObject* GetDescription() { | |
1165 | wxString str; | |
c8bc7bb8 RD |
1166 | if (self->GetDescription(&str)) { |
1167 | #if wxUSE_UNICODE | |
1168 | return PyUnicode_FromUnicode(str.c_str(), str.Len()); | |
1169 | #else | |
1170 | return PyString_FromStringAndSize(str.c_str(), str.Len()); | |
1171 | #endif | |
1172 | } else | |
b37c7e1d RD |
1173 | RETURN_NONE(); |
1174 | } | |
1175 | } | |
1176 | ||
1177 | ||
1178 | // get the command to open/execute the file of given type | |
1179 | %addmethods { | |
1180 | PyObject* GetOpenCommand(const wxString& filename, | |
137b5242 | 1181 | const wxString& mimetype=wxPyEmptyString) { |
b37c7e1d | 1182 | wxString str; |
c8bc7bb8 RD |
1183 | if (self->GetOpenCommand(&str, wxFileType::MessageParameters(filename, mimetype))) { |
1184 | #if wxUSE_UNICODE | |
1185 | return PyUnicode_FromUnicode(str.c_str(), str.Len()); | |
1186 | #else | |
1187 | return PyString_FromStringAndSize(str.c_str(), str.Len()); | |
1188 | #endif | |
1189 | } else | |
b37c7e1d RD |
1190 | RETURN_NONE(); |
1191 | } | |
1192 | } | |
1193 | ||
1194 | ||
1195 | // get the command to print the file of given type | |
1196 | %addmethods { | |
1197 | PyObject* GetPrintCommand(const wxString& filename, | |
137b5242 | 1198 | const wxString& mimetype=wxPyEmptyString) { |
b37c7e1d | 1199 | wxString str; |
c8bc7bb8 RD |
1200 | if (self->GetPrintCommand(&str, wxFileType::MessageParameters(filename, mimetype))) { |
1201 | #if wxUSE_UNICODE | |
1202 | return PyUnicode_FromUnicode(str.c_str(), str.Len()); | |
1203 | #else | |
1204 | return PyString_FromStringAndSize(str.c_str(), str.Len()); | |
1205 | #endif | |
1206 | } else | |
b37c7e1d RD |
1207 | RETURN_NONE(); |
1208 | } | |
1209 | } | |
1210 | ||
1211 | ||
1212 | // Get all commands defined for this file type | |
1213 | %addmethods { | |
1214 | PyObject* GetAllCommands(const wxString& filename, | |
137b5242 | 1215 | const wxString& mimetype=wxPyEmptyString) { |
b37c7e1d RD |
1216 | wxArrayString verbs; |
1217 | wxArrayString commands; | |
1218 | if (self->GetAllCommands(&verbs, &commands, | |
1219 | wxFileType::MessageParameters(filename, mimetype))) { | |
4268f798 | 1220 | wxPyBeginBlockThreads(); |
b37c7e1d RD |
1221 | PyObject* tuple = PyTuple_New(2); |
1222 | PyTuple_SetItem(tuple, 0, wxArrayString2PyList_helper(verbs)); | |
1223 | PyTuple_SetItem(tuple, 1, wxArrayString2PyList_helper(commands)); | |
4268f798 | 1224 | wxPyEndBlockThreads(); |
b37c7e1d RD |
1225 | return tuple; |
1226 | } | |
1227 | else | |
1228 | RETURN_NONE(); | |
1229 | } | |
1230 | } | |
1231 | ||
1232 | ||
1233 | // set an arbitrary command, ask confirmation if it already exists and | |
1234 | // overwriteprompt is TRUE | |
1235 | bool SetCommand(const wxString& cmd, const wxString& verb, | |
1236 | bool overwriteprompt = TRUE); | |
1237 | ||
137b5242 | 1238 | bool SetDefaultIcon(const wxString& cmd = wxPyEmptyString, int index = 0); |
b37c7e1d RD |
1239 | |
1240 | ||
1241 | // remove the association for this filetype from the system MIME database: | |
1242 | // notice that it will only work if the association is defined in the user | |
1243 | // file/registry part, we will never modify the system-wide settings | |
1244 | bool Unassociate(); | |
1245 | ||
1246 | // operations | |
1247 | // expand a string in the format of GetOpenCommand (which may contain | |
1248 | // '%s' and '%t' format specificators for the file name and mime type | |
1249 | // and %{param} constructions). | |
1250 | static wxString ExpandCommand(const wxString& command, | |
1251 | const MessageParameters& params); | |
1252 | ||
1253 | // dtor (not virtual, shouldn't be derived from) | |
1254 | ~wxFileType(); | |
1255 | ||
1256 | }; | |
1257 | ||
1258 | ||
1259 | ||
1260 | ||
1261 | class wxMimeTypesManager | |
1262 | { | |
1263 | public: | |
1264 | // static helper functions | |
1265 | // ----------------------- | |
1266 | ||
1267 | // check if the given MIME type is the same as the other one: the | |
1268 | // second argument may contain wildcards ('*'), but not the first. If | |
1269 | // the types are equal or if the mimeType matches wildcard the function | |
1270 | // returns TRUE, otherwise it returns FALSE | |
1271 | static bool IsOfType(const wxString& mimeType, const wxString& wildcard); | |
1272 | ||
1273 | // ctor | |
1274 | wxMimeTypesManager(); | |
1275 | ||
1276 | // loads data from standard files according to the mailcap styles | |
1277 | // specified: this is a bitwise OR of wxMailcapStyle values | |
1278 | // | |
1279 | // use the extraDir parameter if you want to look for files in another | |
1280 | // directory | |
1281 | void Initialize(int mailcapStyle = wxMAILCAP_STANDARD, | |
137b5242 | 1282 | const wxString& extraDir = wxPyEmptyString); |
b37c7e1d RD |
1283 | |
1284 | // and this function clears all the data from the manager | |
1285 | void ClearData(); | |
1286 | ||
1287 | // Database lookup: all functions return a pointer to wxFileType object | |
1288 | // whose methods may be used to query it for the information you're | |
1289 | // interested in. If the return value is !NULL, caller is responsible for | |
1290 | // deleting it. | |
1291 | // get file type from file extension | |
1292 | %new wxFileType *GetFileTypeFromExtension(const wxString& ext); | |
1293 | ||
1294 | // get file type from MIME type (in format <category>/<format>) | |
1295 | %new wxFileType *GetFileTypeFromMimeType(const wxString& mimeType); | |
1296 | ||
1297 | // other operations: return TRUE if there were no errors or FALSE if there | |
1298 | // were some unreckognized entries (the good entries are always read anyhow) | |
1299 | // | |
1300 | ||
1301 | // read in additional file (the standard ones are read automatically) | |
1302 | // in mailcap format (see mimetype.cpp for description) | |
1303 | // | |
1304 | // 'fallback' parameter may be set to TRUE to avoid overriding the | |
1305 | // settings from other, previously parsed, files by this one: normally, | |
1306 | // the files read most recently would override the older files, but with | |
1307 | // fallback == TRUE this won't happen | |
1308 | bool ReadMailcap(const wxString& filename, bool fallback = FALSE); | |
1309 | ||
1310 | // read in additional file in mime.types format | |
1311 | bool ReadMimeTypes(const wxString& filename); | |
1312 | ||
1313 | // enumerate all known MIME types | |
1314 | %addmethods { | |
1315 | PyObject* EnumAllFileTypes() { | |
1316 | wxArrayString arr; | |
1317 | self->EnumAllFileTypes(arr); | |
1318 | return wxArrayString2PyList_helper(arr); | |
1319 | } | |
1320 | } | |
1321 | ||
1322 | // these functions can be used to provide default values for some of the | |
1323 | // MIME types inside the program itself (you may also use | |
1324 | // ReadMailcap(filenameWithDefaultTypes, TRUE /* use as fallback */) to | |
1325 | // achieve the same goal, but this requires having this info in a file). | |
1326 | // | |
1327 | void AddFallback(const wxFileTypeInfo& ft); | |
1328 | ||
1329 | ||
1330 | // create or remove associations | |
1331 | ||
1332 | // create a new association using the fields of wxFileTypeInfo (at least | |
1333 | // the MIME type and the extension should be set) | |
1334 | // if the other fields are empty, the existing values should be left alone | |
1335 | %new wxFileType *Associate(const wxFileTypeInfo& ftInfo); | |
1336 | ||
1337 | // undo Associate() | |
1338 | bool Unassociate(wxFileType *ft) ; | |
1339 | ||
1340 | // dtor (not virtual, shouldn't be derived from) | |
1341 | ~wxMimeTypesManager(); | |
1342 | }; | |
1343 | ||
1344 | ||
1345 | %readonly | |
1346 | %{ | |
1347 | #if 0 | |
1348 | %} | |
1349 | extern wxMimeTypesManager* wxTheMimeTypesManager; | |
1350 | %{ | |
1351 | #endif | |
1352 | %} | |
1353 | %readwrite | |
1354 | ||
7dbce44a RD |
1355 | //---------------------------------------------------------------------- |
1356 | ||
1357 | %{ | |
1358 | #include <wx/docview.h> | |
1359 | %} | |
1360 | ||
1361 | class wxFileHistory : public wxObject | |
1362 | { | |
1363 | public: | |
1364 | wxFileHistory(int maxFiles = 9); | |
1365 | ~wxFileHistory(); | |
1366 | ||
1367 | // Operations | |
1368 | void AddFileToHistory(const wxString& file); | |
1369 | void RemoveFileFromHistory(int i); | |
1370 | int GetMaxFiles() const; | |
1371 | void UseMenu(wxMenu *menu); | |
1372 | ||
1373 | // Remove menu from the list (MDI child may be closing) | |
1374 | void RemoveMenu(wxMenu *menu); | |
1375 | ||
1376 | void Load(wxConfigBase& config); | |
1377 | void Save(wxConfigBase& config); | |
1378 | ||
1379 | void AddFilesToMenu(); | |
1380 | %name(AddFilesToSingleMenu)void AddFilesToMenu(wxMenu* menu); | |
1381 | ||
1382 | // Accessors | |
1383 | wxString GetHistoryFile(int i) const; | |
1384 | ||
1385 | // A synonym for GetNoHistoryFiles | |
1386 | int GetCount() const; | |
1387 | int GetNoHistoryFiles() const; | |
1388 | ||
1389 | }; | |
1390 | ||
4f3449b4 | 1391 | //---------------------------------------------------------------------- |
f0261a72 | 1392 | //---------------------------------------------------------------------- |
9416aa89 | 1393 | |
493f1553 | 1394 | |
9416aa89 RD |
1395 | %init %{ |
1396 | wxPyPtrTypeMap_Add("wxFontEnumerator", "wxPyFontEnumerator"); | |
1397 | wxPyPtrTypeMap_Add("wxDragImage", "wxGenericDragImage"); | |
1398 | wxPyPtrTypeMap_Add("wxProcess", "wxPyProcess"); | |
1399 | %} | |
1400 | ||
f0261a72 RD |
1401 | //---------------------------------------------------------------------- |
1402 |