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 <wx/resource.h>
20 #include <wx/tooltip.h>
22 #include <wx/fontenum.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__)
35 //----------------------------------------------------------------------
38 %include my_typemaps.i
40 // Import some definitions of other classes, etc.
49 static wxString wxPyEmptyStr("");
52 //---------------------------------------------------------------------------
55 wxString wxFileSelector(char* message,
56 char* default_path = NULL,
57 char* default_filename = NULL,
58 char* default_extension = NULL,
59 char* wildcard = "*.*",
61 wxWindow *parent = NULL,
62 int x = -1, int y = -1);
64 wxString wxGetTextFromUser(const wxString& message,
65 const wxString& caption = wxPyEmptyStr,
66 const wxString& default_value = wxPyEmptyStr,
67 wxWindow *parent = NULL,
68 int x = -1, int y = -1,
71 wxString wxGetPasswordFromUser(const wxString& message,
72 const wxString& caption = wxPyEmptyStr,
73 const wxString& default_value = wxPyEmptyStr,
74 wxWindow *parent = NULL);
77 // TODO: Need to custom wrap this one...
78 // int wxGetMultipleChoice(char* message, char* caption,
79 // int LCOUNT, char** choices,
80 // int nsel, int *selection,
81 // wxWindow *parent = NULL, int x = -1, int y = -1,
82 // bool centre = TRUE, int width=150, int height=200);
85 wxString wxGetSingleChoice(const wxString& message, const wxString& caption,
86 int LCOUNT, wxString* choices,
87 wxWindow *parent = NULL,
88 int x = -1, int y = -1,
90 int width=150, int height=200);
92 int wxGetSingleChoiceIndex(const wxString& message, const wxString& caption,
93 int LCOUNT, wxString* choices,
94 wxWindow *parent = NULL,
95 int x = -1, int y = -1,
97 int width=150, int height=200);
100 int wxMessageBox(const wxString& message,
101 const wxString& caption = wxPyEmptyStr,
102 int style = wxOK | wxCENTRE,
103 wxWindow *parent = NULL,
104 int x = -1, int y = -1);
106 long wxGetNumberFromUser(const wxString& message,
107 const wxString& prompt,
108 const wxString& caption,
110 long min = 0, long max = 100,
111 wxWindow *parent = NULL,
112 const wxPoint& pos = wxDefaultPosition);
114 //---------------------------------------------------------------------------
117 bool wxColourDisplay();
119 int wxDisplayDepth();
120 int wxGetDisplayDepth();
122 void wxDisplaySize(int* OUTPUT, int* OUTPUT);
123 wxSize wxGetDisplaySize();
125 void wxDisplaySizeMM(int* OUTPUT, int* OUTPUT);
126 wxSize wxGetDisplaySizeMM();
128 void wxClientDisplayRect(int *OUTPUT, int *OUTPUT, int *OUTPUT, int *OUTPUT);
129 wxRect wxGetClientDisplayRect();
131 void wxSetCursor(wxCursor& cursor);
133 //----------------------------------------------------------------------
134 // Miscellaneous functions
136 wxWindow * wxFindWindowByLabel(const wxString& label, wxWindow *parent=NULL);
137 wxWindow * wxFindWindowByName(const wxString& name, wxWindow *parent=NULL);
139 void wxBeginBusyCursor(wxCursor *cursor = wxHOURGLASS_CURSOR);
140 wxWindow * wxGetActiveWindow();
142 wxWindow* wxGenericFindWindowAtPoint(const wxPoint& pt);
143 wxWindow* wxFindWindowAtPoint(const wxPoint& pt);
146 bool wxCheckForInterrupt(wxWindow *wnd);
147 void wxFlushEvents();
150 //---------------------------------------------------------------------------
153 bool wxResourceAddIdentifier(char *name, int value);
154 void wxResourceClear(void);
155 wxBitmap wxResourceCreateBitmap(char *resource);
156 wxIcon wxResourceCreateIcon(char *resource);
157 wxMenuBar * wxResourceCreateMenuBar(char *resource);
158 int wxResourceGetIdentifier(char *name);
159 bool wxResourceParseData(char *resource, wxResourceTable *table = NULL);
160 bool wxResourceParseFile(char *filename, wxResourceTable *table = NULL);
161 bool wxResourceParseString(char *resource, wxResourceTable *table = NULL);
163 //---------------------------------------------------------------------------
177 wxSYS_OEM_FIXED_FONT,
178 wxSYS_ANSI_FIXED_FONT,
181 wxSYS_DEVICE_DEFAULT_FONT,
182 wxSYS_DEFAULT_PALETTE,
183 wxSYS_SYSTEM_FIXED_FONT,
184 wxSYS_DEFAULT_GUI_FONT,
186 wxSYS_COLOUR_SCROLLBAR,
187 wxSYS_COLOUR_BACKGROUND,
188 wxSYS_COLOUR_ACTIVECAPTION,
189 wxSYS_COLOUR_INACTIVECAPTION,
192 wxSYS_COLOUR_WINDOWFRAME,
193 wxSYS_COLOUR_MENUTEXT,
194 wxSYS_COLOUR_WINDOWTEXT,
195 wxSYS_COLOUR_CAPTIONTEXT,
196 wxSYS_COLOUR_ACTIVEBORDER,
197 wxSYS_COLOUR_INACTIVEBORDER,
198 wxSYS_COLOUR_APPWORKSPACE,
199 wxSYS_COLOUR_HIGHLIGHT,
200 wxSYS_COLOUR_HIGHLIGHTTEXT,
201 wxSYS_COLOUR_BTNFACE,
202 wxSYS_COLOUR_BTNSHADOW,
203 wxSYS_COLOUR_GRAYTEXT,
204 wxSYS_COLOUR_BTNTEXT,
205 wxSYS_COLOUR_INACTIVECAPTIONTEXT,
206 wxSYS_COLOUR_BTNHIGHLIGHT,
208 wxSYS_COLOUR_3DDKSHADOW,
209 wxSYS_COLOUR_3DLIGHT,
210 wxSYS_COLOUR_INFOTEXT,
213 wxSYS_COLOUR_DESKTOP,
215 wxSYS_COLOUR_3DSHADOW,
216 wxSYS_COLOUR_3DHIGHLIGHT,
217 wxSYS_COLOUR_3DHILIGHT,
218 wxSYS_COLOUR_BTNHILIGHT,
231 wxSYS_HSCROLL_ARROW_X,
232 wxSYS_HSCROLL_ARROW_Y,
248 wxSYS_VSCROLL_ARROW_X,
249 wxSYS_VSCROLL_ARROW_Y,
253 wxSYS_NETWORK_PRESENT,
254 wxSYS_PENWINDOWS_PRESENT,
263 wxColour wxSystemSettings_GetSystemColour(int index) {
264 return wxSystemSettings::GetSystemColour(index);
267 wxFont wxSystemSettings_GetSystemFont(int index) {
268 return wxSystemSettings::GetSystemFont(index);
271 int wxSystemSettings_GetSystemMetric(int index) {
272 return wxSystemSettings::GetSystemMetric(index);
276 //---------------------------------------------------------------------------
279 class wxToolTip : public wxObject {
281 wxToolTip(const wxString &tip);
283 void SetTip(const wxString& tip);
285 // *** Not in the "public" interface void SetWindow(wxWindow *win);
286 wxWindow *GetWindow();
291 void wxToolTip_Enable(bool flag) {
292 wxToolTip::Enable(flag);
295 void wxToolTip_SetDelay(long milliseconds) {
296 wxToolTip::SetDelay(milliseconds);
300 //----------------------------------------------------------------------
304 wxCaret(wxWindow* window, const wxSize& size);
309 %name(GetPositionTuple)void GetPosition(int *OUTPUT, int *OUTPUT);
310 wxPoint GetPosition();
311 %name(GetSizeTuple)void GetSize(int *OUTPUT, int *OUTPUT);
313 wxWindow *GetWindow();
314 %name(MoveXY)void Move(int x, int y);
315 void Move(const wxPoint& pt);
316 %name(SetSizeWH) void SetSize(int width, int height);
317 void SetSize(const wxSize& size);
318 void Show(int show = TRUE);
323 int wxCaret_GetBlinkTime() {
324 return wxCaret::GetBlinkTime();
327 void wxCaret_SetBlinkTime(int milliseconds) {
328 wxCaret::SetBlinkTime(milliseconds);
332 //----------------------------------------------------------------------
335 class wxPyFontEnumerator : public wxFontEnumerator {
337 wxPyFontEnumerator() {}
338 ~wxPyFontEnumerator() {}
340 DEC_PYCALLBACK_BOOL_STRING(OnFacename);
341 DEC_PYCALLBACK_BOOL_STRINGSTRING(OnFontEncoding);
346 IMP_PYCALLBACK_BOOL_STRING(wxPyFontEnumerator, wxFontEnumerator, OnFacename);
347 IMP_PYCALLBACK_BOOL_STRINGSTRING(wxPyFontEnumerator, wxFontEnumerator, OnFontEncoding);
351 %name(wxFontEnumerator) class wxPyFontEnumerator {
353 wxPyFontEnumerator();
354 ~wxPyFontEnumerator();
355 void _setSelf(PyObject* self, PyObject* _class);
356 %pragma(python) addtomethod = "__init__:self._setSelf(self, wxFontEnumerator)"
358 bool EnumerateFacenames(
359 wxFontEncoding encoding = wxFONTENCODING_SYSTEM, // all
360 bool fixedWidthOnly = FALSE);
361 bool EnumerateEncodings(const char* facename = "");
363 //wxArrayString* GetEncodings();
364 //wxArrayString* GetFacenames();
366 PyObject* GetEncodings() {
367 wxArrayString* arr = self->GetEncodings();
368 PyObject* list = PyList_New(0);
369 for (size_t x=0; x<arr->GetCount(); x++)
370 PyList_Append(list, PyString_FromString((*arr)[x]));
374 PyObject* GetFacenames() {
375 wxArrayString* arr = self->GetFacenames();
376 PyObject* list = PyList_New(0);
377 for (size_t x=0; x<arr->GetCount(); x++)
378 PyList_Append(list, PyString_FromString((*arr)[x]));
384 //----------------------------------------------------------------------
388 wxBusyCursor(wxCursor* cursor = wxHOURGLASS_CURSOR);
392 //----------------------------------------------------------------------
394 class wxWindowDisabler {
396 wxWindowDisabler(wxWindow *winToSkip = NULL);
400 //----------------------------------------------------------------------
402 bool wxSafeYield(wxWindow* win=NULL);
403 void wxPostEvent(wxEvtHandler *dest, wxEvent& event);
408 void wxWakeUpMainThread();
411 void wxMutexGuiEnter();
412 void wxMutexGuiLeave();
415 class wxMutexGuiLocker {
423 bool wxThread_IsMain() {
424 return wxThread::IsMain();
428 //----------------------------------------------------------------------
434 // wxTipProvider(size_t currentTip); **** Abstract base class
437 virtual wxString GetTip() = 0;
438 size_t GetCurrentTip();
443 // The C++ version of wxPyTipProvider
445 class wxPyTipProvider : public wxTipProvider {
447 wxPyTipProvider(size_t currentTip)
448 : wxTipProvider(currentTip) {}
450 DEC_PYCALLBACK_STRING__pure(GetTip);
455 IMP_PYCALLBACK_STRING__pure( wxPyTipProvider, wxTipProvider, GetTip);
460 // Now let SWIG know about it
461 class wxPyTipProvider : public wxTipProvider {
463 wxPyTipProvider(size_t currentTip);
468 bool wxShowTip(wxWindow *parent, wxTipProvider *tipProvider, bool showAtStartup = TRUE);
469 %new wxTipProvider * wxCreateFileTipProvider(const wxString& filename, size_t currentTip);
472 //----------------------------------------------------------------------
475 #include <wx/generic/dragimgg.h>
478 %name (wxDragImage) class wxGenericDragImage : public wxObject
482 wxGenericDragImage(const wxBitmap& image,
483 const wxCursor& cursor = wxNullCursor);
484 ~wxGenericDragImage();
486 void SetBackingBitmap(wxBitmap* bitmap);
487 bool BeginDrag(const wxPoint& hotspot, wxWindow* window,
488 bool fullScreen = FALSE, wxRect* rect = NULL);
490 %name(BeginDrag2) bool BeginDrag(const wxPoint& hotspot, wxWindow* window,
491 wxWindow* fullScreenRect);
494 bool Move(const wxPoint& pt);
498 wxRect GetImageRect(const wxPoint& pos) const;
499 bool RedrawImage(const wxPoint& oldPos, const wxPoint& newPos,
500 bool eraseOld, bool drawNew);
504 // Alternate Constructors
505 %new wxGenericDragImage* wxDragIcon(const wxIcon& image,
506 const wxCursor& cursor = wxNullCursor);
508 %new wxGenericDragImage* wxDragString(const wxString& str,
509 const wxCursor& cursor = wxNullCursor);
511 %new wxGenericDragImage* wxDragTreeItem(const wxTreeCtrl& treeCtrl, wxTreeItemId& id);
513 %new wxGenericDragImage* wxDragListItem(const wxListCtrl& listCtrl, long id);
518 wxGenericDragImage* wxDragIcon(const wxIcon& image,
519 const wxCursor& cursor) {
520 return new wxGenericDragImage(image, cursor);
523 wxGenericDragImage* wxDragString(const wxString& str,
524 const wxCursor& cursor) {
525 return new wxGenericDragImage(str, cursor);
528 wxGenericDragImage* wxDragTreeItem(const wxTreeCtrl& treeCtrl, wxTreeItemId& id) {
529 return new wxGenericDragImage(treeCtrl, id);
532 wxGenericDragImage* wxDragListItem(const wxListCtrl& listCtrl, long id) {
533 return new wxGenericDragImage(listCtrl, id);
540 //----------------------------------------------------------------------
542 class wxPyTimer : public wxObject {
544 wxPyTimer(PyObject* notify);
549 void SetOwner(wxEvtHandler *owner, int id = -1);
550 void Start(int milliseconds=-1, int oneShot=FALSE);
554 //----------------------------------------------------------------------
555 //----------------------------------------------------------------------
560 wxLOG_FatalError, // program can't continue, abort immediately
561 wxLOG_Error, // a serious error, user must be informed about it
562 wxLOG_Warning, // user is normally informed about it but may be ignored
563 wxLOG_Message, // normal message (i.e. normal output of a non GUI app)
564 wxLOG_Info, // informational message (a.k.a. 'Verbose')
565 wxLOG_Status, // informational: might go to the status line of GUI app
566 wxLOG_Debug, // never shown to the user, disabled in release mode
567 wxLOG_Trace, // trace messages are also only enabled in debug mode
568 wxLOG_Progress, // used for progress indicator (not yet)
569 wxLOG_User = 100 // user defined levels start here
578 static bool IsEnabled();
579 static bool EnableLogging(bool doIt = TRUE);
580 static void OnLog(wxLogLevel level, const char *szString, int t=0);
582 virtual void Flush();
583 bool HasPendingMessages() const;
585 static void FlushActive();
586 static wxLog *GetActiveTarget();
587 static wxLog *SetActiveTarget(wxLog *pLogger);
589 static void Suspend();
590 static void Resume();
592 void SetVerbose(bool bVerbose = TRUE);
594 static void DontCreateOnDemand();
595 static void SetTraceMask(wxTraceMask ulMask);
596 static void AddTraceMask(const wxString& str);
597 static void RemoveTraceMask(const wxString& str);
599 bool GetVerbose() const { return m_bVerbose; }
601 static wxTraceMask GetTraceMask();
602 static bool IsAllowedTraceMask(const char *mask);
607 class wxLogStderr : public wxLog
610 wxLogStderr(/* TODO: FILE *fp = (FILE *) NULL*/);
614 class wxLogTextCtrl : public wxLog
617 wxLogTextCtrl(wxTextCtrl *pTextCtrl);
621 class wxLogGui : public wxLog
627 class wxLogWindow : public wxLog
630 wxLogWindow(wxFrame *pParent, // the parent frame (can be NULL)
631 const char *szTitle, // the title of the frame
632 bool bShow = TRUE, // show window immediately?
633 bool bPassToOld = TRUE); // pass log messages to the old target?
635 void Show(bool bShow = TRUE);
636 wxFrame *GetFrame() const;
637 wxLog *GetOldLog() const;
638 bool IsPassingMessages() const;
639 void PassMessages(bool bDoPass) { m_bPassMessages = bDoPass; }
651 unsigned long wxSysErrorCode();
652 const char* wxSysErrorMsg(unsigned long nErrCode = 0);
653 void wxLogFatalError(const char *szFormat);
654 void wxLogError(const char *szFormat);
655 void wxLogWarning(const char *szFormat);
656 void wxLogMessage(const char *szFormat);
657 void wxLogInfo(const char *szFormat);
658 void wxLogVerbose(const char *szFormat);
659 void wxLogStatus(const char *szFormat);
660 %name(wxLogStatusFrame)void wxLogStatus(wxFrame *pFrame, const char *szFormat);
661 void wxLogSysError(const char *szFormat);
665 //----------------------------------------------------------------------
674 class wxProcessEvent : public wxEvent {
676 wxProcessEvent(int id = 0, int pid = 0, int exitcode = 0);
679 int m_pid, m_exitcode;
685 %{ // C++ version of wxProcess derived class
687 class wxPyProcess : public wxProcess {
689 wxPyProcess(wxEvtHandler *parent = NULL, int id = -1)
690 : wxProcess(parent, id)
693 DEC_PYCALLBACK_VOID_INTINT(OnTerminate);
698 IMP_PYCALLBACK_VOID_INTINT( wxPyProcess, wxProcess, OnTerminate);
702 %name(wxProcess)class wxPyProcess : public wxEvtHandler {
704 wxPyProcess(wxEvtHandler *parent = NULL, int id = -1);
705 %addmethods { void Destroy() { delete self; } }
707 void _setSelf(PyObject* self, PyObject* _class);
708 %pragma(python) addtomethod = "__init__:self._setSelf(self, wxProcess)"
710 void base_OnTerminate(int pid, int status);
716 wxInputStream *GetInputStream();
717 wxInputStream *GetErrorStream();
718 wxOutputStream *GetOutputStream();
725 long wxExecute(const wxString& command,
727 wxPyProcess *process = NULL);
729 //----------------------------------------------------------------------
732 #if !wxUSE_JOYSTICK && !defined(__WXMSW__)
733 // A C++ stub class for wxJoystick for platforms that don't have it.
734 class wxJoystick : public wxObject {
736 wxJoystick(int joystick = wxJOYSTICK1) {
737 bool doSave = wxPyRestoreThread();
738 PyErr_SetString(PyExc_NotImplementedError, "wxJoystick is not available on this platform.");
739 wxPySaveThread(doSave);
741 wxPoint GetPosition() { return wxPoint(-1,-1); }
742 int GetZPosition() { return -1; }
743 int GetButtonState() { return -1; }
744 int GetPOVPosition() { return -1; }
745 int GetPOVCTSPosition() { return -1; }
746 int GetRudderPosition() { return -1; }
747 int GetUPosition() { return -1; }
748 int GetVPosition() { return -1; }
749 int GetMovementThreshold() { return -1; }
750 void SetMovementThreshold(int threshold) ;
752 bool IsOk(void) { return FALSE; }
753 int GetNumberJoysticks() { return -1; }
754 int GetManufacturerId() { return -1; }
755 int GetProductId() { return -1; }
756 wxString GetProductName() { return ""; }
757 int GetXMin() { return -1; }
758 int GetYMin() { return -1; }
759 int GetZMin() { return -1; }
760 int GetXMax() { return -1; }
761 int GetYMax() { return -1; }
762 int GetZMax() { return -1; }
763 int GetNumberButtons() { return -1; }
764 int GetNumberAxes() { return -1; }
765 int GetMaxButtons() { return -1; }
766 int GetMaxAxes() { return -1; }
767 int GetPollingMin() { return -1; }
768 int GetPollingMax() { return -1; }
769 int GetRudderMin() { return -1; }
770 int GetRudderMax() { return -1; }
771 int GetUMin() { return -1; }
772 int GetUMax() { return -1; }
773 int GetVMin() { return -1; }
774 int GetVMax() { return -1; }
776 bool HasRudder() { return FALSE; }
777 bool HasZ() { return FALSE; }
778 bool HasU() { return FALSE; }
779 bool HasV() { return FALSE; }
780 bool HasPOV() { return FALSE; }
781 bool HasPOV4Dir() { return FALSE; }
782 bool HasPOVCTS() { return FALSE; }
784 bool SetCapture(wxWindow* win, int pollingFreq = 0) { return FALSE; }
785 bool ReleaseCapture() { return FALSE; }
791 class wxJoystick : public wxObject {
793 wxJoystick(int joystick = wxJOYSTICK1);
796 wxPoint GetPosition();
798 int GetButtonState();
799 int GetPOVPosition();
800 int GetPOVCTSPosition();
801 int GetRudderPosition();
804 int GetMovementThreshold();
805 void SetMovementThreshold(int threshold) ;
808 int GetNumberJoysticks();
809 int GetManufacturerId();
811 wxString GetProductName();
818 int GetNumberButtons();
839 bool SetCapture(wxWindow* win, int pollingFreq = 0);
840 bool ReleaseCapture();
843 //----------------------------------------------------------------------
846 #if !wxUSE_WAVE && !defined(__WXMSW__)
847 // A C++ stub class for wxWave for platforms that don't have it.
848 class wxWave : public wxObject
851 wxWave(const wxString& fileName, bool isResource = FALSE) {
852 bool doSave = wxPyRestoreThread();
853 PyErr_SetString(PyExc_NotImplementedError, "wxWave is not available on this platform.");
854 wxPySaveThread(doSave);
856 wxWave(int size, const wxByte* data) {
857 bool doSave = wxPyRestoreThread();
858 PyErr_SetString(PyExc_NotImplementedError, "wxWave is not available on this platform.");
859 wxPySaveThread(doSave);
864 bool IsOk() const { return FALSE; }
865 bool Play(bool async = TRUE, bool looped = FALSE) const { return FALSE; }
871 class wxWave : public wxObject
874 wxWave(const wxString& fileName, bool isResource = FALSE);
878 bool Play(bool async = TRUE, bool looped = FALSE) const;
881 %new wxWave* wxWaveData(const wxString& data);
882 %{ // Implementations of some alternate "constructors"
883 wxWave* wxWaveData(const wxString& data) {
884 return new wxWave(data.Len(), (wxByte*)data.c_str());
888 //----------------------------------------------------------------------
892 wxPyPtrTypeMap_Add("wxFontEnumerator", "wxPyFontEnumerator");
893 wxPyPtrTypeMap_Add("wxDragImage", "wxGenericDragImage");
894 wxPyPtrTypeMap_Add("wxProcess", "wxPyProcess");
897 //----------------------------------------------------------------------