1 /////////////////////////////////////////////////////////////////////////////
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.)
9 // Created: 18-June-1999
11 // Copyright: (c) 1998 by Total Control Software
12 // Licence: wxWindows license
13 /////////////////////////////////////////////////////////////////////////////
19 #include "pyistream.h"
20 #include <wx/resource.h>
21 #include <wx/tooltip.h>
23 #include <wx/tipdlg.h>
24 #include <wx/process.h>
26 #if wxUSE_JOYSTICK || defined(__WXMSW__)
27 #include <wx/joystick.h>
30 #if wxUSE_WAVE || defined(__WXMSW__)
34 #include <wx/mimetype.h>
35 #include <wx/snglinst.h>
36 #include <wx/effects.h>
37 //#include <wx/spawnbrowser.h>
40 //----------------------------------------------------------------------
43 %include my_typemaps.i
45 // Import some definitions of other classes, etc.
55 //----------------------------------------------------------------------
58 // Put some wx default wxChar* values into wxStrings.
59 DECLARE_DEF_STRING(FileSelectorPromptStr);
60 DECLARE_DEF_STRING(FileSelectorDefaultWildcardStr);
61 DECLARE_DEF_STRING(DirSelectorPromptStr);
62 static const wxString wxPyEmptyString(wxT(""));
65 //---------------------------------------------------------------------------
68 wxString wxFileSelector(const wxString& message = wxPyFileSelectorPromptStr,
69 const wxString& default_path = wxPyEmptyString,
70 const wxString& default_filename = wxPyEmptyString,
71 const wxString& default_extension = wxPyEmptyString,
72 const wxString& wildcard = wxPyFileSelectorDefaultWildcardStr,
74 wxWindow *parent = NULL,
75 int x = -1, int y = -1);
77 // Ask for filename to load
78 wxString wxLoadFileSelector(const wxString& what,
79 const wxString& extension,
80 const wxString& default_name = wxPyEmptyString,
81 wxWindow *parent = NULL);
83 // Ask for filename to save
84 wxString wxSaveFileSelector(const wxString& what,
85 const wxString& extension,
86 const wxString& default_name = wxPyEmptyString,
87 wxWindow *parent = NULL);
90 wxString wxDirSelector(const wxString& message = wxPyDirSelectorPromptStr,
91 const wxString& defaultPath = wxPyEmptyString,
92 long style = wxDD_DEFAULT_STYLE,
93 const wxPoint& pos = wxDefaultPosition,
94 wxWindow *parent = NULL);
96 wxString wxGetTextFromUser(const wxString& message,
97 const wxString& caption = wxPyEmptyString,
98 const wxString& default_value = wxPyEmptyString,
99 wxWindow *parent = NULL,
100 int x = -1, int y = -1,
103 wxString wxGetPasswordFromUser(const wxString& message,
104 const wxString& caption = wxPyEmptyString,
105 const wxString& default_value = wxPyEmptyString,
106 wxWindow *parent = NULL);
109 // TODO: Need to custom wrap this one...
110 // int wxGetMultipleChoice(char* message, char* caption,
111 // int LCOUNT, char** choices,
112 // int nsel, int *selection,
113 // wxWindow *parent = NULL, int x = -1, int y = -1,
114 // bool centre = TRUE, int width=150, int height=200);
117 wxString wxGetSingleChoice(const wxString& message, const wxString& caption,
118 int LCOUNT, wxString* choices,
119 wxWindow *parent = NULL,
120 int x = -1, int y = -1,
122 int width=150, int height=200);
124 int wxGetSingleChoiceIndex(const wxString& message, const wxString& caption,
125 int LCOUNT, wxString* choices,
126 wxWindow *parent = NULL,
127 int x = -1, int y = -1,
129 int width=150, int height=200);
132 int wxMessageBox(const wxString& message,
133 const wxString& caption = wxPyEmptyString,
134 int style = wxOK | wxCENTRE,
135 wxWindow *parent = NULL,
136 int x = -1, int y = -1);
138 long wxGetNumberFromUser(const wxString& message,
139 const wxString& prompt,
140 const wxString& caption,
142 long min = 0, long max = 100,
143 wxWindow *parent = NULL,
144 const wxPoint& pos = wxDefaultPosition);
146 //---------------------------------------------------------------------------
149 bool wxColourDisplay();
151 int wxDisplayDepth();
152 int wxGetDisplayDepth();
154 void wxDisplaySize(int* OUTPUT, int* OUTPUT);
155 wxSize wxGetDisplaySize();
157 void wxDisplaySizeMM(int* OUTPUT, int* OUTPUT);
158 wxSize wxGetDisplaySizeMM();
160 void wxClientDisplayRect(int *OUTPUT, int *OUTPUT, int *OUTPUT, int *OUTPUT);
161 wxRect wxGetClientDisplayRect();
163 void wxSetCursor(wxCursor& cursor);
165 //----------------------------------------------------------------------
166 // Miscellaneous functions
168 void wxBeginBusyCursor(wxCursor *cursor = wxHOURGLASS_CURSOR);
169 wxWindow * wxGetActiveWindow();
171 wxWindow* wxGenericFindWindowAtPoint(const wxPoint& pt);
172 wxWindow* wxFindWindowAtPoint(const wxPoint& pt);
175 bool wxCheckForInterrupt(wxWindow *wnd);
176 void wxFlushEvents();
179 wxWindow* wxGetTopLevelParent(wxWindow *win);
181 //bool wxSpawnBrowser(wxWindow *parent, wxString href);
183 //---------------------------------------------------------------------------
186 #ifdef wxUSE_WX_RESOURCES
187 bool wxResourceAddIdentifier(char* name, int value);
188 void wxResourceClear(void);
189 wxBitmap wxResourceCreateBitmap(char* resource);
190 wxIcon wxResourceCreateIcon(char* resource);
191 wxMenuBar * wxResourceCreateMenuBar(char* resource);
192 int wxResourceGetIdentifier(char* name);
193 bool wxResourceParseData(char* resource, wxResourceTable *table = NULL);
194 bool wxResourceParseFile(char* filename, wxResourceTable *table = NULL);
195 bool wxResourceParseString(char* resource, wxResourceTable *table = NULL);
198 //---------------------------------------------------------------------------
201 // possible values for wxSystemSettings::GetFont() parameter
205 wxSYS_OEM_FIXED_FONT = 10,
206 wxSYS_ANSI_FIXED_FONT,
209 wxSYS_DEVICE_DEFAULT_FONT,
210 wxSYS_DEFAULT_PALETTE,
211 wxSYS_SYSTEM_FIXED_FONT,
212 wxSYS_DEFAULT_GUI_FONT
215 // possible values for wxSystemSettings::GetColour() parameter
219 wxSYS_COLOUR_SCROLLBAR,
220 wxSYS_COLOUR_BACKGROUND,
221 wxSYS_COLOUR_DESKTOP = wxSYS_COLOUR_BACKGROUND,
222 wxSYS_COLOUR_ACTIVECAPTION,
223 wxSYS_COLOUR_INACTIVECAPTION,
226 wxSYS_COLOUR_WINDOWFRAME,
227 wxSYS_COLOUR_MENUTEXT,
228 wxSYS_COLOUR_WINDOWTEXT,
229 wxSYS_COLOUR_CAPTIONTEXT,
230 wxSYS_COLOUR_ACTIVEBORDER,
231 wxSYS_COLOUR_INACTIVEBORDER,
232 wxSYS_COLOUR_APPWORKSPACE,
233 wxSYS_COLOUR_HIGHLIGHT,
234 wxSYS_COLOUR_HIGHLIGHTTEXT,
235 wxSYS_COLOUR_BTNFACE,
236 wxSYS_COLOUR_3DFACE = wxSYS_COLOUR_BTNFACE,
237 wxSYS_COLOUR_BTNSHADOW,
238 wxSYS_COLOUR_3DSHADOW = wxSYS_COLOUR_BTNSHADOW,
239 wxSYS_COLOUR_GRAYTEXT,
240 wxSYS_COLOUR_BTNTEXT,
241 wxSYS_COLOUR_INACTIVECAPTIONTEXT,
242 wxSYS_COLOUR_BTNHIGHLIGHT,
243 wxSYS_COLOUR_BTNHILIGHT = wxSYS_COLOUR_BTNHIGHLIGHT,
244 wxSYS_COLOUR_3DHIGHLIGHT = wxSYS_COLOUR_BTNHIGHLIGHT,
245 wxSYS_COLOUR_3DHILIGHT = wxSYS_COLOUR_BTNHIGHLIGHT,
246 wxSYS_COLOUR_3DDKSHADOW,
247 wxSYS_COLOUR_3DLIGHT,
248 wxSYS_COLOUR_INFOTEXT,
250 wxSYS_COLOUR_LISTBOX,
251 wxSYS_COLOUR_HOTLIGHT,
252 wxSYS_COLOUR_GRADIENTACTIVECAPTION,
253 wxSYS_COLOUR_GRADIENTINACTIVECAPTION,
254 wxSYS_COLOUR_MENUHILIGHT,
255 wxSYS_COLOUR_MENUBAR,
260 // possible values for wxSystemSettings::GetMetric() parameter
264 wxSYS_MOUSE_BUTTONS = 1,
275 wxSYS_HSCROLL_ARROW_X,
276 wxSYS_HSCROLL_ARROW_Y,
292 wxSYS_VSCROLL_ARROW_X,
293 wxSYS_VSCROLL_ARROW_Y,
297 wxSYS_NETWORK_PRESENT,
298 wxSYS_PENWINDOWS_PRESENT,
303 // possible values for wxSystemSettings::HasFeature() parameter
306 wxSYS_CAN_DRAW_FRAME_DECORATIONS = 1,
307 wxSYS_CAN_ICONIZE_FRAME
310 enum wxSystemScreenType
312 wxSYS_SCREEN_NONE = 0, // not yet defined
314 wxSYS_SCREEN_TINY, // <
315 wxSYS_SCREEN_PDA, // >= 320x240
316 wxSYS_SCREEN_SMALL, // >= 640x480
317 wxSYS_SCREEN_DESKTOP // >= 800x600
321 class wxSystemSettings {
323 // get a standard system colour
324 static wxColour GetColour(wxSystemColour index);
326 // get a standard system font
327 static wxFont GetFont(wxSystemFont index);
329 // get a system-dependent metric
330 static int GetMetric(wxSystemMetric index);
332 // return true if the port has certain feature
333 static bool HasFeature(wxSystemFeature index);
335 // Get system screen design (desktop, pda, ..) used for
336 // laying out various dialogs.
337 static wxSystemScreenType GetScreenType();
340 static void SetScreenType( wxSystemScreenType screen );
346 //---------------------------------------------------------------------------
349 class wxToolTip : public wxObject {
351 wxToolTip(const wxString &tip);
353 void SetTip(const wxString& tip);
355 // *** Not in the "public" interface void SetWindow(wxWindow *win);
356 wxWindow *GetWindow();
358 static void Enable(bool flag);
359 static void SetDelay(long milliseconds);
362 //----------------------------------------------------------------------
366 wxCaret(wxWindow* window, const wxSize& size);
371 %name(GetPositionTuple)void GetPosition(int *OUTPUT, int *OUTPUT);
372 wxPoint GetPosition();
373 %name(GetSizeTuple)void GetSize(int *OUTPUT, int *OUTPUT);
375 wxWindow *GetWindow();
376 %name(MoveXY)void Move(int x, int y);
377 void Move(const wxPoint& pt);
378 %name(SetSizeWH) void SetSize(int width, int height);
379 void SetSize(const wxSize& size);
380 void Show(int show = TRUE);
385 int wxCaret_GetBlinkTime() {
386 return wxCaret::GetBlinkTime();
389 void wxCaret_SetBlinkTime(int milliseconds) {
390 wxCaret::SetBlinkTime(milliseconds);
394 //----------------------------------------------------------------------
398 wxBusyCursor(wxCursor* cursor = wxHOURGLASS_CURSOR);
402 //----------------------------------------------------------------------
404 class wxWindowDisabler {
406 wxWindowDisabler(wxWindow *winToSkip = NULL);
410 //----------------------------------------------------------------------
412 bool wxSafeYield(wxWindow* win=NULL, bool onlyIfNeeded=FALSE);
413 void wxPostEvent(wxEvtHandler *dest, wxEvent& event);
418 void wxWakeUpMainThread();
421 void wxMutexGuiEnter();
422 void wxMutexGuiLeave();
425 class wxMutexGuiLocker {
433 bool wxThread_IsMain() {
434 #ifdef WXP_WITH_THREAD
435 return wxThread::IsMain();
442 //----------------------------------------------------------------------
448 // wxTipProvider(size_t currentTip); **** Abstract base class
451 virtual wxString GetTip() = 0;
452 size_t GetCurrentTip();
453 virtual wxString PreprocessTip(const wxString& tip);
457 // The C++ version of wxPyTipProvider
459 class wxPyTipProvider : public wxTipProvider {
461 wxPyTipProvider(size_t currentTip)
462 : wxTipProvider(currentTip) {}
464 DEC_PYCALLBACK_STRING__pure(GetTip);
465 DEC_PYCALLBACK_STRING_STRING(PreprocessTip);
469 IMP_PYCALLBACK_STRING__pure( wxPyTipProvider, wxTipProvider, GetTip);
470 IMP_PYCALLBACK_STRING_STRING(wxPyTipProvider, wxTipProvider, PreprocessTip);
474 // Now let SWIG know about it
475 class wxPyTipProvider : public wxTipProvider {
477 wxPyTipProvider(size_t currentTip);
479 void _setCallbackInfo(PyObject* self, PyObject* _class);
480 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxPyTipProvider)"
485 bool wxShowTip(wxWindow *parent, wxTipProvider *tipProvider, bool showAtStartup = TRUE);
486 %new wxTipProvider * wxCreateFileTipProvider(const wxString& filename, size_t currentTip);
489 //----------------------------------------------------------------------
492 #include <wx/generic/dragimgg.h>
495 %name (wxDragImage) class wxGenericDragImage : public wxObject
499 wxGenericDragImage(const wxBitmap& image,
500 const wxCursor& cursor = wxNullCursor);
501 %name(wxDragIcon)wxGenericDragImage(const wxIcon& image,
502 const wxCursor& cursor = wxNullCursor);
503 %name(wxDragString)wxGenericDragImage(const wxString& str,
504 const wxCursor& cursor = wxNullCursor);
505 %name(wxDragTreeItem)wxGenericDragImage(const wxTreeCtrl& treeCtrl, wxTreeItemId& id);
506 %name(wxDragListItem)wxGenericDragImage(const wxListCtrl& listCtrl, long id);
508 ~wxGenericDragImage();
510 void SetBackingBitmap(wxBitmap* bitmap);
511 bool BeginDrag(const wxPoint& hotspot, wxWindow* window,
512 bool fullScreen = FALSE, wxRect* rect = NULL);
514 %name(BeginDragBounded) bool BeginDrag(const wxPoint& hotspot, wxWindow* window,
515 wxWindow* boundingWindow);
517 %pragma(python) addtoclass = "BeginDrag2 = BeginDragBounded"
520 bool Move(const wxPoint& pt);
524 wxRect GetImageRect(const wxPoint& pos) const;
525 bool RedrawImage(const wxPoint& oldPos, const wxPoint& newPos,
526 bool eraseOld, bool drawNew);
530 //----------------------------------------------------------------------
532 class wxPyTimer : public wxObject {
534 wxPyTimer(PyObject* notify);
539 void SetOwner(wxEvtHandler *owner, int id = -1);
540 void Start(int milliseconds=-1, int oneShot=FALSE);
548 // ctor starts the stop watch
551 void Start(long t = 0);
555 // get elapsed time since the last Start() or Pause() in milliseconds
560 //----------------------------------------------------------------------
561 //----------------------------------------------------------------------
566 wxLOG_FatalError, // program can't continue, abort immediately
567 wxLOG_Error, // a serious error, user must be informed about it
568 wxLOG_Warning, // user is normally informed about it but may be ignored
569 wxLOG_Message, // normal message (i.e. normal output of a non GUI app)
570 wxLOG_Info, // informational message (a.k.a. 'Verbose')
571 wxLOG_Status, // informational: might go to the status line of GUI app
572 wxLOG_Debug, // never shown to the user, disabled in release mode
573 wxLOG_Trace, // trace messages are also only enabled in debug mode
574 wxLOG_Progress, // used for progress indicator (not yet)
575 wxLOG_User = 100 // user defined levels start here
578 #define wxTRACE_MemAlloc "memalloc" // trace memory allocation (new/delete)
579 #define wxTRACE_Messages "messages" // trace window messages/X callbacks
580 #define wxTRACE_ResAlloc "resalloc" // trace GDI resource allocation
581 #define wxTRACE_RefCount "refcount" // trace various ref counting operations
584 #define wxTRACE_OleCalls "ole" // OLE interface calls
605 static bool IsEnabled();
606 static bool EnableLogging(bool doIt = TRUE);
607 static void OnLog(unsigned long level, const wxString& szString, int t=0);
609 virtual void Flush();
610 static void FlushActive();
611 static wxLog *GetActiveTarget();
612 static wxLog *SetActiveTarget(wxLog *pLogger);
614 static void Suspend();
615 static void Resume();
617 static void SetVerbose(bool bVerbose = TRUE);
619 static void DontCreateOnDemand();
620 static void SetTraceMask(long ulMask);
621 static void AddTraceMask(const wxString& str);
622 static void RemoveTraceMask(const wxString& str);
623 static void ClearTraceMasks();
624 static const wxArrayString &GetTraceMasks();
626 static void SetTimestamp(const wxString& ts);
627 static const wxString& GetTimestamp();
629 bool GetVerbose() const;
631 static unsigned long GetTraceMask();
632 static bool IsAllowedTraceMask(const wxString& mask);
634 static void SetLogLevel(unsigned long logLevel);
635 static unsigned long GetLogLevel();
638 // static void TimeStamp(wxString *str);
640 wxString TimeStamp() {
642 wxLog::TimeStamp(&msg);
650 class wxLogStderr : public wxLog
653 wxLogStderr(/* TODO: FILE *fp = (FILE *) NULL*/);
657 class wxLogTextCtrl : public wxLog
660 wxLogTextCtrl(wxTextCtrl *pTextCtrl);
664 class wxLogGui : public wxLog
670 class wxLogWindow : public wxLog
673 wxLogWindow(wxFrame *pParent, // the parent frame (can be NULL)
674 const wxString& szTitle, // the title of the frame
675 bool bShow = TRUE, // show window immediately?
676 bool bPassToOld = TRUE); // pass log messages to the old target?
678 void Show(bool bShow = TRUE);
679 wxFrame *GetFrame() const;
680 wxLog *GetOldLog() const;
681 bool IsPassingMessages() const;
682 void PassMessages(bool bDoPass);
686 class wxLogChain : public wxLog
689 wxLogChain(wxLog *logger);
690 void SetLog(wxLog *logger);
691 void PassMessages(bool bDoPass);
692 bool IsPassingMessages();
697 unsigned long wxSysErrorCode();
698 const wxString wxSysErrorMsg(unsigned long nErrCode = 0);
699 void wxLogFatalError(const wxString& msg);
700 void wxLogError(const wxString& msg);
701 void wxLogWarning(const wxString& msg);
702 void wxLogMessage(const wxString& msg);
703 void wxLogInfo(const wxString& msg);
704 void wxLogDebug(const wxString& msg);
705 void wxLogVerbose(const wxString& msg);
706 void wxLogStatus(const wxString& msg);
707 %name(wxLogStatusFrame)void wxLogStatus(wxFrame *pFrame, const wxString& msg);
708 void wxLogSysError(const wxString& msg);
710 void wxLogTrace(const wxString& msg);
711 %name(wxLogTraceMask)void wxLogTrace(const wxString& mask, const wxString& msg);
713 void wxLogGeneric(unsigned long level, const wxString& msg);
715 // wxLogFatalError helper: show the (fatal) error to the user in a safe way,
716 // i.e. without using wxMessageBox() for example because it could crash
717 void wxSafeShowMessage(const wxString& title, const wxString& text);
721 // Suspress logging while an instance of this class exists
733 // A wxLog class that can be derived from in wxPython
734 class wxPyLog : public wxLog {
736 wxPyLog() : wxLog() {}
738 virtual void DoLog(wxLogLevel level, const wxChar *szString, time_t t) {
740 wxPyBeginBlockThreads();
741 if ((found = wxPyCBH_findCallback(m_myInst, "DoLog"))) {
742 PyObject* s = wx2PyString(szString);
743 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iOi)", level, s, t));
746 wxPyEndBlockThreads();
748 wxLog::DoLog(level, szString, t);
751 virtual void DoLogString(const wxChar *szString, time_t t) {
753 wxPyBeginBlockThreads();
754 if ((found = wxPyCBH_findCallback(m_myInst, "DoLogString"))) {
755 PyObject* s = wx2PyString(szString);
756 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(Oi)", s, t));
759 wxPyEndBlockThreads();
761 wxLog::DoLogString(szString, t);
768 // Now tell SWIG about it
769 class wxPyLog : public wxLog {
772 void _setCallbackInfo(PyObject* self, PyObject* _class);
773 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxPyLog)"
774 %addmethods { void Destroy() { delete self; } }
779 //----------------------------------------------------------------------
784 wxKILL_OK, // no error
785 wxKILL_BAD_SIGNAL, // no such signal
786 wxKILL_ACCESS_DENIED, // permission denied
787 wxKILL_NO_PROCESS, // no such process
788 wxKILL_ERROR // another, unspecified error
793 wxSIGNONE = 0, // verify if the process exists under Unix
800 wxSIGIOT = wxSIGABRT, // another name
811 // further signals are different in meaning between different Unix systems
823 class wxProcessEvent : public wxEvent {
825 wxProcessEvent(int id = 0, int pid = 0, int exitcode = 0);
828 int m_pid, m_exitcode;
834 %{ // C++ version of wxProcess derived class
836 class wxPyProcess : public wxProcess {
838 wxPyProcess(wxEvtHandler *parent = NULL, int id = -1)
839 : wxProcess(parent, id)
842 DEC_PYCALLBACK_VOID_INTINT(OnTerminate);
847 IMP_PYCALLBACK_VOID_INTINT( wxPyProcess, wxProcess, OnTerminate);
852 %name(wxProcess)class wxPyProcess : public wxEvtHandler {
854 // kill the process with the given PID
855 static wxKillError Kill(int pid, wxSignal sig = wxSIGTERM);
857 // test if the given process exists
858 static bool Exists(int pid);
860 // this function replaces the standard popen() one: it launches a process
861 // asynchronously and allows the caller to get the streams connected to its
864 // on error NULL is returned, in any case the process object will be
865 // deleted automatically when the process terminates and should *not* be
866 // deleted by the caller
867 static wxPyProcess *Open(const wxString& cmd, int flags = wxEXEC_ASYNC);
871 wxPyProcess(wxEvtHandler *parent = NULL, int id = -1);
872 %addmethods { void Destroy() { delete self; } }
874 void _setCallbackInfo(PyObject* self, PyObject* _class);
875 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxProcess)"
877 void base_OnTerminate(int pid, int status);
883 wxInputStream *GetInputStream();
884 wxInputStream *GetErrorStream();
885 wxOutputStream *GetOutputStream();
889 // return TRUE if the child process stdout is not closed
890 bool IsInputOpened() const;
892 // return TRUE if any input is available on the child process stdout/err
893 bool IsInputAvailable() const;
894 bool IsErrorAvailable() const;
900 // execute the process asynchronously
903 // execute it synchronously, i.e. wait until it finishes
906 // under Windows, don't hide the child even if it's IO is redirected (this
907 // is done by default)
910 // under Unix, if the process is the group leader then killing -pid kills
911 // all children as well as pid
912 wxEXEC_MAKE_GROUP_LEADER = 4
916 long wxExecute(const wxString& command,
917 int flags = wxEXEC_ASYNC,
918 wxPyProcess *process = NULL);
920 //----------------------------------------------------------------------
923 // Which joystick? Same as Windows ids so no conversion necessary.
930 // Which button is down?
942 #if !wxUSE_JOYSTICK && !defined(__WXMSW__)
943 // A C++ stub class for wxJoystick for platforms that don't have it.
944 class wxJoystick : public wxObject {
946 wxJoystick(int joystick = wxJOYSTICK1) {
947 wxPyBeginBlockThreads();
948 PyErr_SetString(PyExc_NotImplementedError, "wxJoystick is not available on this platform.");
949 wxPyEndBlockThreads();
951 wxPoint GetPosition() { return wxPoint(-1,-1); }
952 int GetZPosition() { return -1; }
953 int GetButtonState() { return -1; }
954 int GetPOVPosition() { return -1; }
955 int GetPOVCTSPosition() { return -1; }
956 int GetRudderPosition() { return -1; }
957 int GetUPosition() { return -1; }
958 int GetVPosition() { return -1; }
959 int GetMovementThreshold() { return -1; }
960 void SetMovementThreshold(int threshold) {}
962 bool IsOk(void) { return FALSE; }
963 int GetNumberJoysticks() { return -1; }
964 int GetManufacturerId() { return -1; }
965 int GetProductId() { return -1; }
966 wxString GetProductName() { return ""; }
967 int GetXMin() { return -1; }
968 int GetYMin() { return -1; }
969 int GetZMin() { return -1; }
970 int GetXMax() { return -1; }
971 int GetYMax() { return -1; }
972 int GetZMax() { return -1; }
973 int GetNumberButtons() { return -1; }
974 int GetNumberAxes() { return -1; }
975 int GetMaxButtons() { return -1; }
976 int GetMaxAxes() { return -1; }
977 int GetPollingMin() { return -1; }
978 int GetPollingMax() { return -1; }
979 int GetRudderMin() { return -1; }
980 int GetRudderMax() { return -1; }
981 int GetUMin() { return -1; }
982 int GetUMax() { return -1; }
983 int GetVMin() { return -1; }
984 int GetVMax() { return -1; }
986 bool HasRudder() { return FALSE; }
987 bool HasZ() { return FALSE; }
988 bool HasU() { return FALSE; }
989 bool HasV() { return FALSE; }
990 bool HasPOV() { return FALSE; }
991 bool HasPOV4Dir() { return FALSE; }
992 bool HasPOVCTS() { return FALSE; }
994 bool SetCapture(wxWindow* win, int pollingFreq = 0) { return FALSE; }
995 bool ReleaseCapture() { return FALSE; }
1001 class wxJoystick : public wxObject {
1003 wxJoystick(int joystick = wxJOYSTICK1);
1006 wxPoint GetPosition();
1008 int GetButtonState();
1009 int GetPOVPosition();
1010 int GetPOVCTSPosition();
1011 int GetRudderPosition();
1014 int GetMovementThreshold();
1015 void SetMovementThreshold(int threshold) ;
1018 int GetNumberJoysticks();
1019 int GetManufacturerId();
1021 wxString GetProductName();
1028 int GetNumberButtons();
1029 int GetNumberAxes();
1030 int GetMaxButtons();
1032 int GetPollingMin();
1033 int GetPollingMax();
1049 bool SetCapture(wxWindow* win, int pollingFreq = 0);
1050 bool ReleaseCapture();
1053 //----------------------------------------------------------------------
1057 // A C++ stub class for wxWave for platforms that don't have it.
1058 class wxWave : public wxObject
1061 wxWave(const wxString& fileName, bool isResource = FALSE) {
1062 wxPyBeginBlockThreads();
1063 PyErr_SetString(PyExc_NotImplementedError, "wxWave is not available on this platform.");
1064 wxPyEndBlockThreads();
1066 wxWave(int size, const wxByte* data) {
1067 wxPyBeginBlockThreads();
1068 PyErr_SetString(PyExc_NotImplementedError, "wxWave is not available on this platform.");
1069 wxPyEndBlockThreads();
1074 bool IsOk() const { return FALSE; }
1075 bool Play(bool async = TRUE, bool looped = FALSE) const { return FALSE; }
1081 class wxWave : public wxObject
1084 wxWave(const wxString& fileName, bool isResource = FALSE);
1088 bool Play(bool async = TRUE, bool looped = FALSE) const;
1091 %new wxWave* wxWaveData(const wxString& data);
1092 %{ // Implementations of some alternate "constructors"
1093 wxWave* wxWaveData(const wxString& data) {
1094 return new wxWave(data.Len(), (wxByte*)data.c_str());
1099 //----------------------------------------------------------------------
1103 wxMAILCAP_STANDARD = 1,
1104 wxMAILCAP_NETSCAPE = 2,
1106 wxMAILCAP_GNOME = 8,
1113 class wxFileTypeInfo
1118 wxFileTypeInfo(const wxString& mimeType,
1119 const wxString& openCmd,
1120 const wxString& printCmd,
1121 const wxString& desc);
1124 // the array elements correspond to the parameters of the ctor above in
1126 %name(wxFileTypeInfoSequence)wxFileTypeInfo(const wxArrayString& sArray);
1128 // invalid item - use this to terminate the array passed to
1129 // wxMimeTypesManager::AddFallbacks
1130 %name(wxNullFileTypeInfo)wxFileTypeInfo();
1133 // test if this object can be used
1134 bool IsValid() const;
1137 // set the icon info
1138 void SetIcon(const wxString& iconFile, int iconIndex = 0);
1140 // set the short desc
1141 void SetShortDesc(const wxString& shortDesc);
1144 // get the MIME type
1145 const wxString& GetMimeType() const;
1146 // get the open command
1147 const wxString& GetOpenCommand() const;
1148 // get the print command
1149 const wxString& GetPrintCommand() const;
1150 // get the short description (only used under Win32 so far)
1151 const wxString& GetShortDesc() const;
1152 // get the long, user visible description
1153 const wxString& GetDescription() const;
1156 // get the array of all extensions
1157 //const wxArrayString& GetExtensions() const;
1159 PyObject* GetExtensions() {
1160 wxArrayString& arr = (wxArrayString&)self->GetExtensions();
1161 return wxArrayString2PyList_helper(arr);
1165 int GetExtensionsCount() const;
1167 // get the icon info
1168 const wxString& GetIconFile() const;
1169 int GetIconIndex() const;
1179 // TODO: Make a wxPyMessageParameters with virtual GetParamValue...
1181 // An object of this class must be passed to Get{Open|Print}Command. The
1182 // default implementation is trivial and doesn't know anything at all about
1183 // parameters, only filename and MIME type are used (so it's probably ok for
1184 // Windows where %{param} is not used anyhow)
1185 class MessageParameters
1189 MessageParameters(const wxString& filename=wxPyEmptyString,
1190 const wxString& mimetype=wxPyEmptyString);
1192 // accessors (called by GetOpenCommand)
1194 const wxString& GetFileName() const;
1196 const wxString& GetMimeType() const;;
1198 // override this function in derived class
1199 virtual wxString GetParamValue(const wxString& name) const;
1201 // virtual dtor as in any base class
1202 virtual ~MessageParameters();
1206 // ctor from static data
1207 wxFileType(const wxFileTypeInfo& ftInfo);
1209 // return the MIME type for this file type
1211 PyObject* GetMimeType() {
1213 if (self->GetMimeType(&str)) {
1215 return PyUnicode_FromWideChar(str.c_str(), str.Len());
1217 return PyString_FromStringAndSize(str.c_str(), str.Len());
1223 PyObject* GetMimeTypes() {
1225 if (self->GetMimeTypes(arr))
1226 return wxArrayString2PyList_helper(arr);
1233 // Get all extensions associated with this file type
1235 PyObject* GetExtensions() {
1237 if (self->GetExtensions(arr))
1238 return wxArrayString2PyList_helper(arr);
1246 // Get the icon corresponding to this file type
1247 %new wxIcon* GetIcon() {
1249 if (self->GetIcon(&icon))
1250 return new wxIcon(icon);
1255 // Get the icon corresponding to this file type, the name of the file
1256 // where this icon resides, and its index in this file if applicable.
1257 PyObject* GetIconInfo() {
1261 if (self->GetIcon(&icon, &iconFile, &iconIndex)) {
1262 wxPyBeginBlockThreads();
1263 PyObject* tuple = PyTuple_New(3);
1264 PyTuple_SetItem(tuple, 0, wxPyConstructObject(new wxIcon(icon),
1265 wxT("wxIcon"), TRUE));
1267 PyTuple_SetItem(tuple, 1, PyUnicode_FromWideChar(iconFile.c_str(), iconFile.Len()));
1269 PyTuple_SetItem(tuple, 1, PyString_FromStringAndSize(iconFile.c_str(), iconFile.Len()));
1271 PyTuple_SetItem(tuple, 2, PyInt_FromLong(iconIndex));
1272 wxPyEndBlockThreads();
1281 // get a brief file type description ("*.txt" => "text document")
1282 PyObject* GetDescription() {
1284 if (self->GetDescription(&str)) {
1286 return PyUnicode_FromWideChar(str.c_str(), str.Len());
1288 return PyString_FromStringAndSize(str.c_str(), str.Len());
1296 // get the command to open/execute the file of given type
1298 PyObject* GetOpenCommand(const wxString& filename,
1299 const wxString& mimetype=wxPyEmptyString) {
1301 if (self->GetOpenCommand(&str, wxFileType::MessageParameters(filename, mimetype))) {
1303 return PyUnicode_FromWideChar(str.c_str(), str.Len());
1305 return PyString_FromStringAndSize(str.c_str(), str.Len());
1313 // get the command to print the file of given type
1315 PyObject* GetPrintCommand(const wxString& filename,
1316 const wxString& mimetype=wxPyEmptyString) {
1318 if (self->GetPrintCommand(&str, wxFileType::MessageParameters(filename, mimetype))) {
1320 return PyUnicode_FromWideChar(str.c_str(), str.Len());
1322 return PyString_FromStringAndSize(str.c_str(), str.Len());
1330 // Get all commands defined for this file type
1332 PyObject* GetAllCommands(const wxString& filename,
1333 const wxString& mimetype=wxPyEmptyString) {
1334 wxArrayString verbs;
1335 wxArrayString commands;
1336 if (self->GetAllCommands(&verbs, &commands,
1337 wxFileType::MessageParameters(filename, mimetype))) {
1338 wxPyBeginBlockThreads();
1339 PyObject* tuple = PyTuple_New(2);
1340 PyTuple_SetItem(tuple, 0, wxArrayString2PyList_helper(verbs));
1341 PyTuple_SetItem(tuple, 1, wxArrayString2PyList_helper(commands));
1342 wxPyEndBlockThreads();
1351 // set an arbitrary command, ask confirmation if it already exists and
1352 // overwriteprompt is TRUE
1353 bool SetCommand(const wxString& cmd, const wxString& verb,
1354 bool overwriteprompt = TRUE);
1356 bool SetDefaultIcon(const wxString& cmd = wxPyEmptyString, int index = 0);
1359 // remove the association for this filetype from the system MIME database:
1360 // notice that it will only work if the association is defined in the user
1361 // file/registry part, we will never modify the system-wide settings
1365 // expand a string in the format of GetOpenCommand (which may contain
1366 // '%s' and '%t' format specificators for the file name and mime type
1367 // and %{param} constructions).
1368 static wxString ExpandCommand(const wxString& command,
1369 const MessageParameters& params);
1371 // dtor (not virtual, shouldn't be derived from)
1379 class wxMimeTypesManager
1382 // static helper functions
1383 // -----------------------
1385 // check if the given MIME type is the same as the other one: the
1386 // second argument may contain wildcards ('*'), but not the first. If
1387 // the types are equal or if the mimeType matches wildcard the function
1388 // returns TRUE, otherwise it returns FALSE
1389 static bool IsOfType(const wxString& mimeType, const wxString& wildcard);
1392 wxMimeTypesManager();
1394 // loads data from standard files according to the mailcap styles
1395 // specified: this is a bitwise OR of wxMailcapStyle values
1397 // use the extraDir parameter if you want to look for files in another
1399 void Initialize(int mailcapStyle = wxMAILCAP_ALL,
1400 const wxString& extraDir = wxPyEmptyString);
1402 // and this function clears all the data from the manager
1405 // Database lookup: all functions return a pointer to wxFileType object
1406 // whose methods may be used to query it for the information you're
1407 // interested in. If the return value is !NULL, caller is responsible for
1409 // get file type from file extension
1410 %new wxFileType *GetFileTypeFromExtension(const wxString& ext);
1412 // get file type from MIME type (in format <category>/<format>)
1413 %new wxFileType *GetFileTypeFromMimeType(const wxString& mimeType);
1415 // other operations: return TRUE if there were no errors or FALSE if there
1416 // were some unreckognized entries (the good entries are always read anyhow)
1419 // read in additional file (the standard ones are read automatically)
1420 // in mailcap format (see mimetype.cpp for description)
1422 // 'fallback' parameter may be set to TRUE to avoid overriding the
1423 // settings from other, previously parsed, files by this one: normally,
1424 // the files read most recently would override the older files, but with
1425 // fallback == TRUE this won't happen
1426 bool ReadMailcap(const wxString& filename, bool fallback = FALSE);
1428 // read in additional file in mime.types format
1429 bool ReadMimeTypes(const wxString& filename);
1431 // enumerate all known MIME types
1433 PyObject* EnumAllFileTypes() {
1435 self->EnumAllFileTypes(arr);
1436 return wxArrayString2PyList_helper(arr);
1440 // these functions can be used to provide default values for some of the
1441 // MIME types inside the program itself (you may also use
1442 // ReadMailcap(filenameWithDefaultTypes, TRUE /* use as fallback */) to
1443 // achieve the same goal, but this requires having this info in a file).
1445 void AddFallback(const wxFileTypeInfo& ft);
1448 // create or remove associations
1450 // create a new association using the fields of wxFileTypeInfo (at least
1451 // the MIME type and the extension should be set)
1452 // if the other fields are empty, the existing values should be left alone
1453 %new wxFileType *Associate(const wxFileTypeInfo& ftInfo);
1456 bool Unassociate(wxFileType *ft) ;
1458 // dtor (not virtual, shouldn't be derived from)
1459 ~wxMimeTypesManager();
1467 extern wxMimeTypesManager* wxTheMimeTypesManager;
1473 //----------------------------------------------------------------------
1476 #include <wx/artprov.h>
1478 DECLARE_DEF_STRING(ART_OTHER);
1482 %pragma(python) code = "
1484 wxART_TOOLBAR = 'wxART_TOOLBAR_C'
1485 wxART_MENU = 'wxART_MENU_C'
1486 wxART_FRAME_ICON = 'wxART_FRAME_ICON_C'
1487 wxART_CMN_DIALOG = 'wxART_CMN_DIALOG_C'
1488 wxART_HELP_BROWSER = 'wxART_HELP_BROWSER_C'
1489 wxART_MESSAGE_BOX = 'wxART_MESSAGE_BOX_C'
1490 wxART_OTHER = 'wxART_OTHER_C'
1493 wxART_ADD_BOOKMARK = 'wxART_ADD_BOOKMARK'
1494 wxART_DEL_BOOKMARK = 'wxART_DEL_BOOKMARK'
1495 wxART_HELP_SIDE_PANEL = 'wxART_HELP_SIDE_PANEL'
1496 wxART_HELP_SETTINGS = 'wxART_HELP_SETTINGS'
1497 wxART_HELP_BOOK = 'wxART_HELP_BOOK'
1498 wxART_HELP_FOLDER = 'wxART_HELP_FOLDER'
1499 wxART_HELP_PAGE = 'wxART_HELP_PAGE'
1500 wxART_GO_BACK = 'wxART_GO_BACK'
1501 wxART_GO_FORWARD = 'wxART_GO_FORWARD'
1502 wxART_GO_UP = 'wxART_GO_UP'
1503 wxART_GO_DOWN = 'wxART_GO_DOWN'
1504 wxART_GO_TO_PARENT = 'wxART_GO_TO_PARENT'
1505 wxART_GO_HOME = 'wxART_GO_HOME'
1506 wxART_FILE_OPEN = 'wxART_FILE_OPEN'
1507 wxART_PRINT = 'wxART_PRINT'
1508 wxART_HELP = 'wxART_HELP'
1509 wxART_TIP = 'wxART_TIP'
1510 wxART_REPORT_VIEW = 'wxART_REPORT_VIEW'
1511 wxART_LIST_VIEW = 'wxART_LIST_VIEW'
1512 wxART_NEW_DIR = 'wxART_NEW_DIR'
1513 wxART_FOLDER = 'wxART_FOLDER'
1514 wxART_GO_DIR_UP = 'wxART_GO_DIR_UP'
1515 wxART_EXECUTABLE_FILE = 'wxART_EXECUTABLE_FILE'
1516 wxART_NORMAL_FILE = 'wxART_NORMAL_FILE'
1517 wxART_TICK_MARK = 'wxART_TICK_MARK'
1518 wxART_CROSS_MARK = 'wxART_CROSS_MARK'
1519 wxART_ERROR = 'wxART_ERROR'
1520 wxART_QUESTION = 'wxART_QUESTION'
1521 wxART_WARNING = 'wxART_WARNING'
1522 wxART_INFORMATION = 'wxART_INFORMATION'
1523 wxART_MISSING_IMAGE = 'wxART_MISSING_IMAGE'
1526 %{ // Python aware wxArtProvider
1527 class wxPyArtProvider : public wxArtProvider {
1530 virtual wxBitmap CreateBitmap(const wxArtID& id,
1531 const wxArtClient& client,
1532 const wxSize& size) {
1533 wxBitmap rval = wxNullBitmap;
1534 wxPyBeginBlockThreads();
1535 if ((wxPyCBH_findCallback(m_myInst, "CreateBitmap"))) {
1536 PyObject* so = wxPyConstructObject((void*)&size, wxT("wxSize"), 0);
1540 s1 = wx2PyString(id);
1541 s2 = wx2PyString(client);
1542 ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(OOO)", s1, s2, so));
1547 if (!SWIG_GetPtrObj(ro, (void**)&ptr, "_wxBitmap_p"))
1552 wxPyEndBlockThreads();
1560 // The one for SWIG to see
1561 %name(wxArtProvider) class wxPyArtProvider : public wxObject
1566 void _setCallbackInfo(PyObject* self, PyObject* _class);
1567 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxArtProvider)"
1569 // Add new provider to the top of providers stack.
1570 static void PushProvider(wxPyArtProvider *provider);
1572 // Remove latest added provider and delete it.
1573 static bool PopProvider();
1575 // Remove provider. The provider must have been added previously!
1576 // The provider is _not_ deleted.
1577 static bool RemoveProvider(wxPyArtProvider *provider);
1579 // Query the providers for bitmap with given ID and return it. Return
1580 // wxNullBitmap if no provider provides it.
1581 static wxBitmap GetBitmap(const wxString& id,
1582 const wxString& client = wxPyART_OTHER,
1583 const wxSize& size = wxDefaultSize);
1585 // Query the providers for icon with given ID and return it. Return
1586 // wxNullIcon if no provider provides it.
1587 static wxIcon GetIcon(const wxString& id,
1588 const wxString& client = wxPyART_OTHER,
1589 const wxSize& size = wxDefaultSize);
1594 //----------------------------------------------------------------------
1597 #include <wx/docview.h>
1600 class wxFileHistory : public wxObject
1603 wxFileHistory(int maxFiles = 9);
1607 void AddFileToHistory(const wxString& file);
1608 void RemoveFileFromHistory(int i);
1609 int GetMaxFiles() const;
1610 void UseMenu(wxMenu *menu);
1612 // Remove menu from the list (MDI child may be closing)
1613 void RemoveMenu(wxMenu *menu);
1615 void Load(wxConfigBase& config);
1616 void Save(wxConfigBase& config);
1618 void AddFilesToMenu();
1619 %name(AddFilesToThisMenu)void AddFilesToMenu(wxMenu* menu);
1622 wxString GetHistoryFile(int i) const;
1624 // A synonym for GetNoHistoryFiles
1625 int GetCount() const;
1626 int GetNoHistoryFiles() const;
1630 //----------------------------------------------------------------------
1632 class wxEffects: public wxObject
1635 // Assume system colours
1638 wxColour GetHighlightColour() const;
1639 wxColour GetLightShadow() const;
1640 wxColour GetFaceColour() const;
1641 wxColour GetMediumShadow() const;
1642 wxColour GetDarkShadow() const;
1644 void SetHighlightColour(const wxColour& c);
1645 void SetLightShadow(const wxColour& c);
1646 void SetFaceColour(const wxColour& c);
1647 void SetMediumShadow(const wxColour& c);
1648 void SetDarkShadow(const wxColour& c);
1650 void Set(const wxColour& highlightColour, const wxColour& lightShadow,
1651 const wxColour& faceColour, const wxColour& mediumShadow,
1652 const wxColour& darkShadow);
1654 // Draw a sunken edge
1655 void DrawSunkenEdge(wxDC& dc, const wxRect& rect, int borderSize = 1);
1658 bool TileBitmap(const wxRect& rect, wxDC& dc, wxBitmap& bitmap);
1662 //----------------------------------------------------------------------
1664 class wxSingleInstanceChecker
1667 // like Create() but no error checking (dangerous!)
1668 wxSingleInstanceChecker(const wxString& name,
1669 const wxString& path = wxPyEmptyString);
1671 // default ctor, use Create() after it
1672 %name(wxPreSingleInstanceChecker) wxSingleInstanceChecker();
1674 ~wxSingleInstanceChecker();
1677 // name must be given and be as unique as possible, it is used as the mutex
1678 // name under Win32 and the lock file name under Unix -
1679 // wxTheApp->GetAppName() may be a good value for this parameter
1681 // path is optional and is ignored under Win32 and used as the directory to
1682 // create the lock file in under Unix (default is wxGetHomeDir())
1684 // returns FALSE if initialization failed, it doesn't mean that another
1685 // instance is running - use IsAnotherRunning() to check it
1686 bool Create(const wxString& name, const wxString& path = wxPyEmptyString);
1688 // is another copy of this program already running?
1689 bool IsAnotherRunning() const;
1692 //----------------------------------------------------------------------
1696 wxPyPtrTypeMap_Add("wxDragImage", "wxGenericDragImage");
1697 wxPyPtrTypeMap_Add("wxProcess", "wxPyProcess");
1698 wxPyPtrTypeMap_Add("wxArtProvider", "wxPyArtProvider");
1702 //----------------------------------------------------------------------