Add *wxTopLevelWindowGTK*RequestUserAttention*int*;

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

diff --git a/wxPython/src/_cmndlgs.i b/wxPython/src/_cmndlgs.i
index b06600a377623d43e3f2462672f77cba123695a3..f7ea72c2cb5ccf0827d0ed29e9a4d218bd292e8e 100644 (file)
--- a/wxPython/src/_cmndlgs.i
+++ b/wxPython/src/_cmndlgs.i
@@ -353,21 +353,34 @@ public:
                             int choices=0, wxString* choices_array=NULL,
                             long style = wxCHOICEDLG_STYLE,
                             const wxPoint& pos = wxDefaultPosition),
                             int choices=0, wxString* choices_array=NULL,
                             long style = wxCHOICEDLG_STYLE,
                             const wxPoint& pos = wxDefaultPosition),

-        "__init__(Window parent, String message, String caption,
-    List choices=[], long style=CHOICEDLG_STYLE,
+        "__init__(self, Window parent, String message, String caption,
+    List choices=EmptyList, long style=CHOICEDLG_STYLE,

     Point pos=DefaultPosition) -> MultiChoiceDialog",
     Point pos=DefaultPosition) -> MultiChoiceDialog",

-        "Constructor.  Use ShowModal method to show the dialog.", "");
+        "Constructor.  Use the `ShowModal` method to show the dialog.
+
+    :param parent: The parent window.
+    :param message: Text to display above the list of selections.
+    :param caption: Text to use in the title bar of the dialog.
+    :param choices: A list of strings or unicode objects that the
+        user is allowed to choose from.
+    :param style: Styles to apply to the dialog.  The default value is
+        equivallent to wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER|wx.OK|wx.CANCEL|wx.CENTER.
+    :param pos: Where to position the dialog (not used on Windows)
+
+", "");

 
     
     DocDeclAStr(
         void, SetSelections(const wxArrayInt& selections),
         "SetSelections(List selections)",
         "Specify the items in the list that should be selected, using a list of
 
     
     DocDeclAStr(
         void, SetSelections(const wxArrayInt& selections),
         "SetSelections(List selections)",
         "Specify the items in the list that should be selected, using a list of

-integers.", "");
+integers.  The list should specify the indexes of the items that
+should be selected.", "");

 
     DocAStr(GetSelections,
             "GetSelections() -> [selections]",
 
     DocAStr(GetSelections,
             "GetSelections() -> [selections]",

-            "Returns a list of integers representing the items that are selected.", "");
+            "Returns a list of integers representing the items that are selected.
+If an item is selected then its index will appear in the list.", "");

     %extend {
         PyObject* GetSelections() {
             return wxArrayInt2PyList_helper(self->GetSelections());
     %extend {
         PyObject* GetSelections() {
             return wxArrayInt2PyList_helper(self->GetSelections());


@@ -389,7 +402,7 @@ public:
 
     DocAStr(wxSingleChoiceDialog,
             "__init__(Window parent, String message, String caption,
 
     DocAStr(wxSingleChoiceDialog,
             "__init__(Window parent, String message, String caption,

-    List choices=[], long style=CHOICEDLG_STYLE,
+    List choices=EmptyList, long style=CHOICEDLG_STYLE,

     Point pos=DefaultPosition) -> SingleChoiceDialog",
             "Constructor.  Use ShowModal method to show the dialog.", "");
 
     Point pos=DefaultPosition) -> SingleChoiceDialog",
             "Constructor.  Use ShowModal method to show the dialog.", "");
 


@@ -653,10 +666,15 @@ Window Styles
 
     wx.PD_REMAINING_TIME     This flag tells the dialog that it should show
                              remaining time.
 
     wx.PD_REMAINING_TIME     This flag tells the dialog that it should show
                              remaining time.

+
+    wx.PD_SMOOTH             Uses the wx.GA_SMOOTH style on the embedded
+                             wx.Gauge widget.

     ====================     =============================================
 ");
 
 
     ====================     =============================================
 ");
 
 

+// TODO: wxPD_CAN_SKIP
+

 MustHaveApp(wxProgressDialog);
 
 class wxProgressDialog : public wxFrame {
 MustHaveApp(wxProgressDialog);
 
 class wxProgressDialog : public wxFrame {


@@ -673,12 +691,15 @@ public:
 for other windows, or, if wx.PD_APP_MODAL flag is not given, for its
 parent window only.", "");
 
 for other windows, or, if wx.PD_APP_MODAL flag is not given, for its
 parent window only.", "");
 

+    // TODO: support getting the skipped value back in the return value, but
+    // only if style is set.  This is so the API doesn't change for existing
+    // users...

     DocDeclStr(
         virtual bool , Update(int value, const wxString& newmsg = wxPyEmptyString),
         "Updates the dialog, setting the progress bar to the new value and, if
 given changes the message above it. The value given should be less
 than or equal to the maximum value given to the constructor and the
     DocDeclStr(
         virtual bool , Update(int value, const wxString& newmsg = wxPyEmptyString),
         "Updates the dialog, setting the progress bar to the new value and, if
 given changes the message above it. The value given should be less
 than or equal to the maximum value given to the constructor and the

-dialog is closed if it is equal to the maximum.  Returns true unless
+dialog is closed if it is equal to the maximum.  Returns True unless

 the Cancel button has been pressed.
 
 If false is returned, the application can either immediately destroy
 the Cancel button has been pressed.
 
 If false is returned, the application can either immediately destroy