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

Subversion Repositories or1k

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

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 578 markom
 
2
 
3
 
4
<TITLE>tixScrolledWindow - Create and manipulate Tix ScrolledWindow widgets</TITLE>
5
<Center><H2>tixScrolledWindow - Create and manipulate Tix ScrolledWindow widgets</H2></Center><hr>
6
 
7
</pre><H3>SYNOPSIS</H3>
8
<B>tixScrolledWindow<I> <I>pathName ?<I>options</I></B>?
9
</pre><H3>STANDARD OPTIONS</H3>
10
<P>
11
<pre><code><code><code>
12
<B>
13
anchor  background      cursor
14
relief  borderWidth
15
</B></I>
16
</code></code></code></pre>
17
<P>
18
See the <B>options(n)</B></I> manual entry for details on the standard options.
19
</pre><H3>WIDGET-SPECIFIC OPTIONS</H3>
20
<P>
21
<pre><code><code><code>
22
Name:           <B>height</B></I>
23
Class:          <B>Height</B></I>
24
Switch:         <B>-height</B></I>
25
</code></code></code></pre>
26
<UL>
27
Specifies the desired height for the window, in pixels.
28
</UL>
29
<P>
30
<pre><code><code><code>
31
Name:           <B>scrollbar</B></I>
32
Class:          <B>Scrollbar</B></I>
33
Switch:         <B>-scrollbar</B></I>
34
</code></code></code></pre>
35
<UL>
36
Specifies the display policy of the scrollbars. The following
37
values are recognized:
38
</UL>
39
<UL>
40
<DL>
41
<DT> <B>auto</B></I> </B></I>?<I>\+x</I></B>? </B></I>?<I>-x</I></B>? </B></I>?<I>\+y</I></B>? </B></I>?<I>-y</I></B>?
42
</I></B>
43
<DD> When <B>-scrollbar</B></I> is set to "<B>auto</B></I>", the scrollbars are
44
shown only when needed. Additional modifiers can be used to force a
45
scrollbar to be shown or hidden. For example, "<B>auto -y</B></I>" means
46
the horizontal scrollbar should be shown when needed but the vertical
47
scrollbar should always be hidden; "<B>auto +x</B></I>" means the vertical
48
scrollbar should be shown when needed but the horizontal scrollbar
49
should always be shown, and so on.
50
</DL>
51
<DL>
52
<DT> <B>both</B></I>
53
</I></B>
54
<DD> Both scrollbars are shown
55
</DL>
56
<DL>
57
<DT> <B>none</B></I>
58
</I></B>
59
<DD> The scrollbars are never shown.
60
</DL>
61
<DL>
62
<DT> <B>x</B></I>
63
</I></B>
64
<DD> Only the horizontal scrollbar is shown;
65
</DL>
66
<DL>
67
<DT> <B>y</B></I>
68
</I></B>
69
<DD> Only the vertical scrollbar is shown.
70
</DL>
71
</UL>
72
<P>
73
<pre><code><code><code>
74
Name:           <B>width</B></I>
75
Class:          <B>Width</B></I>
76
Switch:         <B>-width</B></I>
77
</code></code></code></pre>
78
<UL>
79
Specifies the desired width for the window, in pixels.
80
</UL>
81
<P>
82
<pre><code><code><code>
83
Name:           <B>xScrollIncrement</B></I>
84
Class:          <B>ScrollIncrement</B></I>
85
Switch:         <B>-xscrollincrement</B></I>
86
</code></code></code></pre>
87
<UL>
88
Specifies by how much the window should be scrolled in the horizontal
89
direction when the user presses the arrows in the horizontal
90
scrollbar. In Pixels.
91
</UL>
92
<P>
93
<pre><code><code><code>
94
Name:           <B>yScrollIncrement</B></I>
95
Class:          <B>ScrollIncrement</B></I>
96
Switch:         <B>-yscrollincrement</B></I>
97
</code></code></code></pre>
98
<UL>
99
Specifies by how much the window should be scrolled in the vertical
100
direction when the user presses the arrows in the horizontal
101
scrollbar. In pixels.
102
</UL>
103
</pre><H3>SUBWIDGETS</H3>
104
<P>
105
<pre><code><code><code>
106
Name:           <B>hsb</B></I>
107
Class:          <B>Scrollbar</B></I>
108
</code></code></code></pre>
109
<UL>
110
The horizontal scrollbar subwidget.
111
</UL>
112
<P>
113
<pre><code><code><code>
114
Name:           <B>window</B></I>
115
Class:          <B>Frame</B></I>
116
</code></code></code></pre>
117
<UL>
118
The frame subwidget which is scrolled by the ScrolledWindow widget.
119
</UL>
120
<P>
121
<pre><code><code><code>
122
Name:           <B>vsb</B></I>
123
Class:          <B>Scrollbar</B></I>
124
</code></code></code></pre>
125
<UL>
126
The vertical scrollbar subwidget.
127
</UL>
128
</pre><HR>
129
</pre><H3>DESCRIPTION</H3>
130
<P>
131
The <B>tixScrolledWindow</B></I> command creates a new window (given by the
132
<I>pathName</I></B> argument) and makes it into a ScrolledWindow widget.
133
Additional options, described above, may be specified on the command
134
line or in the option database to configure aspects of the
135
ScrolledWindow widget such as its cursor and relief.
136
</pre><H3>CREATING WIDGETS INSIDE A SCROLLEDWINDOW WIDGET</H3>
137
<P>
138
To create widgets inside a ScrolledWindow widget, one must create the
139
new widgets relative to the <B>window</B></I> subwidget and manage them
140
inside the <B>window</B></I> subwidget. An error will be generated if one
141
tries to create widgets as immediate children of the ScrolledWindow.
142
For example: the following is correct code, which creates new widgets
143
inside the window subwidget:
144
<P>
145
<pre><code><code><code>
146
    tixScrolledWindow .w; pack .w
147
    set f [.w subwidget window]
148
    button $f.b -text hi -width 40 -height 40
149
    pack $f.b
150
</code></code></code></pre>
151
<P>
152
The following example code is <I>incorrect</I></B> because it tries to
153
create immediate children of the ScrolledWindow <B>\.w</B></I>:
154
<P>
155
<pre><code><code><code>
156
    tixScrolledWindow .w; pack .w
157
    button .w.b -text hi -width 40 -height 40
158
    pack .w.b
159
</code></code></code></pre>
160
</pre><H3>WIDGET COMMANDS</H3>
161
<P>
162
The <B>tixScrolledWindow</B></I> command creates a new Tcl command whose
163
command may be used to invoke various
164
operations on the widget. It has the following general form:
165
<pre>
166
<I>pathName option </I></B>?<I>arg arg ...</I></B>?
167
 
168
</pre>
169
<I>PathName</I></B> is the name of the command, which is the same as
170
determine the exact behavior of the command.  The following
171
commands are possible for ScrolledWindow widgets:
172
<DL>
173
<DT> <I>pathName <B>cget</B></I> <I>option</I></B>
174
</I></B>
175
<DD> Returns the current value of the configuration option given by
176
<I>option</I></B>. <I>Option</I></B> may have any of the values accepted by the
177
<B>tixScrolledWindow</B></I> command.
178
</DL>
179
<DL>
180
<DT> <I>pathName <B>configure</B></I> ?<I>option</I></B>? <I>?value option value ...</I></B>?
181
</I></B>
182
<DD> Query or modify the configuration options of the widget.  If
183
no <I>option</I></B> is specified, returns a list describing all of the
184
available options for <I>pathName</I></B> (see <B>Tk_ConfigureInfo</B></I> for
185
information on the format of this list).  If <I>option</I></B> is specified
186
with no <I>value</I></B>, then the command returns a list describing the
187
one named option (this list will be identical to the corresponding
188
sublist of the value returned if no <I>option</I></B> is specified).  If
189
one or more <I>option-value</I></B> pairs are specified, then the command
190
modifies the given widget option(s) to have the given value(s); in
191
this case the command returns an empty string.  <I>Option</I></B> may have
192
any of the values accepted by the <B>tixScrolledWindow</B></I> command.
193
</DL>
194
<DL>
195
<DT> <I>pathName <B>subwidget <I> name ?args?</I></B>
196
</I></B>
197
<DD> When no additional arguments are given, returns the pathname of the
198
subwidget of the specified name.
199
 
200
When no additional arguments are given, the widget command of the
201
specified subwidget will be called with these parameters.
202
</DL>
203
</pre><H3>KEYWORDS</H3>
204
Tix(n)
205
<hr><i>Last modified Sun Jan 19 22:34:37 EST 1997 </i> ---
206
<i>Serial 853731304</i>

powered by: WebSVN 2.1.0

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