X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d07d2bc9d05408c58b76c53a0a291915b88e5064..f5158fa61f150b8a11f175588f2c6afe455ff7fe:/wxPython/src/_cmndlgs.i diff --git a/wxPython/src/_cmndlgs.i b/wxPython/src/_cmndlgs.i index 1b1294e0ab..c0050c56cc 100644 --- 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 -all white.", ""); +all invalid colours.", ""); 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 -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.", ""); +MustHaveApp(wxColourDialog); + class wxColourDialog : public wxDialog { public: %pythonAppend wxColourDialog "self._setOORInfo(self)" @@ -96,6 +98,11 @@ instance.", ""); }; +wxColour wxGetColourFromUser(wxWindow *parent = (wxWindow *)NULL, + const wxColour& colInit = wxNullColour, + const wxString& caption = wxPyEmptyString); + + //-------------------------------------------------------------------------------- @@ -113,6 +120,8 @@ Window Styles ==================== ========================================== "); +MustHaveApp(wxDirDialog); + class wxDirDialog : public wxDialog { public: %pythonAppend wxDirDialog "self._setOORInfo(self)" @@ -198,6 +207,8 @@ Window Styles +MustHaveApp(wxFileDialog); + class wxFileDialog : public wxDialog { public: %pythonAppend wxFileDialog "self._setOORInfo(self)" @@ -246,7 +257,6 @@ example:: 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.", ""); @@ -279,23 +289,22 @@ which will be used when the dialog is first displayed. After the dialog is shown, this is the index selected by the user.", ""); - DocStr(GetFilenames, - "Returns a list of filenames chosen in the dialog. This function + %extend { + DocStr(GetFilenames, + "Returns a list of filenames chosen in the dialog. This function should only be used with the dialogs which have wx.MULTIPLE style, use GetFilename for the others.", ""); - - DocStr(GetPaths, - "Fills the array paths with the full paths of the files chosen. This -function should only be used with the dialogs which have wx.MULTIPLE -style, use GetPath for the others.", ""); - - %extend { PyObject* GetFilenames() { wxArrayString arr; self->GetFilenames(arr); return wxArrayString2PyList_helper(arr); } + DocStr(GetPaths, + "Fills the array paths with the full paths of the files chosen. This +function should only be used with the dialogs which have wx.MULTIPLE +style, use GetPath for the others.", ""); + PyObject* GetPaths() { wxArrayString arr; self->GetPaths(arr); @@ -334,6 +343,8 @@ enum { wxCHOICEDLG_STYLE }; DocStr(wxMultiChoiceDialog, "A simple dialog with a multi selection listbox.", ""); +MustHaveApp(wxMultiChoiceDialog); + class wxMultiChoiceDialog : public wxDialog { public: @@ -343,24 +354,37 @@ public: 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, - 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", - "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 -integers.", ""); +integers. The list should specify the indexes of the items that +should be selected.", ""); 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()); @@ -374,13 +398,15 @@ integers.", ""); 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, - 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.", ""); @@ -418,6 +444,10 @@ public: 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)" @@ -427,7 +457,7 @@ public: 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.", ""); @@ -443,6 +473,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 @@ -528,6 +573,8 @@ DocStr(wxFontDialog, :see: `wx.FontData` ", ""); +MustHaveApp(wxFontDialog); + class wxFontDialog : public wxDialog { public: %pythonAppend wxFontDialog "self._setOORInfo(self)" @@ -547,6 +594,11 @@ wx.FontDialog.", ""); }; +wxFont wxGetFontFromUser(wxWindow *parent = NULL, + const wxFont& fontInit = wxNullFont, + const wxString& caption = wxPyEmptyString); + + //--------------------------------------------------------------------------- @@ -575,6 +627,8 @@ Window Styles "); +MustHaveApp(wxMessageDialog); + class wxMessageDialog : public wxDialog { public: %pythonAppend wxMessageDialog "self._setOORInfo(self)" @@ -621,10 +675,17 @@ Window Styles 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)" @@ -639,11 +700,16 @@ public: 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. 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 @@ -841,6 +907,8 @@ Window Styles ===================== ========================================= "); +MustHaveApp(wxFindReplaceDialog); + class wxFindReplaceDialog : public wxDialog { public: %pythonAppend wxFindReplaceDialog "self._setOORInfo(self)"