X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fcafa8a99e85911258e8f783a5099894a2322261..49bffb1482cd2a6a30b38280f6c9bffc72dbfe42:/wxPython/src/_cmndlgs.i?ds=inline diff --git a/wxPython/src/_cmndlgs.i b/wxPython/src/_cmndlgs.i index 66c82e438d..e898f3fabe 100644 --- a/wxPython/src/_cmndlgs.i +++ b/wxPython/src/_cmndlgs.i @@ -27,7 +27,9 @@ MAKE_CONST_WXSTRING(MessageBoxCaptionStr); DocStr(wxColourData, - "This class holds a variety of information related to colour dialogs."); +"This class holds a variety of information related to the colour +chooser dialog, used to transfer settings and results to and from the +`wx.ColourDialog`."); class wxColourData : public wxObject { public: @@ -40,9 +42,9 @@ public: DocDeclStr( bool , GetChooseFull(), - "Under Windows, determines whether the Windows colour dialog will display\n" - "the full dialog with custom colour selection controls. Has no meaning\n" - "under other platforms. The default value is true."); + "Under Windows, determines whether the Windows colour dialog will +display the full dialog with custom colour selection controls. Has no +meaning under other platforms. The default value is true."); DocDeclStr( wxColour , GetColour(), @@ -50,27 +52,31 @@ public: DocDeclStr( wxColour , GetCustomColour(int i), - "Gets the i'th custom colour associated with the colour dialog. i should\n" - "be an integer between 0 and 15. The default custom colours are all white."); + "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."); DocDeclStr( void , SetChooseFull(int flag), - "Under Windows, tells the Windows colour dialog to display the full dialog\n" - "with custom colour selection controls. Under other platforms, has no effect.\n" - "The default value is true."); + "Under Windows, tells the Windows colour dialog to display the full +dialog with custom colour selection controls. Under other platforms, +has no effect. The default value is true."); DocDeclStr( void , SetColour(const wxColour& colour), - "Sets the default colour for the colour dialog. The default colour is black."); + "Sets the default colour for the colour dialog. The default colour is +black."); DocDeclStr( void , SetCustomColour(int i, const wxColour& colour), - "Sets the i'th custom colour for the colour dialog. i should be an integer\n" - "between 0 and 15. The default custom colours are all white."); + "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."); }; + + DocStr(wxColourDialog, "This class represents the colour chooser dialog."); @@ -80,12 +86,13 @@ public: DocCtorStr( wxColourDialog(wxWindow* parent, wxColourData* data = NULL), - "Constructor. Pass a parent window, and optionally a ColourData, which\n" - "will be copied to the colour dialog's internal ColourData instance."); + "Constructor. Pass a parent window, and optionally a `wx.ColourData`, +which will be copied to the colour dialog's internal ColourData +instance."); DocDeclStr( wxColourData& , GetColourData(), - "Returns a reference to the ColourData used by the dialog."); + "Returns a reference to the `wx.ColourData` used by the dialog."); }; @@ -93,19 +100,26 @@ public: DocStr(wxDirDialog, - "This class represents the directory chooser dialog."); - -RefDoc(wxDirDialog, " - Styles - wxDD_NEW_DIR_BUTTON Add \"Create new directory\" button and allow - directory names to be editable. On Windows the new - directory button is only available with recent - versions of the common dialogs."); + "wx.DirDialog allows the user to select a directory by browising the +file system. + + +Window Styles +-------------- + ==================== ========================================== + wx.DD_NEW_DIR_BUTTON Add 'Create new directory' button and allow + directory names to be editable. On Windows + the new directory button is only available + with recent versions of the common dialogs. + ==================== ========================================== +"); class wxDirDialog : public wxDialog { public: %pythonAppend wxDirDialog "self._setOORInfo(self)" + RefDoc(wxDirDialog, ""); // turn it off for the ctors + DocCtorStr( wxDirDialog(wxWindow* parent, const wxString& message = wxPyDirSelectorPromptStr, @@ -143,40 +157,46 @@ public: //--------------------------------------------------------------------------- DocStr(wxFileDialog, - "This class represents the file chooser dialog."); - -RefDoc(wxFileDialog, " -In Windows, this is the common file selector dialog. In X, this is a file -selector box with somewhat less functionality. The path and filename are -distinct elements of a full file pathname. If path is \"\", the current -directory will be used. If filename is \"\", no default filename will be -supplied. The wildcard determines what files are displayed in the file -selector, and file extension supplies a type extension for the required -filename. - -Both the X and Windows versions implement a wildcard filter. Typing a filename -containing wildcards (*, ?) in the filename text item, and clicking on Ok, -will result in only those files matching the pattern being displayed. The -wildcard may be a specification for multiple types of file with a description -for each, such as: +"wx.FileDialog allows the user to select one or more files from the +filesystem. + +In Windows, this is the common file selector dialog. On X based +platforms a generic alternative is used. The path and filename are +distinct elements of a full file pathname. If path is \"\", the +current directory will be used. If filename is \"\", no default +filename will be supplied. The wildcard determines what files are +displayed in the file selector, and file extension supplies a type +extension for the required filename. + +Both the X and Windows versions implement a wildcard filter. Typing a +filename containing wildcards (*, ?) in the filename text item, and +clicking on Ok, will result in only those files matching the pattern +being displayed. The wildcard may be a specification for multiple +types of file with a description for each, such as:: \"BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif\" - Styles + +Window Styles +-------------- + ================== ========================================== wx.OPEN This is an open dialog. wx.SAVE This is a save dialog. - wx.HIDE_READONLY For open dialog only: hide the checkbox allowing to - open the file in read-only mode. + wx.HIDE_READONLY For open dialog only: hide the checkbox + allowing to open the file in read-only mode. - wx.OVERWRITE_PROMPT For save dialog only: prompt for a confirmation if a - file will be overwritten. + wx.OVERWRITE_PROMPT For save dialog only: prompt for a confirmation + if a file will be overwritten. - wx.MULTIPLE For open dialog only: allows selecting multiple files. + wx.MULTIPLE For open dialog only: allows selecting multiple + files. - wx.CHANGE_DIR Change the current working directory to the directory - where the file(s) chosen by the user are. + wx.CHANGE_DIR Change the current working directory to the + directory where the file(s) chosen by the user + are. + ================== ========================================== "); @@ -185,6 +205,8 @@ class wxFileDialog : public wxDialog { public: %pythonAppend wxFileDialog "self._setOORInfo(self)" + RefDoc(wxFileDialog, ""); // turn it off for the ctors + DocCtorStr( wxFileDialog(wxWindow* parent, const wxString& message = wxPyFileSelectorPromptStr, @@ -202,8 +224,8 @@ public: DocDeclStr( void , SetPath(const wxString& path), - "Sets the path (the combined directory and filename that will\n" - "be returned when the dialog is dismissed)."); + "Sets the path (the combined directory and filename that will be +returned when the dialog is dismissed)."); DocDeclStr( void , SetDirectory(const wxString& dir), @@ -215,8 +237,11 @@ public: DocDeclStr( void , SetWildcard(const wxString& wildCard), - "Sets the wildcard, which can contain multiple file types, for example:\n" - " \"BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif\""); + "Sets the wildcard, which can contain multiple file types, for +example:: + + \"BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif\" +"); DocDeclStr( void , SetStyle(long style), @@ -253,21 +278,21 @@ public: DocDeclStr( int , GetFilterIndex() const, - "Returns the index into the list of filters supplied, optionally, in\n" - "the wildcard parameter. Before the dialog is shown, this is the index\n" - "which will be used when the dialog is first displayed. After the dialog\n" - "is shown, this is the index selected by the user."); + "Returns the index into the list of filters supplied, optionally, in +the wildcard parameter. Before the dialog is shown, this is the index +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 should\n" - "only be used with the dialogs which have wx.MULTIPLE style, use\n" - "GetFilename for the others."); + "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\n" - "function should only be used with the dialogs which have wx.MULTIPLE style,\n" - "use GetPath for the others."); + "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() { @@ -310,21 +335,37 @@ public: enum { wxCHOICEDLG_STYLE }; + +DocStr(wxMultiChoiceDialog, + "A simple dialog with a multi selection listbox."); + class wxMultiChoiceDialog : public wxDialog { public: %pythonAppend wxMultiChoiceDialog "self._setOORInfo(self)" - - wxMultiChoiceDialog(wxWindow *parent, - const wxString& message, - const wxString& caption, - int choices=0, wxString* choices_array, - long style = wxCHOICEDLG_STYLE, - const wxPoint& pos = wxDefaultPosition); - void SetSelections(const wxArrayInt& selections); + DocCtorAStr( + wxMultiChoiceDialog(wxWindow *parent, + const wxString& message, + const wxString& caption, + int choices=0, wxString* choices_array, + long style = wxCHOICEDLG_STYLE, + const wxPoint& pos = wxDefaultPosition), + "__init__(Window parent, String message, String caption, + List choices=[], long style=CHOICEDLG_STYLE, + Point pos=DefaultPosition) -> MultiChoiceDialog", + "Constructor. Use ShowModal method to show the dialog."); + + + DocDeclAStr( + void, SetSelections(const wxArrayInt& selections), + "SetSelections(List selections)", + "Specify the items in the list that should be selected, using a list of +integers."); - // wxArrayInt GetSelections() const; + DocAStr(GetSelections, + "GetSelections() -> [selections]", + "Returns a list of integers representing the items that are selected."); %extend { PyObject* GetSelections() { return wxArrayInt2PyList_helper(self->GetSelections()); @@ -335,10 +376,19 @@ public: //--------------------------------------------------------------------------- +DocStr(wxSingleChoiceDialog, + "A simple dialog with a single selection listbox."); + 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, + Point pos=DefaultPosition) -> SingleChoiceDialog", + "Constructor. Use ShowModal method to show the dialog."); + %extend { // TODO: ignoring clientData for now... FIX THIS // SWIG is messing up the &/*'s for some reason. @@ -354,94 +404,266 @@ public: } } - int GetSelection(); - wxString GetStringSelection(); - void SetSelection(int sel); - int ShowModal(); + DocDeclStr( + int , GetSelection(), + "Get the index of teh currently selected item."); + + DocDeclStr( + wxString , GetStringSelection(), + "Returns the string value of the currently selected item"); + + DocDeclStr( + void , SetSelection(int sel), + "Set the current selected item to sel"); }; //--------------------------------------------------------------------------- +DocStr(wxTextEntryDialog, + "A dialog with text control, [ok] and [cancel] buttons"); + class wxTextEntryDialog : public wxDialog { public: %pythonAppend wxTextEntryDialog "self._setOORInfo(self)" - - wxTextEntryDialog(wxWindow* parent, - const wxString& message, - const wxString& caption = wxPyGetTextFromUserPromptStr, - const wxString& defaultValue = wxPyEmptyString, - long style = wxOK | wxCANCEL | wxCENTRE, - const wxPoint& pos = wxDefaultPosition); - wxString GetValue(); - void SetValue(const wxString& value); - int ShowModal(); + DocCtorStr( + wxTextEntryDialog(wxWindow* parent, + const wxString& message, + const wxString& caption = wxPyGetTextFromUserPromptStr, + const wxString& defaultValue = wxPyEmptyString, + long style = wxOK | wxCANCEL | wxCENTRE, + const wxPoint& pos = wxDefaultPosition), + "Constructor. Use ShowModal method to show the dialog."); + + DocDeclStr( + wxString , GetValue(), + "Returns the text that the user has entered if the user has pressed OK, +or the original value if the user has pressed Cancel."); + + DocDeclStr( + void , SetValue(const wxString& value), + "Sets the default text value."); }; //--------------------------------------------------------------------------- + +DocStr(wxFontData, + "This class holds a variety of information related to font dialogs and +is used to transfer settings to and results from a `wx.FontDialog`."); + + class wxFontData : public wxObject { public: wxFontData(); ~wxFontData(); - void EnableEffects(bool enable); - bool GetAllowSymbols(); - wxColour GetColour(); - wxFont GetChosenFont(); - bool GetEnableEffects(); - wxFont GetInitialFont(); - bool GetShowHelp(); - void SetAllowSymbols(bool allowSymbols); - void SetChosenFont(const wxFont& font); - void SetColour(const wxColour& colour); - void SetInitialFont(const wxFont& font); - void SetRange(int min, int max); - void SetShowHelp(bool showHelp); + DocDeclStr( + void , EnableEffects(bool enable), + "Enables or disables 'effects' under MS Windows only. This refers to +the controls for manipulating colour, strikeout and underline +properties. The default value is true."); + + DocDeclStr( + bool , GetAllowSymbols(), + "Under MS Windows, returns a flag determining whether symbol fonts can +be selected. Has no effect on other platforms. The default value is +true."); + + DocDeclStr( + wxColour , GetColour(), + "Gets the colour associated with the font dialog. The default value is +black."); + + DocDeclStr( + wxFont , GetChosenFont(), + "Gets the font chosen by the user."); + + DocDeclStr( + bool , GetEnableEffects(), + "Determines whether 'effects' are enabled under Windows."); + + DocDeclStr( + wxFont , GetInitialFont(), + "Gets the font that will be initially used by the font dialog. This +should have previously been set by the application."); + + DocDeclStr( + bool , GetShowHelp(), + "Returns true if the Help button will be shown (Windows only). The +default value is false."); + + DocDeclStr( + void , SetAllowSymbols(bool allowSymbols), + "Under MS Windows, determines whether symbol fonts can be selected. Has +no effect on other platforms. The default value is true."); + + DocDeclStr( + void , SetChosenFont(const wxFont& font), + "Sets the font that will be returned to the user (normally for internal +use only)."); + + DocDeclStr( + void , SetColour(const wxColour& colour), + "Sets the colour that will be used for the font foreground colour. The +default colour is black."); + + DocDeclStr( + void , SetInitialFont(const wxFont& font), + "Sets the font that will be initially used by the font dialog."); + + DocDeclStr( + void , SetRange(int min, int max), + "Sets the valid range for the font point size (Windows only). The +default is 0, 0 (unrestricted range)."); + + DocDeclStr( + void , SetShowHelp(bool showHelp), + "Determines whether the Help button will be displayed in the font +dialog (Windows only). The default value is false."); }; + + +DocStr(wxFontDialog, + "wx.FontDialog allows the user to select a system font and its attributes. + +:see: `wx.FontData` +"); + class wxFontDialog : public wxDialog { public: %pythonAppend wxFontDialog "self._setOORInfo(self)" - + + DocStr(wxFontDialog, + "Constructor. Pass a parent window and the `wx.FontData` object to be +used to initialize the dialog controls. Call `ShowModal` to display +the dialog. If ShowModal returns ``wx.ID_OK`` then you can fetch the +results with via the `wx.FontData` returned by `GetFontData`."); wxFontDialog(wxWindow* parent, const wxFontData& data); - wxFontData& GetFontData(); - int ShowModal(); + + DocDeclStr( + wxFontData& , GetFontData(), + "Returns a reference to the internal `wx.FontData` used by the +wx.FontDialog."); }; //--------------------------------------------------------------------------- + +DocStr(wxMessageDialog, +"This class provides a simple dialog that shows a single or multi-line +message, with a choice of OK, Yes, No and/or Cancel buttons. + + +Window Styles +-------------- + ================= ============================================= + wx.OK Show an OK button. + wx.CANCEL Show a Cancel button. + wx.YES_NO Show Yes and No buttons. + wx.YES_DEFAULT Used with wxYES_NO, makes Yes button the + default - which is the default behaviour. + wx.NO_DEFAULT Used with wxYES_NO, makes No button the default. + wx.ICON_EXCLAMATION Shows an exclamation mark icon. + wx.ICON_HAND Shows an error icon. + wx.ICON_ERROR Shows an error icon - the same as wxICON_HAND. + wx.ICON_QUESTION Shows a question mark icon. + wx.ICON_INFORMATION Shows an information (i) icon. + wx.STAY_ON_TOP The message box stays on top of all other + window, even those of the other applications + (Windows only). + ================= ============================================= +"); + + class wxMessageDialog : public wxDialog { public: %pythonAppend wxMessageDialog "self._setOORInfo(self)" - wxMessageDialog(wxWindow* parent, - const wxString& message, - const wxString& caption = wxPyMessageBoxCaptionStr, - long style = wxOK | wxCANCEL | wxCENTRE, - const wxPoint& pos = wxDefaultPosition); + RefDoc(wxMessageDialog, ""); // turn it off for the ctors + + DocCtorStr( + wxMessageDialog(wxWindow* parent, + const wxString& message, + const wxString& caption = wxPyMessageBoxCaptionStr, + long style = wxOK | wxCANCEL | wxCENTRE, + const wxPoint& pos = wxDefaultPosition), + "Constructor, use `ShowModal` to display the dialog."); - int ShowModal(); }; //--------------------------------------------------------------------------- + +DocStr(wxProgressDialog, +"A dialog that shows a short message and a progress bar. Optionally, it +can display an ABORT button. + +Window Styles +-------------- + ================= ============================================= + wx.PD_APP_MODAL Make the progress dialog modal. If this flag is + not given, it is only \"locally\" modal - + that is the input to the parent window is + disabled, but not to the other ones. + + wx.PD_AUTO_HIDE Causes the progress dialog to disappear from + screen as soon as the maximum value of the + progress meter has been reached. + + wx.PD_CAN_ABORT This flag tells the dialog that it should have + a \"Cancel\" button which the user may press. If + this happens, the next call to Update() will + return false. + + wx.PD_ELAPSED_TIME This flag tells the dialog that it should show + elapsed time (since creating the dialog). + + wx.PD_ESTIMATED_TIME This flag tells the dialog that it should show + estimated time. + + wx.PD_REMAINING_TIME This flag tells the dialog that it should show + remaining time. + ================= ============================================= +"); + + class wxProgressDialog : public wxFrame { public: %pythonAppend wxProgressDialog "self._setOORInfo(self)" + + RefDoc(wxProgressDialog, ""); // turn it off for the ctors - wxProgressDialog(const wxString& title, - const wxString& message, - int maximum = 100, - wxWindow* parent = NULL, - int style = wxPD_AUTO_HIDE | wxPD_APP_MODAL ); + DocCtorStr( + wxProgressDialog(const wxString& title, + const wxString& message, + int maximum = 100, + wxWindow* parent = NULL, + int style = wxPD_AUTO_HIDE | wxPD_APP_MODAL ), + "Constructor. Creates the dialog, displays it and disables user input +for other windows, or, if wx.PD_APP_MODAL flag is not given, for its +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 +given changes the message above it. Returns true unless the Cancel +button has been pressed. - bool Update(int value, const wxString& newmsg = wxPyEmptyString); - void Resume(); +If false is returned, the application can either immediately destroy +the dialog or ask the user for the confirmation and if the abort is +not confirmed the dialog may be resumed with Resume function."); + + DocDeclStr( + void , Resume(), + "Can be used to continue with the dialog, after the user had chosen to +abort."); + }; //--------------------------------------------------------------------------- @@ -499,54 +721,171 @@ EVT_COMMAND_FIND_CLOSE = EVT_FIND_CLOSE } +DocStr(wxFindDialogEvent, + "Events for the FindReplaceDialog"); + class wxFindDialogEvent : public wxCommandEvent { public: wxFindDialogEvent(wxEventType commandType = wxEVT_NULL, int id = 0); - int GetFlags(); - const wxString& GetFindString(); - const wxString& GetReplaceString(); - wxFindReplaceDialog *GetDialog(); - void SetFlags(int flags); - void SetFindString(const wxString& str); - void SetReplaceString(const wxString& str); + + DocDeclStr( + int , GetFlags(), + "Get the currently selected flags: this is the combination of +wx.FR_DOWN, wx.FR_WHOLEWORD and wx.FR_MATCHCASE flags."); + + DocDeclStr( + const wxString& , GetFindString(), + "Return the string to find (never empty)."); + + DocDeclStr( + const wxString& , GetReplaceString(), + "Return the string to replace the search string with (only for replace +and replace all events)."); + + DocDeclStr( + wxFindReplaceDialog *, GetDialog(), + "Return the pointer to the dialog which generated this event."); + + DocDeclStr( + void , SetFlags(int flags), + ""); + + DocDeclStr( + void , SetFindString(const wxString& str), + ""); + + DocDeclStr( + void , SetReplaceString(const wxString& str), + ""); }; +DocStr(wxFindReplaceData, +"wx.FindReplaceData holds the data for wx.FindReplaceDialog. It is used +to initialize the dialog with the default values and will keep the +last values from the dialog when it is closed. It is also updated each +time a `wx.FindDialogEvent` is generated so instead of using the +`wx.FindDialogEvent` methods you can also directly query this object. + +Note that all SetXXX() methods may only be called before showing the +dialog and calling them has no effect later. + +Flags +----- + ================ =============================================== + wx.FR_DOWN Downward search/replace selected (otherwise, + upwards) + + wx.FR_WHOLEWORD Whole word search/replace selected + + wx.FR_MATCHCASE Case sensitive search/replace selected + (otherwise, case insensitive) + ================ =============================================== +"); + + + + class wxFindReplaceData : public wxObject { public: - wxFindReplaceData(int flags=0); + DocCtorStr( + wxFindReplaceData(int flags=0), + "Constuctor initializes the flags to default value (0)."); + ~wxFindReplaceData(); + - const wxString& GetFindString(); - const wxString& GetReplaceString(); - int GetFlags(); - void SetFlags(int flags); - void SetFindString(const wxString& str); - void SetReplaceString(const wxString& str); + DocDeclStr( + const wxString& , GetFindString(), + "Get the string to find."); + + DocDeclStr( + const wxString& , GetReplaceString(), + "Get the replacement string."); + + DocDeclStr( + int , GetFlags(), + "Get the combination of flag values."); + + DocDeclStr( + void , SetFlags(int flags), + "Set the flags to use to initialize the controls of the dialog."); + + DocDeclStr( + void , SetFindString(const wxString& str), + "Set the string to find (used as initial value by the dialog)."); + + DocDeclStr( + void , SetReplaceString(const wxString& str), + "Set the replacement string (used as initial value by the dialog)."); + }; + + +DocStr(wxFindReplaceDialog, +"wx.FindReplaceDialog is a standard modeless dialog which is used to +allow the user to search for some text (and possibly replace it with +something else). The actual searching is supposed to be done in the +owner window which is the parent of this dialog. Note that it means +that unlike for the other standard dialogs this one must have a parent +window. Also note that there is no way to use this dialog in a modal +way; it is always, by design and implementation, modeless. + + +Window Styles +------------- + + ===================== ========================================= + wx.FR_REPLACEDIALOG replace dialog (otherwise find dialog) + + wx.FR_NOUPDOWN don't allow changing the search direction + + wx.FR_NOMATCHCASE don't allow case sensitive searching + + wx.FR_NOWHOLEWORD don't allow whole word searching + ===================== ========================================= +"); + class wxFindReplaceDialog : public wxDialog { public: %pythonAppend wxFindReplaceDialog "self._setOORInfo(self)" %pythonAppend wxFindReplaceDialog() "" - wxFindReplaceDialog(wxWindow *parent, - wxFindReplaceData *data, - const wxString &title, - int style = 0); - %name(PreFindReplaceDialog)wxFindReplaceDialog(); + RefDoc(wxFindReplaceDialog, ""); // turn it off for the ctors + + DocCtorStr( + wxFindReplaceDialog(wxWindow *parent, + wxFindReplaceData *data, + const wxString &title, + int style = 0), + "Create a FindReplaceDialog. The parent and data parameters must be +non-None. Use Show to display the dialog."); + + DocCtorStrName( + wxFindReplaceDialog(), + "Precreate a FindReplaceDialog for 2-phase creation", + PreFindReplaceDialog); - bool Create(wxWindow *parent, - wxFindReplaceData *data, - const wxString &title, - int style = 0); + + DocDeclStr( + bool , Create(wxWindow *parent, wxFindReplaceData *data, + const wxString &title, int style = 0), + "Create the dialog, for 2-phase create."); + - const wxFindReplaceData *GetData(); - void SetData(wxFindReplaceData *data); + DocDeclStr( + const wxFindReplaceData *, GetData(), + "Get the FindReplaceData object used by this dialog."); + + DocDeclStr( + void , SetData(wxFindReplaceData *data), + "Set the FindReplaceData object used by this dialog."); + }; //---------------------------------------------------------------------------