update build and install docs

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

diff --git a/wxPython/src/_cmndlgs.i b/wxPython/src/_cmndlgs.i
index bb15ae01389b1165b39e6a33a73fdc8d680867d6..0d4f2483596517a45e41147030cfdb865ef2ce41 100644 (file)
--- a/wxPython/src/_cmndlgs.i
+++ b/wxPython/src/_cmndlgs.i
@@ -440,6 +440,8 @@ If an item is selected then its index will appear in the list.", "");
             return wxArrayInt2PyList_helper(self->GetSelections());
         }
     }
             return wxArrayInt2PyList_helper(self->GetSelections());
         }
     }

+
+    %property(Selections, GetSelections, SetSelections, doc="See `GetSelections` and `SetSelections`");

 };
 
 
 };
 
 


@@ -486,6 +488,9 @@ public:
     DocDeclStr(
         void , SetSelection(int sel),
         "Set the current selected item to sel", "");
     DocDeclStr(
         void , SetSelection(int sel),
         "Set the current selected item to sel", "");

+
+    %property(Selection, GetSelection, SetSelection, doc="See `GetSelection` and `SetSelection`");
+    %property(StringSelection, GetStringSelection, doc="See `GetStringSelection`");

 };
 
 
 };
 
 


@@ -519,6 +524,8 @@ or the original value if the user has pressed Cancel.", "");
     DocDeclStr(
         void , SetValue(const wxString& value),
         "Sets the default text value.", "");
     DocDeclStr(
         void , SetValue(const wxString& value),
         "Sets the default text value.", "");

+    
+    %property(Value, GetValue, SetValue, doc="See `GetValue` and `SetValue`");

 };
 
 //---------------------------------------------------------------------------
 };
 
 //---------------------------------------------------------------------------


@@ -558,6 +565,9 @@ public:
         "Constructor.  Use ShowModal method to show the dialog.", "");
 
     long GetValue();
         "Constructor.  Use ShowModal method to show the dialog.", "");
 
     long GetValue();

+
+    %property(Value, GetValue, doc="See `GetValue`");
+   

 };
 
 //---------------------------------------------------------------------------
 };
 
 //---------------------------------------------------------------------------


@@ -729,6 +739,17 @@ public:
 
 //---------------------------------------------------------------------------
 
 
 //---------------------------------------------------------------------------
 

+enum {
+    wxPD_AUTO_HIDE,
+    wxPD_APP_MODAL,
+    wxPD_CAN_ABORT,
+    wxPD_ELAPSED_TIME,
+    wxPD_ESTIMATED_TIME,
+    wxPD_REMAINING_TIME,
+    wxPD_SMOOTH,
+    wxPD_CAN_SKIP
+};
+

 
 DocStr(wxProgressDialog,
 "A dialog that shows a short message and a progress bar. Optionally, it
 
 DocStr(wxProgressDialog,
 "A dialog that shows a short message and a progress bar. Optionally, it


@@ -794,7 +815,8 @@ parent window only.", "");
     // only if style is set.  This is so the API doesn't change for existing
     // users...
     DocDeclAStr(
     // only if style is set.  This is so the API doesn't change for existing
     // users...
     DocDeclAStr(

-        virtual bool , Update(int value, const wxString& newmsg = wxPyEmptyString,
+        virtual bool , Update(int value,
+                              const wxString& newmsg = wxPyEmptyString,

                               bool *OUTPUT),
         "Update(self, int value, String newmsg) --> (continue, skip)",
         "Updates the dialog, setting the progress bar to the new value and, if
                               bool *OUTPUT),
         "Update(self, int value, String newmsg) --> (continue, skip)",
         "Updates the dialog, setting the progress bar to the new value and, if


@@ -805,11 +827,21 @@ boolean values, ``(continue, skip)`` where ``continue`` is ``True``
 unless the Cancel button has been pressed, and ``skip`` is ``False``
 unless the Skip button (if any) has been pressed.
 
 unless the Cancel button has been pressed, and ``skip`` is ``False``
 unless the Skip button (if any) has been pressed.
 

-If the ``continue`` return value is ``false``, the application can either
+If the ``continue`` return value is ``False``, the application can either

 immediately destroy the dialog or ask the user for confirmation, and if the
 abort is not confirmed the dialog may be resumed with `Resume` function.
 ", "");
 
 immediately destroy the dialog or ask the user for confirmation, and if the
 abort is not confirmed the dialog may be resumed with `Resume` function.
 ", "");
 

+
+    DocDeclAStr(
+        virtual bool , UpdatePulse(const wxString& newmsg = wxPyEmptyString,
+                                   bool *OUTPUT),
+        "UpdatePulse(self, String newmsg) --> (continue, skip)",
+        "Just like `Update` but switches the dialog to use a gauge in
+interminante mode and calls `wx.Gauge.Pulse` to show the user a bit of
+progress.", "");
+    
+

     DocDeclStr(
         void , Resume(),
         "Can be used to continue with the dialog, after the user had chosen to
     DocDeclStr(
         void , Resume(),
         "Can be used to continue with the dialog, after the user had chosen to