<!DOCTYPE html PUBLIC
"-//W3C//DTD HTML 4.0 Transitional//EN">
<link rel=
"STYLESHEET" href=
"lib.css" type='text/css'
/>
<link rel=
"SHORTCUT ICON" href=
"../icons/pyfav.png" type=
"image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index'
/>
<link rel=
"first" href=
"lib.html" title='Python Library Reference'
/>
<link rel='contents' href='contents.html'
title=
"Contents" />
<link rel='index' href='genindex.html' title='Index'
/>
<link rel='last' href='about.html' title='About this document...'
/>
<link rel='help' href='about.html' title='About this document...'
/>
<link rel=
"next" href=
"forms-objects.html" />
<link rel=
"prev" href=
"node807.html" />
<link rel=
"parent" href=
"module-fl.html" />
<link rel=
"next" href=
"forms-objects.html" />
<meta name='aesop' content='information'
/>
<title>20.4.2 Form Objects
</title>
<div id='top-navigation-panel' xml:id='top-navigation-panel'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"20.4.1 Functions Defined in"
href=
"node807.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"20.4 fl "
href=
"module-fl.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"20.4.3 FORMS Objects"
href=
"forms-objects.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python Library Reference
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"node807.html">20.4.1 Functions Defined in
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"module-fl.html">20.4 fl
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"forms-objects.html">20.4.3 FORMS Objects
</A>
<!--End of Navigation Panel-->
<H2><A NAME=
"SECTION0022420000000000000000"></A>
<A NAME=
"form-objects"></A>
Form objects (returned by
<tt class=
"function">make_form()
</tt> above) have the
following methods. Each method corresponds to a C function whose
name is prefixed with
"<tt class="samp
">fl_</tt>"; and whose first argument is a form
pointer; please refer to the official FORMS documentation for
All the
<tt class=
"method">add_*()
</tt> methods return a Python object representing
the FORMS object. Methods of FORMS objects are described below. Most
kinds of FORMS object also have some methods specific to that kind;
these methods are listed here.
<DIV ALIGN=
"LEFT"></DIV><dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
5140' xml:id='l2h-
5140'
class=
"method">show_form
</tt></b>(
</nobr></td>
<td><var>placement, bordertype, name
</var>)
</td></tr></table></dt>
<DIV ALIGN=
"LEFT"></DIV><dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
5141' xml:id='l2h-
5141'
class=
"method">hide_form
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
<DIV ALIGN=
"LEFT"></DIV><dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
5142' xml:id='l2h-
5142'
class=
"method">redraw_form
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
<DIV ALIGN=
"LEFT"></DIV><dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
5143' xml:id='l2h-
5143'
class=
"method">set_form_position
</tt></b>(
</nobr></td>
<td><var>x, y
</var>)
</td></tr></table></dt>
<DIV ALIGN=
"LEFT"></DIV><dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
5144' xml:id='l2h-
5144'
class=
"method">freeze_form
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
<DIV ALIGN=
"LEFT"></DIV><dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
5145' xml:id='l2h-
5145'
class=
"method">unfreeze_form
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
<DIV ALIGN=
"LEFT"></DIV><dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
5146' xml:id='l2h-
5146'
class=
"method">activate_form
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
<DIV ALIGN=
"LEFT"></DIV><dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
5147' xml:id='l2h-
5147'
class=
"method">deactivate_form
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
<DIV ALIGN=
"LEFT"></DIV><dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
5148' xml:id='l2h-
5148'
class=
"method">bgn_group
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
Begin a new group of objects; return a group object.
<DIV ALIGN=
"LEFT"></DIV><dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
5149' xml:id='l2h-
5149'
class=
"method">end_group
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
End the current group of objects.
<DIV ALIGN=
"LEFT"></DIV><dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
5150' xml:id='l2h-
5150'
class=
"method">find_first
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
Find the first object in the form.
<DIV ALIGN=
"LEFT"></DIV><dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
5151' xml:id='l2h-
5151'
class=
"method">find_last
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
Find the last object in the form.
<DIV ALIGN=
"LEFT"></DIV><dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
5152' xml:id='l2h-
5152'
class=
"method">add_box
</tt></b>(
</nobr></td>
<td><var>type, x, y, w, h, name
</var>)
</td></tr></table></dt>
Add a box object to the form.
<DIV ALIGN=
"LEFT"></DIV><dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
5153' xml:id='l2h-
5153'
class=
"method">add_text
</tt></b>(
</nobr></td>
<td><var>type, x, y, w, h, name
</var>)
</td></tr></table></dt>
Add a text object to the form.
<DIV ALIGN=
"LEFT"></DIV><dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
5154' xml:id='l2h-
5154'
class=
"method">add_clock
</tt></b>(
</nobr></td>
<td><var>type, x, y, w, h, name
</var>)
</td></tr></table></dt>
Add a clock object to the form.
<tt class=
"method">get_clock()
</tt>.
<DIV ALIGN=
"LEFT"></DIV><dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
5155' xml:id='l2h-
5155'
class=
"method">add_button
</tt></b>(
</nobr></td>
<td><var>type, x, y, w, h, name
</var>)
</td></tr></table></dt>
Add a button object to the form.
<tt class=
"method">get_button()
</tt>,
<tt class=
"method">set_button()
</tt>.
<DIV ALIGN=
"LEFT"></DIV><dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
5156' xml:id='l2h-
5156'
class=
"method">add_lightbutton
</tt></b>(
</nobr></td>
<td><var>type, x, y, w, h, name
</var>)
</td></tr></table></dt>
Add a lightbutton object to the form.
<tt class=
"method">get_button()
</tt>,
<tt class=
"method">set_button()
</tt>.
<DIV ALIGN=
"LEFT"></DIV><dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
5157' xml:id='l2h-
5157'
class=
"method">add_roundbutton
</tt></b>(
</nobr></td>
<td><var>type, x, y, w, h, name
</var>)
</td></tr></table></dt>
Add a roundbutton object to the form.
<tt class=
"method">get_button()
</tt>,
<tt class=
"method">set_button()
</tt>.
<DIV ALIGN=
"LEFT"></DIV><dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
5158' xml:id='l2h-
5158'
class=
"method">add_slider
</tt></b>(
</nobr></td>
<td><var>type, x, y, w, h, name
</var>)
</td></tr></table></dt>
Add a slider object to the form.
<tt class=
"method">set_slider_value()
</tt>,
<tt class=
"method">get_slider_value()
</tt>,
<tt class=
"method">set_slider_bounds()
</tt>,
<tt class=
"method">get_slider_bounds()
</tt>,
<tt class=
"method">set_slider_return()
</tt>,
<tt class=
"method">set_slider_size()
</tt>,
<tt class=
"method">set_slider_precision()
</tt>,
<tt class=
"method">set_slider_step()
</tt>.
<DIV ALIGN=
"LEFT"></DIV><dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
5159' xml:id='l2h-
5159'
class=
"method">add_valslider
</tt></b>(
</nobr></td>
<td><var>type, x, y, w, h, name
</var>)
</td></tr></table></dt>
Add a valslider object to the form.
<tt class=
"method">set_slider_value()
</tt>,
<tt class=
"method">get_slider_value()
</tt>,
<tt class=
"method">set_slider_bounds()
</tt>,
<tt class=
"method">get_slider_bounds()
</tt>,
<tt class=
"method">set_slider_return()
</tt>,
<tt class=
"method">set_slider_size()
</tt>,
<tt class=
"method">set_slider_precision()
</tt>,
<tt class=
"method">set_slider_step()
</tt>.
<DIV ALIGN=
"LEFT"></DIV><dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
5160' xml:id='l2h-
5160'
class=
"method">add_dial
</tt></b>(
</nobr></td>
<td><var>type, x, y, w, h, name
</var>)
</td></tr></table></dt>
Add a dial object to the form.
<tt class=
"method">set_dial_value()
</tt>,
<tt class=
"method">get_dial_value()
</tt>,
<tt class=
"method">set_dial_bounds()
</tt>,
<tt class=
"method">get_dial_bounds()
</tt>.
<DIV ALIGN=
"LEFT"></DIV><dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
5161' xml:id='l2h-
5161'
class=
"method">add_positioner
</tt></b>(
</nobr></td>
<td><var>type, x, y, w, h, name
</var>)
</td></tr></table></dt>
Add a positioner object to the form.
<tt class=
"method">set_positioner_xvalue()
</tt>,
<tt class=
"method">set_positioner_yvalue()
</tt>,
<tt class=
"method">set_positioner_xbounds()
</tt>,
<tt class=
"method">set_positioner_ybounds()
</tt>,
<tt class=
"method">get_positioner_xvalue()
</tt>,
<tt class=
"method">get_positioner_yvalue()
</tt>,
<tt class=
"method">get_positioner_xbounds()
</tt>,
<tt class=
"method">get_positioner_ybounds()
</tt>.
<DIV ALIGN=
"LEFT"></DIV><dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
5162' xml:id='l2h-
5162'
class=
"method">add_counter
</tt></b>(
</nobr></td>
<td><var>type, x, y, w, h, name
</var>)
</td></tr></table></dt>
Add a counter object to the form.
<tt class=
"method">set_counter_value()
</tt>,
<tt class=
"method">get_counter_value()
</tt>,
<tt class=
"method">set_counter_bounds()
</tt>,
<tt class=
"method">set_counter_step()
</tt>,
<tt class=
"method">set_counter_precision()
</tt>,
<tt class=
"method">set_counter_return()
</tt>.
<DIV ALIGN=
"LEFT"></DIV><dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
5163' xml:id='l2h-
5163'
class=
"method">add_input
</tt></b>(
</nobr></td>
<td><var>type, x, y, w, h, name
</var>)
</td></tr></table></dt>
Add a input object to the form.
<tt class=
"method">set_input()
</tt>,
<tt class=
"method">get_input()
</tt>,
<tt class=
"method">set_input_color()
</tt>,
<tt class=
"method">set_input_return()
</tt>.
<DIV ALIGN=
"LEFT"></DIV><dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
5164' xml:id='l2h-
5164'
class=
"method">add_menu
</tt></b>(
</nobr></td>
<td><var>type, x, y, w, h, name
</var>)
</td></tr></table></dt>
Add a menu object to the form.
<tt class=
"method">set_menu()
</tt>,
<tt class=
"method">get_menu()
</tt>,
<tt class=
"method">addto_menu()
</tt>.
<DIV ALIGN=
"LEFT"></DIV><dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
5165' xml:id='l2h-
5165'
class=
"method">add_choice
</tt></b>(
</nobr></td>
<td><var>type, x, y, w, h, name
</var>)
</td></tr></table></dt>
Add a choice object to the form.
<tt class=
"method">set_choice()
</tt>,
<tt class=
"method">get_choice()
</tt>,
<tt class=
"method">clear_choice()
</tt>,
<tt class=
"method">addto_choice()
</tt>,
<tt class=
"method">replace_choice()
</tt>,
<tt class=
"method">delete_choice()
</tt>,
<tt class=
"method">get_choice_text()
</tt>,
<tt class=
"method">set_choice_fontsize()
</tt>,
<tt class=
"method">set_choice_fontstyle()
</tt>.
<DIV ALIGN=
"LEFT"></DIV><dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
5166' xml:id='l2h-
5166'
class=
"method">add_browser
</tt></b>(
</nobr></td>
<td><var>type, x, y, w, h, name
</var>)
</td></tr></table></dt>
Add a browser object to the form.
<tt class=
"method">set_browser_topline()
</tt>,
<tt class=
"method">clear_browser()
</tt>,
<tt class=
"method">add_browser_line()
</tt>,
<tt class=
"method">addto_browser()
</tt>,
<tt class=
"method">insert_browser_line()
</tt>,
<tt class=
"method">delete_browser_line()
</tt>,
<tt class=
"method">replace_browser_line()
</tt>,
<tt class=
"method">get_browser_line()
</tt>,
<tt class=
"method">load_browser()
</tt>,
<tt class=
"method">get_browser_maxline()
</tt>,
<tt class=
"method">select_browser_line()
</tt>,
<tt class=
"method">deselect_browser_line()
</tt>,
<tt class=
"method">deselect_browser()
</tt>,
<tt class=
"method">isselected_browser_line()
</tt>,
<tt class=
"method">get_browser()
</tt>,
<tt class=
"method">set_browser_fontsize()
</tt>,
<tt class=
"method">set_browser_fontstyle()
</tt>,
<tt class=
"method">set_browser_specialkey()
</tt>.
<DIV ALIGN=
"LEFT"></DIV><dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
5167' xml:id='l2h-
5167'
class=
"method">add_timer
</tt></b>(
</nobr></td>
<td><var>type, x, y, w, h, name
</var>)
</td></tr></table></dt>
Add a timer object to the form.
<tt class=
"method">set_timer()
</tt>,
<tt class=
"method">get_timer()
</tt>.
Form objects have the following data attributes; see the FORMS
<div class=
"center"><table class=
"realtable">
<th class=
"left" >Name
</th>
<th class=
"left" >C Type
</th>
<th class=
"left" >Meaning
</th>
<tr><td class=
"left" valign=
"baseline"><tt class=
"member">window
</tt></td>
<td class=
"left" >int (read-only)
</td>
<td class=
"left" >GL window id
</td></tr>
<tr><td class=
"left" valign=
"baseline"><tt class=
"member">w
</tt></td>
<td class=
"left" >float
</td>
<td class=
"left" >form width
</td></tr>
<tr><td class=
"left" valign=
"baseline"><tt class=
"member">h
</tt></td>
<td class=
"left" >float
</td>
<td class=
"left" >form height
</td></tr>
<tr><td class=
"left" valign=
"baseline"><tt class=
"member">x
</tt></td>
<td class=
"left" >float
</td>
<td class=
"left" >form x origin
</td></tr>
<tr><td class=
"left" valign=
"baseline"><tt class=
"member">y
</tt></td>
<td class=
"left" >float
</td>
<td class=
"left" >form y origin
</td></tr>
<tr><td class=
"left" valign=
"baseline"><tt class=
"member">deactivated
</tt></td>
<td class=
"left" >int
</td>
<td class=
"left" >nonzero if form is deactivated
</td></tr>
<tr><td class=
"left" valign=
"baseline"><tt class=
"member">visible
</tt></td>
<td class=
"left" >int
</td>
<td class=
"left" >nonzero if form is visible
</td></tr>
<tr><td class=
"left" valign=
"baseline"><tt class=
"member">frozen
</tt></td>
<td class=
"left" >int
</td>
<td class=
"left" >nonzero if form is frozen
</td></tr>
<tr><td class=
"left" valign=
"baseline"><tt class=
"member">doublebuf
</tt></td>
<td class=
"left" >int
</td>
<td class=
"left" >nonzero if double buffering on
</td></tr></tbody>
<div class='online-navigation'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"20.4.1 Functions Defined in"
href=
"node807.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"20.4 fl "
href=
"module-fl.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"20.4.3 FORMS Objects"
href=
"forms-objects.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python Library Reference
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"node807.html">20.4.1 Functions Defined in
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"module-fl.html">20.4 fl
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"forms-objects.html">20.4.3 FORMS Objects
</A>
<span class=
"release-info">Release
2.4.2, documentation updated on
28 September
2005.
</span>
<!--End of Navigation Panel-->
See
<i><a href=
"about.html">About this document...
</a></i> for information on suggesting changes.