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 wxWindow * wxFindWindowByLabel(const wxString& label, wxWindow *parent=NULL);
166 wxWindow * wxFindWindowByName(const wxString& name, wxWindow *parent=NULL);
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 //---------------------------------------------------------------------------
184 bool wxResourceAddIdentifier(char* name, int value);
185 void wxResourceClear(void);
186 wxBitmap wxResourceCreateBitmap(char* resource);
187 wxIcon wxResourceCreateIcon(char* resource);
188 wxMenuBar * wxResourceCreateMenuBar(char* resource);
189 int wxResourceGetIdentifier(char* name);
190 bool wxResourceParseData(char* resource, wxResourceTable *table = NULL);
191 bool wxResourceParseFile(char* filename, wxResourceTable *table = NULL);
192 bool wxResourceParseString(char* resource, wxResourceTable *table = NULL);
194 //---------------------------------------------------------------------------
197 // possible values for wxSystemSettings::GetFont() parameter
201 wxSYS_OEM_FIXED_FONT = 10,
202 wxSYS_ANSI_FIXED_FONT,
205 wxSYS_DEVICE_DEFAULT_FONT,
206 wxSYS_DEFAULT_PALETTE,
207 wxSYS_SYSTEM_FIXED_FONT,
208 wxSYS_DEFAULT_GUI_FONT
211 // possible values for wxSystemSettings::GetColour() parameter
215 wxSYS_COLOUR_SCROLLBAR,
216 wxSYS_COLOUR_BACKGROUND,
217 wxSYS_COLOUR_DESKTOP = wxSYS_COLOUR_BACKGROUND,
218 wxSYS_COLOUR_ACTIVECAPTION,
219 wxSYS_COLOUR_INACTIVECAPTION,
222 wxSYS_COLOUR_WINDOWFRAME,
223 wxSYS_COLOUR_MENUTEXT,
224 wxSYS_COLOUR_WINDOWTEXT,
225 wxSYS_COLOUR_CAPTIONTEXT,
226 wxSYS_COLOUR_ACTIVEBORDER,
227 wxSYS_COLOUR_INACTIVEBORDER,
228 wxSYS_COLOUR_APPWORKSPACE,
229 wxSYS_COLOUR_HIGHLIGHT,
230 wxSYS_COLOUR_HIGHLIGHTTEXT,
231 wxSYS_COLOUR_BTNFACE,
232 wxSYS_COLOUR_3DFACE = wxSYS_COLOUR_BTNFACE,
233 wxSYS_COLOUR_BTNSHADOW,
234 wxSYS_COLOUR_3DSHADOW = wxSYS_COLOUR_BTNSHADOW,
235 wxSYS_COLOUR_GRAYTEXT,
236 wxSYS_COLOUR_BTNTEXT,
237 wxSYS_COLOUR_INACTIVECAPTIONTEXT,
238 wxSYS_COLOUR_BTNHIGHLIGHT,
239 wxSYS_COLOUR_BTNHILIGHT = wxSYS_COLOUR_BTNHIGHLIGHT,
240 wxSYS_COLOUR_3DHIGHLIGHT = wxSYS_COLOUR_BTNHIGHLIGHT,
241 wxSYS_COLOUR_3DHILIGHT = wxSYS_COLOUR_BTNHIGHLIGHT,
242 wxSYS_COLOUR_3DDKSHADOW,
243 wxSYS_COLOUR_3DLIGHT,
244 wxSYS_COLOUR_INFOTEXT,
246 wxSYS_COLOUR_LISTBOX,
247 wxSYS_COLOUR_HOTLIGHT,
248 wxSYS_COLOUR_GRADIENTACTIVECAPTION,
249 wxSYS_COLOUR_GRADIENTINACTIVECAPTION,
250 wxSYS_COLOUR_MENUHILIGHT,
251 wxSYS_COLOUR_MENUBAR,
256 // possible values for wxSystemSettings::GetMetric() parameter
260 wxSYS_MOUSE_BUTTONS = 1,
271 wxSYS_HSCROLL_ARROW_X,
272 wxSYS_HSCROLL_ARROW_Y,
288 wxSYS_VSCROLL_ARROW_X,
289 wxSYS_VSCROLL_ARROW_Y,
293 wxSYS_NETWORK_PRESENT,
294 wxSYS_PENWINDOWS_PRESENT,
299 // possible values for wxSystemSettings::HasFeature() parameter
302 wxSYS_CAN_DRAW_FRAME_DECORATIONS = 1,
303 wxSYS_CAN_ICONIZE_FRAME
306 // values for different screen designs
309 wxSYS_SCREEN_NONE = 0, // not yet defined
310 wxSYS_SCREEN_DESKTOP, // >= 800x600
311 wxSYS_SCREEN_SMALL, // >= 640x480
312 wxSYS_SCREEN_PDA, // >= 320x240
313 wxSYS_SCREEN_TINY // <
317 class wxSystemSettings {
319 // get a standard system colour
320 static wxColour GetColour(wxSystemColour index);
322 // get a standard system font
323 static wxFont GetFont(wxSystemFont index);
325 // get a system-dependent metric
326 static int GetMetric(wxSystemMetric index);
328 // return true if the port has certain feature
329 static bool HasFeature(wxSystemFeature index);
331 // // Get system screen design (desktop, pda, ..) used for
332 // // laying out various dialogs.
333 // static wxSystemScreen GetScreen();
335 // // Override default.
336 // static void SetScreen( wxSystemScreen screen );
342 //---------------------------------------------------------------------------
345 class wxToolTip : public wxObject {
347 wxToolTip(const wxString &tip);
349 void SetTip(const wxString& tip);
351 // *** Not in the "public" interface void SetWindow(wxWindow *win);
352 wxWindow *GetWindow();
354 static void Enable(bool flag);
355 static void SetDelay(long milliseconds);
358 //----------------------------------------------------------------------
362 wxCaret(wxWindow* window, const wxSize& size);
367 %name(GetPositionTuple)void GetPosition(int *OUTPUT, int *OUTPUT);
368 wxPoint GetPosition();
369 %name(GetSizeTuple)void GetSize(int *OUTPUT, int *OUTPUT);
371 wxWindow *GetWindow();
372 %name(MoveXY)void Move(int x, int y);
373 void Move(const wxPoint& pt);
374 %name(SetSizeWH) void SetSize(int width, int height);
375 void SetSize(const wxSize& size);
376 void Show(int show = TRUE);
381 int wxCaret_GetBlinkTime() {
382 return wxCaret::GetBlinkTime();
385 void wxCaret_SetBlinkTime(int milliseconds) {
386 wxCaret::SetBlinkTime(milliseconds);
390 //----------------------------------------------------------------------
394 wxBusyCursor(wxCursor* cursor = wxHOURGLASS_CURSOR);
398 //----------------------------------------------------------------------
400 class wxWindowDisabler {
402 wxWindowDisabler(wxWindow *winToSkip = NULL);
406 //----------------------------------------------------------------------
408 bool wxSafeYield(wxWindow* win=NULL);
409 void wxPostEvent(wxEvtHandler *dest, wxEvent& event);
414 void wxWakeUpMainThread();
417 void wxMutexGuiEnter();
418 void wxMutexGuiLeave();
421 class wxMutexGuiLocker {
429 bool wxThread_IsMain() {
430 #ifdef WXP_WITH_THREAD
431 return wxThread::IsMain();
438 //----------------------------------------------------------------------
444 // wxTipProvider(size_t currentTip); **** Abstract base class
447 virtual wxString GetTip() = 0;
448 size_t GetCurrentTip();
453 // The C++ version of wxPyTipProvider
455 class wxPyTipProvider : public wxTipProvider {
457 wxPyTipProvider(size_t currentTip)
458 : wxTipProvider(currentTip) {}
460 DEC_PYCALLBACK_STRING__pure(GetTip);
465 IMP_PYCALLBACK_STRING__pure( wxPyTipProvider, wxTipProvider, GetTip);
470 // Now let SWIG know about it
471 class wxPyTipProvider : public wxTipProvider {
473 wxPyTipProvider(size_t currentTip);
478 bool wxShowTip(wxWindow *parent, wxTipProvider *tipProvider, bool showAtStartup = TRUE);
479 %new wxTipProvider * wxCreateFileTipProvider(const wxString& filename, size_t currentTip);
482 //----------------------------------------------------------------------
485 #include <wx/generic/dragimgg.h>
488 %name (wxDragImage) class wxGenericDragImage : public wxObject
492 wxGenericDragImage(const wxBitmap& image,
493 const wxCursor& cursor = wxNullCursor);
494 %name(wxDragIcon)wxGenericDragImage(const wxIcon& image,
495 const wxCursor& cursor = wxNullCursor);
496 %name(wxDragString)wxGenericDragImage(const wxString& str,
497 const wxCursor& cursor = wxNullCursor);
498 %name(wxDragTreeItem)wxGenericDragImage(const wxTreeCtrl& treeCtrl, wxTreeItemId& id);
499 %name(wxDragListItem)wxGenericDragImage(const wxListCtrl& listCtrl, long id);
501 ~wxGenericDragImage();
503 void SetBackingBitmap(wxBitmap* bitmap);
504 bool BeginDrag(const wxPoint& hotspot, wxWindow* window,
505 bool fullScreen = FALSE, wxRect* rect = NULL);
507 %name(BeginDrag2) bool BeginDrag(const wxPoint& hotspot, wxWindow* window,
508 wxWindow* fullScreenRect);
511 bool Move(const wxPoint& pt);
515 wxRect GetImageRect(const wxPoint& pos) const;
516 bool RedrawImage(const wxPoint& oldPos, const wxPoint& newPos,
517 bool eraseOld, bool drawNew);
521 //----------------------------------------------------------------------
523 class wxPyTimer : public wxObject {
525 wxPyTimer(PyObject* notify);
530 void SetOwner(wxEvtHandler *owner, int id = -1);
531 void Start(int milliseconds=-1, int oneShot=FALSE);
539 // ctor starts the stop watch
542 void Start(long t = 0);
546 // get elapsed time since the last Start() or Pause() in milliseconds
551 //----------------------------------------------------------------------
552 //----------------------------------------------------------------------
557 wxLOG_FatalError, // program can't continue, abort immediately
558 wxLOG_Error, // a serious error, user must be informed about it
559 wxLOG_Warning, // user is normally informed about it but may be ignored
560 wxLOG_Message, // normal message (i.e. normal output of a non GUI app)
561 wxLOG_Info, // informational message (a.k.a. 'Verbose')
562 wxLOG_Status, // informational: might go to the status line of GUI app
563 wxLOG_Debug, // never shown to the user, disabled in release mode
564 wxLOG_Trace, // trace messages are also only enabled in debug mode
565 wxLOG_Progress, // used for progress indicator (not yet)
566 wxLOG_User = 100 // user defined levels start here
575 static bool IsEnabled();
576 static bool EnableLogging(bool doIt = TRUE);
577 static void OnLog(wxLogLevel level, const wxString& szString, int t=0);
579 virtual void Flush();
580 bool HasPendingMessages() const;
582 static void FlushActive();
583 static wxLog *GetActiveTarget();
584 static wxLog *SetActiveTarget(wxLog *pLogger);
586 static void Suspend();
587 static void Resume();
589 static void SetVerbose(bool bVerbose = TRUE);
591 static void DontCreateOnDemand();
592 static void SetTraceMask(wxTraceMask ulMask);
593 static void AddTraceMask(const wxString& str);
594 static void RemoveTraceMask(const wxString& str);
595 static void ClearTraceMasks();
597 static void SetTimestamp(const wxString& ts);
598 static const wxString& GetTimestamp();
600 bool GetVerbose() const;
602 static wxTraceMask GetTraceMask();
603 static bool IsAllowedTraceMask(const wxString& mask);
605 // static void TimeStamp(wxString *str);
607 wxString TimeStamp() {
609 wxLog::TimeStamp(&msg);
617 class wxLogStderr : public wxLog
620 wxLogStderr(/* TODO: FILE *fp = (FILE *) NULL*/);
624 class wxLogTextCtrl : public wxLog
627 wxLogTextCtrl(wxTextCtrl *pTextCtrl);
631 class wxLogGui : public wxLog
637 class wxLogWindow : public wxLog
640 wxLogWindow(wxFrame *pParent, // the parent frame (can be NULL)
641 const wxString& szTitle, // the title of the frame
642 bool bShow = TRUE, // show window immediately?
643 bool bPassToOld = TRUE); // pass log messages to the old target?
645 void Show(bool bShow = TRUE);
646 wxFrame *GetFrame() const;
647 wxLog *GetOldLog() const;
648 bool IsPassingMessages() const;
649 void PassMessages(bool bDoPass);
653 class wxLogChain : public wxLog
656 wxLogChain(wxLog *logger);
657 void SetLog(wxLog *logger);
658 void PassMessages(bool bDoPass);
659 bool IsPassingMessages();
664 unsigned long wxSysErrorCode();
665 const wxString wxSysErrorMsg(unsigned long nErrCode = 0);
666 void wxLogFatalError(const wxString& szFormat);
667 void wxLogError(const wxString& szFormat);
668 void wxLogWarning(const wxString& szFormat);
669 void wxLogMessage(const wxString& szFormat);
670 void wxLogInfo(const wxString& szFormat);
671 void wxLogVerbose(const wxString& szFormat);
672 void wxLogStatus(const wxString& szFormat);
673 %name(wxLogStatusFrame)void wxLogStatus(wxFrame *pFrame, const wxString& szFormat);
674 void wxLogSysError(const wxString& szFormat);
677 // wxLogFatalError helper: show the (fatal) error to the user in a safe way,
678 // i.e. without using wxMessageBox() for example because it could crash
680 // TODO: Why am I getting a link error on this???
681 // void wxSafeShowMessage(const wxString& title, const wxString& text);
685 // Suspress logging while an instance of this class exists
697 // A wxLog class that can be derived from in wxPython
698 class wxPyLog : public wxLog {
700 wxPyLog() : wxLog() {}
702 virtual void DoLog(wxLogLevel level, const wxChar *szString, time_t t) {
704 wxPyBeginBlockThreads();
705 if ((found = wxPyCBH_findCallback(m_myInst, "DoLog")))
706 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iOi)", level,
707 wx2PyString(szString), t));
708 wxPyEndBlockThreads();
710 wxLog::DoLog(level, szString, t);
713 virtual void DoLogString(const wxChar *szString, time_t t) {
715 wxPyBeginBlockThreads();
716 if ((found = wxPyCBH_findCallback(m_myInst, "DoLogString")))
717 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(Oi)",
718 wx2PyString(szString), t));
719 wxPyEndBlockThreads();
721 wxLog::DoLogString(szString, t);
728 // Now tell SWIG about it
729 class wxPyLog : public wxLog {
732 void _setCallbackInfo(PyObject* self, PyObject* _class);
733 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxPyLog)"
734 %addmethods { void Destroy() { delete self; } }
739 //----------------------------------------------------------------------
748 class wxProcessEvent : public wxEvent {
750 wxProcessEvent(int id = 0, int pid = 0, int exitcode = 0);
753 int m_pid, m_exitcode;
759 %{ // C++ version of wxProcess derived class
761 class wxPyProcess : public wxProcess {
763 wxPyProcess(wxEvtHandler *parent = NULL, int id = -1)
764 : wxProcess(parent, id)
767 DEC_PYCALLBACK_VOID_INTINT(OnTerminate);
772 IMP_PYCALLBACK_VOID_INTINT( wxPyProcess, wxProcess, OnTerminate);
777 %name(wxProcess)class wxPyProcess : public wxEvtHandler {
779 wxPyProcess(wxEvtHandler *parent = NULL, int id = -1);
780 %addmethods { void Destroy() { delete self; } }
782 void _setCallbackInfo(PyObject* self, PyObject* _class);
783 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxProcess)"
785 void base_OnTerminate(int pid, int status);
791 wxInputStream *GetInputStream();
792 wxInputStream *GetErrorStream();
793 wxOutputStream *GetOutputStream();
801 // execute the process asynchronously
804 // execute it synchronously, i.e. wait until it finishes
807 // under Windows, don't hide the child even if it's IO is redirected (this
808 // is done by default)
811 // under Unix, if the process is the group leader then killing -pid kills
812 // all children as well as pid
813 wxEXEC_MAKE_GROUP_LEADER = 4
817 long wxExecute(const wxString& command,
818 int flags = wxEXEC_ASYNC,
819 wxPyProcess *process = NULL);
821 //----------------------------------------------------------------------
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 {
828 wxJoystick(int joystick = wxJOYSTICK1) {
829 wxPyBeginBlockThreads();
830 PyErr_SetString(PyExc_NotImplementedError, "wxJoystick is not available on this platform.");
831 wxPyEndBlockThreads();
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; }
842 void SetMovementThreshold(int threshold) {}
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; }
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; }
876 bool SetCapture(wxWindow* win, int pollingFreq = 0) { return FALSE; }
877 bool ReleaseCapture() { return FALSE; }
883 class wxJoystick : public wxObject {
885 wxJoystick(int joystick = wxJOYSTICK1);
888 wxPoint GetPosition();
890 int GetButtonState();
891 int GetPOVPosition();
892 int GetPOVCTSPosition();
893 int GetRudderPosition();
896 int GetMovementThreshold();
897 void SetMovementThreshold(int threshold) ;
900 int GetNumberJoysticks();
901 int GetManufacturerId();
903 wxString GetProductName();
910 int GetNumberButtons();
931 bool SetCapture(wxWindow* win, int pollingFreq = 0);
932 bool ReleaseCapture();
935 //----------------------------------------------------------------------
939 // A C++ stub class for wxWave for platforms that don't have it.
940 class wxWave : public wxObject
943 wxWave(const wxString& fileName, bool isResource = FALSE) {
944 wxPyBeginBlockThreads();
945 PyErr_SetString(PyExc_NotImplementedError, "wxWave is not available on this platform.");
946 wxPyEndBlockThreads();
948 wxWave(int size, const wxByte* data) {
949 wxPyBeginBlockThreads();
950 PyErr_SetString(PyExc_NotImplementedError, "wxWave is not available on this platform.");
951 wxPyEndBlockThreads();
956 bool IsOk() const { return FALSE; }
957 bool Play(bool async = TRUE, bool looped = FALSE) const { return FALSE; }
963 class wxWave : public wxObject
966 wxWave(const wxString& fileName, bool isResource = FALSE);
970 bool Play(bool async = TRUE, bool looped = FALSE) const;
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());
981 //----------------------------------------------------------------------
985 wxMAILCAP_STANDARD = 1,
986 wxMAILCAP_NETSCAPE = 2,
1000 wxFileTypeInfo(const char* mimeType,
1001 const char* openCmd,
1002 const char* printCmd,
1006 // the array elements correspond to the parameters of the ctor above in
1008 %name(wxFileTypeInfoSequence)wxFileTypeInfo(const wxArrayString& sArray);
1010 // invalid item - use this to terminate the array passed to
1011 // wxMimeTypesManager::AddFallbacks
1012 %name(wxNullFileTypeInfo)wxFileTypeInfo();
1015 // test if this object can be used
1016 bool IsValid() const;
1019 // set the icon info
1020 void SetIcon(const wxString& iconFile, int iconIndex = 0);
1022 // set the short desc
1023 void SetShortDesc(const wxString& shortDesc);
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;
1038 // get the array of all extensions
1039 //const wxArrayString& GetExtensions() const;
1041 PyObject* GetExtensions() {
1042 wxArrayString& arr = (wxArrayString&)self->GetExtensions();
1043 return wxArrayString2PyList_helper(arr);
1047 int GetExtensionsCount() const;
1049 // get the icon info
1050 const wxString& GetIconFile() const;
1051 int GetIconIndex() const;
1061 // TODO: Make a wxPyMessageParameters with virtual GetParamValue...
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
1071 MessageParameters(const wxString& filename=wxPyEmptyString,
1072 const wxString& mimetype=wxPyEmptyString);
1074 // accessors (called by GetOpenCommand)
1076 const wxString& GetFileName() const;
1078 const wxString& GetMimeType() const;;
1080 // override this function in derived class
1081 virtual wxString GetParamValue(const wxString& name) const;
1083 // virtual dtor as in any base class
1084 virtual ~MessageParameters();
1088 // ctor from static data
1089 wxFileType(const wxFileTypeInfo& ftInfo);
1091 // return the MIME type for this file type
1093 PyObject* GetMimeType() {
1095 if (self->GetMimeType(&str)) {
1097 return PyUnicode_FromUnicode(str.c_str(), str.Len());
1099 return PyString_FromStringAndSize(str.c_str(), str.Len());
1105 PyObject* GetMimeTypes() {
1107 if (self->GetMimeTypes(arr))
1108 return wxArrayString2PyList_helper(arr);
1115 // Get all extensions associated with this file type
1117 PyObject* GetExtensions() {
1119 if (self->GetExtensions(arr))
1120 return wxArrayString2PyList_helper(arr);
1128 // Get the icon corresponding to this file type
1129 %new wxIcon* GetIcon() {
1131 if (self->GetIcon(&icon))
1132 return new wxIcon(icon);
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() {
1143 if (self->GetIcon(&icon, &iconFile, &iconIndex)) {
1144 wxPyBeginBlockThreads();
1145 PyObject* tuple = PyTuple_New(3);
1146 PyTuple_SetItem(tuple, 0, wxPyConstructObject(new wxIcon(icon),
1149 PyTuple_SetItem(tuple, 1, PyUnicode_FromUnicode(iconFile.c_str(), iconFile.Len()));
1151 PyTuple_SetItem(tuple, 1, PyString_FromStringAndSize(iconFile.c_str(), iconFile.Len()));
1153 PyTuple_SetItem(tuple, 2, PyInt_FromLong(iconIndex));
1154 wxPyEndBlockThreads();
1163 // get a brief file type description ("*.txt" => "text document")
1164 PyObject* GetDescription() {
1166 if (self->GetDescription(&str)) {
1168 return PyUnicode_FromUnicode(str.c_str(), str.Len());
1170 return PyString_FromStringAndSize(str.c_str(), str.Len());
1178 // get the command to open/execute the file of given type
1180 PyObject* GetOpenCommand(const wxString& filename,
1181 const wxString& mimetype=wxPyEmptyString) {
1183 if (self->GetOpenCommand(&str, wxFileType::MessageParameters(filename, mimetype))) {
1185 return PyUnicode_FromUnicode(str.c_str(), str.Len());
1187 return PyString_FromStringAndSize(str.c_str(), str.Len());
1195 // get the command to print the file of given type
1197 PyObject* GetPrintCommand(const wxString& filename,
1198 const wxString& mimetype=wxPyEmptyString) {
1200 if (self->GetPrintCommand(&str, wxFileType::MessageParameters(filename, mimetype))) {
1202 return PyUnicode_FromUnicode(str.c_str(), str.Len());
1204 return PyString_FromStringAndSize(str.c_str(), str.Len());
1212 // Get all commands defined for this file type
1214 PyObject* GetAllCommands(const wxString& filename,
1215 const wxString& mimetype=wxPyEmptyString) {
1216 wxArrayString verbs;
1217 wxArrayString commands;
1218 if (self->GetAllCommands(&verbs, &commands,
1219 wxFileType::MessageParameters(filename, mimetype))) {
1220 wxPyBeginBlockThreads();
1221 PyObject* tuple = PyTuple_New(2);
1222 PyTuple_SetItem(tuple, 0, wxArrayString2PyList_helper(verbs));
1223 PyTuple_SetItem(tuple, 1, wxArrayString2PyList_helper(commands));
1224 wxPyEndBlockThreads();
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);
1238 bool SetDefaultIcon(const wxString& cmd = wxPyEmptyString, int index = 0);
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
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);
1253 // dtor (not virtual, shouldn't be derived from)
1261 class wxMimeTypesManager
1264 // static helper functions
1265 // -----------------------
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);
1274 wxMimeTypesManager();
1276 // loads data from standard files according to the mailcap styles
1277 // specified: this is a bitwise OR of wxMailcapStyle values
1279 // use the extraDir parameter if you want to look for files in another
1281 void Initialize(int mailcapStyle = wxMAILCAP_STANDARD,
1282 const wxString& extraDir = wxPyEmptyString);
1284 // and this function clears all the data from the manager
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
1291 // get file type from file extension
1292 %new wxFileType *GetFileTypeFromExtension(const wxString& ext);
1294 // get file type from MIME type (in format <category>/<format>)
1295 %new wxFileType *GetFileTypeFromMimeType(const wxString& mimeType);
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)
1301 // read in additional file (the standard ones are read automatically)
1302 // in mailcap format (see mimetype.cpp for description)
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);
1310 // read in additional file in mime.types format
1311 bool ReadMimeTypes(const wxString& filename);
1313 // enumerate all known MIME types
1315 PyObject* EnumAllFileTypes() {
1317 self->EnumAllFileTypes(arr);
1318 return wxArrayString2PyList_helper(arr);
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).
1327 void AddFallback(const wxFileTypeInfo& ft);
1330 // create or remove associations
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);
1338 bool Unassociate(wxFileType *ft) ;
1340 // dtor (not virtual, shouldn't be derived from)
1341 ~wxMimeTypesManager();
1349 extern wxMimeTypesManager* wxTheMimeTypesManager;
1355 //----------------------------------------------------------------------
1358 #include <wx/docview.h>
1361 class wxFileHistory : public wxObject
1364 wxFileHistory(int maxFiles = 9);
1368 void AddFileToHistory(const wxString& file);
1369 void RemoveFileFromHistory(int i);
1370 int GetMaxFiles() const;
1371 void UseMenu(wxMenu *menu);
1373 // Remove menu from the list (MDI child may be closing)
1374 void RemoveMenu(wxMenu *menu);
1376 void Load(wxConfigBase& config);
1377 void Save(wxConfigBase& config);
1379 void AddFilesToMenu();
1380 %name(AddFilesToThisMenu)void AddFilesToMenu(wxMenu* menu);
1383 wxString GetHistoryFile(int i) const;
1385 // A synonym for GetNoHistoryFiles
1386 int GetCount() const;
1387 int GetNoHistoryFiles() const;
1391 //----------------------------------------------------------------------
1392 //----------------------------------------------------------------------
1396 wxPyPtrTypeMap_Add("wxDragImage", "wxGenericDragImage");
1397 wxPyPtrTypeMap_Add("wxProcess", "wxPyProcess");
1400 //----------------------------------------------------------------------