1 |
578 |
markom |
'\"
|
2 |
|
|
'\" Copyright (c) 1995 DSC Technologies Corporation
|
3 |
|
|
'\"
|
4 |
|
|
'\" See the file "license.terms" for information on usage and redistribution
|
5 |
|
|
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
6 |
|
|
'\"
|
7 |
|
|
'\" @(#) finddialog.n 1.21 94/12/17 16:04:44
|
8 |
|
|
'/"
|
9 |
|
|
.so man.macros
|
10 |
|
|
.HS finddialog iwid
|
11 |
|
|
.BS
|
12 |
|
|
'\" Note: do not modify the .SH NAME line immediately below!
|
13 |
|
|
.SH NAME
|
14 |
|
|
finddialog \- Create and manipulate a find dialog widget
|
15 |
|
|
.SH SYNOPSIS
|
16 |
|
|
\fBfinddialog\fI \fIpathName \fR?\fIoptions\fR?
|
17 |
|
|
.SH "INHERITANCE"
|
18 |
|
|
itk::Toplevel <- Shell <- Dialogshell <- Finddialog
|
19 |
|
|
.SH "STANDARD OPTIONS"
|
20 |
|
|
.LP
|
21 |
|
|
.nf
|
22 |
|
|
.ta 4c 8c 12c
|
23 |
|
|
\fBactiveBackground\fR \fBactiveForeground\fR \fBbackground\fR \fBborderWidth\fR
|
24 |
|
|
\fBcursor\fR \fBdisabledForeground\fR \fBfont\fR \fBforeground\fR
|
25 |
|
|
\fBhighlightColor\fR \fBhighlightThickness\fR \fBinsertBackground\fR \fBinsertBorderWidth\fR
|
26 |
|
|
\fBinsertOffTime\fR \fBinsertOnTime\fR \fBinsertWidth\fR \fBselectBackground\fR
|
27 |
|
|
\fBselectBorderWidth\fR \fBselectColor\fR \fBselectForeground\fR
|
28 |
|
|
.fi
|
29 |
|
|
.LP
|
30 |
|
|
See the "options" manual entry for details on the standard options.
|
31 |
|
|
.SH "ASSOCIATED OPTIONS"
|
32 |
|
|
.LP
|
33 |
|
|
.nf
|
34 |
|
|
.ta 4c 8c 12c
|
35 |
|
|
\fBselectColor\fR
|
36 |
|
|
.fi
|
37 |
|
|
.LP
|
38 |
|
|
See the "checkbutton" widget manual entry for details on the above
|
39 |
|
|
associated options.
|
40 |
|
|
.LP
|
41 |
|
|
.nf
|
42 |
|
|
.ta 4c 8c 12c
|
43 |
|
|
\fBselectColor\fR
|
44 |
|
|
.fi
|
45 |
|
|
.LP
|
46 |
|
|
See the "entryfield" widget manual entry for details on the above
|
47 |
|
|
associated options.
|
48 |
|
|
.LP
|
49 |
|
|
.nf
|
50 |
|
|
.ta 4c 8c 12c
|
51 |
|
|
\fBlabelFont\fR
|
52 |
|
|
.fi
|
53 |
|
|
.LP
|
54 |
|
|
See the "labeledwidget" widget manual entry for details on the above
|
55 |
|
|
associated options.
|
56 |
|
|
.SH "INHERITED OPTIONS"
|
57 |
|
|
.LP
|
58 |
|
|
.nf
|
59 |
|
|
.ta 4c 8c 12c
|
60 |
|
|
\fBbuttonBoxPadX\fR \fBbuttonBoxPadY\fR \fBbuttonBoxPos\fR \fBpadX\fR
|
61 |
|
|
\fBpadY\fR \fBseparator\fR \fBthickness\fR
|
62 |
|
|
.fi
|
63 |
|
|
.LP
|
64 |
|
|
See the "dialogshell" widget manual entry for details on the above
|
65 |
|
|
inherited options.
|
66 |
|
|
.LP
|
67 |
|
|
.nf
|
68 |
|
|
.ta 4c 8c 12c
|
69 |
|
|
\fBheight\fR \fBmaster\fR \fBmodality\fR \fBwidth\fR
|
70 |
|
|
.fi
|
71 |
|
|
.LP
|
72 |
|
|
See the "shell" widget manual entry for details on the above
|
73 |
|
|
inherited options.
|
74 |
|
|
.LP
|
75 |
|
|
.nf
|
76 |
|
|
.ta 4c 8c 12c
|
77 |
|
|
\fBtitle\fR
|
78 |
|
|
.fi
|
79 |
|
|
.LP
|
80 |
|
|
See the "Toplevel" widget manual entry for details on the above
|
81 |
|
|
inherited options.
|
82 |
|
|
.SH "WIDGET-SPECIFIC OPTIONS"
|
83 |
|
|
.LP
|
84 |
|
|
.nf
|
85 |
|
|
Name: \fBclearCommand\fR
|
86 |
|
|
Class: \fBCommand\fR
|
87 |
|
|
Command-Line Switch: \fB-clearcommand\fR
|
88 |
|
|
.fi
|
89 |
|
|
.IP
|
90 |
|
|
Specifies a command to be invoked following a clear operation.
|
91 |
|
|
The option is meant to be used as means of notification that the
|
92 |
|
|
clear has taken place and allow other actions to take place such
|
93 |
|
|
as disabling a find again menu.
|
94 |
|
|
.LP
|
95 |
|
|
.nf
|
96 |
|
|
Name: \fBmatchCommand\fR
|
97 |
|
|
Class: \fBCommand\fR
|
98 |
|
|
Command-Line Switch: \fB-matchcommand\fR
|
99 |
|
|
.fi
|
100 |
|
|
.IP
|
101 |
|
|
Specifies a command to be invoked following a find operation.
|
102 |
|
|
The command is called with a match point as an argument which identifies
|
103 |
|
|
where exactly where in the text or scrolledtext widget that the match
|
104 |
|
|
is located. Should a match not be found the match point is {}. The
|
105 |
|
|
option is meant to be used as a means of notification that the
|
106 |
|
|
find operation has completed and allow other actions to take place
|
107 |
|
|
such as disabling a find again menu option if the match point was {}.
|
108 |
|
|
.LP
|
109 |
|
|
.nf
|
110 |
|
|
Name: \fBpatternBackground\fR
|
111 |
|
|
Class: \fBBackground\fR
|
112 |
|
|
Command-Line Switch: \fB-patternbackground\fR
|
113 |
|
|
.fi
|
114 |
|
|
.IP
|
115 |
|
|
Specifies the background color of the text matching the search
|
116 |
|
|
pattern. It may have any of the forms accepted by Tk_GetColor.
|
117 |
|
|
The default is gray44.
|
118 |
|
|
.LP
|
119 |
|
|
.nf
|
120 |
|
|
Name: \fBpatternForeground\fR
|
121 |
|
|
Class: \fBBackground\fR
|
122 |
|
|
Command-Line Switch: \fB-patternforeground\fR
|
123 |
|
|
.fi
|
124 |
|
|
.IP
|
125 |
|
|
Specifies the foreground color of the text matching the search
|
126 |
|
|
pattern. It may have any of the forms accepted by Tk_GetColor.
|
127 |
|
|
The default is white.
|
128 |
|
|
.LP
|
129 |
|
|
.nf
|
130 |
|
|
Name: \fBsearchBackground\fR
|
131 |
|
|
Class: \fBBackground\fR
|
132 |
|
|
Command-Line Switch: \fB-searchbackground\fR
|
133 |
|
|
.fi
|
134 |
|
|
.IP
|
135 |
|
|
Specifies the background color of the line containing the matching
|
136 |
|
|
the search pattern. It may have any of the forms accepted by Tk_GetColor.
|
137 |
|
|
The default is gray77.
|
138 |
|
|
.LP
|
139 |
|
|
.nf
|
140 |
|
|
Name: \fBsearchForeground\fR
|
141 |
|
|
Class: \fBBackground\fR
|
142 |
|
|
Command-Line Switch: \fB-searchforeground\fR
|
143 |
|
|
.fi
|
144 |
|
|
.IP
|
145 |
|
|
Specifies the foreground color of the line containing the matching
|
146 |
|
|
the search pattern. It may have any of the forms accepted by Tk_GetColor.
|
147 |
|
|
The default is black.
|
148 |
|
|
.LP
|
149 |
|
|
.nf
|
150 |
|
|
Name: \fBtextWidget\fR
|
151 |
|
|
Class: \fBTextWidget\fR
|
152 |
|
|
Command-Line Switch: \fB-textwidget\fR
|
153 |
|
|
.fi
|
154 |
|
|
.IP
|
155 |
|
|
Specifies the text or scrolledtext widget to be searched.
|
156 |
|
|
.BE
|
157 |
|
|
|
158 |
|
|
.SH DESCRIPTION
|
159 |
|
|
.PP
|
160 |
|
|
The \fBfinddialog\fR command creates a find dialog that works in
|
161 |
|
|
conjunction with a text or scrolledtext widget to provide a means
|
162 |
|
|
of performing search operations. The user is prompted for a text
|
163 |
|
|
pattern to be found in the text or scrolledtext widget. The
|
164 |
|
|
search can be for all occurances, by regular expression, considerate
|
165 |
|
|
of the case, or backwards.
|
166 |
|
|
|
167 |
|
|
.SH "METHODS"
|
168 |
|
|
.PP
|
169 |
|
|
The \fBfinddialog\fR command creates a new Tcl command whose
|
170 |
|
|
name is \fIpathName\fR. This
|
171 |
|
|
command may be used to invoke various
|
172 |
|
|
operations on the widget. It has the following general form:
|
173 |
|
|
.DS C
|
174 |
|
|
\fIpathName option \fR?\fIarg arg ...\fR?
|
175 |
|
|
.DE
|
176 |
|
|
\fIOption\fR and the \fIarg\fRs
|
177 |
|
|
determine the exact behavior of the command. The following
|
178 |
|
|
commands are possible for finddialog widgets:
|
179 |
|
|
.SH "INHERITED METHODS"
|
180 |
|
|
.LP
|
181 |
|
|
.nf
|
182 |
|
|
.ta 4c 8c 12c
|
183 |
|
|
\fBadd\fR \fBbuttonconfigure\fR \fBdefault\fR \fBhide\fR
|
184 |
|
|
\fBinvoke\fR \fBshow\fR
|
185 |
|
|
.fi
|
186 |
|
|
.LP
|
187 |
|
|
See the "buttonbox" widget manual entry for details on the above
|
188 |
|
|
inherited methods.
|
189 |
|
|
.LP
|
190 |
|
|
.nf
|
191 |
|
|
.ta 4c 8c 12c
|
192 |
|
|
\fBactivate\fR \fBcenter\fR \fBdeactivate\fR
|
193 |
|
|
.fi
|
194 |
|
|
.LP
|
195 |
|
|
See the "shell" widget manual entry for details on the above
|
196 |
|
|
inherited methods.
|
197 |
|
|
.SH "WIDGET-SPECIFIC METHODS"
|
198 |
|
|
.TP
|
199 |
|
|
\fIpathName \fBcget\fR \fIoption\fR
|
200 |
|
|
Returns the current value of the configuration option given
|
201 |
|
|
by \fIoption\fR.
|
202 |
|
|
\fIOption\fR may have any of the values accepted by the \fBfinddialog\fR
|
203 |
|
|
command.
|
204 |
|
|
.TP
|
205 |
|
|
\fIpathName \fBclear\fR
|
206 |
|
|
Clears the pattern in the entry field and the pattern matchin
|
207 |
|
|
indicators in the text or scrolledtext widget.
|
208 |
|
|
.TP
|
209 |
|
|
\fIpathName\fR \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
|
210 |
|
|
Query or modify the configuration options of the widget.
|
211 |
|
|
If no \fIoption\fR is specified, returns a list describing all of
|
212 |
|
|
the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
213 |
|
|
information on the format of this list). If \fIoption\fR is specified
|
214 |
|
|
with no \fIvalue\fR, then the command returns a list describing the
|
215 |
|
|
one named option (this list will be identical to the corresponding
|
216 |
|
|
sublist of the value returned if no \fIoption\fR is specified). If
|
217 |
|
|
one or more \fIoption\-value\fR pairs are specified, then the command
|
218 |
|
|
modifies the given widget option(s) to have the given value(s); in
|
219 |
|
|
this case the command returns an empty string.
|
220 |
|
|
\fIOption\fR may have any of the values accepted by the \fBfinddialog\fR
|
221 |
|
|
command.
|
222 |
|
|
.TP
|
223 |
|
|
\fIpathName \fBfind\fR
|
224 |
|
|
Search for a specific text string in the text widget given by
|
225 |
|
|
the -textwidget option. This method is the standard callback
|
226 |
|
|
for the Find button. It is made available such that it can be
|
227 |
|
|
bound to a find again action.
|
228 |
|
|
|
229 |
|
|
.SH "COMPONENTS"
|
230 |
|
|
.LP
|
231 |
|
|
.nf
|
232 |
|
|
Name: \fBall\fR
|
233 |
|
|
Class: \fBCheckbutton\fR
|
234 |
|
|
.fi
|
235 |
|
|
.IP
|
236 |
|
|
The all component specifies that all the matches of the pattern should be
|
237 |
|
|
found when performing the search. See the "checkbutton" widget manual
|
238 |
|
|
entry for details on the all component item.
|
239 |
|
|
.LP
|
240 |
|
|
.nf
|
241 |
|
|
Name: \fBbackwards\fR
|
242 |
|
|
Class: \fBCheckbutton\fR
|
243 |
|
|
.fi
|
244 |
|
|
.IP
|
245 |
|
|
The backwards component specifies that the search should continue in
|
246 |
|
|
a backwards direction towards the beginning of the text or scrolledtext
|
247 |
|
|
widget. See the "checkbutton" widget manual entry for details on the
|
248 |
|
|
backwards component item.
|
249 |
|
|
.LP
|
250 |
|
|
.nf
|
251 |
|
|
Name: \fBcase\fR
|
252 |
|
|
Class: \fBCheckbutton\fR
|
253 |
|
|
.fi
|
254 |
|
|
.IP
|
255 |
|
|
The case component specifies that the case of the pattern should be
|
256 |
|
|
taken into consideration when performing the search. See the
|
257 |
|
|
"checkbutton" widget manual entry for details on the case component item.
|
258 |
|
|
.LP
|
259 |
|
|
.nf
|
260 |
|
|
Name: \fBpattern\fR
|
261 |
|
|
Class: \fBEntryfield\fR
|
262 |
|
|
.fi
|
263 |
|
|
.IP
|
264 |
|
|
The pattern component provides the pattern entry field. See the
|
265 |
|
|
"entryfield" widget manual entry for details on the pattern component item.
|
266 |
|
|
.LP
|
267 |
|
|
.nf
|
268 |
|
|
Name: \fBregexp\fR
|
269 |
|
|
Class: \fBCheckbutton\fR
|
270 |
|
|
.fi
|
271 |
|
|
.IP
|
272 |
|
|
The regexp component specifies that the pattern is a regular expression.
|
273 |
|
|
See the "checkbutton" widget manual entry for details on the regexp
|
274 |
|
|
component item.
|
275 |
|
|
.fi
|
276 |
|
|
|
277 |
|
|
.SH EXAMPLE
|
278 |
|
|
.DS
|
279 |
|
|
scrolledtext .st
|
280 |
|
|
pack .st
|
281 |
|
|
.st insert end "Now is the time for all good men\\n"
|
282 |
|
|
.st insert end "to come to the aid of their country"
|
283 |
|
|
|
284 |
|
|
finddialog .fd -textwidget .st
|
285 |
|
|
.fd center .st
|
286 |
|
|
.fd activate
|
287 |
|
|
.DE
|
288 |
|
|
.SH AUTHOR
|
289 |
|
|
Mark L. Ulferts
|
290 |
|
|
.SH KEYWORDS
|
291 |
|
|
finddialog, dialogshell, shell, widget
|
292 |
|
|
|