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

Subversion Repositories or1k

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

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 578 markom
 
2
 
3
 
4
<TITLE>tixListNoteBook - Create and manipulate tixListNoteBook widgets</TITLE>
5
<Center><H2>tixListNoteBook - Create and manipulate tixListNoteBook widgets</H2></Center><hr>
6
 
7
</pre><H3>SYNOPSIS</H3>
8
<B>tixListNoteBook<I> <I>pathName ?<I>options</I></B>?
9
</pre><H3>STANDARD OPTIONS</H3>
10
The ListNoteBook widget supports all the standard options of a frame widget.
11
See the options(n) manual entry for details on the standard options.
12
</pre><H3>WIDGET-SPECIFIC OPTIONS</H3>
13
<P>
14
<pre><code><code><code>
15
Name:           <B>dynamicGeometry</B></I>
16
Class:          <B>DynamicGeometry</B></I>
17
Switch:         <B>-dynamicgeometry</B></I>
18
</code></code></code></pre>
19
<UL>
20
If set to false, the size of the ListNotebook will match the size of the
21
largest page. If set to true, the size of the ListNotebook will match the
22
size of the current page (therefore, the size may change when the user
23
selects different pages). The default value is false. A setting of true
24
is discouraged.
25
</UL>
26
<P>
27
<pre><code><code><code>
28
Name:           <B>ipadX</B></I>
29
Class:          <B>Pad</B></I>
30
Switch:         <B>-ipadx</B></I>
31
</code></code></code></pre>
32
<UL>
33
The amount of internal horizontal paddings around the sides of the
34
page subwidgets.
35
</UL>
36
<P>
37
<pre><code><code><code>
38
Name:           <B>ipadY</B></I>
39
Class:          <B>Pad</B></I>
40
Switch:         <B>-ipady</B></I>
41
</code></code></code></pre>
42
<UL>
43
The amount of internal vertical paddings around the sides of the
44
page subwidgets.
45
</UL>
46
</pre><H3>SUBWIDGETS</H3>
47
<P>
48
<pre><code><code><code>
49
Name:           <B>hlist</B></I>
50
Class:          <B>TixHList</B></I>
51
</code></code></code></pre>
52
<UL>
53
The HList widget that displays the names of the pages.
54
</UL>
55
<P>
56
In addition, all the page subwidgets created as a result of the
57
<B>add</B></I> command can be accessed by the <B>subwidget</B></I> command. They
58
are identified by the <B>pageName</B></I> parameter to the <B>add</B></I>
59
command.
60
</pre><HR>
61
</pre><H3>DESCRIPTION</H3>
62
<P>
63
The <B>tixListNoteBook</B></I> command creates a new window (given by the
64
<I>pathName</I></B> argument) and makes it into a ListNoteBook widget.
65
Additional options, described above, may be specified on the command
66
line or in the option database to configure aspects of the
67
ListNoteBook widget such as its cursor and relief.
68
 
69
The ListNoteBook widget is very similar to the TixNoteBook widget: it
70
can be used to display many windows in a limited space using a
71
"notebook" metaphore. The notebook is divided into a stack of pages
72
(windows). At one time only one of these pages can be shown. The user
73
can navigate through these pages by choosing the name of the desired
74
page in the <B>hlist</B></I> subwidget.
75
</pre><H3>WIDGET COMMANDS</H3>
76
<P>
77
The <B>tixListNoteBook</B></I> command creates a new Tcl command whose name is
78
command may be used to invoke various operations on the widget. It has
79
the following general form:
80
<pre>
81
<I>pathName option </I></B>?<I>arg arg ...</I></B>?
82
<P>
83
</pre>
84
<I>PathName</I></B> is the name of the command, which is the same as the
85
determine the exact behavior of the command. The following commands
86
are possible for ListNoteBook widgets:
87
<DL>
88
<DT> <I>pathName <B>add<I> pageName </I></B>?<I>option value ...</I></B>?
89
</I></B>
90
<DD> Adds a new ListNotebook page subwidget into the ListNoteBook widget.
91
<I>pageName</I></B> must be the name of an existing entry of the
92
<B>hlist</B></I> subwidget. You must create the entry before calling the
93
<B>add</B></I> command. Please refer to the <B>tixHList(n)</B></I> manual entry
94
for adding entries in an HList widget.
95
 
96
Additional parameters may be supplied to configure this page
97
subwidget. Possible options are:
98
</DL>
99
<UL>
100
<DL>
101
<DT> <B>-createcmd</B></I>
102
</I></B>
103
<DD> Specifies a TCL command to be called the first time a page is shown on
104
the screen. This option can be used to delay the creation of the
105
contents of a page until necessary. Therefore, it can be used to speed
106
up interface creation process especially when there are a large number
107
of pages in a ListNoteBook widget.
108
</DL>
109
<DL>
110
<DT> <B>-raisecmd</B></I>
111
</I></B>
112
<DD> Specifies a TCL command to be called whenever this page is raised by
113
the user.
114
</DL>
115
</UL>
116
When successful, this command returns the pathname of the newly
117
created page.
118
<DL>
119
<DT> <I>pathName <B>cget</B></I> <I>option</I></B>
120
</I></B>
121
<DD> Returns the current value of the configuration option given by
122
<I>option</I></B>.<I>Option</I></B> may have any of the values accepted by the
123
<B>tixListNoteBook</B></I> command.
124
</DL>
125
<DL>
126
<DT> <I>pathName <B>configure</B></I> ?<I>option</I></B>? <I>?value option value ...</I></B>?
127
</I></B>
128
<DD> Query or modify the configuration options of the widget.  If no
129
<I>option</I></B> is specified, returns a list describing all of the
130
available options for <I>pathName</I></B> (see <B>Tk_ConfigureInfo</B></I> for
131
information on the format of this list). If <I>option</I></B> is specified
132
with no <I>value</I></B>, then the command returns a list describing the
133
one named option (this list will be identical to the corresponding
134
sublist of the value returned if no <I>option</I></B> is specified).  If
135
one or more <I>option-value</I></B> pairs are specified, then the command
136
modifies the given widget option(s) to have the given value(s); in
137
this case the command returns an empty string.  <I>Option</I></B> may have
138
any of the values accepted by the <B>tixListNoteBook</B></I> command.
139
</DL>
140
<DL>
141
<DT> <I>pathName <B>delete<I> pageName</I></B>?
142
</I></B>
143
<DD> Deletes the page identified by <I>pageName</I></B>.
144
</DL>
145
<DL>
146
<DT> <I>pathName <B>pagecget</B></I> <I>pageName option</I></B>
147
</I></B>
148
<DD> Returns the current value of the configuration option given by
149
<I>option</I></B> in the page given by <I>pageName</I></B>. <I>Option</I></B> may
150
have any of the values accepted by the <B>add</B></I> widget command.
151
</DL>
152
<DL>
153
<DT> <I>pathName <B>pageconfigure<I> pageName ?<I>option</I></B>? <I>?value ...</I></B>?
154
</I></B>
155
<DD> When no option is given, prints out the values of all options of this
156
page. If <I>option</I></B> is specified with no <I>value</I></B>, then the
157
command returns the current value of that option. If one or more
158
<I>option-value</I></B> pairs are specified, then the command modifies the
159
command returns an empty string. <I>Option</I></B> may be any of options
160
accepted by the <B>add</B></I> widget command.
161
</DL>
162
<DL>
163
<DT> <I>pathName <B>pages</B></I>
164
</I></B>
165
<DD> Returns a list of the names of all the pages.
166
</DL>
167
<DL>
168
<DT> <I>pathName <B>raise <I>pageName</I></B>
169
</I></B>
170
<DD> Raise the page identified by <I>pageName</I></B>.
171
</DL>
172
<DL>
173
<DT> <I>pathName <B>raised</B></I>
174
</I></B>
175
<DD> Returns the name of the currently raised page.
176
</DL>
177
<DL>
178
<DT> <I>pathName <B>subwidget <I> name ?args?</I></B>
179
</I></B>
180
<DD> When no options are given, this command returns the pathname of the
181
subwidget of the specified name.
182
 
183
When options are given, the widget command of the specified subwidget
184
will be called with these options.
185
</DL>
186
</pre><H3>EXAMPLE</H3>
187
<pre><code><code><code>
188
 tixListNoteBook .n; pack .n
189
 .n subwidget hlist add page1 -text "Page 1"
190
 .n subwidget hlist add page2 -text "Page 2"
191
 
192
 set page1 [.n add page1]
193
 set page2 [.n add page2]
194
 
195
 button $page1.b -text "On page1"
196
 button $page2.b -text "On page2"
197
 
198
 pack $page1.b
199
 pack $page2.b
200
 
201
 .n raise page2
202
</code></code></code></pre>
203
</pre><H3>BINDINGS</H3>
204
<P>
205
When the user activates an entry in the <B>hlist</B></I> subwidget, the
206
page associated with that entry will be raised to the front.  This can
207
be done by using the mouse or keyboard. The <I>hlist</I></B> subwidget
208
operates with its <B>-selectmode</B></I> option set to single. See the
209
event bindings of the HList widget for more details.
210
</pre><H3>KEYWORDS</H3>
211
Tix(n), tixHList(n)
212
<hr><i>Last modified Sun Jan 19 22:34:32 EST 1997 </i> ---
213
<i>Serial 853731302</i>

powered by: WebSVN 2.1.0

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