/////////////////////////////////////////////////////////////////////////////
// Name: fdrepdlg.h
-// Purpose: documentation for wxFindDialogEvent class
+// Purpose: interface of wxFindDialogEvent
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/**
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}
/**
Get the combination of @c wxFindReplaceFlags values.
*/
- int GetFlags();
+ int GetFlags() const;
/**
Get the replacement string.
};
+
/**
@class wxFindReplaceDialog
@wxheader{fdrepdlg.h}
/**
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);
/**
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;
};
+