Add wxPyTabArt

[wxWidgets.git] / wxPython / src / _functions.i

diff --git a/wxPython/src/_functions.i b/wxPython/src/_functions.i
index 4e7423d5060697ccf6aaa481a74fc08b32aef9a5..7b5d74e13340a822e30fdb69143897d67c3f5395 100644 (file)
--- a/wxPython/src/_functions.i
+++ b/wxPython/src/_functions.i
@@ -13,6 +13,10 @@
 // Not a %module
 
 
 // Not a %module
 
 

+%{
+#include <wx/stockitem.h>
+%}
+

 //---------------------------------------------------------------------------
 
 MAKE_CONST_WXSTRING(FileSelectorPromptStr);
 //---------------------------------------------------------------------------
 
 MAKE_CONST_WXSTRING(FileSelectorPromptStr);


@@ -27,31 +31,90 @@ long wxNewId();
 void wxRegisterId(long id);
 long wxGetCurrentId();
 
 void wxRegisterId(long id);
 long wxGetCurrentId();
 

-void wxBell();
-void wxEndBusyCursor();
+// 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);

 
 

-long wxGetElapsedTime(bool resetTimer = True);
+enum wxStockLabelQueryFlag
+{
+    wxSTOCK_NOFLAGS = 0,

 
 

-DocDeclA(
-    void, wxGetMousePosition(int* OUTPUT, int* OUTPUT),
-    "GetMousePosition() -> (x,y)");
+    wxSTOCK_WITH_MNEMONIC = 1,
+    wxSTOCK_WITH_ACCELERATOR = 2
+};
+
+// Returns label that should be used for given stock UI element (e.g. "&OK"
+// for wxID_OK):
+wxString wxGetStockLabel(wxWindowID id,
+                         long flags = wxSTOCK_WITH_MNEMONIC);
+
+
+enum wxStockHelpStringClient
+{
+    wxSTOCK_MENU        // help string to use for menu items
+};
+
+// Returns an help string for the given stock UI element and for the given "context".
+wxString wxGetStockHelpString(wxWindowID id,
+                              wxStockHelpStringClient client = wxSTOCK_MENU);
+
+
+
+
+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();
 
 bool wxIsBusy();
 wxString wxNow();
 bool wxShell(const wxString& command = wxPyEmptyString);
 void wxStartTimer();
 

+

 DocDeclA(
     int, wxGetOsVersion(int *OUTPUT, int *OUTPUT),
     "GetOsVersion() -> (platform, major, minor)");
 
 wxString wxGetOsDescription();
 
 DocDeclA(
     int, wxGetOsVersion(int *OUTPUT, int *OUTPUT),
     "GetOsVersion() -> (platform, major, minor)");
 
 wxString wxGetOsDescription();
 

+
+// Get platform endianness
+bool wxIsPlatformLittleEndian();
+
+// Get platform architecture
+bool wxIsPlatform64Bit();
+
+
+// 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);
+
+
+%typemap(out) wxMemorySize {
+    %#if wxUSE_LONGLONG
+         $result = PyLong_FromLongLong($1.GetValue());
+    %#else
+         $result = PyInt_FromLong($1);
+    %#endif
+}
+

 #if defined(__WXMSW__) || defined(__WXMAC__)
 #if defined(__WXMSW__) || defined(__WXMAC__)

-long wxGetFreeMemory();
+wxMemorySize wxGetFreeMemory();

 #else
 %inline %{
 #else
 %inline %{

-    long wxGetFreeMemory()
+    wxMemorySize wxGetFreeMemory()

         { wxPyRaiseNotImplemented(); return 0; }
 %}
 #endif
         { wxPyRaiseNotImplemented(); return 0; }
 %}
 #endif


@@ -63,11 +126,15 @@ enum wxShutdownFlags
 };
 
 // Shutdown or reboot the PC
 };
 
 // Shutdown or reboot the PC

+MustHaveApp(wxShutdown);

 bool wxShutdown(wxShutdownFlags wFlags);
 
 
 void wxSleep(int secs);
 bool wxShutdown(wxShutdownFlags wFlags);
 
 
 void wxSleep(int secs);

-void wxUsleep(unsigned long milliseconds);
+void wxMilliSleep(unsigned long milliseconds);
+void wxMicroSleep(unsigned long microseconds);
+%pythoncode { Usleep = MilliSleep }
+

 void wxEnableTopLevelWindows(bool enable);
 
 wxString wxStripMenuCodes(const wxString& in);
 void wxEnableTopLevelWindows(bool enable);
 
 wxString wxStripMenuCodes(const wxString& in);


@@ -88,6 +155,7 @@ void wxTrap();
 
 // Dialog Functions
 
 
 // Dialog Functions
 

+MustHaveApp(wxFileSelector);

 wxString wxFileSelector(const wxString& message = wxPyFileSelectorPromptStr,
                         const wxString& default_path = wxPyEmptyString,
                         const wxString& default_filename = wxPyEmptyString,
 wxString wxFileSelector(const wxString& message = wxPyFileSelectorPromptStr,
                         const wxString& default_path = wxPyEmptyString,
                         const wxString& default_filename = wxPyEmptyString,


@@ -101,31 +169,36 @@ wxString wxFileSelector(const wxString& message = wxPyFileSelectorPromptStr,
 
 
 // Ask for filename to load
 
 
 // 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
 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);
 
 
 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);
 
 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,
 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);
+                           bool centre = true);

 
 

+MustHaveApp(wxGetPasswordFromUser);

 wxString wxGetPasswordFromUser(const wxString& message,
                                const wxString& caption = wxPyEmptyString,
                                const wxString& default_value = wxPyEmptyString,
 wxString wxGetPasswordFromUser(const wxString& message,
                                const wxString& caption = wxPyEmptyString,
                                const wxString& default_value = wxPyEmptyString,


@@ -137,30 +210,34 @@ wxString wxGetPasswordFromUser(const wxString& message,
 //                         int LCOUNT, char** choices,
 //                         int nsel, int *selection,
 //                         wxWindow *parent = NULL, int x = -1, int y = -1,
 //                         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);
+//                         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,
 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,
+                           bool centre = true,

                            int width=150, int height=200);
 
                            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,
 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,
+                           bool centre = true,

                            int width=150, int height=200);
 
 
                            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);
 
 int wxMessageBox(const wxString& message,
                  const wxString& caption = wxPyEmptyString,
                  int style = wxOK | wxCENTRE,
                  wxWindow *parent = NULL,
                  int x = -1, int y = -1);
 

+MustHaveApp(wxGetNumberFromUser);

 long wxGetNumberFromUser(const wxString& message,
                          const wxString& prompt,
                          const wxString& caption,
 long wxGetNumberFromUser(const wxString& message,
                          const wxString& prompt,
                          const wxString& caption,


@@ -171,56 +248,183 @@ long wxGetNumberFromUser(const wxString& message,
 
 // GDI Functions
 
 
 // GDI Functions
 

+MustHaveApp(wxColourDisplay);

 bool wxColourDisplay();
 
 bool wxColourDisplay();
 

+MustHaveApp(wxDisplayDepth);

 int wxDisplayDepth();
 int wxDisplayDepth();

+
+MustHaveApp(wxGetDisplayDepth);

 int wxGetDisplayDepth();
 
 int wxGetDisplayDepth();
 

+MustHaveApp(wxDisplaySize);

 DocDeclA(
     void, wxDisplaySize(int* OUTPUT, int* OUTPUT),
     "DisplaySize() -> (width, height)");
 DocDeclA(
     void, wxDisplaySize(int* OUTPUT, int* OUTPUT),
     "DisplaySize() -> (width, height)");

+
+MustHaveApp(wxGetDisplaySize);

 wxSize wxGetDisplaySize();
 
 wxSize wxGetDisplaySize();
 

+MustHaveApp(wxDisplaySizeMM);

 DocDeclA(
     void, wxDisplaySizeMM(int* OUTPUT, int* OUTPUT),
     "DisplaySizeMM() -> (width, height)");
 DocDeclA(
     void, wxDisplaySizeMM(int* OUTPUT, int* OUTPUT),
     "DisplaySizeMM() -> (width, height)");

+
+MustHaveApp(wxGetDisplaySizeMM);

 wxSize wxGetDisplaySizeMM();
 
 wxSize wxGetDisplaySizeMM();
 

+MustHaveApp(wxClientDisplayRect);

 DocDeclA(
     void, wxClientDisplayRect(int *OUTPUT, int *OUTPUT, int *OUTPUT, int *OUTPUT),
     "ClientDisplayRect() -> (x, y, width, height)");
 DocDeclA(
     void, wxClientDisplayRect(int *OUTPUT, int *OUTPUT, int *OUTPUT, int *OUTPUT),
     "ClientDisplayRect() -> (x, y, width, height)");

+
+MustHaveApp(wxGetClientDisplayRect);

 wxRect wxGetClientDisplayRect();
 
 wxRect wxGetClientDisplayRect();
 

+
+MustHaveApp(wxSetCursor);

 void wxSetCursor(wxCursor& cursor);
 
 
 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
 
 
 // Miscellaneous functions
 

+MustHaveApp(wxBeginBusyCursor);

 void wxBeginBusyCursor(wxCursor *cursor = wxHOURGLASS_CURSOR);
 void wxBeginBusyCursor(wxCursor *cursor = wxHOURGLASS_CURSOR);

-wxWindow * wxGetActiveWindow();

 
 

+
+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);
 wxWindow* wxGenericFindWindowAtPoint(const wxPoint& pt);

+
+MustHaveApp(wxFindWindowAtPoint);

 wxWindow* wxFindWindowAtPoint(const wxPoint& pt);
 
 wxWindow* wxFindWindowAtPoint(const wxPoint& pt);
 

+MustHaveApp(wxGetTopLevelParent);

 wxWindow* wxGetTopLevelParent(wxWindow *win);
 
 wxWindow* wxGetTopLevelParent(wxWindow *win);
 

-//bool wxSpawnBrowser(wxWindow *parent, wxString href);

 
 

+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
 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 work.
+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
 #if defined(__WXMSW__) || defined(__WXMAC__)
 void wxWakeUpMainThread();
 #else


@@ -229,10 +433,15 @@ void wxWakeUpMainThread();
 %}
 #endif
 
 %}
 #endif
 

+
+MustHaveApp(wxMutexGuiEnter);

 void wxMutexGuiEnter();
 void wxMutexGuiEnter();

+
+MustHaveApp(wxMutexGuiLeave);

 void wxMutexGuiLeave();
 
 
 void wxMutexGuiLeave();
 
 

+MustHaveApp(wxMutexGuiLocker);

 class wxMutexGuiLocker  {
 public:
     wxMutexGuiLocker();
 class wxMutexGuiLocker  {
 public:
     wxMutexGuiLocker();


@@ -240,12 +449,13 @@ public:
 };
 
 
 };
 
 

+MustHaveApp(wxThread);

 %inline %{
     bool wxThread_IsMain() {
 #ifdef WXP_WITH_THREAD
         return wxThread::IsMain();
 #else
 %inline %{
     bool wxThread_IsMain() {
 #ifdef WXP_WITH_THREAD
         return wxThread::IsMain();
 #else

-        return True;
+        return true;

 #endif
     }
 %}
 #endif
     }
 %}