Contents of Form object methods and data attributes

Form object methods and data attributes

Form objects (returned by fl.make_form() above) have the following methods. Each method corresponds to a C function whose name is prefixed with fl_; and whose first argument is a form pointer; please refer to the official FORMS documentation for descriptions.

All the add_... functions 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.

$\begin{funcdesc}{show_form}{placement\, bordertype\, name} Show the form. \end{funcdesc}$

$\begin{funcdesc}{hide_form}{} Hide the form. \end{funcdesc}$

$\begin{funcdesc}{redraw_form}{} Redraw the form. \end{funcdesc}$

$\begin{funcdesc}{set_form_position}{x\, y} Set the form's position. \end{funcdesc}$

$\begin{funcdesc}{freeze_form}{} Freeze the form. \end{funcdesc}$

$\begin{funcdesc}{unfreeze_form}{} Unfreeze the form. \end{funcdesc}$

$\begin{funcdesc}{activate_form}{} Activate the form. \end{funcdesc}$

$\begin{funcdesc}{deactivate_form}{} Deactivate the form. \end{funcdesc}$

$\begin{funcdesc}{bgn_group}{} Begin a new group of objects; return a group object. \end{funcdesc}$

$\begin{funcdesc}{end_group}{} End the current group of objects. \end{funcdesc}$

$\begin{funcdesc}{find_first}{} Find the first object in the form. \end{funcdesc}$

$\begin{funcdesc}{find_last}{} Find the last object in the form. \end{funcdesc}$

$\begin{funcdesc}{add_box}{type\, x\, y\, w\, h\, name} Add a box object to the form. No extra methods. \end{funcdesc}$

$\begin{funcdesc}{add_text}{type\, x\, y\, w\, h\, name} Add a text object to the form. No extra methods. \end{funcdesc}$

$\begin{funcdesc}{add_clock}{type\, x\, y\, w\, h\, name} Add a clock object to the form. \\ Method: \code{get_clock}. \end{funcdesc}$

$\begin{funcdesc}{add_button}{type\, x\, y\, w\, h\, name} Add a button object to the form. \\ Methods: \code{get_button}, \code{set_button}. \end{funcdesc}$

$\begin{funcdesc}{add_lightbutton}{type\, x\, y\, w\, h\, name} Add a lightbutton... ...t to the form. \\ Methods: \code{get_button}, \code{set_button}. \end{funcdesc}$

$\begin{funcdesc}{add_roundbutton}{type\, x\, y\, w\, h\, name} Add a roundbutton... ...t to the form. \\ Methods: \code{get_button}, \code{set_button}. \end{funcdesc}$

$\begin{funcdesc}{add_slider}{type\, x\, y\, w\, h\, name} Add a slider object to... ...lider_size}, \code{set_slider_precision}, \code{set_slider_step}. \end{funcdesc}$

$\begin{funcdesc}{add_valslider}{type\, x\, y\, w\, h\, name} Add a valslider obj... ...lider_size}, \code{set_slider_precision}, \code{set_slider_step}. \end{funcdesc}$

$\begin{funcdesc}{add_dial}{type\, x\, y\, w\, h\, name} Add a dial object to the... ...{get_dial_value}, \code{set_dial_bounds}, \code{get_dial_bounds}. \end{funcdesc}$

$\begin{funcdesc}{add_positioner}{type\, x\, y\, w\, h\, name} Add a positioner o... ...e}, \code{get_positioner_xbounds}, \code{get_positioner_ybounds}. \end{funcdesc}$

$\begin{funcdesc}{add_counter}{type\, x\, y\, w\, h\, name} Add a counter object ... ...r_step}, \code{set_counter_precision}, \code{set_counter_return}. \end{funcdesc}$

$\begin{funcdesc}{add_input}{type\, x\, y\, w\, h\, name} Add a input object to t... ...code{get_input}, \code{set_input_color}, \code{set_input_return}. \end{funcdesc}$

$\begin{funcdesc}{add_menu}{type\, x\, y\, w\, h\, name} Add a menu object to the... ...\\ Methods: \code{set_menu}, \code{get_menu}, \code{addto_menu}. \end{funcdesc}$

$\begin{funcdesc}{add_choice}{type\, x\, y\, w\, h\, name} Add a choice object to... ...e_text}, \code{set_choice_fontsize}, \code{set_choice_fontstyle}. \end{funcdesc}$

$\begin{funcdesc}{add_browser}{type\, x\, y\, w\, h\, name} Add a browser object ... ...ze}, \code{set_browser_fontstyle}, \code{set_browser_specialkey}. \end{funcdesc}$

$\begin{funcdesc}{add_timer}{type\, x\, y\, w\, h\, name} Add a timer object to the form. \\ Methods: \code{set_timer}, \code{get_timer}. \end{funcdesc}$

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

$\begin{tableiii}{\vert l\vert c\vert l\vert}{code}{Name}{Type}{Meaning} \lineii... ...frozen} \lineiii{doublebuf}{int}{nonzero if double buffering on} \end{tableiii}$