docs/latex/wx/fdrepdlg.tex

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