Get/SetTitle only for wxTopLevelWindow (wxMGL part).

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

diff --git a/wxPython/src/_cmndlgs.i b/wxPython/src/_cmndlgs.i
index 1b1294e0abc4508e0b34783031fdb9d6d5a56a61..f7ea72c2cb5ccf0827d0ed29e9a4d218bd292e8e 100644 (file)
--- a/wxPython/src/_cmndlgs.i
+++ b/wxPython/src/_cmndlgs.i
@@ -54,7 +54,7 @@ meaning under other platforms.  The default value is true.", "");
         wxColour , GetCustomColour(int i),
         "Gets the i'th custom colour associated with the colour dialog. i
 should be an integer between 0 and 15. The default custom colours are
         wxColour , GetCustomColour(int i),
         "Gets the i'th custom colour associated with the colour dialog. i
 should be an integer between 0 and 15. The default custom colours are

-all white.", "");
+all invalid colours.", "");

     
     DocDeclStr(
         void , SetChooseFull(int flag),
     
     DocDeclStr(
         void , SetChooseFull(int flag),


@@ -70,7 +70,7 @@ black.", "");
     DocDeclStr(
         void , SetCustomColour(int i, const wxColour& colour),
         "Sets the i'th custom colour for the colour dialog. i should be an
     DocDeclStr(
         void , SetCustomColour(int i, const wxColour& colour),
         "Sets the i'th custom colour for the colour dialog. i should be an

-integer between 0 and 15. The default custom colours are all white.", "");
+integer between 0 and 15. The default custom colours are all invalid colours.", "");

     
 };
 
     
 };
 


@@ -80,6 +80,8 @@ integer between 0 and 15. The default custom colours are all white.", "");
 DocStr(wxColourDialog,
        "This class represents the colour chooser dialog.", "");
 
 DocStr(wxColourDialog,
        "This class represents the colour chooser dialog.", "");
 

+MustHaveApp(wxColourDialog);
+

 class wxColourDialog : public wxDialog {
 public:
     %pythonAppend wxColourDialog   "self._setOORInfo(self)"
 class wxColourDialog : public wxDialog {
 public:
     %pythonAppend wxColourDialog   "self._setOORInfo(self)"


@@ -113,6 +115,8 @@ Window  Styles
     ====================  ==========================================
 ");
 
     ====================  ==========================================
 ");
 

+MustHaveApp(wxDirDialog);
+

 class wxDirDialog : public wxDialog {
 public:
     %pythonAppend wxDirDialog   "self._setOORInfo(self)"
 class wxDirDialog : public wxDialog {
 public:
     %pythonAppend wxDirDialog   "self._setOORInfo(self)"


@@ -198,6 +202,8 @@ Window  Styles
 
 
 
 
 
 

+MustHaveApp(wxFileDialog);
+

 class wxFileDialog : public wxDialog {
 public:
     %pythonAppend wxFileDialog   "self._setOORInfo(self)"
 class wxFileDialog : public wxDialog {
 public:
     %pythonAppend wxFileDialog   "self._setOORInfo(self)"


@@ -246,7 +252,6 @@ example::
         void , SetFilterIndex(int filterIndex),
         "Sets the default filter index, starting from zero.", "");
     
         void , SetFilterIndex(int filterIndex),
         "Sets the default filter index, starting from zero.", "");
     

-

     DocDeclStr(
         wxString , GetMessage() const,
         "Returns the message that will be displayed on the dialog.", "");
     DocDeclStr(
         wxString , GetMessage() const,
         "Returns the message that will be displayed on the dialog.", "");


@@ -334,6 +339,8 @@ enum { wxCHOICEDLG_STYLE };
 DocStr(wxMultiChoiceDialog,
        "A simple dialog with a multi selection listbox.", "");
 
 DocStr(wxMultiChoiceDialog,
        "A simple dialog with a multi selection listbox.", "");
 

+MustHaveApp(wxMultiChoiceDialog);
+

 class wxMultiChoiceDialog : public wxDialog
 {
 public:
 class wxMultiChoiceDialog : public wxDialog
 {
 public:


@@ -343,24 +350,37 @@ public:
         wxMultiChoiceDialog(wxWindow *parent,
                             const wxString& message,
                             const wxString& caption,
         wxMultiChoiceDialog(wxWindow *parent,
                             const wxString& message,
                             const wxString& caption,

-                            int choices=0, wxString* choices_array,
+                            int choices=0, wxString* choices_array=NULL,

                             long style = wxCHOICEDLG_STYLE,
                             const wxPoint& pos = wxDefaultPosition),
                             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());


@@ -374,13 +394,15 @@ integers.", "");
 DocStr(wxSingleChoiceDialog,
        "A simple dialog with a single selection listbox.", "");
 
 DocStr(wxSingleChoiceDialog,
        "A simple dialog with a single selection listbox.", "");
 

+MustHaveApp(wxSingleChoiceDialog);
+

 class wxSingleChoiceDialog : public wxDialog {
 public:
     %pythonAppend wxSingleChoiceDialog   "self._setOORInfo(self)"
 
     DocAStr(wxSingleChoiceDialog,
             "__init__(Window parent, String message, String caption,
 class wxSingleChoiceDialog : public wxDialog {
 public:
     %pythonAppend wxSingleChoiceDialog   "self._setOORInfo(self)"
 
     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.", "");
 


@@ -418,6 +440,10 @@ public:
 DocStr(wxTextEntryDialog,
        "A dialog with text control, [ok] and [cancel] buttons", "");
 
 DocStr(wxTextEntryDialog,
        "A dialog with text control, [ok] and [cancel] buttons", "");
 

+MustHaveApp(wxTextEntryDialog);
+
+enum { wxTextEntryDialogStyle };
+

 class wxTextEntryDialog : public wxDialog {
 public:
     %pythonAppend wxTextEntryDialog   "self._setOORInfo(self)"
 class wxTextEntryDialog : public wxDialog {
 public:
     %pythonAppend wxTextEntryDialog   "self._setOORInfo(self)"


@@ -427,7 +453,7 @@ public:
                           const wxString& message,
                           const wxString& caption = wxPyGetTextFromUserPromptStr,
                           const wxString& defaultValue = wxPyEmptyString,
                           const wxString& message,
                           const wxString& caption = wxPyGetTextFromUserPromptStr,
                           const wxString& defaultValue = wxPyEmptyString,

-                          long style = wxOK | wxCANCEL | wxCENTRE,
+                          long style = wxTextEntryDialogStyle,

                           const wxPoint& pos = wxDefaultPosition),
         "Constructor.  Use ShowModal method to show the dialog.", "");
 
                           const wxPoint& pos = wxDefaultPosition),
         "Constructor.  Use ShowModal method to show the dialog.", "");
 


@@ -443,6 +469,21 @@ or the original value if the user has pressed Cancel.", "");
 
 //---------------------------------------------------------------------------
 
 
 //---------------------------------------------------------------------------
 

+MAKE_CONST_WXSTRING(GetPasswordFromUserPromptStr);
+
+class wxPasswordEntryDialog : public wxTextEntryDialog
+{
+public:
+    wxPasswordEntryDialog(wxWindow *parent,
+                      const wxString& message,
+                      const wxString& caption = wxPyGetPasswordFromUserPromptStr,
+                      const wxString& value = wxPyEmptyString,
+                      long style = wxTextEntryDialogStyle,
+                      const wxPoint& pos = wxDefaultPosition);
+};
+
+//---------------------------------------------------------------------------
+

 
 DocStr(wxFontData,
        "This class holds a variety of information related to font dialogs and
 
 DocStr(wxFontData,
        "This class holds a variety of information related to font dialogs and


@@ -528,6 +569,8 @@ DocStr(wxFontDialog,
 :see: `wx.FontData`
 ", "");
 
 :see: `wx.FontData`
 ", "");
 

+MustHaveApp(wxFontDialog);
+

 class wxFontDialog : public wxDialog {
 public:
     %pythonAppend wxFontDialog   "self._setOORInfo(self)"
 class wxFontDialog : public wxDialog {
 public:
     %pythonAppend wxFontDialog   "self._setOORInfo(self)"


@@ -575,6 +618,8 @@ Window Styles
 ");
 
 
 ");
 
 

+MustHaveApp(wxMessageDialog);
+

 class wxMessageDialog : public wxDialog {
 public:
     %pythonAppend wxMessageDialog   "self._setOORInfo(self)"
 class wxMessageDialog : public wxDialog {
 public:
     %pythonAppend wxMessageDialog   "self._setOORInfo(self)"


@@ -621,10 +666,17 @@ 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 {
 public:
     %pythonAppend wxProgressDialog   "self._setOORInfo(self)"
 class wxProgressDialog : public wxFrame {
 public:
     %pythonAppend wxProgressDialog   "self._setOORInfo(self)"


@@ -639,11 +691,16 @@ 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
     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. Returns true unless the Cancel
-button has been pressed.
+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
+the Cancel button has been pressed.

 
 If false is returned, the application can either immediately destroy
 the dialog or ask the user for the confirmation and if the abort is
 
 If false is returned, the application can either immediately destroy
 the dialog or ask the user for the confirmation and if the abort is


@@ -841,6 +898,8 @@ Window Styles
     =====================  =========================================
 ");
 
     =====================  =========================================
 ");
 

+MustHaveApp(wxFindReplaceDialog);
+

 class wxFindReplaceDialog : public wxDialog {
 public:
     %pythonAppend wxFindReplaceDialog     "self._setOORInfo(self)"
 class wxFindReplaceDialog : public wxDialog {
 public:
     %pythonAppend wxFindReplaceDialog     "self._setOORInfo(self)"