1tixCheckList(n) Tix Built-In Commands tixCheckList(n)
2
6 tixCheckList - Create and manipulate tixCheckList widgets
7
9 tixCheckList pathName ?options?
10
12 The TixCheckList class is derived from the TixTree class and inherits
13 all the commands, options and subwidgets of its super-class.
14
16 TixCheckList 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 an entry (usually by single-clicking on the entry). The com‐
22 mand is called with one argument, the pathname of the entry. [-com‐
23 mand command] Specifies a command to call whenever the user activates
24 an entry (usually by double-clicking on the entry). The command is
25 called with one argument, the pathname of the entry. [-radio radio] A
26 Boolean value. If set to true, the user can select at most one item at
27 a time; if set to false, the user can select as many items as possible.
28
30 Name: hlist
31 Class: TixHList
32 The hierarchical listbox that displays the CheckList.
34 Name: hsb
36 Class: Scrollbar
37 The horizontal scrollbar subwidget.
39 Name: vsb
41 Class: Scrollbar
42 The vertical scrollbar subwidget.
44
46 The tixCheckList command creates a new window (given by the pathName
47 argument) and makes it into a CheckList widget. Additional options,
48 described above, may be specified on the command line or in the option
49 database to configure aspects of the CheckList widget such as its cur‐
50 sor and relief.
51 The CheckList widget displays a list of items to be selected by the
53 user. CheckList acts similarly to the Tk checkbutton or radiobutton
54 widgets, except it is capable of handling many more items than check‐
55 buttons or radiobuttons.
56 The items are contained in the hlist subwidget. Each item may be in
58 one of the following status: on (indicated by a check bitmap), off
59 (indicated by a cross bitmap) default (indicated by a gray box bitmap)
60 or none, in which case the item will not be accompanied by a bitmap.
61 The items whose status is on, off or default are called the selectable
62 items and can be checked or crossed by the user. All selectable entries
63 must be of the type imagetext.
64 The items whose status is none cannot be checked or crossed by the
66 user; usually they are included in the hlist subwidget only for expla‐
67 nation purposes or as separators.
68 Initially, all the items have a none status. To make an item
70 selectable, you can call the setstatus command to change its status
71 (see below).
72 Notice that CheckList is a subclass of the TixTree widget and thus is
74 is capable of displaying a hierachy of selectable entries. When neces‐
75 sary, you can call the setmode method (see TixTree(n)) to define the
76 hierachical structure of the selectable entries.
77
79 The tixCheckList command creates a new Tcl command whose name is the
80 same as the path name of the CheckList's window. This command may be
81 used to invoke various operations on the widget. It has the following
82 general form:
83 pathName option ?arg arg ...?
84 PathName is the name of the command, which is the same as the CheckList
85 widget's path name. Option and the args determine the exact behavior of
86 the command. The following commands are possible for CheckList widgets:
87 pathName getselection ?status?
89 Returns a list of items whose status matches status. If status
90 is not specified, the list of items in the "on" status will be
91 returned.
92 pathName getstatus entryPath
94 Returns the current status of entryPath.
95 pathName setstatus entryPath status
97 Sets the status of entryPath to be status. A bitmap will be dis‐
98 played next to the entry its status is on, off or default.
99 pathName subwidget name ?args?
101 When no options are given, this command returns the pathname of
102 the subwidget of the specified name.
103 When options are given, the widget command of the specified sub‐
105 widget will be called with these options.
106
108 This example creates several choices for the user to select.
109 set c [tixCheckList .c] $c subwidget hlist add choice1 -itemtype image‐
111 text -text Choice1 $c subwidget hlist add choice2 -itemtype imagetext
112 -text Choice2 $c subwidget hlist add choice3 -itemtype imagetext -text
113 Choice3 $c setstatus choice1 on $c setstatus choice2 off $c setstatus
114 choice3 off pack $c
115
117 The basic mouse and keyboard bindings of the CheckList widget are the
118 same as the bindings of the TixTree widget.
119 In addition, the status of the entries in the CheckList are toggled
121 under the following conditions:
122 [1] When the user press the mouse button over an entry.
124 [2] When the user press the <space> key over an entry.
126 [3] When the user press the <Return> key over an entry.
128
130 Tix(n), tixHList(n), tixTree(n)
131Tix 4.0 tixCheckList(n)