///////////////////////////////////////////////////////////////////////////// // Name: _functions.i // Purpose: SWIG interface defs for various functions and such // // Author: Robin Dunn // // Created: 3-July-1997 // RCS-ID: $Id$ // Copyright: (c) 2003 by Total Control Software // Licence: wxWindows license ///////////////////////////////////////////////////////////////////////////// // Not a %module %{ #include %} //--------------------------------------------------------------------------- MAKE_CONST_WXSTRING(FileSelectorPromptStr); MAKE_CONST_WXSTRING(FileSelectorDefaultWildcardStr); MAKE_CONST_WXSTRING(DirSelectorPromptStr); //--------------------------------------------------------------------------- %newgroup; long wxNewId(); void wxRegisterId(long id); long wxGetCurrentId(); // Returns true if the ID is in the list of recognized stock actions bool wxIsStockID(wxWindowID id); // Returns true of the label is empty or label of a stock button with // given ID bool wxIsStockLabel(wxWindowID id, const wxString& label); // Returns label that should be used for given stock UI element (e.g. "&OK" // for wxID_OK): wxString wxGetStockLabel(wxWindowID id, bool withCodes = true, wxString accelerator = wxPyEmptyString); MustHaveApp(wxBell); void wxBell(); MustHaveApp(wxEndBusyCursor); void wxEndBusyCursor(); long wxGetElapsedTime(bool resetTimer = true); %pythoncode { GetElapsedTime = wx._deprecated(GetElapsedTime) } bool wxIsBusy(); wxString wxNow(); bool wxShell(const wxString& command = wxPyEmptyString); void wxStartTimer(); enum { wxUNKNOWN_PLATFORM, wxCURSES, /* Text-only CURSES */ wxXVIEW_X, /* Sun's XView OpenLOOK toolkit */ wxMOTIF_X, /* OSF Motif 1.x.x */ wxCOSE_X, /* OSF Common Desktop Environment */ wxNEXTSTEP, /* NeXTStep */ wxMAC, /* Apple Mac OS 8/9/X with Mac paths */ wxMAC_DARWIN, /* Apple Mac OS X with Unix paths */ wxBEOS, /* BeOS */ wxGTK, /* GTK on X */ wxGTK_WIN32, /* GTK on Win32 */ wxGTK_OS2, /* GTK on OS/2 */ wxGTK_BEOS, /* GTK on BeOS */ wxGEOS, /* GEOS */ wxOS2_PM, /* OS/2 Workplace */ wxWINDOWS, /* Windows or WfW */ wxMICROWINDOWS, /* MicroWindows */ wxPENWINDOWS, /* Windows for Pen Computing */ wxWINDOWS_NT, /* Windows NT */ wxWIN32S, /* Windows 32S API */ wxWIN95, /* Windows 95 */ wxWIN386, /* Watcom 32-bit supervisor modus */ wxWINDOWS_CE, /* Windows CE (generic) */ wxWINDOWS_POCKETPC, /* Windows CE PocketPC */ wxWINDOWS_SMARTPHONE, /* Windows CE Smartphone */ wxMGL_UNIX, /* MGL with direct hardware access */ wxMGL_X, /* MGL on X */ wxMGL_WIN32, /* MGL on Win32 */ wxMGL_OS2, /* MGL on OS/2 */ wxMGL_DOS, /* MGL on MS-DOS */ wxWINDOWS_OS2, /* Native OS/2 PM */ wxUNIX, /* wxBase under Unix */ wxX11, /* Plain X11 and Universal widgets */ wxPALMOS, /* PalmOS */ wxDOS /* wxBase under MS-DOS */ }; DocDeclA( int, wxGetOsVersion(int *OUTPUT, int *OUTPUT), "GetOsVersion() -> (platform, major, minor)"); wxString wxGetOsDescription(); // TODO: // // Parses the wildCard, returning the number of filters. // // Returns 0 if none or if there's a problem, // // The arrays will contain an equal number of items found before the error. // // wildCard is in the form: // // "All files (*)|*|Image Files (*.jpeg *.png)|*.jpg;*.png" // int wxParseCommonDialogsFilter(const wxString& wildCard, wxArrayString& descriptions, wxArrayString& filters); #if defined(__WXMSW__) || defined(__WXMAC__) wxMemorySize wxGetFreeMemory(); #else %inline %{ wxMemorySize wxGetFreeMemory() { wxPyRaiseNotImplemented(); return 0; } %} #endif enum wxShutdownFlags { wxSHUTDOWN_POWEROFF, // power off the computer wxSHUTDOWN_REBOOT // shutdown and reboot }; // Shutdown or reboot the PC MustHaveApp(wxShutdown); bool wxShutdown(wxShutdownFlags wFlags); void wxSleep(int secs); void wxMilliSleep(unsigned long milliseconds); void wxMicroSleep(unsigned long microseconds); %pythoncode { Usleep = MilliSleep } void wxEnableTopLevelWindows(bool enable); wxString wxStripMenuCodes(const wxString& in); wxString wxGetEmailAddress(); wxString wxGetHostName(); wxString wxGetFullHostName(); wxString wxGetUserId(); wxString wxGetUserName(); wxString wxGetHomeDir(); wxString wxGetUserHome(const wxString& user = wxPyEmptyString); unsigned long wxGetProcessId(); void wxTrap(); // Dialog Functions MustHaveApp(wxFileSelector); wxString wxFileSelector(const wxString& message = wxPyFileSelectorPromptStr, const wxString& default_path = wxPyEmptyString, const wxString& default_filename = wxPyEmptyString, const wxString& default_extension = wxPyEmptyString, const wxString& wildcard = wxPyFileSelectorDefaultWildcardStr, int flags = 0, wxWindow *parent = NULL, int x = -1, int y = -1); // TODO: wxFileSelectorEx // Ask for filename to load MustHaveApp(wxLoadFileSelector); wxString wxLoadFileSelector(const wxString& what, const wxString& extension, const wxString& default_name = wxPyEmptyString, wxWindow *parent = NULL); // Ask for filename to save MustHaveApp(wxSaveFileSelector); wxString wxSaveFileSelector(const wxString& what, const wxString& extension, const wxString& default_name = wxPyEmptyString, wxWindow *parent = NULL); MustHaveApp(wxDirSelector); wxString wxDirSelector(const wxString& message = wxPyDirSelectorPromptStr, const wxString& defaultPath = wxPyEmptyString, long style = wxDD_DEFAULT_STYLE, const wxPoint& pos = wxDefaultPosition, wxWindow *parent = NULL); MustHaveApp(wxGetTextFromUser); wxString wxGetTextFromUser(const wxString& message, const wxString& caption = wxPyEmptyString, const wxString& default_value = wxPyEmptyString, wxWindow *parent = NULL, int x = -1, int y = -1, bool centre = true); MustHaveApp(wxGetPasswordFromUser); wxString wxGetPasswordFromUser(const wxString& message, const wxString& caption = wxPyEmptyString, const wxString& default_value = wxPyEmptyString, wxWindow *parent = NULL); // TODO: Need to custom wrap this one... // int wxGetMultipleChoice(char* message, char* caption, // int LCOUNT, char** choices, // int nsel, int *selection, // wxWindow *parent = NULL, int x = -1, int y = -1, // bool centre = true, int width=150, int height=200); MustHaveApp(wxGetSingleChoice); wxString wxGetSingleChoice(const wxString& message, const wxString& caption, int choices, wxString* choices_array, wxWindow *parent = NULL, int x = -1, int y = -1, bool centre = true, int width=150, int height=200); MustHaveApp(wxGetSingleChoiceIndex); int wxGetSingleChoiceIndex(const wxString& message, const wxString& caption, int choices, wxString* choices_array, wxWindow *parent = NULL, int x = -1, int y = -1, bool centre = true, int width=150, int height=200); MustHaveApp(wxMessageBox); int wxMessageBox(const wxString& message, const wxString& caption = wxPyEmptyString, int style = wxOK | wxCENTRE, wxWindow *parent = NULL, int x = -1, int y = -1); // WXWIN_COMPATIBILITY_2_4 #if 0 MustHaveApp(wxGetNumberFromUser); long wxGetNumberFromUser(const wxString& message, const wxString& prompt, const wxString& caption, long value, long min = 0, long max = 100, wxWindow *parent = NULL, const wxPoint& pos = wxDefaultPosition); %pythoncode { GetNumberFromUser = wx._deprecated(GetNumberFromUser) } #endif // GDI Functions MustHaveApp(wxColourDisplay); bool wxColourDisplay(); MustHaveApp(wxDisplayDepth); int wxDisplayDepth(); MustHaveApp(wxGetDisplayDepth); int wxGetDisplayDepth(); MustHaveApp(wxDisplaySize); DocDeclA( void, wxDisplaySize(int* OUTPUT, int* OUTPUT), "DisplaySize() -> (width, height)"); MustHaveApp(wxGetDisplaySize); wxSize wxGetDisplaySize(); MustHaveApp(wxDisplaySizeMM); DocDeclA( void, wxDisplaySizeMM(int* OUTPUT, int* OUTPUT), "DisplaySizeMM() -> (width, height)"); MustHaveApp(wxGetDisplaySizeMM); wxSize wxGetDisplaySizeMM(); MustHaveApp(wxClientDisplayRect); DocDeclA( void, wxClientDisplayRect(int *OUTPUT, int *OUTPUT, int *OUTPUT, int *OUTPUT), "ClientDisplayRect() -> (x, y, width, height)"); MustHaveApp(wxGetClientDisplayRect); wxRect wxGetClientDisplayRect(); MustHaveApp(wxSetCursor); void wxSetCursor(wxCursor& cursor); MustHaveApp(wxGetXDisplay); DocStr(wxGetXDisplay, "Returns a swigified pointer to the X11 display. Returns None on other platforms.", ""); %inline %{ void* wxGetXDisplay() { #ifdef __WXGTK__ return wxGetDisplay(); #else return NULL; #endif } %} // Miscellaneous functions MustHaveApp(wxBeginBusyCursor); void wxBeginBusyCursor(wxCursor *cursor = wxHOURGLASS_CURSOR); MustHaveApp(wxGetMousePosition); DocDeclStr( wxPoint, wxGetMousePosition(), "Get the current mouse position on the screen.", ""); MustHaveApp(FindWindowAtPointer); DocStr(FindWindowAtPointer, "Returns the window currently under the mouse pointer, if it belongs to this application. Otherwise it returns None.", ""); %inline %{ wxWindow* FindWindowAtPointer() { wxPoint unused; return wxFindWindowAtPointer(unused); } %} MustHaveApp(wxGetActiveWindow); DocDeclStr( wxWindow *, wxGetActiveWindow(), "Get the currently active window of this application, or None", ""); MustHaveApp(wxGenericFindWindowAtPoint); wxWindow* wxGenericFindWindowAtPoint(const wxPoint& pt); MustHaveApp(wxFindWindowAtPoint); wxWindow* wxFindWindowAtPoint(const wxPoint& pt); MustHaveApp(wxGetTopLevelParent); wxWindow* wxGetTopLevelParent(wxWindow *win); DocDeclStr( bool , wxLaunchDefaultBrowser(const wxString& url), "Launches the user's default browser and tells it to open the location at ``url``. Returns ``True`` if the application was successfully launched.", ""); MustHaveApp(wxGetKeyState); DocDeclStr( bool , wxGetKeyState(wxKeyCode key), "Get the state of a key (true if pressed or toggled on, false if not.) This is generally most useful getting the state of the modifier or toggle keys. On some platforms those may be the only keys that this function is able to detect. ", ""); //--------------------------------------------------------------------------- DocStr(wxMouseState, "`wx.MouseState` is used to hold information about mouse button and modifier key states and is what is returned from `wx.GetMouseState`.", ""); class wxMouseState { public: wxMouseState(); ~wxMouseState(); wxCoord GetX(); wxCoord GetY(); bool LeftDown(); bool MiddleDown(); bool RightDown(); bool ControlDown(); bool ShiftDown(); bool AltDown(); bool MetaDown(); bool CmdDown(); void SetX(wxCoord x); void SetY(wxCoord y); void SetLeftDown(bool down); void SetMiddleDown(bool down); void SetRightDown(bool down); void SetControlDown(bool down); void SetShiftDown(bool down); void SetAltDown(bool down); void SetMetaDown(bool down); %pythoncode { x = property(GetX, SetX) y = property(GetY, SetY) leftDown = property(LeftDown, SetLeftDown) middleDown = property(MiddleDown, SetMiddleDown) rightDown = property(RightDown, SetRightDown) controlDown = property(ControlDown, SetControlDown) shiftDown = property(ShiftDown, SetShiftDown) altDown = property(AltDown, SetAltDown) metaDown = property(MetaDown, SetMetaDown) cmdDown = property(CmdDown) } }; DocDeclStr( wxMouseState , wxGetMouseState(), "Returns the current state of the mouse. Returns an instance of a `wx.MouseState` object that contains the current position of the mouse pointer in screen coordinants, as well as boolean values indicating the up/down status of the mouse buttons and the modifier keys.", ""); //--------------------------------------------------------------------------- MustHaveApp(wxWakeUpMainThread); #if defined(__WXMSW__) || defined(__WXMAC__) void wxWakeUpMainThread(); #else %inline %{ void wxWakeUpMainThread() {} %} #endif MustHaveApp(wxMutexGuiEnter); void wxMutexGuiEnter(); MustHaveApp(wxMutexGuiLeave); void wxMutexGuiLeave(); MustHaveApp(wxMutexGuiLocker); class wxMutexGuiLocker { public: wxMutexGuiLocker(); ~wxMutexGuiLocker(); }; MustHaveApp(wxThread); %inline %{ bool wxThread_IsMain() { #ifdef WXP_WITH_THREAD return wxThread::IsMain(); #else return true; #endif } %} //--------------------------------------------------------------------------- //---------------------------------------------------------------------------