]>
Commit | Line | Data |
---|---|---|
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: wxWindows license | |
10 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | |
11 | ||
12 | \section{\class{wxFindDialogEvent}}\label{wxfinddialogevent} | |
13 | ||
14 | wxFindReplaceDialog 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 | ||
26 | To process a command event from | |
27 | \helpref{wxFindReplaceDialog}{wxfindreplacedialog}, use these event handler | |
28 | macros to direct input to member functions that take a wxFindDialogEvent | |
29 | argument. The {\it id} parameter is the identifier of the find dialog and you | |
30 | may usually specify $-1$ for it unless you plan to have several find dialogs | |
31 | sending 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, | |
40 | any 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 | ||
49 | Constuctor used by wxWindows only. | |
50 | ||
51 | \membersection{wxFindDialogEvent::GetFlags}\label{wxfinddialogeventgetflags} | |
52 | ||
53 | \constfunc{int}{GetFlags}{\void} | |
54 | ||
55 | Get 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 | ||
62 | Return the string to find (never empty). | |
63 | ||
64 | \membersection{wxFindDialogEvent::GetReplaceString}\label{wxfinddialogeventgetreplacestring} | |
65 | ||
66 | \constfunc{const wxString\&}{GetReplaceString}{\void} | |
67 | ||
68 | Return the string to replace the search string with (only for replace and | |
69 | replace all events). | |
70 | ||
71 | \membersection{wxFindDialogEvent::GetDialog}\label{wxfinddialogeventgetdialog} | |
72 | ||
73 | \constfunc{wxFindReplaceDialog*}{GetDialog}{\void} | |
74 | ||
75 | Return the pointer to the dialog which generated this event. | |
76 | ||
77 | \section{\class{wxFindReplaceData}}\label{wxfindreplacedata} | |
78 | ||
79 | wxFindReplaceData holds the data for | |
80 | \helpref{wxFindReplaceDialog}{wxfindreplacedialog}. It is used to initialize | |
81 | the dialog with the default values and will keep the last values from the | |
82 | dialog when it is closed. It is also updated each time a | |
83 | \helpref{wxFindDialogEvent}{wxfinddialogevent} is generated so instead of | |
84 | using the wxFindDialogEvent methods you can also directly query this object. | |
85 | ||
86 | Note that all {\tt SetXXX()} methods may only be called before showing the | |
87 | dialog and calling them has no effect later. | |
88 | ||
89 | \wxheading{Include files} | |
90 | ||
91 | #include <wx/fdrepdlg.h> | |
92 | ||
93 | \wxheading{Derived from} | |
94 | ||
95 | \helpref{wxObject}{wxobject} | |
96 | ||
97 | \wxheading{Data structures} | |
98 | ||
99 | Flages used by | |
100 | \helpref{wxFindReplaceData::GetFlags()}{wxfindreplacedatagetflags} and | |
101 | \helpref{wxFindDialogEvent::GetFlags()}{wxfinddialogeventgetflags}: | |
102 | ||
103 | \begin{verbatim} | |
104 | enum wxFindReplaceFlags | |
105 | { | |
106 | // downward search/replace selected (otherwise - upwards) | |
107 | wxFR_DOWN = 1, | |
108 | ||
109 | // whole word search/replace selected | |
110 | wxFR_WHOLEWORD = 2, | |
111 | ||
112 | // case sensitive search/replace selected (otherwise - case insensitive) | |
113 | wxFR_MATCHCASE = 4 | |
114 | } | |
115 | \end{verbatim} | |
116 | ||
117 | These flags can be specified in | |
118 | \helpref{wxFindReplaceDialog ctor}{wxfindreplacedialogctor} or | |
119 | \helpref{Create()}{wxfindreplacedialogcreate}: | |
120 | ||
121 | \begin{verbatim} | |
122 | enum wxFindReplaceDialogStyles | |
123 | { | |
124 | // replace dialog (otherwise find dialog) | |
125 | wxFR_REPLACEDIALOG = 1, | |
126 | ||
127 | // don't allow changing the search direction | |
128 | wxFR_NOUPDOWN = 2, | |
129 | ||
130 | // don't allow case sensitive searching | |
131 | wxFR_NOMATCHCASE = 4, | |
132 | ||
133 | // don't allow whole word searching | |
134 | wxFR_NOWHOLEWORD = 8 | |
135 | } | |
136 | \end{verbatim} | |
137 | ||
138 | \latexignore{\rtfignore{\wxheading{Members}}} | |
139 | ||
140 | \membersection{wxFindReplaceData::wxFindReplaceData}\label{wxfindreplacedatactor} | |
141 | ||
142 | \func{}{wxFindReplaceData}{\param{wxUint32 }{flags = 0}} | |
143 | ||
144 | Constuctor initializes the flags to default value ($0$). | |
145 | ||
146 | \membersection{wxFindReplaceData::GetFindString}\label{wxfindreplacedatagetfindstring} | |
147 | ||
148 | \func{const wxString\&}{GetFindString}{\void} | |
149 | ||
150 | Get the string to find. | |
151 | ||
152 | \membersection{wxFindReplaceData::GetReplaceString}\label{wxfindreplacedatagetreplacestring} | |
153 | ||
154 | \func{const wxString\&}{GetReplaceString}{\void} | |
155 | ||
156 | Get the replacement string. | |
157 | ||
158 | \membersection{wxFindReplaceData::GetFlags}\label{wxfindreplacedatagetflags} | |
159 | ||
160 | \constfunc{int}{GetFlags}{\void} | |
161 | ||
162 | Get the combination of {\tt wxFindReplaceFlags} values. | |
163 | ||
164 | \membersection{wxFindReplaceData::SetFlags}\label{wxfindreplacedatasetflags} | |
165 | ||
166 | \func{void}{SetFlags}{\param{wxUint32 }{flags}} | |
167 | ||
168 | Set the flags to use to initialize the controls of the dialog. | |
169 | ||
170 | \membersection{wxFindReplaceData::SetFindString}\label{wxfindreplacedatasetfindstring} | |
171 | ||
172 | \func{void}{SetFindString}{\param{const wxString\& }{str}} | |
173 | ||
174 | Set the string to find (used as initial value by the dialog). | |
175 | ||
176 | \membersection{wxFindReplaceData::SetReplaceString}\label{wxfindreplacedatasetreplacestring} | |
177 | ||
178 | \func{void}{SetReplaceString}{\param{const wxString\& }{str}} | |
179 | ||
180 | Set the replacement string (used as initial value by the dialog). | |
181 | ||
182 | \section{\class{wxFindReplaceDialog}}\label{wxfindreplacedialog} | |
183 | ||
184 | wxFindReplaceDialog is a standard modeless dialog which is used to allow the | |
185 | user to search for some text (and possible replace it with something else). | |
186 | The actual searching is supposed to be done in the owner window which is the | |
187 | parent of this dialog. Note that it means that unlike for the other standard | |
188 | dialogs this one {\bf must} have a parent window. | |
189 | ||
190 | Please see the dialogs sample for example of using it. | |
191 | ||
192 | \wxheading{Include files} | |
193 | ||
194 | #include <wx/fdrepdlg.h> | |
195 | ||
196 | \wxheading{Derived from} | |
197 | ||
198 | \helpref{wxDialog}{wxdialog} | |
199 | ||
200 | \latexignore{\rtfignore{\wxheading{Members}}} | |
201 | ||
202 | \membersection{wxFindReplaceDialog::wxFindReplaceDialog}\label{wxfindreplacedialogctor} | |
203 | ||
204 | \func{}{wxFindReplaceDialogBase}{\void} | |
205 | ||
206 | \func{}{wxFindReplaceDialogBase}{\param{wxWindow * }{parent}, \param{wxFindReplaceData* }{data}, \param{const wxString\& }{title}, \param{int }{style = 0}} | |
207 | ||
208 | After using default constructor \helpref{Created}{wxfindreplacedialogcreate} | |
209 | must be called. | |
210 | ||
211 | The {\it parent} and {\it data} parameters must be non-{\tt NULL}. | |
212 | ||
213 | \membersection{wxFindReplaceDialogBase::\destruct{wxFindReplaceDialogBase}}\label{wxfindreplacedialogdtor} | |
214 | ||
215 | \func{}{\destruct{wxFindReplaceDialogBase}}{\void} | |
216 | ||
217 | Destructor. | |
218 | ||
219 | \func{bool}{Create}{\param{wxWindow * }{parent}, \param{wxFindReplaceData* }{data}, \param{const wxString\& }{title}, \param{int }{style = 0}} | |
220 | ||
221 | Creates the dialog and shows it on screen. | |
222 | ||
223 | The {\it parent} and {\it data} parameters must be non-{\tt NULL}. | |
224 | ||
225 | \membersection{wxFindReplaceDialogBase::GetData}\label{wxfindreplacedialoggetdata} | |
226 | ||
227 | \constfunc{const wxFindReplaceData*}{GetData}{\void} | |
228 | ||
229 | Get the \helpref{wxFindReplaceData}{wxfindreplacedata} object used by this | |
230 | dialog. | |
231 |