HAW_form Class Reference

List of all members.

Public Member Functions

 HAW_form ($url, $method=HAW_METHOD_GET)
 add_text ($text)
 add_image ($image)
 add_table ($table)
 add_input ($input)
 add_textarea ($textarea)
 add_select ($select)
 add_radio ($radio)
 add_checkbox ($checkbox)
 add_hidden ($hidden)
 add_submit ($submit)
 add_raw ($raw)
 add_plugin ($plugin)
 add_userdefined ($udef)
 add_rule ($rule)
 set_voice_text ($text, $audio_src="")

Detailed Description

This class defines a form with various possible input elements. The input elements have to be defined as separate objects and are linked to the form with a special "add" function. One HAW_deck object can contain only one HAW_form object.

Examples:

$myPage = new HAW_deck(...);
...
$myForm = new HAW_form("/mynextpage.php");
$myText = new HAW_text(...);
$myForm->add_text($myText);
$myInput = new HAW_input(...);
$myForm->add_input($myInput);
$mySubmit = new HAW_submit(...);
$myForm->add_submit($mySubmit);
...
$myPage->add_form($myForm);
...
$myPage->create_page();

See also:
HAW_text

HAW_image

HAW_table

HAW_input

HAW_textarea

HAW_select

HAW_radio

HAW_checkbox

HAW_hidden

HAW_submit

HAW_rule


Member Function Documentation

HAW_form::HAW_form ( url,
method = HAW_METHOD_GET 
)

Constructor

Parameters:
url Address where the user input is sent to.
method (optional)
HAW_METHOD_GET (default)
HAW_METHOD_POST

HAW_form::add_text ( text  ) 

Adds a HAW_text object to HAW_form.

Parameters:
text Some HAW_text object.
See also:
HAW_text

HAW_form::add_image ( image  ) 

Adds a HAW_image object to HAW_form.

Parameters:
image Some HAW_image object.
See also:
HAW_image

HAW_form::add_table ( table  ) 

Adds a HAW_table object to HAW_form.

Parameters:
table Some HAW_table object.
See also:
HAW_table

HAW_form::add_input ( input  ) 

Adds a HAW_input object to HAW_form.

Parameters:
input Some HAW_input object.
See also:
HAW_input

HAW_form::add_textarea ( textarea  ) 

Adds a HAW_textarea object to HAW_form.

Parameters:
textarea Some HAW_textarea object.
See also:
HAW_textarea

HAW_form::add_select ( select  ) 

Adds a HAW_select object to HAW_form.

Parameters:
select Some HAW_select object.
See also:
HAW_select

HAW_form::add_radio ( radio  ) 

Adds a HAW_radio object to HAW_form.

Parameters:
radio Some HAW_radio object.
See also:
HAW_radio

HAW_form::add_checkbox ( checkbox  ) 

Adds a HAW_checkbox object to HAW_form.

Parameters:
checkbox Some HAW_checkbox object.
See also:
HAW_checkbox

HAW_form::add_hidden ( hidden  ) 

Adds a HAW_hidden object to HAW_form.

Parameters:
hidden Some HAW_hidden object.
See also:
HAW_hidden

HAW_form::add_submit ( submit  ) 

Adds a HAW_submit object to HAW_form.

Parameters:
submit Some HAW_submit object.
See also:
HAW_submit

HAW_form::add_raw ( raw  ) 

Adds a HAW_raw object to HAW_form.

Parameters:
raw_markup_object Some HAW_raw object.
See also:
HAW_raw

HAW_form::add_plugin ( plugin  ) 

Adds some HAWHAW plugin object to HAW_form

Parameters:
plugin Some user-defined plugin object.
See also:
HAW_deck::add_plugin()

HAW_form::add_userdefined ( udef  ) 

Adds some user-defined HAWHAW object to HAW_form

Parameters:
udef Some user-defined object.
Deprecated:
use HAW_form::add_plugin() instead

HAW_form::add_rule ( rule  ) 

Adds a HAW_rule object to HAW_form.

Parameters:
rule Some HAW_rule object.
See also:
HAW_rule

HAW_form::set_voice_text ( text,
audio_src = "" 
)

Sets form-related text to be spoken by voice browsers.

Parameters:
text Some introducing text that will be spoken before any dialog is started.
audio_src Some audio file (e.g. *.wav file) to play (optional).


The documentation for this class was generated from the following file:
Generated on Mon Dec 6 21:51:55 2010 for HAWHAW PHP by  doxygen 1.5.1