HAW_checkbox Class Reference

List of all members.

Public Member Functions
	HAW_checkbox ($name, $value, $label, $state=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 single checkbox element in a HAW_form object.

Examples:

$myCheckbox = new HAW_checkbox("agmt", "yes", "I agree");
$myCheckbox = new HAW_checkbox("agmt", "yes", "I agree", HAW_NOTCHECKED);
$myCheckbox = new HAW_checkbox("agmt", "yes", "I agree", HAW_CHECKED);

Note: The first and the second example are identical.

See also:

HAW_form

---

Member Function Documentation

HAW_checkbox::HAW_checkbox	(	$	name,
		$	value,
		$	label,
		$	state = HAW_NOTCHECKED
	)

Constructor

Parameters:

	name	Variable in which "value" is sent to the destination URL, in case that the box is checked. Note: Some browsers send empty name parameters like '...&name=&...' for non-selected checkbox elements. Therefore for the receiving script it is not sufficient to check the presence of the name parameter only! The value must be checked too!
	value	See name.
	label	Describes the checkbox on the visitor's screen/display.
	state	(optional) Allowed values are HAW_CHECKED or HAW_NOTCHECKED (default).

HAW_checkbox::set_voice_text	(	$	text,
		$	audio_src = ""
	)

Sets text to be spoken by voice browsers.

Parameters:

	text	Some alternative text that replaces <label>.
	audio_src	Some audio file (e.g. *.wav file) to play (optional).

HAW_checkbox::set_voice_help	(	$	text,
		$	audio_src = "",
		$	url = ""
	)

Sets help text for voice browsers.

Parameters:

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

HAW_checkbox::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_checkbox::set_voice_nomatch	(	$	text,
		$	audio_src = "",
		$	url = ""
	)

Sets nomatch text for voice browsers.

Parameters:

	text	Some text to complain that user input (typically "yes" or "no") 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:

• hawhaw.inc

---