fixed typo

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

diff --git a/wxPython/src/_functions.i b/wxPython/src/_functions.i
index 241ad3d5fd82e729f941d28c7a55cde58114c636..02238b8ef58db3c5e1701d58574e1be67886a1e6 100644 (file)
--- a/wxPython/src/_functions.i
+++ b/wxPython/src/_functions.i
@@ -15,11 +15,9 @@
 
 //---------------------------------------------------------------------------
 
-%{
-    DECLARE_DEF_STRING(FileSelectorPromptStr);
-    DECLARE_DEF_STRING(FileSelectorDefaultWildcardStr);
-    DECLARE_DEF_STRING(DirSelectorPromptStr);
-%}
+MAKE_CONST_WXSTRING(FileSelectorPromptStr);
+MAKE_CONST_WXSTRING(FileSelectorDefaultWildcardStr);
+MAKE_CONST_WXSTRING(DirSelectorPromptStr);
 
 //---------------------------------------------------------------------------
 %newgroup;
@@ -29,11 +27,15 @@ long wxNewId();
 void wxRegisterId(long id);
 long wxGetCurrentId();
 
+MustHaveApp(wxBell);
 void wxBell();
+
+MustHaveApp(wxEndBusyCursor);
 void wxEndBusyCursor();
 
 long wxGetElapsedTime(bool resetTimer = True);
 
+MustHaveApp(wxGetMousePosition);
 DocDeclA(
     void, wxGetMousePosition(int* OUTPUT, int* OUTPUT),
     "GetMousePosition() -> (x,y)");
@@ -49,12 +51,20 @@ DocDeclA(
 
 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
 %inline %{
     long wxGetFreeMemory()
-        { PyErr_SetNone(PyExc_NotImplementedError); return 0; }
+        { wxPyRaiseNotImplemented(); return 0; }
 %}
 #endif
 
@@ -65,11 +75,15 @@ enum wxShutdownFlags
 };
 
 // Shutdown or reboot the PC
+MustHaveApp(wxShutdown);
 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);
@@ -90,6 +104,7 @@ void wxTrap();
 
 // Dialog Functions
 
+MustHaveApp(wxFileSelector);
 wxString wxFileSelector(const wxString& message = wxPyFileSelectorPromptStr,
                         const wxString& default_path = wxPyEmptyString,
                         const wxString& default_filename = wxPyEmptyString,
@@ -103,24 +118,28 @@ wxString wxFileSelector(const wxString& message = wxPyFileSelectorPromptStr,
 
 
 // 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,
@@ -128,6 +147,7 @@ wxString wxGetTextFromUser(const wxString& message,
                            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,
@@ -142,6 +162,7 @@ wxString wxGetPasswordFromUser(const wxString& message,
 //                         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,
@@ -149,6 +170,7 @@ wxString wxGetSingleChoice(const wxString& message, const wxString& caption,
                            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,
@@ -157,12 +179,14 @@ int wxGetSingleChoiceIndex(const wxString& message, const wxString& caption,
                            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);
 
+MustHaveApp(wxGetNumberFromUser);
 long wxGetNumberFromUser(const wxString& message,
                          const wxString& prompt,
                          const wxString& caption,
@@ -173,54 +197,81 @@ long wxGetNumberFromUser(const wxString& message,
 
 // 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);
 
 
 
 // Miscellaneous functions
 
+MustHaveApp(wxBeginBusyCursor);
 void wxBeginBusyCursor(wxCursor *cursor = wxHOURGLASS_CURSOR);
+
+MustHaveApp(wxGetActiveWindow);
 wxWindow * wxGetActiveWindow();
 
+MustHaveApp(wxGenericFindWindowAtPoint);
 wxWindow* wxGenericFindWindowAtPoint(const wxPoint& pt);
+
+MustHaveApp(wxFindWindowAtPoint);
 wxWindow* wxFindWindowAtPoint(const wxPoint& pt);
 
+MustHaveApp(wxGetTopLevelParent);
 wxWindow* wxGetTopLevelParent(wxWindow *win);
 
 //bool wxSpawnBrowser(wxWindow *parent, wxString href);
 
 
 
-#if defined(__WXMSW__) || defined(__WXMAC__)
-// Get the state of a key (true if pressed, false if not)
-// This is generally most useful getting the state of
-// Caps Lock, Num Lock and Scroll Lock...
-bool wxGetKeyState(wxKeyCode key);
-#endif
+
+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 work.
+", "");
+
 
 
 //---------------------------------------------------------------------------
 
+MustHaveApp(wxWakeUpMainThread);
+
 #if defined(__WXMSW__) || defined(__WXMAC__)
 void wxWakeUpMainThread();
 #else
@@ -229,10 +280,15 @@ void wxWakeUpMainThread();
 %}
 #endif
 
+
+MustHaveApp(wxMutexGuiEnter);
 void wxMutexGuiEnter();
+
+MustHaveApp(wxMutexGuiLeave);
 void wxMutexGuiLeave();
 
 
+MustHaveApp(wxMutexGuiLocker);
 class wxMutexGuiLocker  {
 public:
     wxMutexGuiLocker();
@@ -240,6 +296,7 @@ public:
 };
 
 
+MustHaveApp(wxThread);
 %inline %{
     bool wxThread_IsMain() {
 #ifdef WXP_WITH_THREAD