-1->wxID_ANY, TRUE->true, FALSE->false and tabs replacements.

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

diff --git a/wxPython/src/_functions.i b/wxPython/src/_functions.i
index c4395b6a749e9230b0d3193549774b433d55eed9..b562214ae4b976957b71009245d86e4d8fb5fc34 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;
 
 //---------------------------------------------------------------------------
 %newgroup;


@@ -29,16 +27,28 @@ long wxNewId();
 void wxRegisterId(long id);
 long wxGetCurrentId();
 
 void wxRegisterId(long id);
 long wxGetCurrentId();
 

+MustHaveApp(wxBell);

 void wxBell();
 void wxBell();

+
+MustHaveApp(wxEndBusyCursor);

 void wxEndBusyCursor();
 
 long wxGetElapsedTime(bool resetTimer = True);
 void wxEndBusyCursor();
 
 long wxGetElapsedTime(bool resetTimer = True);

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

 bool wxIsBusy();
 wxString wxNow();
 bool wxShell(const wxString& command = wxPyEmptyString);
 void wxStartTimer();
 bool wxIsBusy();
 wxString wxNow();
 bool wxShell(const wxString& command = wxPyEmptyString);
 void wxStartTimer();

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

 wxString wxGetOsDescription();
 
 #if defined(__WXMSW__) || defined(__WXMAC__)
 wxString wxGetOsDescription();
 
 #if defined(__WXMSW__) || defined(__WXMAC__)


@@ -46,7 +56,7 @@ long wxGetFreeMemory();
 #else
 %inline %{
     long wxGetFreeMemory()
 #else
 %inline %{
     long wxGetFreeMemory()

-        { PyErr_SetNone(PyExc_NotImplementedError); return 0; }
+        { wxPyRaiseNotImplemented(); return 0; }

 %}
 #endif
 
 %}
 #endif
 


@@ -57,6 +67,7 @@ enum wxShutdownFlags
 };
 
 // Shutdown or reboot the PC
 };
 
 // Shutdown or reboot the PC

+MustHaveApp(wxShutdown);

 bool wxShutdown(wxShutdownFlags wFlags);
 
 
 bool wxShutdown(wxShutdownFlags wFlags);
 
 


@@ -82,6 +93,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,


@@ -95,24 +107,28 @@ 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,
 wxString wxGetTextFromUser(const wxString& message,
                            const wxString& caption = wxPyEmptyString,
                            const wxString& default_value = wxPyEmptyString,


@@ -120,6 +136,7 @@ wxString wxGetTextFromUser(const wxString& message,
                            int x = -1, int y = -1,
                            bool centre = True);
 
                            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,
 wxString wxGetPasswordFromUser(const wxString& message,
                                const wxString& caption = wxPyEmptyString,
                                const wxString& default_value = wxPyEmptyString,


@@ -134,6 +151,7 @@ wxString wxGetPasswordFromUser(const wxString& message,
 //                         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,
 wxString wxGetSingleChoice(const wxString& message, const wxString& caption,
                            int choices, wxString* choices_array,
                            wxWindow *parent = NULL,


@@ -141,6 +159,7 @@ wxString wxGetSingleChoice(const wxString& message, const wxString& caption,
                            bool centre = True,
                            int width=150, int height=200);
 
                            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 wxGetSingleChoiceIndex(const wxString& message, const wxString& caption,
                            int choices, wxString* choices_array,
                            wxWindow *parent = NULL,


@@ -149,12 +168,14 @@ int wxGetSingleChoiceIndex(const wxString& message, const wxString& caption,
                            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,


@@ -165,40 +186,81 @@ 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();
 

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

 wxSize wxGetDisplaySize();
 
 wxSize wxGetDisplaySize();
 

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

 wxSize wxGetDisplaySizeMM();
 
 wxSize wxGetDisplaySizeMM();
 

-void   wxClientDisplayRect(int *OUTPUT, int *OUTPUT, int *OUTPUT, int *OUTPUT);
+MustHaveApp(wxClientDisplayRect);
+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);
 
 
 

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


@@ -207,10 +269,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();


@@ -218,6 +285,7 @@ public:
 };
 
 
 };
 
 

+MustHaveApp(wxThread);

 %inline %{
     bool wxThread_IsMain() {
 #ifdef WXP_WITH_THREAD
 %inline %{
     bool wxThread_IsMain() {
 #ifdef WXP_WITH_THREAD