View source for Yurttas/PL/SL/python/docs/core-python-programming/doc/152/lib/form-objects.html

<div class="navigation">

{| width="100%" cellspacing="2" align="center"
|
[[yurttas/PL/SL/python/docs/core-python-programming/doc/152/lib/forms-objects.html|[[Image:yurttas_PL_SL_python_docs_core-python-programming_doc_152_icons_next.gif|32px|next]]]]
|
[[yurttas/PL/SL/python/docs/core-python-programming/doc/152/lib/module-fl.html|[[Image:yurttas_PL_SL_python_docs_core-python-programming_doc_152_icons_up.gif|32px|up]]]]
|
[[yurttas/PL/SL/python/docs/core-python-programming/doc/152/lib/FL Functions.html|[[Image:yurttas_PL_SL_python_docs_core-python-programming_doc_152_icons_previous.gif|32px|previous]]]]
| width="100%" bgcolor="#99CCFF" align="center" | '''Python Library Reference'''
|
[[yurttas/PL/SL/python/docs/core-python-programming/doc/152/lib/contents.html|[[Image:yurttas_PL_SL_python_docs_core-python-programming_doc_152_icons_contents.gif|32px|contents]]]]
|
[[yurttas/PL/SL/python/docs/core-python-programming/doc/152/lib/modindex.html|[[Image:yurttas_PL_SL_python_docs_core-python-programming_doc_152_icons_modules.gif|32px|modules]]]]
|
[[yurttas/PL/SL/python/docs/core-python-programming/doc/152/lib/genindex.html|[[Image:yurttas_PL_SL_python_docs_core-python-programming_doc_152_icons_index.gif|32px|index]]]]
|}

'''Next:''' <span class="sectref">[[yurttas/PL/SL/python/docs/core-python-programming/doc/152/lib/forms-objects.html|16.4.3 FORMS Objects]]</span> '''Up:''' <span class="sectref">[[yurttas/PL/SL/python/docs/core-python-programming/doc/152/lib/module-fl.html|16.4 fl ]]</span> '''Previous:''' <span class="sectref">[[yurttas/PL/SL/python/docs/core-python-programming/doc/152/lib/FL Functions.html|16.4.1 Functions Defined in]]</span><br />
----
</div>

==<br /> 16.4.2 Form Objects==

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 descriptions.

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>

<div align="LEFT"></div>

; '''<tt class="method">show_form</tt>''' (<var>placement, bordertype, name</var>)
: Show the form.

<div align="LEFT"></div>

<div align="LEFT"></div>

; '''<tt class="method">hide_form</tt>''' ()
: Hide the form.

<div align="LEFT"></div>

<div align="LEFT"></div>

; '''<tt class="method">redraw_form</tt>''' ()
: Redraw the form.

<div align="LEFT"></div>

<div align="LEFT"></div>

; '''<tt class="method">set_form_position</tt>''' (<var>x, y</var>)
: Set the form's position.

<div align="LEFT"></div>

<div align="LEFT"></div>

; '''<tt class="method">freeze_form</tt>''' ()
: Freeze the form.

<div align="LEFT"></div>

<div align="LEFT"></div>

; '''<tt class="method">unfreeze_form</tt>''' ()
: Unfreeze the form.

<div align="LEFT"></div>

<div align="LEFT"></div>

; '''<tt class="method">activate_form</tt>''' ()
: Activate the form.

<div align="LEFT"></div>

<div align="LEFT"></div>

; '''<tt class="method">deactivate_form</tt>''' ()
: Deactivate the form.

<div align="LEFT"></div>

<div align="LEFT"></div>

; '''<tt class="method">bgn_group</tt>''' ()
: Begin a new group of objects; return a group object.

<div align="LEFT"></div>

<div align="LEFT"></div>

; '''<tt class="method">end_group</tt>''' ()
: End the current group of objects.

<div align="LEFT"></div>

<div align="LEFT"></div>

; '''<tt class="method">find_first</tt>''' ()
: Find the first object in the form.

<div align="LEFT"></div>

<div align="LEFT"></div>

; '''<tt class="method">find_last</tt>''' ()
: Find the last object in the form.

<div align="LEFT"></div>

<div align="LEFT"></div>

; '''<tt class="method">add_box</tt>''' (<var>type, x, y, w, h, name</var>)
: Add a box object to the form. No extra methods.

<div align="LEFT"></div>

<div align="LEFT"></div>

; '''<tt class="method">add_text</tt>''' (<var>type, x, y, w, h, name</var>)
: Add a text object to the form. No extra methods.

<div align="LEFT"></div>

<div align="LEFT"></div>

; '''<tt class="method">add_clock</tt>''' (<var>type, x, y, w, h, name</var>)
: Add a clock object to the form. <br /> Method: <tt class="method">get_clock()</tt>.

<div align="LEFT"></div>

<div align="LEFT"></div>

; '''<tt class="method">add_button</tt>''' (<var>type, x, y, w, h, name</var>)
: Add a button object to the form. <br /> Methods: <tt class="method">get_button()</tt>, <tt class="method">set_button()</tt>.

<div align="LEFT"></div>

<div align="LEFT"></div>

; '''<tt class="method">add_lightbutton</tt>''' (<var>type, x, y, w, h, name</var>)
: Add a lightbutton object to the form. <br /> Methods: <tt class="method">get_button()</tt>, <tt class="method">set_button()</tt>.

<div align="LEFT"></div>

<div align="LEFT"></div>

; '''<tt class="method">add_roundbutton</tt>''' (<var>type, x, y, w, h, name</var>)
: Add a roundbutton object to the form. <br /> Methods: <tt class="method">get_button()</tt>, <tt class="method">set_button()</tt>.

<div align="LEFT"></div>

<div align="LEFT"></div>

; '''<tt class="method">add_slider</tt>''' (<var>type, x, y, w, h, name</var>)
: Add a slider object to the form. <br /> Methods: <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>

<div align="LEFT"></div>

; '''<tt class="method">add_valslider</tt>''' (<var>type, x, y, w, h, name</var>)
: Add a valslider object to the form. <br /> Methods: <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>

<div align="LEFT"></div>

; '''<tt class="method">add_dial</tt>''' (<var>type, x, y, w, h, name</var>)
: Add a dial object to the form. <br /> Methods: <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>

<div align="LEFT"></div>

; '''<tt class="method">add_positioner</tt>''' (<var>type, x, y, w, h, name</var>)
: Add a positioner object to the form. <br /> Methods: <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>

<div align="LEFT"></div>

; '''<tt class="method">add_counter</tt>''' (<var>type, x, y, w, h, name</var>)
: Add a counter object to the form. <br /> Methods: <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>

<div align="LEFT"></div>

; '''<tt class="method">add_input</tt>''' (<var>type, x, y, w, h, name</var>)
: Add a input object to the form. <br /> Methods: <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>

<div align="LEFT"></div>

; '''<tt class="method">add_menu</tt>''' (<var>type, x, y, w, h, name</var>)
: Add a menu object to the form. <br /> Methods: <tt class="method">set_menu()</tt>, <tt class="method">get_menu()</tt>, <tt class="method">addto_menu()</tt>.

<div align="LEFT"></div>

<div align="LEFT"></div>

; '''<tt class="method">add_choice</tt>''' (<var>type, x, y, w, h, name</var>)
: Add a choice object to the form. <br /> Methods: <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>

<div align="LEFT"></div>

; '''<tt class="method">add_browser</tt>''' (<var>type, x, y, w, h, name</var>)
: Add a browser object to the form. <br /> Methods: <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>

<div align="LEFT"></div>

; '''<tt class="method">add_timer</tt>''' (<var>type, x, y, w, h, name</var>)
: Add a timer object to the form. <br /> Methods: <tt class="method">set_timer()</tt>, <tt class="method">get_timer()</tt>.

<div align="LEFT"></div>

Form objects have the following data attributes; see the FORMS documentation:

{| style="border-collapse: collapse" border="border" align="center"
|- bgcolor="#99CCFF"
! align="left" | '''Name'''
! align="left" | '''C Type'''
! align="left" | '''Meaning'''
| align="left" valign="baseline" | <tt class="member">window</tt>
| align="left" | int (read-only)
| align="left" | GL window id
|-
| align="left" valign="baseline" | <tt class="member">w</tt>
| align="left" | float
| align="left" | form width
|-
| align="left" valign="baseline" | <tt class="member">h</tt>
| align="left" | float
| align="left" | form height
|-
| align="left" valign="baseline" | <tt class="member">x</tt>
| align="left" | float
| align="left" | form x origin
|-
| align="left" valign="baseline" | <tt class="member">y</tt>
| align="left" | float
| align="left" | form y origin
|-
| align="left" valign="baseline" | <tt class="member">deactivated</tt>
| align="left" | int
| align="left" | nonzero if form is deactivated
|-
| align="left" valign="baseline" | <tt class="member">visible</tt>
| align="left" | int
| align="left" | nonzero if form is visible
|-
| align="left" valign="baseline" | <tt class="member">frozen</tt>
| align="left" | int
| align="left" | nonzero if form is frozen
|-
| align="left" valign="baseline" | <tt class="member">doublebuf</tt>
| align="left" | int
| align="left" | nonzero if double buffering on
|}

<div class="navigation">
----

{| width="100%" cellspacing="2" align="center"
|
[[yurttas/PL/SL/python/docs/core-python-programming/doc/152/lib/forms-objects.html|[[Image:yurttas_PL_SL_python_docs_core-python-programming_doc_152_icons_next.gif|32px|next]]]]
|
[[yurttas/PL/SL/python/docs/core-python-programming/doc/152/lib/module-fl.html|[[Image:yurttas_PL_SL_python_docs_core-python-programming_doc_152_icons_up.gif|32px|up]]]]
|
[[yurttas/PL/SL/python/docs/core-python-programming/doc/152/lib/FL Functions.html|[[Image:yurttas_PL_SL_python_docs_core-python-programming_doc_152_icons_previous.gif|32px|previous]]]]
| width="100%" bgcolor="#99CCFF" align="center" | '''Python Library Reference'''
|
[[yurttas/PL/SL/python/docs/core-python-programming/doc/152/lib/contents.html|[[Image:yurttas_PL_SL_python_docs_core-python-programming_doc_152_icons_contents.gif|32px|contents]]]]
|
[[yurttas/PL/SL/python/docs/core-python-programming/doc/152/lib/modindex.html|[[Image:yurttas_PL_SL_python_docs_core-python-programming_doc_152_icons_modules.gif|32px|modules]]]]
|
[[yurttas/PL/SL/python/docs/core-python-programming/doc/152/lib/genindex.html|[[Image:yurttas_PL_SL_python_docs_core-python-programming_doc_152_icons_index.gif|32px|index]]]]
|}

'''Next:''' <span class="sectref">[[yurttas/PL/SL/python/docs/core-python-programming/doc/152/lib/forms-objects.html|16.4.3 FORMS Objects]]</span> '''Up:''' <span class="sectref">[[yurttas/PL/SL/python/docs/core-python-programming/doc/152/lib/module-fl.html|16.4 fl ]]</span> '''Previous:''' <span class="sectref">[[yurttas/PL/SL/python/docs/core-python-programming/doc/152/lib/FL Functions.html|16.4.1 Functions Defined in]]</span></div>
----
Send comments on this document to [mailto:python-docs@python.org python-docs@python.org].