1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
|
<!-- manual page source format generated by RosettaMan v2.5a6, -->
<!-- available via anonymous ftp from ftp.cs.berkeley.edu:/ucb/people/phelps/tcltk/rman.tar.Z -->
<HTML>
<HEAD>
<TITLE>man page(1) manual page</TITLE>
</HEAD>
<BODY>
<A HREF="#toc">Table of Contents</A><P>
_________________________________________________________________
<P>
<H2><A NAME="sect1" HREF="#toc1"><B>NAME</B></A></H2>
finddialog - Create and manipulate a find dialog widget
<P>
<H2><A NAME="sect2" HREF="#toc2"><B>SYNOPSIS</B></A></H2>
<B>finddialog</B> <I>pathName</I> ?<I>options</I>?
<P>
<H2><A NAME="sect3" HREF="#toc3"><B>INHERITANCE</B></A></H2>
itk::Toplevel <- Shell <- Dialogshell <- Finddialog
<P>
<H2><A NAME="sect4" HREF="#toc4"><B>STANDARD</B> <B>OPTIONS</B></A></H2>
<DL>
<DT><B>activeBackground</B> <DD> <B>activeForegroundbackgroundborderWidth</B>
<B>cursor</B> <B>disabledForeground</B> <B>fontforeground</B>
<B>highlightColor</B> <B>highlightThickness</B> <B>insertBackgroundinsertBorderWidth</B>
<B>insertOffTime</B> <B>insertOnTime</B> <B>insertWidth</B> <B>selectBackground</B>
</DD>
</DL>
<DL>
<DT><B>selectBorderWidth</B> <DD> <B>selectColor</B> <B>selectForeground</B>
<P>
</DD>
</DL>
See the "options" manual entry for details on the standard
options.
<P>
<H2><A NAME="sect5" HREF="#toc5"><B>ASSOCIATED</B> <B>OPTIONS</B></A></H2>
<B>selectColor</B>
<P>
See the "checkbutton" widget manual entry for details on the
above associated options.
<P>
<B>selectColor</B>
<P>
See the "entryfield" widget manual entry for details on the
above associated options.
<P>
<B>labelFont</B>
<P>
See the "labeledwidget" widget manual entry for details on
the above associated options.
<P>
<H2><A NAME="sect6" HREF="#toc6"><B>INHERITED</B> <B>OPTIONS</B></A></H2>
<B>buttonBoxPadX</B> <B>buttonBoxPadY</B> <B>buttonBoxPos</B> <B>padX</B>
<DL>
<DT><B>padY</B> <DD> <B>separator</B> <B>thickness</B>
<P>
</DD>
</DL>
See the "dialogshell" widget manual entry for details on
the above inherited options.
<P>
<B>height</B> <B>master</B> <B>modality</B> <B>width</B>
<P>
See the "shell" widget manual entry for details on the
above inherited options.
<P>
<B>title</B>
<P>
See the "Toplevel" widget manual entry for details on the
above inherited options.
<P>
<H2><A NAME="sect7" HREF="#toc7"><B>WIDGET-SPECIFIC</B> <B>OPTIONS</B></A></H2>
<DL>
<DT>Name: <DD> <B>clearCommand</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Command</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-clearcommand</B>
<P>
</DD>
</DL>
Specifies a command to be invoked following a clear
operation. The option is meant to be used as means of
notification that the clear has taken place and allow
other actions to take place such as disabling a find
again menu.
<P>
<DL>
<DT>Name: <DD> <B>matchCommand</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Command</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-matchcommand</B>
<P>
</DD>
</DL>
Specifies a command to be invoked following a find
operation. The command is called with a match point as
an argument which identifies where exactly where in the
text or scrolledtext widget that the match is located.
Should a match not be found the match point is {}. The
option is meant to be used as a means of notification
that the find operation has completed and allow other
actions to take place such as disabling a find again
menu option if the match point was {}.
<P>
<DL>
<DT>Name: <DD> <B>patternBackground</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Background</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-patternbackground</B>
<P>
</DD>
</DL>
Specifies the background color of the text matching the
search pattern. It may have any of the forms accepted
by Tk_GetColor. The default is gray44.
<P>
<DL>
<DT>Name: <DD> <B>patternForeground</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Background</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-patternforeground</B>
<P>
</DD>
</DL>
Specifies the foreground color of the text matching the
search pattern. It may have any of the forms accepted
by Tk_GetColor. The default is white.
<P>
<DL>
<DT>Name: <DD> <B>searchBackground</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Background</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-searchbackground</B>
<P>
</DD>
</DL>
Specifies the background color of the line containing
the matching the search pattern. It may have any of
the forms accepted by Tk_GetColor. The default is
gray77.
<P>
<DL>
<DT>Name: <DD> <B>searchForeground</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Background</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-searchforeground</B>
<P>
</DD>
</DL>
Specifies the foreground color of the line containing
the matching the search pattern. It may have any of
the forms accepted by Tk_GetColor. The default is
black.
<P>
<DL>
<DT>Name: <DD> <B>textWidget</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>TextWidget</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-textwidget</B>
<P>
</DD>
</DL>
Specifies the text or scrolledtext widget to be
searched.<BR>
_________________________________________________________________
<P>
<H2><A NAME="sect8" HREF="#toc8"><B>DESCRIPTION</B></A></H2>
The <B>finddialog</B> command creates a find dialog that works in
conjunction with a text or scrolledtext widget to provide a
means of performing search operations. The user is prompted
for a text pattern to be found in the text or scrolledtext
widget. The search can be for all occurances, by regular
expression, considerate of the case, or backwards.
<P>
<H2><A NAME="sect9" HREF="#toc9"><B>METHODS</B></A></H2>
The <B>finddialog</B> command creates a new Tcl command whose name
is <I>pathName</I>. This command may be used to invoke various
operations on the widget. It has the following general
form:
<P>
<I>pathName</I> <I>option</I> ?<I>arg</I> <I>arg</I> ...?
<P>
<I>Option</I> and the <I>arg</I>s determine the exact behavior of the command.
The following commands are possible for finddialog
widgets:
<P>
<H2><A NAME="sect10" HREF="#toc10"><B>INHERITED</B> <B>METHODS</B></A></H2>
<B>add</B> <B>buttonconfigure</B> <B>defaulthide</B>
<DL>
<DT><B>invoke</B> <DD> <B>show</B>
<P>
</DD>
</DL>
See the "buttonbox" widget manual entry for details on the
above inherited methods.
<P>
<B>activate</B> <B>center</B> <B>deactivate</B>
<P>
See the "shell" widget manual entry for details on the above
inherited methods.
<P>
<H2><A NAME="sect11" HREF="#toc11"><B>WIDGET-SPECIFIC</B> <B>METHODS</B></A></H2>
<I>pathName</I> <B>cget</B> <I>option</I><BR>
Returns the current value of the configuration option
given by <I>option</I>. <I>Option</I> may have any of the values
accepted by the <B>finddialog</B> command.
<P>
<I>pathName</I> <B>clear</B><BR>
Clears the pattern in the entry field and the pattern
matchin indicators in the text or scrolledtext widget.
<P>
<I>pathName</I> <B>configure</B> ?<I>option</I>? ?<I>value</I> <I>option</I> <I>value</I> ...?
Query or modify the configuration options of the
widget. If no <I>option</I> is specified, returns a list
describing all of the available options for <I>pathName</I>
(see <B>Tk_ConfigureInfo</B> for information on the format of
this list). If <I>option</I> is specified with no <I>value</I>, then
the command returns a list describing the one named
option (this list will be identical to the corresponding
sublist of the value returned if no <I>option</I> is
specified). If one or more <I>option</I> - <I>value</I> pairs are
specified, then the command modifies the given widget
option(s) to have the given value(s); in this case the
command returns an empty string. <I>Option</I> may have any
of the values accepted by the <B>finddialog</B> command.
<P>
<I>pathName</I> <B>find</B><BR>
Search for a specific text string in the text widget
given by the -textwidget option. This method is the
standard callback for the Find button. It is made
available such that it can be bound to a find again
action.
<P>
<H2><A NAME="sect12" HREF="#toc12"><B>COMPONENTS</B></A></H2>
<DL>
<DT>Name: <DD> <B>all</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Checkbutton</B>
<P>
</DD>
</DL>
The all component specifies that all the matches of the
pattern should be found when performing the search.
See the "checkbutton" widget manual entry for details
on the all component item.
<P>
<DL>
<DT>Name: <DD> <B>backwards</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Checkbutton</B>
<P>
</DD>
</DL>
The backwards component specifies that the search
should continue in a backwards direction towards the
beginning of the text or scrolledtext widget. See the
"checkbutton" widget manual entry for details on the
backwards component item.
<P>
<DL>
<DT>Name: <DD> <B>case</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Checkbutton</B>
<P>
</DD>
</DL>
The case component specifies that the case of the pattern
should be taken into consideration when performing
the search. See the "checkbutton" widget manual entry
for details on the case component item.
<P>
<DL>
<DT>Name: <DD> <B>pattern</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Entryfield</B>
<P>
</DD>
</DL>
The pattern component provides the pattern entry field.
See the "entryfield" widget manual entry for details on
the pattern component item.
<P>
<DL>
<DT>Name: <DD> <B>regexp</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Checkbutton</B>
<P>
</DD>
</DL>
The regexp component specifies that the pattern is a
regular expression. See the "checkbutton" widget
manual entry for details on the regexp component item.
<P>
<H2><A NAME="sect13" HREF="#toc13"><B>EXAMPLE</B></A></H2>
scrolledtext .st<BR>
pack .st<BR>
.st insert end "Now is the time for all good men\n"
.st insert end "to come to the aid of their country"
<P>
finddialog .fd -textwidget .st<BR>
.fd center .st<BR>
.fd activate
<P>
<H2><A NAME="sect14" HREF="#toc14"><B>AUTHOR</B></A></H2>
Mark L. Ulferts
<P>
<H2><A NAME="sect15" HREF="#toc15"><B>KEYWORDS</B></A></H2>
finddialog, dialogshell, shell, widget
<P>
<HR><P>
<A NAME="toc"><B>Table of Contents</B></A><P>
<UL>
<LI><A NAME="toc1" HREF="#sect1">NAME</A></LI>
<LI><A NAME="toc2" HREF="#sect2">SYNOPSIS</A></LI>
<LI><A NAME="toc3" HREF="#sect3">INHERITANCE</A></LI>
<LI><A NAME="toc4" HREF="#sect4">STANDARD OPTIONS</A></LI>
<LI><A NAME="toc5" HREF="#sect5">ASSOCIATED OPTIONS</A></LI>
<LI><A NAME="toc6" HREF="#sect6">INHERITED OPTIONS</A></LI>
<LI><A NAME="toc7" HREF="#sect7">WIDGET-SPECIFIC OPTIONS</A></LI>
<LI><A NAME="toc8" HREF="#sect8">DESCRIPTION</A></LI>
<LI><A NAME="toc9" HREF="#sect9">METHODS</A></LI>
<LI><A NAME="toc10" HREF="#sect10">INHERITED METHODS</A></LI>
<LI><A NAME="toc11" HREF="#sect11">WIDGET-SPECIFIC METHODS</A></LI>
<LI><A NAME="toc12" HREF="#sect12">COMPONENTS</A></LI>
<LI><A NAME="toc13" HREF="#sect13">EXAMPLE</A></LI>
<LI><A NAME="toc14" HREF="#sect14">AUTHOR</A></LI>
<LI><A NAME="toc15" HREF="#sect15">KEYWORDS</A></LI>
</UL>
</BODY></HTML>
|
