Initial commit of OpenSPARC T2 architecture model.
[OpenSPARC-T2-SAM] / sam-t2 / devtools / amd64 / html / python / lib / forms-objects.html
CommitLineData
920dae64
AT
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<html>
3<head>
4<link rel="STYLESHEET" href="lib.css" type='text/css' />
5<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
6<link rel='start' href='../index.html' title='Python Documentation Index' />
7<link rel="first" href="lib.html" title='Python Library Reference' />
8<link rel='contents' href='contents.html' title="Contents" />
9<link rel='index' href='genindex.html' title='Index' />
10<link rel='last' href='about.html' title='About this document...' />
11<link rel='help' href='about.html' title='About this document...' />
12<link rel="prev" href="form-objects.html" />
13<link rel="parent" href="module-fl.html" />
14<link rel="next" href="module-fl-constants.html" />
15<meta name='aesop' content='information' />
16<title>20.4.3 FORMS Objects</title>
17</head>
18<body>
19<DIV CLASS="navigation">
20<div id='top-navigation-panel' xml:id='top-navigation-panel'>
21<table align="center" width="100%" cellpadding="0" cellspacing="2">
22<tr>
23<td class='online-navigation'><a rel="prev" title="20.4.2 Form Objects"
24 href="form-objects.html"><img src='../icons/previous.png'
25 border='0' height='32' alt='Previous Page' width='32' /></A></td>
26<td class='online-navigation'><a rel="parent" title="20.4 fl "
27 href="module-fl.html"><img src='../icons/up.png'
28 border='0' height='32' alt='Up One Level' width='32' /></A></td>
29<td class='online-navigation'><a rel="next" title="20.5 FL "
30 href="module-fl-constants.html"><img src='../icons/next.png'
31 border='0' height='32' alt='Next Page' width='32' /></A></td>
32<td align="center" width="100%">Python Library Reference</td>
33<td class='online-navigation'><a rel="contents" title="Table of Contents"
34 href="contents.html"><img src='../icons/contents.png'
35 border='0' height='32' alt='Contents' width='32' /></A></td>
36<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
37 border='0' height='32' alt='Module Index' width='32' /></a></td>
38<td class='online-navigation'><a rel="index" title="Index"
39 href="genindex.html"><img src='../icons/index.png'
40 border='0' height='32' alt='Index' width='32' /></A></td>
41</tr></table>
42<div class='online-navigation'>
43<b class="navlabel">Previous:</b>
44<a class="sectref" rel="prev" href="form-objects.html">20.4.2 Form Objects</A>
45<b class="navlabel">Up:</b>
46<a class="sectref" rel="parent" href="module-fl.html">20.4 fl </A>
47<b class="navlabel">Next:</b>
48<a class="sectref" rel="next" href="module-fl-constants.html">20.5 FL </A>
49</div>
50<hr /></div>
51</DIV>
52<!--End of Navigation Panel-->
53
54<H2><A NAME="SECTION0022430000000000000000"></A>
55<A NAME="forms-objects"></A>
56<BR>
5720.4.3 FORMS Objects
58</H2>
59
60<P>
61Besides methods specific to particular kinds of FORMS objects, all
62FORMS objects also have the following methods:
63
64<P>
65<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
66 <td><nobr><b><tt id='l2h-5168' xml:id='l2h-5168' class="method">set_call_back</tt></b>(</nobr></td>
67 <td><var>function, argument</var>)</td></tr></table></dt>
68<dd>
69Set the object's callback function and argument. When the object
70needs interaction, the callback function will be called with two
71arguments: the object, and the callback argument. (FORMS objects
72without a callback function are returned by <tt class="function">fl.do_forms()</tt>
73or <tt class="function">fl.check_forms()</tt> when they need interaction.) Call this
74method without arguments to remove the callback function.
75</dl>
76
77<P>
78<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
79 <td><nobr><b><tt id='l2h-5169' xml:id='l2h-5169' class="method">delete_object</tt></b>(</nobr></td>
80 <td><var></var>)</td></tr></table></dt>
81<dd>
82 Delete the object.
83</dl>
84
85<P>
86<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
87 <td><nobr><b><tt id='l2h-5170' xml:id='l2h-5170' class="method">show_object</tt></b>(</nobr></td>
88 <td><var></var>)</td></tr></table></dt>
89<dd>
90 Show the object.
91</dl>
92
93<P>
94<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
95 <td><nobr><b><tt id='l2h-5171' xml:id='l2h-5171' class="method">hide_object</tt></b>(</nobr></td>
96 <td><var></var>)</td></tr></table></dt>
97<dd>
98 Hide the object.
99</dl>
100
101<P>
102<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
103 <td><nobr><b><tt id='l2h-5172' xml:id='l2h-5172' class="method">redraw_object</tt></b>(</nobr></td>
104 <td><var></var>)</td></tr></table></dt>
105<dd>
106 Redraw the object.
107</dl>
108
109<P>
110<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
111 <td><nobr><b><tt id='l2h-5173' xml:id='l2h-5173' class="method">freeze_object</tt></b>(</nobr></td>
112 <td><var></var>)</td></tr></table></dt>
113<dd>
114 Freeze the object.
115</dl>
116
117<P>
118<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
119 <td><nobr><b><tt id='l2h-5174' xml:id='l2h-5174' class="method">unfreeze_object</tt></b>(</nobr></td>
120 <td><var></var>)</td></tr></table></dt>
121<dd>
122 Unfreeze the object.
123</dl>
124
125<P>
126FORMS objects have these data attributes; see the FORMS documentation:
127
128<P>
129<div class="center"><table class="realtable">
130 <thead>
131 <tr>
132 <th class="left" >Name</th>
133 <th class="left" >C Type</th>
134 <th class="left" >Meaning</th>
135 </tr>
136 </thead>
137 <tbody>
138 <tr><td class="left" valign="baseline"><tt class="member">objclass</tt></td>
139 <td class="left" >int (read-only)</td>
140 <td class="left" >object class</td></tr>
141 <tr><td class="left" valign="baseline"><tt class="member">type</tt></td>
142 <td class="left" >int (read-only)</td>
143 <td class="left" >object type</td></tr>
144 <tr><td class="left" valign="baseline"><tt class="member">boxtype</tt></td>
145 <td class="left" >int</td>
146 <td class="left" >box type</td></tr>
147 <tr><td class="left" valign="baseline"><tt class="member">x</tt></td>
148 <td class="left" >float</td>
149 <td class="left" >x origin</td></tr>
150 <tr><td class="left" valign="baseline"><tt class="member">y</tt></td>
151 <td class="left" >float</td>
152 <td class="left" >y origin</td></tr>
153 <tr><td class="left" valign="baseline"><tt class="member">w</tt></td>
154 <td class="left" >float</td>
155 <td class="left" >width</td></tr>
156 <tr><td class="left" valign="baseline"><tt class="member">h</tt></td>
157 <td class="left" >float</td>
158 <td class="left" >height</td></tr>
159 <tr><td class="left" valign="baseline"><tt class="member">col1</tt></td>
160 <td class="left" >int</td>
161 <td class="left" >primary color</td></tr>
162 <tr><td class="left" valign="baseline"><tt class="member">col2</tt></td>
163 <td class="left" >int</td>
164 <td class="left" >secondary color</td></tr>
165 <tr><td class="left" valign="baseline"><tt class="member">align</tt></td>
166 <td class="left" >int</td>
167 <td class="left" >alignment</td></tr>
168 <tr><td class="left" valign="baseline"><tt class="member">lcol</tt></td>
169 <td class="left" >int</td>
170 <td class="left" >label color</td></tr>
171 <tr><td class="left" valign="baseline"><tt class="member">lsize</tt></td>
172 <td class="left" >float</td>
173 <td class="left" >label font size</td></tr>
174 <tr><td class="left" valign="baseline"><tt class="member">label</tt></td>
175 <td class="left" >string</td>
176 <td class="left" >label string</td></tr>
177 <tr><td class="left" valign="baseline"><tt class="member">lstyle</tt></td>
178 <td class="left" >int</td>
179 <td class="left" >label style</td></tr>
180 <tr><td class="left" valign="baseline"><tt class="member">pushed</tt></td>
181 <td class="left" >int (read-only)</td>
182 <td class="left" >(see FORMS docs)</td></tr>
183 <tr><td class="left" valign="baseline"><tt class="member">focus</tt></td>
184 <td class="left" >int (read-only)</td>
185 <td class="left" >(see FORMS docs)</td></tr>
186 <tr><td class="left" valign="baseline"><tt class="member">belowmouse</tt></td>
187 <td class="left" >int (read-only)</td>
188 <td class="left" >(see FORMS docs)</td></tr>
189 <tr><td class="left" valign="baseline"><tt class="member">frozen</tt></td>
190 <td class="left" >int (read-only)</td>
191 <td class="left" >(see FORMS docs)</td></tr>
192 <tr><td class="left" valign="baseline"><tt class="member">active</tt></td>
193 <td class="left" >int (read-only)</td>
194 <td class="left" >(see FORMS docs)</td></tr>
195 <tr><td class="left" valign="baseline"><tt class="member">input</tt></td>
196 <td class="left" >int (read-only)</td>
197 <td class="left" >(see FORMS docs)</td></tr>
198 <tr><td class="left" valign="baseline"><tt class="member">visible</tt></td>
199 <td class="left" >int (read-only)</td>
200 <td class="left" >(see FORMS docs)</td></tr>
201 <tr><td class="left" valign="baseline"><tt class="member">radio</tt></td>
202 <td class="left" >int (read-only)</td>
203 <td class="left" >(see FORMS docs)</td></tr>
204 <tr><td class="left" valign="baseline"><tt class="member">automatic</tt></td>
205 <td class="left" >int (read-only)</td>
206 <td class="left" >(see FORMS docs)</td></tr></tbody>
207</table></div>
208
209<P>
210
211<DIV CLASS="navigation">
212<div class='online-navigation'>
213<p></p><hr />
214<table align="center" width="100%" cellpadding="0" cellspacing="2">
215<tr>
216<td class='online-navigation'><a rel="prev" title="20.4.2 Form Objects"
217 href="form-objects.html"><img src='../icons/previous.png'
218 border='0' height='32' alt='Previous Page' width='32' /></A></td>
219<td class='online-navigation'><a rel="parent" title="20.4 fl "
220 href="module-fl.html"><img src='../icons/up.png'
221 border='0' height='32' alt='Up One Level' width='32' /></A></td>
222<td class='online-navigation'><a rel="next" title="20.5 FL "
223 href="module-fl-constants.html"><img src='../icons/next.png'
224 border='0' height='32' alt='Next Page' width='32' /></A></td>
225<td align="center" width="100%">Python Library Reference</td>
226<td class='online-navigation'><a rel="contents" title="Table of Contents"
227 href="contents.html"><img src='../icons/contents.png'
228 border='0' height='32' alt='Contents' width='32' /></A></td>
229<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
230 border='0' height='32' alt='Module Index' width='32' /></a></td>
231<td class='online-navigation'><a rel="index" title="Index"
232 href="genindex.html"><img src='../icons/index.png'
233 border='0' height='32' alt='Index' width='32' /></A></td>
234</tr></table>
235<div class='online-navigation'>
236<b class="navlabel">Previous:</b>
237<a class="sectref" rel="prev" href="form-objects.html">20.4.2 Form Objects</A>
238<b class="navlabel">Up:</b>
239<a class="sectref" rel="parent" href="module-fl.html">20.4 fl </A>
240<b class="navlabel">Next:</b>
241<a class="sectref" rel="next" href="module-fl-constants.html">20.5 FL </A>
242</div>
243</div>
244<hr />
245<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
246</DIV>
247<!--End of Navigation Panel-->
248<ADDRESS>
249See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
250</ADDRESS>
251</BODY>
252</HTML>