/////////////////////////////////////////////////////////////////////////////
// Name: fdrepdlg.h
-// Purpose: documentation for wxFindDialogEvent class
+// Purpose: interface of wxFindDialogEvent
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/**
@class wxFindDialogEvent
@wxheader{fdrepdlg.h}
-
+
wxFindReplaceDialog events
-
+
@library{wxcore}
@category{events}
*/
/**
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}
-
- wxFindReplaceData holds the data for
+
+ wxFindReplaceData holds the data for
wxFindReplaceDialog. 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
+ dialog when it is closed. It is also updated each time a
wxFindDialogEvent is generated so instead of
using the wxFindDialogEvent methods you can also directly query this object.
-
+
Note that all @c SetXXX() methods may only be called before showing the
dialog and calling them has no effect later.
-
+
@library{wxcore}
@category{FIXME}
*/
/**
Get the combination of @c wxFindReplaceFlags values.
*/
- int GetFlags();
+ int GetFlags() const;
/**
Get the replacement string.
};
+
/**
@class wxFindReplaceDialog
@wxheader{fdrepdlg.h}
-
+
wxFindReplaceDialog 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
dialogs this one @b 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.
-
+
Please see the dialogs sample for an example of using it.
-
+
@library{wxcore}
@category{cmndlg}
*/
public:
//@{
/**
- After using default constructor Create()
+ 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,
- wxFindReplaceData* data,
- const wxString& title,
- int style = 0);
+ 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;
};
+