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>
37 //----------------------------------------------------------------------
40 %include my_typemaps.i
42 // Import some definitions of other classes, etc.
52 //----------------------------------------------------------------------
55 // Put some wx default wxChar* values into wxStrings.
56 DECLARE_DEF_STRING(FileSelectorPromptStr);
57 DECLARE_DEF_STRING(FileSelectorDefaultWildcardStr);
58 DECLARE_DEF_STRING(DirSelectorPromptStr);
59 static const wxString wxPyEmptyString(wxT(""));
62 //---------------------------------------------------------------------------
65 wxString wxFileSelector(const wxString& message = wxPyFileSelectorPromptStr,
66 const wxString& default_path = wxPyEmptyString,
67 const wxString& default_filename = wxPyEmptyString,
68 const wxString& default_extension = wxPyEmptyString,
69 const wxString& wildcard = wxPyFileSelectorDefaultWildcardStr,
71 wxWindow *parent = NULL,
72 int x = -1, int y = -1);
74 // Ask for filename to load
75 wxString wxLoadFileSelector(const wxString& what,
76 const wxString& extension,
77 const wxString& default_name = wxPyEmptyString,
78 wxWindow *parent = NULL);
80 // Ask for filename to save
81 wxString wxSaveFileSelector(const wxString& what,
82 const wxString& extension,
83 const wxString& default_name = wxPyEmptyString,
84 wxWindow *parent = NULL);
87 wxString wxDirSelector(const wxString& message = wxPyDirSelectorPromptStr,
88 const wxString& defaultPath = wxPyEmptyString,
89 long style = wxDD_DEFAULT_STYLE,
90 const wxPoint& pos = wxDefaultPosition,
91 wxWindow *parent = NULL);
93 wxString wxGetTextFromUser(const wxString& message,
94 const wxString& caption = wxPyEmptyString,
95 const wxString& default_value = wxPyEmptyString,
96 wxWindow *parent = NULL,
97 int x = -1, int y = -1,
100 wxString wxGetPasswordFromUser(const wxString& message,
101 const wxString& caption = wxPyEmptyString,
102 const wxString& default_value = wxPyEmptyString,
103 wxWindow *parent = NULL);
106 // TODO: Need to custom wrap this one...
107 // int wxGetMultipleChoice(char* message, char* caption,
108 // int LCOUNT, char** choices,
109 // int nsel, int *selection,
110 // wxWindow *parent = NULL, int x = -1, int y = -1,
111 // bool centre = TRUE, int width=150, int height=200);
114 wxString wxGetSingleChoice(const wxString& message, const wxString& caption,
115 int LCOUNT, wxString* choices,
116 wxWindow *parent = NULL,
117 int x = -1, int y = -1,
119 int width=150, int height=200);
121 int wxGetSingleChoiceIndex(const wxString& message, const wxString& caption,
122 int LCOUNT, wxString* choices,
123 wxWindow *parent = NULL,
124 int x = -1, int y = -1,
126 int width=150, int height=200);
129 int wxMessageBox(const wxString& message,
130 const wxString& caption = wxPyEmptyString,
131 int style = wxOK | wxCENTRE,
132 wxWindow *parent = NULL,
133 int x = -1, int y = -1);
135 long wxGetNumberFromUser(const wxString& message,
136 const wxString& prompt,
137 const wxString& caption,
139 long min = 0, long max = 100,
140 wxWindow *parent = NULL,
141 const wxPoint& pos = wxDefaultPosition);
143 //---------------------------------------------------------------------------
146 bool wxColourDisplay();
148 int wxDisplayDepth();
149 int wxGetDisplayDepth();
151 void wxDisplaySize(int* OUTPUT, int* OUTPUT);
152 wxSize wxGetDisplaySize();
154 void wxDisplaySizeMM(int* OUTPUT, int* OUTPUT);
155 wxSize wxGetDisplaySizeMM();
157 void wxClientDisplayRect(int *OUTPUT, int *OUTPUT, int *OUTPUT, int *OUTPUT);
158 wxRect wxGetClientDisplayRect();
160 void wxSetCursor(wxCursor& cursor);
162 //----------------------------------------------------------------------
163 // Miscellaneous functions
165 void wxBeginBusyCursor(wxCursor *cursor = wxHOURGLASS_CURSOR);
166 wxWindow * wxGetActiveWindow();
168 wxWindow* wxGenericFindWindowAtPoint(const wxPoint& pt);
169 wxWindow* wxFindWindowAtPoint(const wxPoint& pt);
172 bool wxCheckForInterrupt(wxWindow *wnd);
173 void wxFlushEvents();
176 wxWindow* wxGetTopLevelParent(wxWindow *win);
178 //---------------------------------------------------------------------------
181 bool wxResourceAddIdentifier(char* name, int value);
182 void wxResourceClear(void);
183 wxBitmap wxResourceCreateBitmap(char* resource);
184 wxIcon wxResourceCreateIcon(char* resource);
185 wxMenuBar * wxResourceCreateMenuBar(char* resource);
186 int wxResourceGetIdentifier(char* name);
187 bool wxResourceParseData(char* resource, wxResourceTable *table = NULL);
188 bool wxResourceParseFile(char* filename, wxResourceTable *table = NULL);
189 bool wxResourceParseString(char* resource, wxResourceTable *table = NULL);
191 //---------------------------------------------------------------------------
194 // possible values for wxSystemSettings::GetFont() parameter
198 wxSYS_OEM_FIXED_FONT = 10,
199 wxSYS_ANSI_FIXED_FONT,
202 wxSYS_DEVICE_DEFAULT_FONT,
203 wxSYS_DEFAULT_PALETTE,
204 wxSYS_SYSTEM_FIXED_FONT,
205 wxSYS_DEFAULT_GUI_FONT
208 // possible values for wxSystemSettings::GetColour() parameter
212 wxSYS_COLOUR_SCROLLBAR,
213 wxSYS_COLOUR_BACKGROUND,
214 wxSYS_COLOUR_DESKTOP = wxSYS_COLOUR_BACKGROUND,
215 wxSYS_COLOUR_ACTIVECAPTION,
216 wxSYS_COLOUR_INACTIVECAPTION,
219 wxSYS_COLOUR_WINDOWFRAME,
220 wxSYS_COLOUR_MENUTEXT,
221 wxSYS_COLOUR_WINDOWTEXT,
222 wxSYS_COLOUR_CAPTIONTEXT,
223 wxSYS_COLOUR_ACTIVEBORDER,
224 wxSYS_COLOUR_INACTIVEBORDER,
225 wxSYS_COLOUR_APPWORKSPACE,
226 wxSYS_COLOUR_HIGHLIGHT,
227 wxSYS_COLOUR_HIGHLIGHTTEXT,
228 wxSYS_COLOUR_BTNFACE,
229 wxSYS_COLOUR_3DFACE = wxSYS_COLOUR_BTNFACE,
230 wxSYS_COLOUR_BTNSHADOW,
231 wxSYS_COLOUR_3DSHADOW = wxSYS_COLOUR_BTNSHADOW,
232 wxSYS_COLOUR_GRAYTEXT,
233 wxSYS_COLOUR_BTNTEXT,
234 wxSYS_COLOUR_INACTIVECAPTIONTEXT,
235 wxSYS_COLOUR_BTNHIGHLIGHT,
236 wxSYS_COLOUR_BTNHILIGHT = wxSYS_COLOUR_BTNHIGHLIGHT,
237 wxSYS_COLOUR_3DHIGHLIGHT = wxSYS_COLOUR_BTNHIGHLIGHT,
238 wxSYS_COLOUR_3DHILIGHT = wxSYS_COLOUR_BTNHIGHLIGHT,
239 wxSYS_COLOUR_3DDKSHADOW,
240 wxSYS_COLOUR_3DLIGHT,
241 wxSYS_COLOUR_INFOTEXT,
243 wxSYS_COLOUR_LISTBOX,
244 wxSYS_COLOUR_HOTLIGHT,
245 wxSYS_COLOUR_GRADIENTACTIVECAPTION,
246 wxSYS_COLOUR_GRADIENTINACTIVECAPTION,
247 wxSYS_COLOUR_MENUHILIGHT,
248 wxSYS_COLOUR_MENUBAR,
253 // possible values for wxSystemSettings::GetMetric() parameter
257 wxSYS_MOUSE_BUTTONS = 1,
268 wxSYS_HSCROLL_ARROW_X,
269 wxSYS_HSCROLL_ARROW_Y,
285 wxSYS_VSCROLL_ARROW_X,
286 wxSYS_VSCROLL_ARROW_Y,
290 wxSYS_NETWORK_PRESENT,
291 wxSYS_PENWINDOWS_PRESENT,
296 // possible values for wxSystemSettings::HasFeature() parameter
299 wxSYS_CAN_DRAW_FRAME_DECORATIONS = 1,
300 wxSYS_CAN_ICONIZE_FRAME
303 enum wxSystemScreenType
305 wxSYS_SCREEN_NONE = 0, // not yet defined
307 wxSYS_SCREEN_TINY, // <
308 wxSYS_SCREEN_PDA, // >= 320x240
309 wxSYS_SCREEN_SMALL, // >= 640x480
310 wxSYS_SCREEN_DESKTOP // >= 800x600
314 class wxSystemSettings {
316 // get a standard system colour
317 static wxColour GetColour(wxSystemColour index);
319 // get a standard system font
320 static wxFont GetFont(wxSystemFont index);
322 // get a system-dependent metric
323 static int GetMetric(wxSystemMetric index);
325 // return true if the port has certain feature
326 static bool HasFeature(wxSystemFeature index);
328 // Get system screen design (desktop, pda, ..) used for
329 // laying out various dialogs.
330 static wxSystemScreenType GetScreenType();
333 static void SetScreenType( wxSystemScreenType screen );
339 //---------------------------------------------------------------------------
342 class wxToolTip : public wxObject {
344 wxToolTip(const wxString &tip);
346 void SetTip(const wxString& tip);
348 // *** Not in the "public" interface void SetWindow(wxWindow *win);
349 wxWindow *GetWindow();
351 static void Enable(bool flag);
352 static void SetDelay(long milliseconds);
355 //----------------------------------------------------------------------
359 wxCaret(wxWindow* window, const wxSize& size);
364 %name(GetPositionTuple)void GetPosition(int *OUTPUT, int *OUTPUT);
365 wxPoint GetPosition();
366 %name(GetSizeTuple)void GetSize(int *OUTPUT, int *OUTPUT);
368 wxWindow *GetWindow();
369 %name(MoveXY)void Move(int x, int y);
370 void Move(const wxPoint& pt);
371 %name(SetSizeWH) void SetSize(int width, int height);
372 void SetSize(const wxSize& size);
373 void Show(int show = TRUE);
378 int wxCaret_GetBlinkTime() {
379 return wxCaret::GetBlinkTime();
382 void wxCaret_SetBlinkTime(int milliseconds) {
383 wxCaret::SetBlinkTime(milliseconds);
387 //----------------------------------------------------------------------
391 wxBusyCursor(wxCursor* cursor = wxHOURGLASS_CURSOR);
395 //----------------------------------------------------------------------
397 class wxWindowDisabler {
399 wxWindowDisabler(wxWindow *winToSkip = NULL);
403 //----------------------------------------------------------------------
405 bool wxSafeYield(wxWindow* win=NULL);
406 void wxPostEvent(wxEvtHandler *dest, wxEvent& event);
411 void wxWakeUpMainThread();
414 void wxMutexGuiEnter();
415 void wxMutexGuiLeave();
418 class wxMutexGuiLocker {
426 bool wxThread_IsMain() {
427 #ifdef WXP_WITH_THREAD
428 return wxThread::IsMain();
435 //----------------------------------------------------------------------
441 // wxTipProvider(size_t currentTip); **** Abstract base class
444 virtual wxString GetTip() = 0;
445 size_t GetCurrentTip();
450 // The C++ version of wxPyTipProvider
452 class wxPyTipProvider : public wxTipProvider {
454 wxPyTipProvider(size_t currentTip)
455 : wxTipProvider(currentTip) {}
457 DEC_PYCALLBACK_STRING__pure(GetTip);
462 IMP_PYCALLBACK_STRING__pure( wxPyTipProvider, wxTipProvider, GetTip);
467 // Now let SWIG know about it
468 class wxPyTipProvider : public wxTipProvider {
470 wxPyTipProvider(size_t currentTip);
475 bool wxShowTip(wxWindow *parent, wxTipProvider *tipProvider, bool showAtStartup = TRUE);
476 %new wxTipProvider * wxCreateFileTipProvider(const wxString& filename, size_t currentTip);
479 //----------------------------------------------------------------------
482 #include <wx/generic/dragimgg.h>
485 %name (wxDragImage) class wxGenericDragImage : public wxObject
489 wxGenericDragImage(const wxBitmap& image,
490 const wxCursor& cursor = wxNullCursor);
491 %name(wxDragIcon)wxGenericDragImage(const wxIcon& image,
492 const wxCursor& cursor = wxNullCursor);
493 %name(wxDragString)wxGenericDragImage(const wxString& str,
494 const wxCursor& cursor = wxNullCursor);
495 %name(wxDragTreeItem)wxGenericDragImage(const wxTreeCtrl& treeCtrl, wxTreeItemId& id);
496 %name(wxDragListItem)wxGenericDragImage(const wxListCtrl& listCtrl, long id);
498 ~wxGenericDragImage();
500 void SetBackingBitmap(wxBitmap* bitmap);
501 bool BeginDrag(const wxPoint& hotspot, wxWindow* window,
502 bool fullScreen = FALSE, wxRect* rect = NULL);
504 %name(BeginDrag2) bool BeginDrag(const wxPoint& hotspot, wxWindow* window,
505 wxWindow* fullScreenRect);
508 bool Move(const wxPoint& pt);
512 wxRect GetImageRect(const wxPoint& pos) const;
513 bool RedrawImage(const wxPoint& oldPos, const wxPoint& newPos,
514 bool eraseOld, bool drawNew);
518 //----------------------------------------------------------------------
520 class wxPyTimer : public wxObject {
522 wxPyTimer(PyObject* notify);
527 void SetOwner(wxEvtHandler *owner, int id = -1);
528 void Start(int milliseconds=-1, int oneShot=FALSE);
536 // ctor starts the stop watch
539 void Start(long t = 0);
543 // get elapsed time since the last Start() or Pause() in milliseconds
548 //----------------------------------------------------------------------
549 //----------------------------------------------------------------------
554 wxLOG_FatalError, // program can't continue, abort immediately
555 wxLOG_Error, // a serious error, user must be informed about it
556 wxLOG_Warning, // user is normally informed about it but may be ignored
557 wxLOG_Message, // normal message (i.e. normal output of a non GUI app)
558 wxLOG_Info, // informational message (a.k.a. 'Verbose')
559 wxLOG_Status, // informational: might go to the status line of GUI app
560 wxLOG_Debug, // never shown to the user, disabled in release mode
561 wxLOG_Trace, // trace messages are also only enabled in debug mode
562 wxLOG_Progress, // used for progress indicator (not yet)
563 wxLOG_User = 100 // user defined levels start here
566 #define wxTRACE_MemAlloc "memalloc" // trace memory allocation (new/delete)
567 #define wxTRACE_Messages "messages" // trace window messages/X callbacks
568 #define wxTRACE_ResAlloc "resalloc" // trace GDI resource allocation
569 #define wxTRACE_RefCount "refcount" // trace various ref counting operations
572 #define wxTRACE_OleCalls "ole" // OLE interface calls
593 static bool IsEnabled();
594 static bool EnableLogging(bool doIt = TRUE);
595 static void OnLog(unsigned long level, const wxString& szString, int t=0);
597 virtual void Flush();
598 bool HasPendingMessages() const;
600 static void FlushActive();
601 static wxLog *GetActiveTarget();
602 static wxLog *SetActiveTarget(wxLog *pLogger);
604 static void Suspend();
605 static void Resume();
607 static void SetVerbose(bool bVerbose = TRUE);
609 static void DontCreateOnDemand();
610 static void SetTraceMask(long ulMask);
611 static void AddTraceMask(const wxString& str);
612 static void RemoveTraceMask(const wxString& str);
613 static void ClearTraceMasks();
615 static void SetTimestamp(const wxString& ts);
616 static const wxString& GetTimestamp();
618 bool GetVerbose() const;
620 static unsigned long GetTraceMask();
621 static bool IsAllowedTraceMask(const wxString& mask);
623 // static void TimeStamp(wxString *str);
625 wxString TimeStamp() {
627 wxLog::TimeStamp(&msg);
635 class wxLogStderr : public wxLog
638 wxLogStderr(/* TODO: FILE *fp = (FILE *) NULL*/);
642 class wxLogTextCtrl : public wxLog
645 wxLogTextCtrl(wxTextCtrl *pTextCtrl);
649 class wxLogGui : public wxLog
655 class wxLogWindow : public wxLog
658 wxLogWindow(wxFrame *pParent, // the parent frame (can be NULL)
659 const wxString& szTitle, // the title of the frame
660 bool bShow = TRUE, // show window immediately?
661 bool bPassToOld = TRUE); // pass log messages to the old target?
663 void Show(bool bShow = TRUE);
664 wxFrame *GetFrame() const;
665 wxLog *GetOldLog() const;
666 bool IsPassingMessages() const;
667 void PassMessages(bool bDoPass);
671 class wxLogChain : public wxLog
674 wxLogChain(wxLog *logger);
675 void SetLog(wxLog *logger);
676 void PassMessages(bool bDoPass);
677 bool IsPassingMessages();
682 unsigned long wxSysErrorCode();
683 const wxString wxSysErrorMsg(unsigned long nErrCode = 0);
684 void wxLogFatalError(const wxString& msg);
685 void wxLogError(const wxString& msg);
686 void wxLogWarning(const wxString& msg);
687 void wxLogMessage(const wxString& msg);
688 void wxLogInfo(const wxString& msg);
689 void wxLogVerbose(const wxString& msg);
690 void wxLogStatus(const wxString& msg);
691 %name(wxLogStatusFrame)void wxLogStatus(wxFrame *pFrame, const wxString& msg);
692 void wxLogSysError(const wxString& msg);
694 void wxLogTrace(const wxString& msg);
695 %name(wxLogTraceMask)void wxLogTrace(const wxString& mask, const wxString& msg);
697 void wxLogGeneric(unsigned long level, const wxString& msg);
699 // wxLogFatalError helper: show the (fatal) error to the user in a safe way,
700 // i.e. without using wxMessageBox() for example because it could crash
701 void wxSafeShowMessage(const wxString& title, const wxString& text);
705 // Suspress logging while an instance of this class exists
717 // A wxLog class that can be derived from in wxPython
718 class wxPyLog : public wxLog {
720 wxPyLog() : wxLog() {}
722 virtual void DoLog(wxLogLevel level, const wxChar *szString, time_t t) {
724 wxPyBeginBlockThreads();
725 if ((found = wxPyCBH_findCallback(m_myInst, "DoLog"))) {
726 PyObject* s = wx2PyString(szString);
727 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iOi)", level, s, t));
730 wxPyEndBlockThreads();
732 wxLog::DoLog(level, szString, t);
735 virtual void DoLogString(const wxChar *szString, time_t t) {
737 wxPyBeginBlockThreads();
738 if ((found = wxPyCBH_findCallback(m_myInst, "DoLogString"))) {
739 PyObject* s = wx2PyString(szString);
740 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(Oi)", s, t));
743 wxPyEndBlockThreads();
745 wxLog::DoLogString(szString, t);
752 // Now tell SWIG about it
753 class wxPyLog : public wxLog {
756 void _setCallbackInfo(PyObject* self, PyObject* _class);
757 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxPyLog)"
758 %addmethods { void Destroy() { delete self; } }
763 //----------------------------------------------------------------------
768 wxKILL_OK, // no error
769 wxKILL_BAD_SIGNAL, // no such signal
770 wxKILL_ACCESS_DENIED, // permission denied
771 wxKILL_NO_PROCESS, // no such process
772 wxKILL_ERROR // another, unspecified error
777 wxSIGNONE = 0, // verify if the process exists under Unix
784 wxSIGIOT = wxSIGABRT, // another name
795 // further signals are different in meaning between different Unix systems
807 class wxProcessEvent : public wxEvent {
809 wxProcessEvent(int id = 0, int pid = 0, int exitcode = 0);
812 int m_pid, m_exitcode;
818 %{ // C++ version of wxProcess derived class
820 class wxPyProcess : public wxProcess {
822 wxPyProcess(wxEvtHandler *parent = NULL, int id = -1)
823 : wxProcess(parent, id)
826 DEC_PYCALLBACK_VOID_INTINT(OnTerminate);
831 IMP_PYCALLBACK_VOID_INTINT( wxPyProcess, wxProcess, OnTerminate);
836 %name(wxProcess)class wxPyProcess : public wxEvtHandler {
838 // kill the process with the given PID
839 static wxKillError Kill(int pid, wxSignal sig = wxSIGTERM);
841 // test if the given process exists
842 static bool Exists(int pid);
844 // this function replaces the standard popen() one: it launches a process
845 // asynchronously and allows the caller to get the streams connected to its
848 // on error NULL is returned, in any case the process object will be
849 // deleted automatically when the process terminates and should *not* be
850 // deleted by the caller
851 static wxPyProcess *Open(const wxString& cmd);
855 wxPyProcess(wxEvtHandler *parent = NULL, int id = -1);
856 %addmethods { void Destroy() { delete self; } }
858 void _setCallbackInfo(PyObject* self, PyObject* _class);
859 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxProcess)"
861 void base_OnTerminate(int pid, int status);
867 wxInputStream *GetInputStream();
868 wxInputStream *GetErrorStream();
869 wxOutputStream *GetOutputStream();
877 // execute the process asynchronously
880 // execute it synchronously, i.e. wait until it finishes
883 // under Windows, don't hide the child even if it's IO is redirected (this
884 // is done by default)
887 // under Unix, if the process is the group leader then killing -pid kills
888 // all children as well as pid
889 wxEXEC_MAKE_GROUP_LEADER = 4
893 long wxExecute(const wxString& command,
894 int flags = wxEXEC_ASYNC,
895 wxPyProcess *process = NULL);
897 //----------------------------------------------------------------------
900 // Which joystick? Same as Windows ids so no conversion necessary.
907 // Which button is down?
919 #if !wxUSE_JOYSTICK && !defined(__WXMSW__)
920 // A C++ stub class for wxJoystick for platforms that don't have it.
921 class wxJoystick : public wxObject {
923 wxJoystick(int joystick = wxJOYSTICK1) {
924 wxPyBeginBlockThreads();
925 PyErr_SetString(PyExc_NotImplementedError, "wxJoystick is not available on this platform.");
926 wxPyEndBlockThreads();
928 wxPoint GetPosition() { return wxPoint(-1,-1); }
929 int GetZPosition() { return -1; }
930 int GetButtonState() { return -1; }
931 int GetPOVPosition() { return -1; }
932 int GetPOVCTSPosition() { return -1; }
933 int GetRudderPosition() { return -1; }
934 int GetUPosition() { return -1; }
935 int GetVPosition() { return -1; }
936 int GetMovementThreshold() { return -1; }
937 void SetMovementThreshold(int threshold) {}
939 bool IsOk(void) { return FALSE; }
940 int GetNumberJoysticks() { return -1; }
941 int GetManufacturerId() { return -1; }
942 int GetProductId() { return -1; }
943 wxString GetProductName() { return ""; }
944 int GetXMin() { return -1; }
945 int GetYMin() { return -1; }
946 int GetZMin() { return -1; }
947 int GetXMax() { return -1; }
948 int GetYMax() { return -1; }
949 int GetZMax() { return -1; }
950 int GetNumberButtons() { return -1; }
951 int GetNumberAxes() { return -1; }
952 int GetMaxButtons() { return -1; }
953 int GetMaxAxes() { return -1; }
954 int GetPollingMin() { return -1; }
955 int GetPollingMax() { return -1; }
956 int GetRudderMin() { return -1; }
957 int GetRudderMax() { return -1; }
958 int GetUMin() { return -1; }
959 int GetUMax() { return -1; }
960 int GetVMin() { return -1; }
961 int GetVMax() { return -1; }
963 bool HasRudder() { return FALSE; }
964 bool HasZ() { return FALSE; }
965 bool HasU() { return FALSE; }
966 bool HasV() { return FALSE; }
967 bool HasPOV() { return FALSE; }
968 bool HasPOV4Dir() { return FALSE; }
969 bool HasPOVCTS() { return FALSE; }
971 bool SetCapture(wxWindow* win, int pollingFreq = 0) { return FALSE; }
972 bool ReleaseCapture() { return FALSE; }
978 class wxJoystick : public wxObject {
980 wxJoystick(int joystick = wxJOYSTICK1);
983 wxPoint GetPosition();
985 int GetButtonState();
986 int GetPOVPosition();
987 int GetPOVCTSPosition();
988 int GetRudderPosition();
991 int GetMovementThreshold();
992 void SetMovementThreshold(int threshold) ;
995 int GetNumberJoysticks();
996 int GetManufacturerId();
998 wxString GetProductName();
1005 int GetNumberButtons();
1006 int GetNumberAxes();
1007 int GetMaxButtons();
1009 int GetPollingMin();
1010 int GetPollingMax();
1026 bool SetCapture(wxWindow* win, int pollingFreq = 0);
1027 bool ReleaseCapture();
1030 //----------------------------------------------------------------------
1034 // A C++ stub class for wxWave for platforms that don't have it.
1035 class wxWave : public wxObject
1038 wxWave(const wxString& fileName, bool isResource = FALSE) {
1039 wxPyBeginBlockThreads();
1040 PyErr_SetString(PyExc_NotImplementedError, "wxWave is not available on this platform.");
1041 wxPyEndBlockThreads();
1043 wxWave(int size, const wxByte* data) {
1044 wxPyBeginBlockThreads();
1045 PyErr_SetString(PyExc_NotImplementedError, "wxWave is not available on this platform.");
1046 wxPyEndBlockThreads();
1051 bool IsOk() const { return FALSE; }
1052 bool Play(bool async = TRUE, bool looped = FALSE) const { return FALSE; }
1058 class wxWave : public wxObject
1061 wxWave(const wxString& fileName, bool isResource = FALSE);
1065 bool Play(bool async = TRUE, bool looped = FALSE) const;
1068 %new wxWave* wxWaveData(const wxString& data);
1069 %{ // Implementations of some alternate "constructors"
1070 wxWave* wxWaveData(const wxString& data) {
1071 return new wxWave(data.Len(), (wxByte*)data.c_str());
1076 //----------------------------------------------------------------------
1080 wxMAILCAP_STANDARD = 1,
1081 wxMAILCAP_NETSCAPE = 2,
1083 wxMAILCAP_GNOME = 8,
1090 class wxFileTypeInfo
1095 wxFileTypeInfo(const char* mimeType,
1096 const char* openCmd,
1097 const char* printCmd,
1101 // the array elements correspond to the parameters of the ctor above in
1103 %name(wxFileTypeInfoSequence)wxFileTypeInfo(const wxArrayString& sArray);
1105 // invalid item - use this to terminate the array passed to
1106 // wxMimeTypesManager::AddFallbacks
1107 %name(wxNullFileTypeInfo)wxFileTypeInfo();
1110 // test if this object can be used
1111 bool IsValid() const;
1114 // set the icon info
1115 void SetIcon(const wxString& iconFile, int iconIndex = 0);
1117 // set the short desc
1118 void SetShortDesc(const wxString& shortDesc);
1121 // get the MIME type
1122 const wxString& GetMimeType() const;
1123 // get the open command
1124 const wxString& GetOpenCommand() const;
1125 // get the print command
1126 const wxString& GetPrintCommand() const;
1127 // get the short description (only used under Win32 so far)
1128 const wxString& GetShortDesc() const;
1129 // get the long, user visible description
1130 const wxString& GetDescription() const;
1133 // get the array of all extensions
1134 //const wxArrayString& GetExtensions() const;
1136 PyObject* GetExtensions() {
1137 wxArrayString& arr = (wxArrayString&)self->GetExtensions();
1138 return wxArrayString2PyList_helper(arr);
1142 int GetExtensionsCount() const;
1144 // get the icon info
1145 const wxString& GetIconFile() const;
1146 int GetIconIndex() const;
1156 // TODO: Make a wxPyMessageParameters with virtual GetParamValue...
1158 // An object of this class must be passed to Get{Open|Print}Command. The
1159 // default implementation is trivial and doesn't know anything at all about
1160 // parameters, only filename and MIME type are used (so it's probably ok for
1161 // Windows where %{param} is not used anyhow)
1162 class MessageParameters
1166 MessageParameters(const wxString& filename=wxPyEmptyString,
1167 const wxString& mimetype=wxPyEmptyString);
1169 // accessors (called by GetOpenCommand)
1171 const wxString& GetFileName() const;
1173 const wxString& GetMimeType() const;;
1175 // override this function in derived class
1176 virtual wxString GetParamValue(const wxString& name) const;
1178 // virtual dtor as in any base class
1179 virtual ~MessageParameters();
1183 // ctor from static data
1184 wxFileType(const wxFileTypeInfo& ftInfo);
1186 // return the MIME type for this file type
1188 PyObject* GetMimeType() {
1190 if (self->GetMimeType(&str)) {
1192 return PyUnicode_FromUnicode(str.c_str(), str.Len());
1194 return PyString_FromStringAndSize(str.c_str(), str.Len());
1200 PyObject* GetMimeTypes() {
1202 if (self->GetMimeTypes(arr))
1203 return wxArrayString2PyList_helper(arr);
1210 // Get all extensions associated with this file type
1212 PyObject* GetExtensions() {
1214 if (self->GetExtensions(arr))
1215 return wxArrayString2PyList_helper(arr);
1223 // Get the icon corresponding to this file type
1224 %new wxIcon* GetIcon() {
1226 if (self->GetIcon(&icon))
1227 return new wxIcon(icon);
1232 // Get the icon corresponding to this file type, the name of the file
1233 // where this icon resides, and its index in this file if applicable.
1234 PyObject* GetIconInfo() {
1238 if (self->GetIcon(&icon, &iconFile, &iconIndex)) {
1239 wxPyBeginBlockThreads();
1240 PyObject* tuple = PyTuple_New(3);
1241 PyTuple_SetItem(tuple, 0, wxPyConstructObject(new wxIcon(icon),
1244 PyTuple_SetItem(tuple, 1, PyUnicode_FromUnicode(iconFile.c_str(), iconFile.Len()));
1246 PyTuple_SetItem(tuple, 1, PyString_FromStringAndSize(iconFile.c_str(), iconFile.Len()));
1248 PyTuple_SetItem(tuple, 2, PyInt_FromLong(iconIndex));
1249 wxPyEndBlockThreads();
1258 // get a brief file type description ("*.txt" => "text document")
1259 PyObject* GetDescription() {
1261 if (self->GetDescription(&str)) {
1263 return PyUnicode_FromUnicode(str.c_str(), str.Len());
1265 return PyString_FromStringAndSize(str.c_str(), str.Len());
1273 // get the command to open/execute the file of given type
1275 PyObject* GetOpenCommand(const wxString& filename,
1276 const wxString& mimetype=wxPyEmptyString) {
1278 if (self->GetOpenCommand(&str, wxFileType::MessageParameters(filename, mimetype))) {
1280 return PyUnicode_FromUnicode(str.c_str(), str.Len());
1282 return PyString_FromStringAndSize(str.c_str(), str.Len());
1290 // get the command to print the file of given type
1292 PyObject* GetPrintCommand(const wxString& filename,
1293 const wxString& mimetype=wxPyEmptyString) {
1295 if (self->GetPrintCommand(&str, wxFileType::MessageParameters(filename, mimetype))) {
1297 return PyUnicode_FromUnicode(str.c_str(), str.Len());
1299 return PyString_FromStringAndSize(str.c_str(), str.Len());
1307 // Get all commands defined for this file type
1309 PyObject* GetAllCommands(const wxString& filename,
1310 const wxString& mimetype=wxPyEmptyString) {
1311 wxArrayString verbs;
1312 wxArrayString commands;
1313 if (self->GetAllCommands(&verbs, &commands,
1314 wxFileType::MessageParameters(filename, mimetype))) {
1315 wxPyBeginBlockThreads();
1316 PyObject* tuple = PyTuple_New(2);
1317 PyTuple_SetItem(tuple, 0, wxArrayString2PyList_helper(verbs));
1318 PyTuple_SetItem(tuple, 1, wxArrayString2PyList_helper(commands));
1319 wxPyEndBlockThreads();
1328 // set an arbitrary command, ask confirmation if it already exists and
1329 // overwriteprompt is TRUE
1330 bool SetCommand(const wxString& cmd, const wxString& verb,
1331 bool overwriteprompt = TRUE);
1333 bool SetDefaultIcon(const wxString& cmd = wxPyEmptyString, int index = 0);
1336 // remove the association for this filetype from the system MIME database:
1337 // notice that it will only work if the association is defined in the user
1338 // file/registry part, we will never modify the system-wide settings
1342 // expand a string in the format of GetOpenCommand (which may contain
1343 // '%s' and '%t' format specificators for the file name and mime type
1344 // and %{param} constructions).
1345 static wxString ExpandCommand(const wxString& command,
1346 const MessageParameters& params);
1348 // dtor (not virtual, shouldn't be derived from)
1356 class wxMimeTypesManager
1359 // static helper functions
1360 // -----------------------
1362 // check if the given MIME type is the same as the other one: the
1363 // second argument may contain wildcards ('*'), but not the first. If
1364 // the types are equal or if the mimeType matches wildcard the function
1365 // returns TRUE, otherwise it returns FALSE
1366 static bool IsOfType(const wxString& mimeType, const wxString& wildcard);
1369 wxMimeTypesManager();
1371 // loads data from standard files according to the mailcap styles
1372 // specified: this is a bitwise OR of wxMailcapStyle values
1374 // use the extraDir parameter if you want to look for files in another
1376 void Initialize(int mailcapStyle = wxMAILCAP_STANDARD,
1377 const wxString& extraDir = wxPyEmptyString);
1379 // and this function clears all the data from the manager
1382 // Database lookup: all functions return a pointer to wxFileType object
1383 // whose methods may be used to query it for the information you're
1384 // interested in. If the return value is !NULL, caller is responsible for
1386 // get file type from file extension
1387 %new wxFileType *GetFileTypeFromExtension(const wxString& ext);
1389 // get file type from MIME type (in format <category>/<format>)
1390 %new wxFileType *GetFileTypeFromMimeType(const wxString& mimeType);
1392 // other operations: return TRUE if there were no errors or FALSE if there
1393 // were some unreckognized entries (the good entries are always read anyhow)
1396 // read in additional file (the standard ones are read automatically)
1397 // in mailcap format (see mimetype.cpp for description)
1399 // 'fallback' parameter may be set to TRUE to avoid overriding the
1400 // settings from other, previously parsed, files by this one: normally,
1401 // the files read most recently would override the older files, but with
1402 // fallback == TRUE this won't happen
1403 bool ReadMailcap(const wxString& filename, bool fallback = FALSE);
1405 // read in additional file in mime.types format
1406 bool ReadMimeTypes(const wxString& filename);
1408 // enumerate all known MIME types
1410 PyObject* EnumAllFileTypes() {
1412 self->EnumAllFileTypes(arr);
1413 return wxArrayString2PyList_helper(arr);
1417 // these functions can be used to provide default values for some of the
1418 // MIME types inside the program itself (you may also use
1419 // ReadMailcap(filenameWithDefaultTypes, TRUE /* use as fallback */) to
1420 // achieve the same goal, but this requires having this info in a file).
1422 void AddFallback(const wxFileTypeInfo& ft);
1425 // create or remove associations
1427 // create a new association using the fields of wxFileTypeInfo (at least
1428 // the MIME type and the extension should be set)
1429 // if the other fields are empty, the existing values should be left alone
1430 %new wxFileType *Associate(const wxFileTypeInfo& ftInfo);
1433 bool Unassociate(wxFileType *ft) ;
1435 // dtor (not virtual, shouldn't be derived from)
1436 ~wxMimeTypesManager();
1444 extern wxMimeTypesManager* wxTheMimeTypesManager;
1450 //----------------------------------------------------------------------
1453 #include <wx/artprov.h>
1455 DECLARE_DEF_STRING(ART_OTHER);
1460 #define wxART_TOOLBAR "toolbar_C"
1461 #define wxART_MENU "menu_C"
1462 #define wxART_FRAME_ICON "frame_icon_C"
1464 #define wxART_CMN_DIALOG "cmn_dialog_C"
1465 #define wxART_HELP_BROWSER "help_browser_C"
1466 #define wxART_MESSAGE_BOX "message_box_C"
1468 #define wxART_OTHER "other_C"
1471 #define wxART_ADD_BOOKMARK "add_bookmark"
1472 #define wxART_DEL_BOOKMARK "del_bookmark"
1473 #define wxART_HELP_SIDE_PANEL "help_side_panel"
1474 #define wxART_HELP_SETTINGS "help_settings"
1475 #define wxART_HELP_BOOK "help_book"
1476 #define wxART_HELP_FOLDER "help_folder"
1477 #define wxART_HELP_PAGE "help_page"
1478 #define wxART_GO_BACK "go_back"
1479 #define wxART_GO_FORWARD "go_forward"
1480 #define wxART_GO_UP "go_up"
1481 #define wxART_GO_DOWN "go_down"
1482 #define wxART_GO_TO_PARENT "go_to_parent"
1483 #define wxART_GO_HOME "go_home"
1484 #define wxART_FILE_OPEN "file_open"
1485 #define wxART_PRINT "print"
1486 #define wxART_HELP "help"
1487 #define wxART_TIP "tip"
1488 #define wxART_REPORT_VIEW "report_view"
1489 #define wxART_LIST_VIEW "list_view"
1490 #define wxART_NEW_DIR "new_dir"
1491 #define wxART_FOLDER "folder"
1492 #define wxART_GO_DIR_UP "go_dir_up"
1493 #define wxART_EXECUTABLE_FILE "executable_file"
1494 #define wxART_NORMAL_FILE "normal_file"
1495 #define wxART_TICK_MARK "tick"
1496 #define wxART_CROSS_MARK "cross"
1497 #define wxART_ERROR "error"
1498 #define wxART_QUESTION "question"
1499 #define wxART_WARNING "warning"
1500 #define wxART_INFORMATION "information"
1503 %{ // Python aware wxArtProvider
1504 class wxPyArtProvider : public wxArtProvider {
1507 virtual wxBitmap CreateBitmap(const wxArtID& id,
1508 const wxArtClient& client,
1509 const wxSize& size) {
1510 wxBitmap rval = wxNullBitmap;
1511 wxPyBeginBlockThreads();
1512 if ((wxPyCBH_findCallback(m_myInst, "CreateBitmap"))) {
1513 PyObject* so = wxPyConstructObject((void*)&size, "wxSize", 0);
1517 s1 = wx2PyString(id);
1518 s2 = wx2PyString(client);
1519 ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(OOO)", s1, s2, so));
1524 if (!SWIG_GetPtrObj(ro, (void**)&ptr, "_wxBitmap_p"))
1529 wxPyEndBlockThreads();
1537 // The one for SWIG to see
1538 %name(wxArtProvider) class wxPyArtProvider : public wxObject
1543 void _setCallbackInfo(PyObject* self, PyObject* _class);
1544 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxArtProvider)"
1546 // Add new provider to the top of providers stack.
1547 static void PushProvider(wxPyArtProvider *provider);
1549 // Remove latest added provider and delete it.
1550 static bool PopProvider();
1552 // Remove provider. The provider must have been added previously!
1553 // The provider is _not_ deleted.
1554 static bool RemoveProvider(wxPyArtProvider *provider);
1556 // Query the providers for bitmap with given ID and return it. Return
1557 // wxNullBitmap if no provider provides it.
1558 static wxBitmap GetBitmap(const wxString& id,
1559 const wxString& client = wxPyART_OTHER,
1560 const wxSize& size = wxDefaultSize);
1562 // Query the providers for icon with given ID and return it. Return
1563 // wxNullIcon if no provider provides it.
1564 static wxIcon GetIcon(const wxString& id,
1565 const wxString& client = wxPyART_OTHER,
1566 const wxSize& size = wxDefaultSize);
1568 // Destroy caches & all providers
1569 static void CleanUpProviders();
1573 //----------------------------------------------------------------------
1576 #include <wx/docview.h>
1579 class wxFileHistory : public wxObject
1582 wxFileHistory(int maxFiles = 9);
1586 void AddFileToHistory(const wxString& file);
1587 void RemoveFileFromHistory(int i);
1588 int GetMaxFiles() const;
1589 void UseMenu(wxMenu *menu);
1591 // Remove menu from the list (MDI child may be closing)
1592 void RemoveMenu(wxMenu *menu);
1594 void Load(wxConfigBase& config);
1595 void Save(wxConfigBase& config);
1597 void AddFilesToMenu();
1598 %name(AddFilesToThisMenu)void AddFilesToMenu(wxMenu* menu);
1601 wxString GetHistoryFile(int i) const;
1603 // A synonym for GetNoHistoryFiles
1604 int GetCount() const;
1605 int GetNoHistoryFiles() const;
1609 //----------------------------------------------------------------------
1610 //----------------------------------------------------------------------
1613 // #if wxUSE_UNICODE
1614 // #define ADD_STRING(dict, str) \
1615 // wxString tmp##str(str); \
1616 // PyDict_SetItemString(dict, #str, \
1617 // PyUnicode_FromUnicode(tmp##str.c_str(), tmp##str.Len()))
1619 // #define ADD_STRING(dict, str) \
1620 // PyDict_SetItemString(d, #str, PyString_FromString(str))
1626 wxPyPtrTypeMap_Add("wxDragImage", "wxGenericDragImage");
1627 wxPyPtrTypeMap_Add("wxProcess", "wxPyProcess");
1628 wxPyPtrTypeMap_Add("wxArtProvider", "wxPyArtProvider");
1632 //----------------------------------------------------------------------