trying to make GetData() return data format more clear

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

diff --git a/wxPython/src/_cmndlgs.i b/wxPython/src/_cmndlgs.i
index 1b1294e0abc4508e0b34783031fdb9d6d5a56a61..1e4c13c7deb0ce773e9b3a3c49b444be0cbccd8d 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)"


@@ -334,6 +340,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,7 +351,7 @@ 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),
         "__init__(Window parent, String message, String caption,
                             long style = wxCHOICEDLG_STYLE,
                             const wxPoint& pos = wxDefaultPosition),
         "__init__(Window parent, String message, String caption,


@@ -374,6 +382,8 @@ 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)"
 class wxSingleChoiceDialog : public wxDialog {
 public:
     %pythonAppend wxSingleChoiceDialog   "self._setOORInfo(self)"


@@ -418,6 +428,8 @@ 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);
+

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


@@ -528,6 +540,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 +589,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)"


@@ -625,6 +641,8 @@ Window Styles
 ");
 
 
 ");
 
 

+MustHaveApp(wxProgressDialog);
+

 class wxProgressDialog : public wxFrame {
 public:
     %pythonAppend wxProgressDialog   "self._setOORInfo(self)"
 class wxProgressDialog : public wxFrame {
 public:
     %pythonAppend wxProgressDialog   "self._setOORInfo(self)"


@@ -642,8 +660,10 @@ parent window only.", "");
     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 +861,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)"