]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/fdrepdlg.tex
Fixed to work with the new wxMacControl system.
[wxWidgets.git] / docs / latex / wx / fdrepdlg.tex
... / ...
CommitLineData
1%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2%% Name: fdrepdlg.tex
3%% Purpose: wxFindReplaceDialog documentation
4%% Author: Vadim Zeitlin
5%% Modified by:
6%% Created: 01.08.01
7%% RCS-ID: $Id$
8%% Copyright: (c) 2001 Vadim Zeitlin
9%% License: wxWidgets license
10%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11
12\section{\class{wxFindDialogEvent}}\label{wxfinddialogevent}
13
14wxFindReplaceDialog events
15
16\wxheading{Derived from}
17
18\helpref{wxCommandEvent}{wxcommandevent}
19
20\wxheading{Include files}
21
22<wx/fdrepdlg.h>
23
24\wxheading{Event table macros}
25
26To process a command event from
27\helpref{wxFindReplaceDialog}{wxfindreplacedialog}, use these event handler
28macros to direct input to member functions that take a wxFindDialogEvent
29argument. The {\it id} parameter is the identifier of the find dialog and you
30may usually specify $-1$ for it unless you plan to have several find dialogs
31sending events to the same owner window simultaneously.
32
33\twocolwidtha{7cm}
34\begin{twocollist}\itemsep=0pt
35\twocolitem{{\bf EVT\_FIND(id, func)}}{Find button was pressed in the dialog.}
36\twocolitem{{\bf EVT\_FIND\_NEXT(id, func)}}{Find next button was pressed in the dialog.}
37\twocolitem{{\bf EVT\_FIND\_REPLACE(id, func)}}{Replace button was pressed in the dialog.}
38\twocolitem{{\bf EVT\_FIND\_REPLACE\_ALL(id, func)}}{Replace all button was pressed in the dialog.}
39\twocolitem{{\bf EVT\_FIND\_CLOSE(id, func)}}{The dialog is being destroyed,
40any pointers to it cannot be used any longer.}
41\end{twocollist}%
42
43\latexignore{\rtfignore{\wxheading{Members}}}
44
45\membersection{wxFindDialogEvent::wxFindDialogEvent}\label{wxfinddialogeventwxfinddialogevent}
46
47\func{}{wxFindDialogEvent}{\param{wxEventType }{commandType = wxEVT\_NULL}, \param{int }{id = 0}}
48
49Constuctor used by wxWidgets only.
50
51\membersection{wxFindDialogEvent::GetFlags}\label{wxfinddialogeventgetflags}
52
53\constfunc{int}{GetFlags}{\void}
54
55Get the currently selected flags: this is the combination of {\tt wxFR\_DOWN},
56{\tt wxFR\_WHOLEWORD} and {\tt wxFR\_MATCHCASE} flags.
57
58\membersection{wxFindDialogEvent::GetFindString}\label{wxfinddialogeventgetfindstring}
59
60\constfunc{wxString}{GetFindString}{\void}
61
62Return the string to find (never empty).
63
64\membersection{wxFindDialogEvent::GetReplaceString}\label{wxfinddialogeventgetreplacestring}
65
66\constfunc{const wxString\&}{GetReplaceString}{\void}
67
68Return the string to replace the search string with (only for replace and
69replace all events).
70
71\membersection{wxFindDialogEvent::GetDialog}\label{wxfinddialogeventgetdialog}
72
73\constfunc{wxFindReplaceDialog*}{GetDialog}{\void}
74
75Return the pointer to the dialog which generated this event.
76
77\section{\class{wxFindReplaceData}}\label{wxfindreplacedata}
78
79wxFindReplaceData holds the data for
80\helpref{wxFindReplaceDialog}{wxfindreplacedialog}. It is used to initialize
81the dialog with the default values and will keep the last values from the
82dialog when it is closed. It is also updated each time a
83\helpref{wxFindDialogEvent}{wxfinddialogevent} is generated so instead of
84using the wxFindDialogEvent methods you can also directly query this object.
85
86Note that all {\tt SetXXX()} methods may only be called before showing the
87dialog and calling them has no effect later.
88
89\wxheading{Include files}
90
91\begin{verbatim}
92#include <wx/fdrepdlg.h>
93\end{verbatim}
94
95\wxheading{Derived from}
96
97\helpref{wxObject}{wxobject}
98
99\wxheading{Data structures}
100
101Flags used by
102\helpref{wxFindReplaceData::GetFlags()}{wxfindreplacedatagetflags} and
103\helpref{wxFindDialogEvent::GetFlags()}{wxfinddialogeventgetflags}:
104
105\begin{verbatim}
106enum wxFindReplaceFlags
107{
108 // downward search/replace selected (otherwise - upwards)
109 wxFR_DOWN = 1,
110
111 // whole word search/replace selected
112 wxFR_WHOLEWORD = 2,
113
114 // case sensitive search/replace selected (otherwise - case insensitive)
115 wxFR_MATCHCASE = 4
116}
117\end{verbatim}
118
119These flags can be specified in
120\helpref{wxFindReplaceDialog ctor}{wxfindreplacedialogctor} or
121\helpref{Create()}{wxfindreplacedialogcreate}:
122
123\begin{verbatim}
124enum wxFindReplaceDialogStyles
125{
126 // replace dialog (otherwise find dialog)
127 wxFR_REPLACEDIALOG = 1,
128
129 // don't allow changing the search direction
130 wxFR_NOUPDOWN = 2,
131
132 // don't allow case sensitive searching
133 wxFR_NOMATCHCASE = 4,
134
135 // don't allow whole word searching
136 wxFR_NOWHOLEWORD = 8
137}
138\end{verbatim}
139
140\latexignore{\rtfignore{\wxheading{Members}}}
141
142\membersection{wxFindReplaceData::wxFindReplaceData}\label{wxfindreplacedatactor}
143
144\func{}{wxFindReplaceData}{\param{wxUint32 }{flags = 0}}
145
146Constuctor initializes the flags to default value ($0$).
147
148\membersection{wxFindReplaceData::GetFindString}\label{wxfindreplacedatagetfindstring}
149
150\func{const wxString\&}{GetFindString}{\void}
151
152Get the string to find.
153
154\membersection{wxFindReplaceData::GetReplaceString}\label{wxfindreplacedatagetreplacestring}
155
156\func{const wxString\&}{GetReplaceString}{\void}
157
158Get the replacement string.
159
160\membersection{wxFindReplaceData::GetFlags}\label{wxfindreplacedatagetflags}
161
162\constfunc{int}{GetFlags}{\void}
163
164Get the combination of {\tt wxFindReplaceFlags} values.
165
166\membersection{wxFindReplaceData::SetFlags}\label{wxfindreplacedatasetflags}
167
168\func{void}{SetFlags}{\param{wxUint32 }{flags}}
169
170Set the flags to use to initialize the controls of the dialog.
171
172\membersection{wxFindReplaceData::SetFindString}\label{wxfindreplacedatasetfindstring}
173
174\func{void}{SetFindString}{\param{const wxString\& }{str}}
175
176Set the string to find (used as initial value by the dialog).
177
178\membersection{wxFindReplaceData::SetReplaceString}\label{wxfindreplacedatasetreplacestring}
179
180\func{void}{SetReplaceString}{\param{const wxString\& }{str}}
181
182Set the replacement string (used as initial value by the dialog).
183
184\section{\class{wxFindReplaceDialog}}\label{wxfindreplacedialog}
185
186wxFindReplaceDialog is a standard modeless dialog which is used to allow the
187user to search for some text (and possibly replace it with something else).
188The actual searching is supposed to be done in the owner window which is the
189parent of this dialog. Note that it means that unlike for the other standard
190dialogs this one {\bf must} have a parent window. Also note that there is no
191way to use this dialog in a modal way; it is always, by design and
192implementation, modeless.
193
194Please see the dialogs sample for an example of using it.
195
196\wxheading{Include files}
197
198\begin{verbatim}
199#include <wx/fdrepdlg.h>
200\end{verbatim}
201
202\wxheading{Derived from}
203
204\helpref{wxDialog}{wxdialog}
205
206\latexignore{\rtfignore{\wxheading{Members}}}
207
208\membersection{wxFindReplaceDialog::wxFindReplaceDialog}\label{wxfindreplacedialogctor}
209
210\func{}{wxFindReplaceDialog}{\void}
211
212\func{}{wxFindReplaceDialog}{\param{wxWindow * }{parent}, \param{wxFindReplaceData* }{data}, \param{const wxString\& }{title}, \param{int }{style = 0}}
213
214After using default constructor \helpref{Create()}{wxfindreplacedialogcreate}
215must be called.
216
217The {\it parent} and {\it data} parameters must be non-{\tt NULL}.
218
219\membersection{wxFindReplaceDialog::\destruct{wxFindReplaceDialog}}\label{wxfindreplacedialogdtor}
220
221\func{}{\destruct{wxFindReplaceDialog}}{\void}
222
223Destructor.
224
225\membersection{wxFindReplaceDialog::Create}\label{wxfindreplacedialogcreate}
226
227\func{bool}{Create}{\param{wxWindow * }{parent}, \param{wxFindReplaceData* }{data}, \param{const wxString\& }{title}, \param{int }{style = 0}}
228
229Creates the dialog; use \helpref{Show}{wxwindowshow} to show it on screen.
230
231The {\it parent} and {\it data} parameters must be non-{\tt NULL}.
232\membersection{wxFindReplaceDialog::GetData}\label{wxfindreplacedialoggetdata}
233
234\constfunc{const wxFindReplaceData*}{GetData}{\void}
235
236Get the \helpref{wxFindReplaceData}{wxfindreplacedata} object used by this
237dialog.
238