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

Subversion Repositories or1k

[/] [or1k/] [trunk/] [insight/] [tix/] [man/] [BtnBox.n] - Blame information for rev 1765

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 578 markom
'\"
2
'\" Copyright (c) 1996, Expert Interface Technologies
3
'\"
4
'\" See the file "license.terms" for information on usage and redistribution
5
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
6
'\"
7
'\" The file man.macros and some of the macros used by this file are
8
'\" copyrighted: (c) 1990 The Regents of the University of California.
9
'\"              (c) 1994-1995 Sun Microsystems, Inc.
10
'\" The license terms of the Tcl/Tk distrobution are in the file
11
'\" license.tcl.
12
.so man.macros
13
'----------------------------------------------------------------------
14
.HS tixButtonBox tix 4.0
15
.BS
16
'
17
'
18
'----------------------------------------------------------------------
19
.SH NAME
20
tixButtonBox \- Create and manipulate Tix ButtonBox widgets
21
'
22
'
23
'
24
'----------------------------------------------------------------------
25
.SH SYNOPSIS
26
\fBtixButtonBox\fI \fIpathName ?\fIoptions\fR?
27
'
28
'
29
'
30
'----------------------------------------------------------------------
31
.SH "STANDARD OPTIONS"
32
.LP
33
.nf
34
.ta 4c 8c 12c
35
\fB
36
'
37
anchor  background      cursor
38
relief  borderWidth
39
'
40
\fR
41
.ta 4c
42
.fi
43
.LP
44
See the \fBoptions(n)\fR manual entry for details on the standard options.
45
'
46
'
47
'----------------------------------------------------------------------
48
.SH "WIDGET-SPECIFIC OPTIONS"
49
'
50
'
51
'----------BEGIN
52
.LP
53
.nf
54
Name:           \fBorientation\fR
55
Class:          \fBOrientation\fR
56
Switch:         \fB\-orientation\fR
57
Alias:          \fB\-orient\fR
58
.fi
59
.IP
60
\fBStatic Option\fR. Specifies the orientation of the button
61
subwidgets. Only the values "horizontal" and "vertical" are recognized.
62
'----------END
63
'
64
'----------BEGIN
65
.LP
66
.nf
67
Name:           \fBpadx\fR
68
Class:          \fBPad\fR
69
Switch:         \fB\-padx\fR
70
.fi
71
.IP
72
Specifies the horizontal padding between two neighboring button
73
subwidgets in the ButtonBox widget.
74
'----------END
75
 
76
'----------BEGIN
77
.LP
78
.nf
79
Name:           \fBpady\fR
80
Class:          \fBPad\fR
81
Switch:         \fB\-pady\fR
82
.fi
83
.IP
84
Specifies the vertical padding between two neighboring button
85
subwidgets in the ButtonBox widget.
86
'----------END
87
'
88
'----------BEGIN
89
.LP
90
.nf
91
Name:           \fBstate\fR
92
Class:          \fBState\fR
93
Switch:         \fB\-state\fR
94
.fi
95
.IP
96
Specifies the state of all the buttons inside the ButtonBox widget.
97
 
98
\fINote\fR:
99
Setting this option using the \fIconfig\fR widget command will enable
100
or disable all the buttons subwidgets. Original states of the
101
individual buttons are \fInot\fR saved. Only the values "normal" and
102
"disabled" are recognized.
103
'----------END
104
'
105
'----------------------------------------------------------------------
106
.SH SUBWIDGETS
107
.PP
108
'
109
All the button subwidgets created as a result of the \fBadd\fR command
110
can be accessed by the \fBsubwidget\fR command. They are identified by
111
the \fBbuttonName\fR parameter to the \fBadd\fR command. Here is an
112
example:
113
.PP
114
.nf
115
        tixButtonBox .bbox
116
        pack .bbox
117
        .bbox add eat   -text Eat
118
        .bbox add sleep -text Sleep
119
        .bbox subwidget eat   config -fg green
120
        .bbox subwidget sleep config -fg red
121
.fi
122
.BE
123
'
124
'
125
'
126
'----------------------------------------------------------------------
127
.SH DESCRIPTION
128
'
129
.PP
130
'
131
The \fBtixButtonBox\fR command creates a new window (given by the
132
\fIpathName\fR argument) and makes it into a ButtonBox
133
widget. Additional options, described above, may be specified on the
134
command line or in the option database to configure aspects of the
135
ButtonBox such as its cursor and relief.
136
'
137
.PP
138
The ButtonBox widget can be used as a container widget to hold the
139
``action'' buttons in a dialog box.
140
'
141
'----------------------------------------------------------------------
142
.SH "WIDGET COMMAND"
143
.PP
144
'
145
The \fBtixButtonBox\fR command creates a new Tcl command whose name is
146
the same as the path name of the ButtonBox's window. This command may
147
be used to invoke various operations on the widget. It has the
148
following general form:
149
'
150
.DS C
151
'
152
\fIpathName option \fR?\fIarg arg ...\fR?
153
 
154
.DE
155
'
156
\fIPathName\fR is the name of the command, which is the same as
157
the ButtonBox widget's path name.  \fIOption\fR and the \fIarg\fRs
158
determine the exact behavior of the command.  The following
159
commands are possible for ButtonBox widgets:
160
'
161
.TP
162
'
163
\fIpathName \fBadd \fIbuttonName \fR?\fIoption value ...\fR?
164
'
165
Add a new button subwidget with the name \fIbuttonName\fR into
166
the ButtonBox widget. Additional configuration options can be given to
167
configure the new button subwidget.
168
'
169
.TP
170
\fIpathName \fBcget\fR \fIoption\fR
171
'
172
Returns the current value of the configuration option given by
173
\fIoption\fR. \fIOption\fR may have any of the values accepted by the
174
\fBtixButtonBox\fR command.
175
'
176
.TP
177
'
178
\fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
179
'
180
Query or modify the configuration options of the widget.  If no
181
\fIoption\fR is specified, returns a list describing all of the
182
available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
183
information on the format of this list). If \fIoption\fR is specified
184
with no \fIvalue\fR, then the command returns a list describing the
185
one named option (this list will be identical to the corresponding
186
sublist of the value returned if no \fIoption\fR is specified).  If
187
one or more \fIoption\-value\fR pairs are specified, then the command
188
modifies the given widget option(s) to have the given value(s); in
189
this case the command returns an empty string. \fIOption\fR may have
190
any of the values accepted by the \fBtixButtonBox\fR command.
191
'
192
'
193
.TP
194
\fIpathName \fBinvoke \fIbuttonName\fR
195
'
196
Invoke the button subwidget with the name \fRbuttonName\fR.
197
'
198
.TP
199
'
200
\fIpathName \fBsubwidget \fI name ?args?\fR
201
'
202
When no additional arguments are given, returns the pathname of the
203
subwidget of the specified name.
204
 
205
When no additional arguments are given, the widget command of the
206
specified subwidget will be called with these parameters.
207
'
208
'----------------------------------------------------------------------
209
.SH BINDINGS
210
.PP
211
TixButtonBox widgets have no default bindings. The button subwidgets
212
retain their default Tk bindings.
213
'
214
'
215
'
216
'
217
'----------------------------------------------------------------------
218
.SH KEYWORDS
219
Tix(n), Container Widgets

powered by: WebSVN 2.1.0

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