HAW_radio Class Reference

List of all members.

Public Member Functions

 HAW_radio ($name)
 add_button ($label, $value, $is_checked=HAW_NOTCHECKED)
 set_voice_text ($text, $audio_src="")
 set_voice_help ($text, $audio_src="", $url="")
 set_voice_noinput ($text, $audio_src="", $url="")
 set_voice_nomatch ($text, $audio_src="", $url="")

Detailed Description

This class provides a radio button element in a HAW_form object.

Examples:

$myRadio = new HAW_radio("country");
$myRadio->add_button("Finland", "F");
$myRadio->add_button("Germany", "G", HAW_CHECKED);
$myRadio->add_button("Sweden", "S");

See also:
HAW_form


Member Function Documentation

HAW_radio::HAW_radio ( name  ) 

Constructor

Parameters:
name Variable in which the information about the pressed button is sent to the destination URL.

HAW_radio::add_button ( label,
value,
is_checked = HAW_NOTCHECKED 
)

Adds one radio button to a HAW_radio object.

Parameters:
label Describes the radiobutton on the visitor's screen/display.
value Value (string!) sent in the "name" variable, if this button is selected.
is_checked (optional)
Allowed values are HAW_CHECKED or HAW_NOTCHECKED (default).
Note: Setting to "checked" will overwrite previous "checked" radiobuttons of this HAW_radio object.

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

Sets text to be spoken by voice browsers.

Parameters:
text Some alternative text that replaces the enumeration of buttons.
audio_src Some audio file (e.g. *.wav file) to play (optional).

HAW_radio::set_voice_help ( text,
audio_src = "",
url = "" 
)

Sets help text for voice browsers.

Parameters:
text Some helpful information concerning this radio button element.
audio_src Some audio file (e.g. *.wav file) to play (optional).
url Some other voice deck to go to (optional).

HAW_radio::set_voice_noinput ( text,
audio_src = "",
url = "" 
)

Sets noinput text for voice browsers.

Parameters:
text Some text to inform the user that no input has been received.
audio_src Some audio file (e.g. *.wav file) to play (optional).
url Some other voice deck to go to (optional).

HAW_radio::set_voice_nomatch ( text,
audio_src = "",
url = "" 
)

Sets nomatch text for voice browsers.

Parameters:
text Some text to complain that user input was not recognized.
audio_src Some audio file (e.g. *.wav file) to play (optional).
url Some other voice deck to go to (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