1tixDirList(n) Tix Built-In Commands tixDirList(n)
2
6 tixDirList - Create and manipulate tixDirList widgets
7
9 tixDirList pathName ?options?
10
12 The TixDirList class is derived from the TixScrolledHList class and
13 inherits all the commands, options and subwidgets of its super-class.
14
16 TixDirList supports all the standard options of a frame widget. See
17 the options(n) manual entry for details on the standard options.
18
20 [-browsecmd browseCmd] Specifies a command to call whenever the user
21 browses on a directory (usually by single-clicking on the name of the
22 directory). The command is called with one argument, the complete path‐
23 name of the directory. [-command command] Specifies the command to be
24 called when the user activates on a directory (usually by double-click‐
25 ing on the name of the directory). The command is called with one argu‐
26 ment, the complete pathname of the directory. [-dircmd dircmd] Speci‐
27 fies the TCL command to be called when a directory listing is needed
28 for a particular directory. If this option is not specified, by default
29 the DirList widget will attempt to read the directory as a Unix direc‐
30 tory. On special occasions, the application programmer may want to sup‐
31 ply a special method for reading directories: for example, when he
32 needs to list remote directories. In this case, the -dircmd option can
33 be used. The specified command accepts two arguments: the first is the
34 name of the directory to be listed; the second is a Boolean value indi‐
35 cating whether hidden sub-directories should be listed. This command
36 returns a list of names of the sub-directories of this directory. For
37 example:
38 proc read_dir {dir show_hidden} {
40 if {$dir == "C:\"} {
41 return {DOS NORTON WINDOWS}
42 } else {
43 return {}
44 } } [-disablecallback disableCallback] A boolean value indicating
45 whether callbacks should be disabled. When set to true, the TCL command
46 specified by the -command option is not executed when the -value of the
47 DirList widget changes. [-showhidden showHidden] Specifies whether
48 hidden directories should be shown. By default, a directory name start‐
49 ing with a period "." is considered as a hidden directory. This rule
50 can be overridden by supplying an alternative -dircmd option.
51 [-root root] Specifies the name of the root directory. Usually this is
52 "/" under Unix machines, but can be changed to "C:\" in DOS environ‐
53 ments. [-rootname rootName] Specifies a text string to display at the
54 root directory. If unspecified, the text string will be the same as the
55 string specified by -root.
56 Name: value
58 Class: Value
59 Switch: -value
60 Alias: -directory
61 Specifies the name of the current directory to be displayed in
63 the DirList widget.
64
66 Name: hlist
67 Class: TixHList
68 The hierarchical listbox that displays the directory listing.
70 Name: hsb
72 Class: Scrollbar
73 The horizontal scrollbar subwidget.
75 Name: vsb
77 Class: Scrollbar
78 The vertical scrollbar subwidget.
80
82 The tixDirList command creates a new window (given by the pathName
83 argument) and makes it into a DirList widget. Additional options,
84 described above, may be specified on the command line or in the option
85 database to configure aspects of the DirList such as its cursor and
86 relief.
87 The DirList widget displays a list view of a directory, its previous
89 directories and its sub-directories. The user can choose one of the
90 directories displayed in the list or change to another directory.
91
93 The tixDirList command creates a new Tcl command whose name is the same
94 as the path name of the DirList's window. This command may be used to
95 invoke various operations on the widget. It has the following general
96 form:
97 pathName option ?arg arg ...?
98 PathName is the name of the command, which is the same as the DirList
99 widget's path name. Option and the args determine the exact behavior of
100 the command. The following commands are possible for DirList widgets:
101 pathName cget option
103 Returns the current value of the configuration option given by
104 option. Option may have any of the values accepted by the
105 tixDirList command.
106 pathName chdir dir
108 Change the current directory to dir.
109 pathName configure ?option? ?value option value ...?
111 Query or modify the configuration options of the widget. If no
112 option is specified, returns a list describing all of the avail‐
113 able options for pathName (see Tk_ConfigureInfo for information
114 on the format of this list). If option is specified with no
115 value, then the command returns a list describing the one named
116 option (this list will be identical to the corresponding sublist
117 of the value returned if no option is specified). If one or
118 more option-value pairs are specified, then the command modifies
119 the given widget option(s) to have the given value(s); in this
120 case the command returns an empty string. Option may have any
121 of the values accepted by the tixDirList command.
122 pathName subwidget name ?args?
124 When no options are given, this command returns the pathname of
125 the subwidget of the specified name.
126 When options are given, the widget command of the specified sub‐
128 widget will be called with these options.
129
131 The mouse and keyboard bindings of the DirList widget are the same as
132 the bindings of the HList widget.
133
135 Tix(n)
136Tix 4.0 tixDirList(n)