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

Subversion Repositories or1k

[/] [or1k/] [trunk/] [insight/] [itcl/] [iwidgets3.0.0/] [demos/] [html/] [radiobox.n.html] - Blame information for rev 1770

Go to most recent revision | Details | Compare with Previous | View Log

Line No. Rev Author Line
1 578 markom
<HTML>
2
<HEAD>
3
<TITLE>iwidgets2.2.0 User Commands - radiobox</TITLE>
4
</HEAD>
5
<BODY BGCOLOR="#FFFFFF">
6
<H1>iwidgets2.2.0 User Commands - radiobox</H1>
7
<HR>
8
<PRE>
9
 
10
</PRE>
11
<H2><HR ALIGN=LEFT WIDTH=70% SIZE=3></H2><PRE>
12
 
13
 
14
</PRE>
15
<H2>NAME</H2><PRE>
16
     radiobox - Create and manipulate a radiobox widget
17
 
18
 
19
</PRE>
20
<H2>SYNOPSIS</H2><PRE>
21
     <STRONG>radiobox</STRONG> <EM>pathName</EM> ?<EM>options</EM>?
22
 
23
 
24
</PRE>
25
<H2>INHERITANCE</H2><PRE>
26
     itk::Widget &lt;- labeledwidget &lt;- radiobox
27
 
28
 
29
</PRE>
30
<H2>STANDARD OPTIONS</H2><PRE>
31
     <STRONG>background</STRONG>      <STRONG>borderWidth</STRONG>    <STRONG>cursor</STRONG>          <STRONG>foreground</STRONG>
32
     <STRONG>relief</STRONG>
33
 
34
     See the "options" manual entry for details on  the  standard
35
     options.
36
 
37
 
38
</PRE>
39
<H2>INHERITED OPTIONS</H2><PRE>
40
     <STRONG>labelBitmap</STRONG>     <STRONG>labelFont</STRONG>      <STRONG>labelImage</STRONG>      <STRONG>labelMargin</STRONG>
41
     <STRONG>labelPos</STRONG>        <STRONG>labelText</STRONG>      <STRONG>labelVariable</STRONG>
42
 
43
     See the "labeledwidget" class manual entry  for  details  on
44
     the inherited options.
45
 
46
 
47
</PRE>
48
<H2>WIDGET-SPECIFIC OPTIONS</H2><PRE>
49
     Name:   <STRONG>command</STRONG>
50
     Class:  <STRONG>Command</STRONG>
51
     Command-Line Switch:    <STRONG>-command</STRONG>
52
 
53
          Specifies a Tcl command procedure to be evaluated  fol-
54
          lowing a  change in the current radio box selection.
55
 
56
 
57
</PRE>
58
<H2><HR ALIGN=LEFT WIDTH=70% SIZE=3></H2><PRE>
59
 
60
 
61
 
62
</PRE>
63
<H2>DESCRIPTION</H2><PRE>
64
     The <STRONG>radiobox</STRONG> command creates a radio button box widget capa-
65
     ble of adding, inserting, deleting, selecting, and configur-
66
     ing radiobuttons as well as obtaining the currently selected
67
     button.
68
 
69
 
70
 
71
</PRE>
72
<H2>METHODS</H2><PRE>
73
     The <STRONG>radiobox</STRONG> command creates a new Tcl command whose name is
74
     <EM>pathName</EM>.  This command may be used to invoke various opera-
75
     tions on the widget.  It has the following general form:
76
 
77
          <EM>pathName</EM> <EM>option</EM> ?<EM>arg</EM> <EM>arg</EM> ...?
78
 
79
     <EM>Option</EM> and the <EM>arg</EM>s determine the exact behavior of the com-
80
     mand.
81
     Many of the widget commands for the  <STRONG>radiobox</STRONG>  take  as  one
82
     argument  an  indicator of which radiobutton of the radiobox
83
     to operate on.  These  indicators  are  called  <EM>indexes</EM>  and
84
     allow  reference and manipulation of radiobuttons.  Radiobox
85
     indexes may be specified in any of the following forms:
86
 
87
     <EM>number</EM>      Specifies the radiobutton numerically,  where  0
88
                 corresponds   to  the  top  radiobutton  of  the
89
                 radiobox.
90
 
91
     <STRONG>end</STRONG>         Indicates the last radiobutton of the radiobox.
92
 
93
     <EM>pattern</EM>     If the index doesn't satisfy one  of  the  above
94
                 forms  then  this  form  is  used.   <EM>Pattern</EM>  is
95
                 pattern-matched  against   the   tag   of   each
96
                 radiobutton  in  the radiobox, in order from top
97
                 to bottom, until a matching entry is found.  The
98
                 rules of <STRONG>Tcl_StringMatch</STRONG> are used.
99
 
100
 
101
 
102
</PRE>
103
<H2>WIDGET-SPECIFIC METHODS</H2><PRE>
104
     <EM>pathName</EM> <STRONG>add</STRONG> <EM>tag</EM> ?<EM>option</EM> <EM>value</EM> <EM>option</EM> <EM>value</EM>?
105
          Adds a new radiobutton to the  radiobuttond  window  on
106
          the bottom.  The command takes additional options which
107
          are passed on to the radiobutton as construction  argu-
108
          ments.   These  include  the  standard  Tk  radiobutton
109
          options.  The tag is returned.
110
 
111
     <EM>pathName</EM> <STRONG>buttonconfigure</STRONG> <EM>index</EM> ?<EM>options</EM>?
112
          This command  is  similar  to  the  <STRONG>configure</STRONG>  command,
113
          except that it applies to the options for an individual
114
          radiobutton, whereas <STRONG>configure</STRONG>applies  to  the  options
115
          for  the  radiobox as a whole.  <EM>Options</EM> may have any of
116
          the values accepted by  the  <STRONG>add</STRONG>  widget  command.   If
117
          <EM>options</EM>  are  specified,  options are modified as indi-
118
          cated in the command and the command returns  an  empty
119
          string.   If  no  <EM>options</EM> are specified, returns a list
120
          describing the current options  for  entry  <EM>index</EM>  (see
121
          <STRONG>Tk_ConfigureInfo</STRONG>  for information on the format of this
122
          list).
123
 
124
     <EM>pathName</EM> <STRONG>cget</STRONG> <EM>option</EM>
125
          Returns the current value of the  configuration  option
126
          given  by  <EM>option</EM>.   <EM>Option</EM>  may have any of the values
127
          accepted by the <STRONG>radiobox</STRONG> command.
128
 
129
     <EM>pathName</EM> <STRONG>configure</STRONG> ?<EM>option</EM>? ?<EM>value</EM> <EM>option</EM> <EM>value</EM> ...?
130
          Query  or  modify  the  configuration  options  of  the
131
          widget.   If  no  <EM>option</EM>  is  specified, returns a list
132
          describing all of the available  options  for  <EM>pathName</EM>
133
          (see  <STRONG>Tk_ConfigureInfo</STRONG> for information on the format of
134
          this list).  If <EM>option</EM> is specified with no <EM>value</EM>, then
135
          the  command  returns  a  list describing the one named
136
          option (this list will be identical to the  correspond-
137
          ing  sublist  of  the  value  returned  if no <EM>option</EM> is
138
          specified).  If one or more  <EM>option</EM> - <EM>value</EM>  pairs  are
139
          specified,  then  the command modifies the given widget
140
          option(s) to have the given value(s);  in this case the
141
          command  returns  an empty string.  <EM>Option</EM> may have any
142
          of the values accepted by the <STRONG>radiobox</STRONG> command.
143
 
144
     <EM>pathName</EM> <STRONG>delete</STRONG> <EM>index</EM>
145
          Deletes a specified radiobutton given an <EM>index</EM>.
146
 
147
     <EM>pathName</EM> <STRONG>deselect</STRONG> <EM>index</EM>
148
          Deselects a specified radiobutton given an <EM>index</EM>.
149
 
150
     <EM>pathName</EM> <STRONG>flash</STRONG> <EM>index</EM>
151
          Flashes a specified radiobutton given an <EM>index</EM>.
152
 
153
     <EM>pathName</EM> <STRONG>get</STRONG>
154
          Returns the tag of the currently selected radiobutton.
155
 
156
     <EM>pathName</EM> <STRONG>index</STRONG> <EM>index</EM>
157
          Returns the numerical index corresponding to index.
158
 
159
     <EM>pathName</EM> <STRONG>insert</STRONG> <EM>index</EM> <EM>tag</EM> ?<EM>option</EM> <EM>value</EM> <EM>option</EM> <EM>value</EM> ...?
160
          Same as the <STRONG>add</STRONG> command except that it inserts the  new
161
          radiobutton just before the one given by <EM>index</EM>, instead
162
          of appending to the end of the radiobox.   The  <EM>option</EM>,
163
          and <EM>value</EM> arguments have the same interpretation as for
164
          the <STRONG>add</STRONG> widget command.
165
 
166
     <EM>pathName</EM> <STRONG>select</STRONG> <EM>index</EM>
167
          Selects a specified radiobutton given an <EM>index</EM>.
168
 
169
 
170
 
171
</PRE>
172
<H2>EXAMPLE</H2><PRE>
173
           radiobox .rb -labeltext Fonts
174
           .rb add times -text Times
175
           .rb add helvetica -text Helvetica
176
           .rb add courier -text Courier
177
           .rb add symbol -text Symbol
178
           .rb select courier
179
 
180
           pack .rb -padx 10 -pady 10 -fill both -expand yes
181
 
182
 
183
 
184
 
185
</PRE>
186
<H2>AUTHOR</H2><PRE>
187
     Michael J. McLennan
188
 
189
     Mark L. Ulferts
190
 
191
 
192
</PRE>
193
<H2>KEYWORDS</H2><PRE>
194
     radiobox, widget
195
 
196
 
197
 
198
 
199
 
200
 
201
 
202
 
203
 
204
 
205
 
206
 
207
 
208
 
209
 
210
 
211
 
212
 
213
 
214
 
215
 
216
 
217
 
218
 
219
 
220
 
221
 
222
 
223
 
224
 
225
 
226
 
227
 
228
 
229
 
230
 
231
 
232
 
233
 
234
 
235
 
236
 
237
 
238
 
239
 
240
 
241
 
242
 
243
 
244
 
245
</PRE>
246
</BODY>
247
</HTML>

powered by: WebSVN 2.1.0

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