OpenCores
URL https://opencores.org/ocsvn/or1k/or1k/trunk

Subversion Repositories or1k

[/] [or1k/] [trunk/] [insight/] [tix/] [man/] [EFileBox.html] - Blame information for rev 1765

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 578 markom
 
2
 
3
 
4
<TITLE>tixExFileSelectBox - Create and manipulate tixExFileSelectBox widgets</TITLE>
5
<Center><H2>tixExFileSelectBox - Create and manipulate tixExFileSelectBox widgets</H2></Center><hr>
6
 
7
</pre><H3>SYNOPSIS</H3>
8
<B>tixExFileSelectBox<I> <I>pathName ?<I>options</I></B>?
9
<P>
10
</pre><H3>SUPER-CLASS</H3>
11
The <B>TixExFileSelectBox</B></I> class does not have a super-class.
12
</pre><H3>STANDARD OPTIONS</H3>
13
<B>TixExFileSelectBox</B></I> supports all the standard options of a frame
14
widget. See the <B>options(n)</B></I> manual entry for details on the
15
standard options.
16
</pre><H3>WIDGET-SPECIFIC OPTIONS</H3>
17
<P>
18
<pre><code><code><code>
19
Name:           <B>browseCmd</B></I>
20
Class:          <B>BrowseCmd</B></I>
21
Switch:         <B>-browsecmd</B></I>
22
</code></code></code></pre>
23
<UL>
24
Specifies a command to call whenever the user browses on a filename in
25
the file listbox (usually by single-clicking on the filename). The command
26
is called with one argument, the complete pathname of the file.
27
</UL>
28
<P>
29
<pre><code><code><code>
30
Name:           <B>command</B></I>
31
Class:          <B>Command</B></I>
32
Switch:         <B>-command</B></I>
33
</code></code></code></pre>
34
<UL>
35
Specifies the command to be called when the user chooses on a filename
36
the file listbox (usually by double-clicking on the filename). The command
37
is called with one argument, the complete pathname of the file.
38
</UL>
39
<P>
40
<pre><code><code><code>
41
Name:           <B>dialog</B></I>
42
Class:          <B>Dialog</B></I>
43
Switch:         <B>-dialog</B></I>
44
</code></code></code></pre>
45
<UL>
46
Specifies a dialog box which contains this ExFileSelectBox widget. The
47
dialog box must be a widget of the class TixShell or its
48
descendant classes. <I>This is an internal option and should not be used
49
by application programmers.</B></I>
50
</UL>
51
<P>
52
<pre><code><code><code>
53
Name:           <B>dircmd</B></I>
54
Class:          <B>DirCmd</B></I>
55
Switch:         <B>-dircmd</B></I>
56
</code></code></code></pre>
57
<UL>
58
Specifies the TCL command to be called when a file listing is needed
59
for a particular directory. If this option is not specified, by
60
default the ExFileSelectBox widget will attempt to read the directory
61
as a Unix directory. On special occasions, the application programmer
62
may want to supply a special method for reading directories: for
63
example, when he needs to list remote files. In this case, the
64
<B>-dircmd</B></I> option can be used. The specified command accepts three
65
arguments: the first is the name of the directory to be listed; the
66
second is a list of file patterns, the third is a Boolean value
67
indicating whether hidden files should be listed. This command returns
68
a list of names of the files of this directory which match with the
69
file patterns.
70
</UL>
71
<P>
72
<pre><code><code><code>
73
Name:           <B>directory</B></I>
74
Class:          <B>Directory</B></I>
75
Switch:         <B>-directory</B></I>
76
Alias:          <B>-dir</B></I>
77
</code></code></code></pre>
78
<UL>
79
Specifies the current directory whose files and sub-directories are
80
displayed in the ExFileSelectBox.
81
</UL>
82
<P>
83
<pre><code><code><code>
84
Name:           <B>disableCallback</B></I>
85
Class:          <B>DisableCallback</B></I>
86
Switch:         <B>-disablecallback</B></I>
87
</code></code></code></pre>
88
<UL>
89
A boolean value indicating whether callbacks should be disabled. When
90
set to true, the TCL command specified by the <B>-command</B></I> option
91
is not executed when the <B>-value</B></I> of the ExFileSelectBox
92
widget changes.
93
</UL>
94
<P>
95
<pre><code><code><code>
96
Name:           <B>fileTypes</B></I>
97
Class:          <B>FileTypes</B></I>
98
Switch:         <B>-filetypes</B></I>
99
</code></code></code></pre>
100
<UL>
101
Specifies the file types that can be selected from the "List Files of
102
Type:" ComboBox subwidget. The value of this option must be a TCL
103
list; each item of this list must in turn be a list of two elements.
104
The first element is a list of file patterns. The second element is a
105
string that describe these file patterns. For example:
106
</UL>
107
<pre><code><code><code>
108
    tixExFileSelectBox .box -filetypes  {
109
        {{*}    {All files}}
110
        {{*.txt}        {Text files}}
111
        {{*.c *.h}      {C source files}}
112
    }
113
</code></code></code></pre>
114
<P>
115
<pre><code><code><code>
116
Name:           <B>showHidden</B></I>
117
Class:          <B>ShowHidden</B></I>
118
Switch:         <B>-showhidden</B></I>
119
</code></code></code></pre>
120
<UL>
121
Specifies whether hidden directories should be shown. By default, a
122
directory name starting with a period "\." is considered as a hidden
123
directory.
124
</UL>
125
<P>
126
<pre><code><code><code>
127
Name:           <B>pattern</B></I>
128
Class:          <B>Pattern</B></I>
129
Switch:         <B>-pattern</B></I>
130
</code></code></code></pre>
131
<UL>
132
Specifies whether the file pattern(s) to match with the files in the
133
current directory. One or more file patterns can be given at the same
134
time. For example, {*\.c *\.h} will match all files that have either the
135
".h" or ".c" extensions.
136
</UL>
137
<P>
138
<pre><code><code><code>
139
Name:           <B>value</B></I>
140
Class:          <B>Value</B></I>
141
Switch:         <B>-value</B></I>
142
Alias:          <B>-selection</B></I>
143
</code></code></code></pre>
144
<UL>
145
Specifies the name of the filename currently selected by the user.
146
</UL>
147
</pre><H3>SUBWIDGETS</H3>
148
<P>
149
<pre><code><code><code>
150
Name:           <B>cancel</B></I>
151
Class:          <B>Button</B></I>
152
</code></code></code></pre>
153
<UL>
154
The button widget with the "Cancel" label.
155
</UL>
156
<P>
157
<pre><code><code><code>
158
Name:           <B>dir</B></I>
159
Class:          <B>TixComboBox</B></I>
160
</code></code></code></pre>
161
<UL>
162
The ComboBox subwidget under the "Directories" heading.
163
</UL>
164
<P>
165
<pre><code><code><code>
166
Name:           <B>dirlist</B></I>
167
Class:          <B>TixDirList</B></I>
168
</code></code></code></pre>
169
<UL>
170
The DirList subwidget that shows the hierarchical list of directories.
171
</UL>
172
<P>
173
<pre><code><code><code>
174
Name:           <B>file</B></I>
175
Class:          <B>TixComboBox</B></I>
176
</code></code></code></pre>
177
<UL>
178
The ComboBox subwidget under the "Files" heading.
179
</UL>
180
<P>
181
<pre><code><code><code>
182
Name:           <B>filelist</B></I>
183
Class:          <B>TixScrolledListBox</B></I>
184
</code></code></code></pre>
185
<UL>
186
The ScrolledListBox subwidget that shows the list of filenames.
187
</UL>
188
<P>
189
<pre><code><code><code>
190
Name:           <B>hidden</B></I>
191
Class:          <B>Checkbutton</B></I>
192
</code></code></code></pre>
193
<UL>
194
The checkbutton widget with the "Show Hidden Files" label.
195
</UL>
196
<P>
197
<pre><code><code><code>
198
Name:           <B>ok</B></I>
199
Class:          <B>Button</B></I>
200
</code></code></code></pre>
201
<UL>
202
The button widget with the "OK" label.
203
</UL>
204
<P>
205
<pre><code><code><code>
206
Name:           <B>types</B></I>
207
Class:          <B>TixComboBox</B></I>
208
</code></code></code></pre>
209
<UL>
210
The ComboBox subwidget under the "List Files of Type" heading.
211
</UL>
212
</pre><HR>
213
</pre><H3>DESCRIPTION</H3>
214
<P>
215
The <B>tixExFileSelectBox</B></I> command creates a new window (given by
216
the <I>pathName</I></B> argument) and makes it into a
217
ExFileSelectBox widget. Additional options, described above,
218
may be specified on the command line or in the option database to
219
configure aspects of the ExFileSelectBox such as its cursor
220
and relief.
221
 
222
The ExFileSelectBox widget is usually embedded in a
223
tixExFileSelectDialog widget. It provides an convenient method for the
224
user to select files. The style of the ExFileSelectBox widget is very
225
similar to the standard file dialog in MS Windows 3.1.
226
</pre><H3>WIDGET COMMANDS</H3>
227
<P>
228
The <B>tixExFileSelectBox</B></I> command creates a new Tcl command whose
229
window. This command may be used to invoke various operations on the
230
widget. It has the following general form:
231
<pre>
232
<I>pathName option </I></B>?<I>arg arg ...</I></B>?
233
<P>
234
</pre>
235
<I>PathName</I></B> is the name of the command, which is the same as the
236
<I>arg</I></B>s determine the exact behavior of the command. The following
237
commands are possible for ExFileSelectBox widgets:
238
<DL>
239
<DT> <I>pathName <B>cget</B></I> <I>option</I></B>
240
</I></B>
241
<DD> Returns the current value of the configuration option given by
242
<I>option</I></B>. <I>Option</I></B> may have any of the values accepted by the
243
<B>tixExFileSelectBox</B></I> command.
244
</DL>
245
<DL>
246
<DT> <I>pathName <B>configure</B></I> ?<I>option</I></B>? <I>?value option value ...</I></B>?
247
</I></B>
248
<DD> Query or modify the configuration options of the widget.  If no
249
<I>option</I></B> is specified, returns a list describing all of the
250
available options for <I>pathName</I></B> (see <B>Tk_ConfigureInfo</B></I> for
251
information on the format of this list).  If <I>option</I></B> is specified
252
with no <I>value</I></B>, then the command returns a list describing the
253
one named option (this list will be identical to the corresponding
254
sublist of the value returned if no <I>option</I></B> is specified).  If
255
one or more <I>option-value</I></B> pairs are specified, then the command
256
modifies the given widget option(s) to have the given value(s); in
257
this case the command returns an empty string.  <I>Option</I></B> may have
258
any of the values accepted by the <B>tixExFileSelectBox</B></I> command.
259
</DL>
260
<DL>
261
<DT> <I>pathName <B>filter</B></I>
262
</I></B>
263
<DD> Forces the ExFileSelectBox widget to re-filter all the filenames
264
according to the <B>-pattern</B></I> option.
265
</DL>
266
<DL>
267
<DT> <I>pathName <B>invoke</B></I>
268
</I></B>
269
<DD> Forces the ExFileSelectBox widget to perform actions as if the user
270
has pressed the "OK" button.
271
</DL>
272
<DL>
273
<DT> <I>pathName <B>subwidget <I> name ?args?</I></B>
274
</I></B>
275
<DD> When no options are given, this command returns the pathname of the
276
subwidget of the specified name.
277
 
278
When options are given, the widget command of the specified subwidget
279
will be called with these options.
280
</DL>
281
</pre><H3>KEYWORDS</H3>
282
Tix(n)
283
<hr><i>Last modified Sun Jan 19 22:34:23 EST 1997 </i> ---
284
<i>Serial 853731298</i>

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.