X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7c913512a4c9f36e11e07ea707002fab1608d324..b3514fd6175a8d8a5ec37d49b161c6f4981d6d71:/interface/fdrepdlg.h diff --git a/interface/fdrepdlg.h b/interface/fdrepdlg.h index a83f956a1b..84fd6047a5 100644 --- a/interface/fdrepdlg.h +++ b/interface/fdrepdlg.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: fdrepdlg.h -// Purpose: documentation for wxFindDialogEvent class +// Purpose: interface of wxFindDialogEvent // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -21,33 +21,34 @@ public: /** Constuctor used by wxWidgets only. */ - wxFindDialogEvent(wxEventType commandType = wxEVT_@NULL, + wxFindDialogEvent(wxEventType commandType = wxEVT_NULL, int id = 0); /** Return the pointer to the dialog which generated this event. */ - wxFindReplaceDialog* GetDialog(); + wxFindReplaceDialog* GetDialog() const; /** Return the string to find (never empty). */ - wxString GetFindString(); + wxString GetFindString() const; /** Get the currently selected flags: this is the combination of @c wxFR_DOWN, @c wxFR_WHOLEWORD and @c wxFR_MATCHCASE flags. */ - int GetFlags(); + int GetFlags() const; /** Return the string to replace the search string with (only for replace and replace all events). */ - const wxString GetReplaceString(); + const wxString GetReplaceString() const; }; + /** @class wxFindReplaceData @wxheader{fdrepdlg.h} @@ -81,7 +82,7 @@ public: /** Get the combination of @c wxFindReplaceFlags values. */ - int GetFlags(); + int GetFlags() const; /** Get the replacement string. @@ -105,6 +106,7 @@ public: }; + /** @class wxFindReplaceDialog @wxheader{fdrepdlg.h} @@ -129,11 +131,10 @@ public: /** After using default constructor Create() must be called. - - The @e parent and @e data parameters must be non-@NULL. + The @a parent and @a data parameters must be non-@NULL. */ wxFindReplaceDialog(); - wxFindReplaceDialog(wxWindow * parent, + wxFindReplaceDialog(wxWindow* parent, wxFindReplaceData* data, const wxString& title, int style = 0); @@ -146,15 +147,15 @@ public: /** Creates the dialog; use wxWindow::Show to show it on screen. - - The @e parent and @e data parameters must be non-@NULL. + The @a parent and @a data parameters must be non-@NULL. */ - bool Create(wxWindow * parent, wxFindReplaceData* data, + bool Create(wxWindow* parent, wxFindReplaceData* data, const wxString& title, int style = 0); /** Get the wxFindReplaceData object used by this dialog. */ - const wxFindReplaceData* GetData(); + const wxFindReplaceData* GetData() const; }; +