warning fix

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

diff --git a/wxPython/src/_functions.i b/wxPython/src/_functions.i
index 4e7423d5060697ccf6aaa481a74fc08b32aef9a5..704f56eea8cd60edbd7e05c7881036b1800bc491 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,11 +31,29 @@ long wxNewId();
 void wxRegisterId(long id);
 long wxGetCurrentId();
 
 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();
 void wxBell();

+
+MustHaveApp(wxEndBusyCursor);

 void wxEndBusyCursor();
 
 void wxEndBusyCursor();
 

-long wxGetElapsedTime(bool resetTimer = True);
+long wxGetElapsedTime(bool resetTimer = true);

 
 

+MustHaveApp(wxGetMousePosition);

 DocDeclA(
     void, wxGetMousePosition(int* OUTPUT, int* OUTPUT),
     "GetMousePosition() -> (x,y)");
 DocDeclA(
     void, wxGetMousePosition(int* OUTPUT, int* OUTPUT),
     "GetMousePosition() -> (x,y)");


@@ -47,6 +69,14 @@ DocDeclA(
 
 wxString wxGetOsDescription();
 
 
 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__)
 long wxGetFreeMemory();
 #else
 #if defined(__WXMSW__) || defined(__WXMAC__)
 long wxGetFreeMemory();
 #else


@@ -63,11 +93,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 +122,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 +136,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 +177,35 @@ 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);
 

+// WXWIN_COMPATIBILITY_2_4
+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,38 +216,60 @@ 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);
 
 
 
 // Miscellaneous functions
 
 void wxSetCursor(wxCursor& cursor);
 
 
 
 // Miscellaneous functions
 

+MustHaveApp(wxBeginBusyCursor);

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

+
+MustHaveApp(wxGetActiveWindow);

 wxWindow * wxGetActiveWindow();
 
 wxWindow * wxGetActiveWindow();
 

+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);
 
 //bool wxSpawnBrowser(wxWindow *parent, wxString href);
 wxWindow* wxGetTopLevelParent(wxWindow *win);
 
 //bool wxSpawnBrowser(wxWindow *parent, wxString href);


@@ -210,6 +277,7 @@ wxWindow* wxGetTopLevelParent(wxWindow *win);
 
 
 
 
 
 

+MustHaveApp(wxGetKeyState);

 DocDeclStr(
     bool , wxGetKeyState(wxKeyCode key),
     "Get the state of a key (true if pressed or toggled on, false if not.)
 DocDeclStr(
     bool , wxGetKeyState(wxKeyCode key),
     "Get the state of a key (true if pressed or toggled on, false if not.)


@@ -221,6 +289,8 @@ toggle keys.  On some platforms those may be the only keys that work.
 
 //---------------------------------------------------------------------------
 
 
 //---------------------------------------------------------------------------
 

+MustHaveApp(wxWakeUpMainThread);
+

 #if defined(__WXMSW__) || defined(__WXMAC__)
 void wxWakeUpMainThread();
 #else
 #if defined(__WXMSW__) || defined(__WXMAC__)
 void wxWakeUpMainThread();
 #else


@@ -229,10 +299,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,15 +315,51 @@ 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
     }
 %}
 

+//---------------------------------------------------------------------------
+
+// enum wxPowerType
+// {
+//     wxPOWER_SOCKET,
+//     wxPOWER_BATTERY,
+//     wxPOWER_UNKNOWN
+// };
+
+// DocDeclStr(
+//     wxPowerType , wxGetPowerType(),
+//     "Returns the type of power source as one of wx.POWER_SOCKET,
+// wx.POWER_BATTERY or wx.POWER_UNKNOWN.  wx.POWER_UNKNOWN is also the
+// default on platforms where this feature is not implemented.", "");
+
+
+// enum wxBatteryState
+// {
+//     wxBATTERY_NORMAL_STATE,    // system is fully usable
+//     wxBATTERY_LOW_STATE,       // start to worry
+//     wxBATTERY_CRITICAL_STATE,  // save quickly
+//     wxBATTERY_SHUTDOWN_STATE,  // too late
+//     wxBATTERY_UNKNOWN_STATE
+// };
+
+// DocDeclStr(
+//     wxBatteryState , wxGetBatteryState(),
+//     "Returns battery state as one of wx.BATTERY_NORMAL_STATE,
+// wx.BATTERY_LOW_STATE}, wx.BATTERY_CRITICAL_STATE,
+// wx.BATTERY_SHUTDOWN_STATE or wx.BATTERY_UNKNOWN_STATE.
+// wx.BATTERY_UNKNOWN_STATE is also the default on platforms where this
+// feature is not implemented.", "");
+
+
+

 //---------------------------------------------------------------------------
 //---------------------------------------------------------------------------
 //---------------------------------------------------------------------------
 //---------------------------------------------------------------------------