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
572 static bool IsEnabled();
573 static bool EnableLogging(bool doIt = TRUE);
574 static void OnLog(wxLogLevel level, const wxString& szString, int t=0);
576 virtual void Flush();
577 bool HasPendingMessages() const;
579 static void FlushActive();
580 static wxLog *GetActiveTarget();
581 static wxLog *SetActiveTarget(wxLog *pLogger);
583 static void Suspend();
584 static void Resume();
586 static void SetVerbose(bool bVerbose = TRUE);
588 static void DontCreateOnDemand();
589 static void SetTraceMask(wxTraceMask ulMask);
590 static void AddTraceMask(const wxString& str);
591 static void RemoveTraceMask(const wxString& str);
592 static void ClearTraceMasks();
594 static void SetTimestamp(const wxString& ts);
595 static const wxString& GetTimestamp();
597 bool GetVerbose() const;
599 static wxTraceMask GetTraceMask();
600 static bool IsAllowedTraceMask(const wxString& mask);
602 // static void TimeStamp(wxString *str);
604 wxString TimeStamp() {
606 wxLog::TimeStamp(&msg);
614 class wxLogStderr : public wxLog
617 wxLogStderr(/* TODO: FILE *fp = (FILE *) NULL*/);
621 class wxLogTextCtrl : public wxLog
624 wxLogTextCtrl(wxTextCtrl *pTextCtrl);
628 class wxLogGui : public wxLog
634 class wxLogWindow : public wxLog
637 wxLogWindow(wxFrame *pParent, // the parent frame (can be NULL)
638 const wxString& szTitle, // the title of the frame
639 bool bShow = TRUE, // show window immediately?
640 bool bPassToOld = TRUE); // pass log messages to the old target?
642 void Show(bool bShow = TRUE);
643 wxFrame *GetFrame() const;
644 wxLog *GetOldLog() const;
645 bool IsPassingMessages() const;
646 void PassMessages(bool bDoPass);
650 class wxLogChain : public wxLog
653 wxLogChain(wxLog *logger);
654 void SetLog(wxLog *logger);
655 void PassMessages(bool bDoPass);
656 bool IsPassingMessages();
661 unsigned long wxSysErrorCode();
662 const wxString wxSysErrorMsg(unsigned long nErrCode = 0);
663 void wxLogFatalError(const wxString& szFormat);
664 void wxLogError(const wxString& szFormat);
665 void wxLogWarning(const wxString& szFormat);
666 void wxLogMessage(const wxString& szFormat);
667 void wxLogInfo(const wxString& szFormat);
668 void wxLogVerbose(const wxString& szFormat);
669 void wxLogStatus(const wxString& szFormat);
670 %name(wxLogStatusFrame)void wxLogStatus(wxFrame *pFrame, const wxString& szFormat);
671 void wxLogSysError(const wxString& szFormat);
673 // wxLogFatalError helper: show the (fatal) error to the user in a safe way,
674 // i.e. without using wxMessageBox() for example because it could crash
675 void wxSafeShowMessage(const wxString& title, const wxString& text);
679 // Suspress logging while an instance of this class exists
691 // A wxLog class that can be derived from in wxPython
692 class wxPyLog : public wxLog {
694 wxPyLog() : wxLog() {}
696 virtual void DoLog(wxLogLevel level, const wxChar *szString, time_t t) {
698 wxPyBeginBlockThreads();
699 if ((found = wxPyCBH_findCallback(m_myInst, "DoLog")))
700 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iOi)", level,
701 wx2PyString(szString), t));
702 wxPyEndBlockThreads();
704 wxLog::DoLog(level, szString, t);
707 virtual void DoLogString(const wxChar *szString, time_t t) {
709 wxPyBeginBlockThreads();
710 if ((found = wxPyCBH_findCallback(m_myInst, "DoLogString")))
711 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(Oi)",
712 wx2PyString(szString), t));
713 wxPyEndBlockThreads();
715 wxLog::DoLogString(szString, t);
722 // Now tell SWIG about it
723 class wxPyLog : public wxLog {
726 void _setCallbackInfo(PyObject* self, PyObject* _class);
727 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxPyLog)"
728 %addmethods { void Destroy() { delete self; } }
733 //----------------------------------------------------------------------
742 class wxProcessEvent : public wxEvent {
744 wxProcessEvent(int id = 0, int pid = 0, int exitcode = 0);
747 int m_pid, m_exitcode;
753 %{ // C++ version of wxProcess derived class
755 class wxPyProcess : public wxProcess {
757 wxPyProcess(wxEvtHandler *parent = NULL, int id = -1)
758 : wxProcess(parent, id)
761 DEC_PYCALLBACK_VOID_INTINT(OnTerminate);
766 IMP_PYCALLBACK_VOID_INTINT( wxPyProcess, wxProcess, OnTerminate);
771 %name(wxProcess)class wxPyProcess : public wxEvtHandler {
773 wxPyProcess(wxEvtHandler *parent = NULL, int id = -1);
774 %addmethods { void Destroy() { delete self; } }
776 void _setCallbackInfo(PyObject* self, PyObject* _class);
777 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxProcess)"
779 void base_OnTerminate(int pid, int status);
785 wxInputStream *GetInputStream();
786 wxInputStream *GetErrorStream();
787 wxOutputStream *GetOutputStream();
795 // execute the process asynchronously
798 // execute it synchronously, i.e. wait until it finishes
801 // under Windows, don't hide the child even if it's IO is redirected (this
802 // is done by default)
805 // under Unix, if the process is the group leader then killing -pid kills
806 // all children as well as pid
807 wxEXEC_MAKE_GROUP_LEADER = 4
811 long wxExecute(const wxString& command,
812 int flags = wxEXEC_ASYNC,
813 wxPyProcess *process = NULL);
815 //----------------------------------------------------------------------
818 #if !wxUSE_JOYSTICK && !defined(__WXMSW__)
819 // A C++ stub class for wxJoystick for platforms that don't have it.
820 class wxJoystick : public wxObject {
822 wxJoystick(int joystick = wxJOYSTICK1) {
823 wxPyBeginBlockThreads();
824 PyErr_SetString(PyExc_NotImplementedError, "wxJoystick is not available on this platform.");
825 wxPyEndBlockThreads();
827 wxPoint GetPosition() { return wxPoint(-1,-1); }
828 int GetZPosition() { return -1; }
829 int GetButtonState() { return -1; }
830 int GetPOVPosition() { return -1; }
831 int GetPOVCTSPosition() { return -1; }
832 int GetRudderPosition() { return -1; }
833 int GetUPosition() { return -1; }
834 int GetVPosition() { return -1; }
835 int GetMovementThreshold() { return -1; }
836 void SetMovementThreshold(int threshold) {}
838 bool IsOk(void) { return FALSE; }
839 int GetNumberJoysticks() { return -1; }
840 int GetManufacturerId() { return -1; }
841 int GetProductId() { return -1; }
842 wxString GetProductName() { return ""; }
843 int GetXMin() { return -1; }
844 int GetYMin() { return -1; }
845 int GetZMin() { return -1; }
846 int GetXMax() { return -1; }
847 int GetYMax() { return -1; }
848 int GetZMax() { return -1; }
849 int GetNumberButtons() { return -1; }
850 int GetNumberAxes() { return -1; }
851 int GetMaxButtons() { return -1; }
852 int GetMaxAxes() { return -1; }
853 int GetPollingMin() { return -1; }
854 int GetPollingMax() { return -1; }
855 int GetRudderMin() { return -1; }
856 int GetRudderMax() { return -1; }
857 int GetUMin() { return -1; }
858 int GetUMax() { return -1; }
859 int GetVMin() { return -1; }
860 int GetVMax() { return -1; }
862 bool HasRudder() { return FALSE; }
863 bool HasZ() { return FALSE; }
864 bool HasU() { return FALSE; }
865 bool HasV() { return FALSE; }
866 bool HasPOV() { return FALSE; }
867 bool HasPOV4Dir() { return FALSE; }
868 bool HasPOVCTS() { return FALSE; }
870 bool SetCapture(wxWindow* win, int pollingFreq = 0) { return FALSE; }
871 bool ReleaseCapture() { return FALSE; }
877 class wxJoystick : public wxObject {
879 wxJoystick(int joystick = wxJOYSTICK1);
882 wxPoint GetPosition();
884 int GetButtonState();
885 int GetPOVPosition();
886 int GetPOVCTSPosition();
887 int GetRudderPosition();
890 int GetMovementThreshold();
891 void SetMovementThreshold(int threshold) ;
894 int GetNumberJoysticks();
895 int GetManufacturerId();
897 wxString GetProductName();
904 int GetNumberButtons();
925 bool SetCapture(wxWindow* win, int pollingFreq = 0);
926 bool ReleaseCapture();
929 //----------------------------------------------------------------------
933 // A C++ stub class for wxWave for platforms that don't have it.
934 class wxWave : public wxObject
937 wxWave(const wxString& fileName, bool isResource = FALSE) {
938 wxPyBeginBlockThreads();
939 PyErr_SetString(PyExc_NotImplementedError, "wxWave is not available on this platform.");
940 wxPyEndBlockThreads();
942 wxWave(int size, const wxByte* data) {
943 wxPyBeginBlockThreads();
944 PyErr_SetString(PyExc_NotImplementedError, "wxWave is not available on this platform.");
945 wxPyEndBlockThreads();
950 bool IsOk() const { return FALSE; }
951 bool Play(bool async = TRUE, bool looped = FALSE) const { return FALSE; }
957 class wxWave : public wxObject
960 wxWave(const wxString& fileName, bool isResource = FALSE);
964 bool Play(bool async = TRUE, bool looped = FALSE) const;
967 %new wxWave* wxWaveData(const wxString& data);
968 %{ // Implementations of some alternate "constructors"
969 wxWave* wxWaveData(const wxString& data) {
970 return new wxWave(data.Len(), (wxByte*)data.c_str());
975 //----------------------------------------------------------------------
979 wxMAILCAP_STANDARD = 1,
980 wxMAILCAP_NETSCAPE = 2,
994 wxFileTypeInfo(const char* mimeType,
996 const char* printCmd,
1000 // the array elements correspond to the parameters of the ctor above in
1002 %name(wxFileTypeInfoSequence)wxFileTypeInfo(const wxArrayString& sArray);
1004 // invalid item - use this to terminate the array passed to
1005 // wxMimeTypesManager::AddFallbacks
1006 %name(wxNullFileTypeInfo)wxFileTypeInfo();
1009 // test if this object can be used
1010 bool IsValid() const;
1013 // set the icon info
1014 void SetIcon(const wxString& iconFile, int iconIndex = 0);
1016 // set the short desc
1017 void SetShortDesc(const wxString& shortDesc);
1020 // get the MIME type
1021 const wxString& GetMimeType() const;
1022 // get the open command
1023 const wxString& GetOpenCommand() const;
1024 // get the print command
1025 const wxString& GetPrintCommand() const;
1026 // get the short description (only used under Win32 so far)
1027 const wxString& GetShortDesc() const;
1028 // get the long, user visible description
1029 const wxString& GetDescription() const;
1032 // get the array of all extensions
1033 //const wxArrayString& GetExtensions() const;
1035 PyObject* GetExtensions() {
1036 wxArrayString& arr = (wxArrayString&)self->GetExtensions();
1037 return wxArrayString2PyList_helper(arr);
1041 int GetExtensionsCount() const;
1043 // get the icon info
1044 const wxString& GetIconFile() const;
1045 int GetIconIndex() const;
1055 // TODO: Make a wxPyMessageParameters with virtual GetParamValue...
1057 // An object of this class must be passed to Get{Open|Print}Command. The
1058 // default implementation is trivial and doesn't know anything at all about
1059 // parameters, only filename and MIME type are used (so it's probably ok for
1060 // Windows where %{param} is not used anyhow)
1061 class MessageParameters
1065 MessageParameters(const wxString& filename=wxPyEmptyString,
1066 const wxString& mimetype=wxPyEmptyString);
1068 // accessors (called by GetOpenCommand)
1070 const wxString& GetFileName() const;
1072 const wxString& GetMimeType() const;;
1074 // override this function in derived class
1075 virtual wxString GetParamValue(const wxString& name) const;
1077 // virtual dtor as in any base class
1078 virtual ~MessageParameters();
1082 // ctor from static data
1083 wxFileType(const wxFileTypeInfo& ftInfo);
1085 // return the MIME type for this file type
1087 PyObject* GetMimeType() {
1089 if (self->GetMimeType(&str)) {
1091 return PyUnicode_FromUnicode(str.c_str(), str.Len());
1093 return PyString_FromStringAndSize(str.c_str(), str.Len());
1099 PyObject* GetMimeTypes() {
1101 if (self->GetMimeTypes(arr))
1102 return wxArrayString2PyList_helper(arr);
1109 // Get all extensions associated with this file type
1111 PyObject* GetExtensions() {
1113 if (self->GetExtensions(arr))
1114 return wxArrayString2PyList_helper(arr);
1122 // Get the icon corresponding to this file type
1123 %new wxIcon* GetIcon() {
1125 if (self->GetIcon(&icon))
1126 return new wxIcon(icon);
1131 // Get the icon corresponding to this file type, the name of the file
1132 // where this icon resides, and its index in this file if applicable.
1133 PyObject* GetIconInfo() {
1137 if (self->GetIcon(&icon, &iconFile, &iconIndex)) {
1138 wxPyBeginBlockThreads();
1139 PyObject* tuple = PyTuple_New(3);
1140 PyTuple_SetItem(tuple, 0, wxPyConstructObject(new wxIcon(icon),
1143 PyTuple_SetItem(tuple, 1, PyUnicode_FromUnicode(iconFile.c_str(), iconFile.Len()));
1145 PyTuple_SetItem(tuple, 1, PyString_FromStringAndSize(iconFile.c_str(), iconFile.Len()));
1147 PyTuple_SetItem(tuple, 2, PyInt_FromLong(iconIndex));
1148 wxPyEndBlockThreads();
1157 // get a brief file type description ("*.txt" => "text document")
1158 PyObject* GetDescription() {
1160 if (self->GetDescription(&str)) {
1162 return PyUnicode_FromUnicode(str.c_str(), str.Len());
1164 return PyString_FromStringAndSize(str.c_str(), str.Len());
1172 // get the command to open/execute the file of given type
1174 PyObject* GetOpenCommand(const wxString& filename,
1175 const wxString& mimetype=wxPyEmptyString) {
1177 if (self->GetOpenCommand(&str, wxFileType::MessageParameters(filename, mimetype))) {
1179 return PyUnicode_FromUnicode(str.c_str(), str.Len());
1181 return PyString_FromStringAndSize(str.c_str(), str.Len());
1189 // get the command to print the file of given type
1191 PyObject* GetPrintCommand(const wxString& filename,
1192 const wxString& mimetype=wxPyEmptyString) {
1194 if (self->GetPrintCommand(&str, wxFileType::MessageParameters(filename, mimetype))) {
1196 return PyUnicode_FromUnicode(str.c_str(), str.Len());
1198 return PyString_FromStringAndSize(str.c_str(), str.Len());
1206 // Get all commands defined for this file type
1208 PyObject* GetAllCommands(const wxString& filename,
1209 const wxString& mimetype=wxPyEmptyString) {
1210 wxArrayString verbs;
1211 wxArrayString commands;
1212 if (self->GetAllCommands(&verbs, &commands,
1213 wxFileType::MessageParameters(filename, mimetype))) {
1214 wxPyBeginBlockThreads();
1215 PyObject* tuple = PyTuple_New(2);
1216 PyTuple_SetItem(tuple, 0, wxArrayString2PyList_helper(verbs));
1217 PyTuple_SetItem(tuple, 1, wxArrayString2PyList_helper(commands));
1218 wxPyEndBlockThreads();
1227 // set an arbitrary command, ask confirmation if it already exists and
1228 // overwriteprompt is TRUE
1229 bool SetCommand(const wxString& cmd, const wxString& verb,
1230 bool overwriteprompt = TRUE);
1232 bool SetDefaultIcon(const wxString& cmd = wxPyEmptyString, int index = 0);
1235 // remove the association for this filetype from the system MIME database:
1236 // notice that it will only work if the association is defined in the user
1237 // file/registry part, we will never modify the system-wide settings
1241 // expand a string in the format of GetOpenCommand (which may contain
1242 // '%s' and '%t' format specificators for the file name and mime type
1243 // and %{param} constructions).
1244 static wxString ExpandCommand(const wxString& command,
1245 const MessageParameters& params);
1247 // dtor (not virtual, shouldn't be derived from)
1255 class wxMimeTypesManager
1258 // static helper functions
1259 // -----------------------
1261 // check if the given MIME type is the same as the other one: the
1262 // second argument may contain wildcards ('*'), but not the first. If
1263 // the types are equal or if the mimeType matches wildcard the function
1264 // returns TRUE, otherwise it returns FALSE
1265 static bool IsOfType(const wxString& mimeType, const wxString& wildcard);
1268 wxMimeTypesManager();
1270 // loads data from standard files according to the mailcap styles
1271 // specified: this is a bitwise OR of wxMailcapStyle values
1273 // use the extraDir parameter if you want to look for files in another
1275 void Initialize(int mailcapStyle = wxMAILCAP_STANDARD,
1276 const wxString& extraDir = wxPyEmptyString);
1278 // and this function clears all the data from the manager
1281 // Database lookup: all functions return a pointer to wxFileType object
1282 // whose methods may be used to query it for the information you're
1283 // interested in. If the return value is !NULL, caller is responsible for
1285 // get file type from file extension
1286 %new wxFileType *GetFileTypeFromExtension(const wxString& ext);
1288 // get file type from MIME type (in format <category>/<format>)
1289 %new wxFileType *GetFileTypeFromMimeType(const wxString& mimeType);
1291 // other operations: return TRUE if there were no errors or FALSE if there
1292 // were some unreckognized entries (the good entries are always read anyhow)
1295 // read in additional file (the standard ones are read automatically)
1296 // in mailcap format (see mimetype.cpp for description)
1298 // 'fallback' parameter may be set to TRUE to avoid overriding the
1299 // settings from other, previously parsed, files by this one: normally,
1300 // the files read most recently would override the older files, but with
1301 // fallback == TRUE this won't happen
1302 bool ReadMailcap(const wxString& filename, bool fallback = FALSE);
1304 // read in additional file in mime.types format
1305 bool ReadMimeTypes(const wxString& filename);
1307 // enumerate all known MIME types
1309 PyObject* EnumAllFileTypes() {
1311 self->EnumAllFileTypes(arr);
1312 return wxArrayString2PyList_helper(arr);
1316 // these functions can be used to provide default values for some of the
1317 // MIME types inside the program itself (you may also use
1318 // ReadMailcap(filenameWithDefaultTypes, TRUE /* use as fallback */) to
1319 // achieve the same goal, but this requires having this info in a file).
1321 void AddFallback(const wxFileTypeInfo& ft);
1324 // create or remove associations
1326 // create a new association using the fields of wxFileTypeInfo (at least
1327 // the MIME type and the extension should be set)
1328 // if the other fields are empty, the existing values should be left alone
1329 %new wxFileType *Associate(const wxFileTypeInfo& ftInfo);
1332 bool Unassociate(wxFileType *ft) ;
1334 // dtor (not virtual, shouldn't be derived from)
1335 ~wxMimeTypesManager();
1343 extern wxMimeTypesManager* wxTheMimeTypesManager;
1349 //----------------------------------------------------------------------
1352 #include <wx/docview.h>
1355 class wxFileHistory : public wxObject
1358 wxFileHistory(int maxFiles = 9);
1362 void AddFileToHistory(const wxString& file);
1363 void RemoveFileFromHistory(int i);
1364 int GetMaxFiles() const;
1365 void UseMenu(wxMenu *menu);
1367 // Remove menu from the list (MDI child may be closing)
1368 void RemoveMenu(wxMenu *menu);
1370 void Load(wxConfigBase& config);
1371 void Save(wxConfigBase& config);
1373 void AddFilesToMenu();
1374 %name(AddFilesToThisMenu)void AddFilesToMenu(wxMenu* menu);
1377 wxString GetHistoryFile(int i) const;
1379 // A synonym for GetNoHistoryFiles
1380 int GetCount() const;
1381 int GetNoHistoryFiles() const;
1385 //----------------------------------------------------------------------
1386 //----------------------------------------------------------------------
1390 wxPyPtrTypeMap_Add("wxDragImage", "wxGenericDragImage");
1391 wxPyPtrTypeMap_Add("wxProcess", "wxPyProcess");
1394 //----------------------------------------------------------------------