accessibility_option_list.h File Reference

Description

Accessibility Option List.

Object type accessibility_option_list.

Functions
ta_e_result_code_t	ta_accessibility_option_list_create (ta_object_t *accessibility_option_list)
	Create Accessibility Option List object. More...
ta_e_result_code_t	ta_accessibility_option_list_copy (ta_object_t *accessibility_option_list, const ta_object_t source_accessibility_option_list)
	Create a copy of Accessibility Option List object. More...
ta_e_result_code_t	ta_accessibility_option_list_get_accessibility_mode (ta_object_t accessibility_option_list, ta_object_t *accessibility_mode)
	Get Accessibility Mode from Accessibility Option List. More...
ta_e_result_code_t	ta_accessibility_option_list_set_accessibility_mode (ta_object_t accessibility_option_list, ta_object_t accessibility_mode)
	Set Accessibility Mode in Accessibility Option List. More...
ta_e_result_code_t	ta_accessibility_option_list_get_accessibility_options (ta_object_t accessibility_option_list, ta_object_t *accessibility_options)
	Get List of Acessibility Options. More...
ta_e_result_code_t	ta_accessibility_option_list_set_accessibility_options (ta_object_t accessibility_option_list, ta_object_t accessibility_options)
	Set List of Accessibility Options. More...

Function Documentation

ta_accessibility_option_list_copy()

ta_e_result_code_t ta_accessibility_option_list_copy	(	ta_object_t *	accessibility_option_list,
		const ta_object_t	source_accessibility_option_list
	)

Create a copy of Accessibility Option List object.

Parameters

[out]	accessibility_option_list	Pointer to variable to write new object to.
[in]	source_accessibility_option_list	Object instance of type accessibility_option_list.

Return values

ta_c_rc_ok	New object created.
ta_c_rc_out_of_memory	Not enough memory to create new object.
ta_c_rc_invalid_argument	accessibility_option_list is null-pointer.
ta_c_rc_invalid_argument	source_accessibility_option_list is ta_object_invalid.
ta_c_rc_invalid_argument	source_accessibility_option_list is not of type accessibility_option_list.

ta_accessibility_option_list_create()

ta_e_result_code_t ta_accessibility_option_list_create

(

ta_object_t *

accessibility_option_list

)

Create Accessibility Option List object.

Parameters

[out]

accessibility_option_list

Pointer to variable to write new object to.

Return values

ta_c_rc_ok	New object created.
ta_c_rc_out_of_memory	Not enough memory to create new object.
ta_c_rc_invalid_argument	accessibility_option_list is null-pointer.

ta_accessibility_option_list_get_accessibility_mode()

ta_e_result_code_t ta_accessibility_option_list_get_accessibility_mode	(	ta_object_t	accessibility_option_list,
		ta_object_t *	accessibility_mode
	)

Get Accessibility Mode from Accessibility Option List.

Parameters

[in]	accessibility_option_list	Object instance of type accessibility_option_list.
[out]	accessibility_mode	Pointer to variable to write value to. Value is ta_c_aom_undefined if not set in accessibility_option_list.

Return values

ta_c_rc_ok	Value written to accessibility_mode.
ta_c_rc_invalid_argument	accessibility_option_list is ta_object_invalid.
ta_c_rc_invalid_argument	accessibility_option_list is not of type accessibility_option_list.
ta_c_rc_invalid_argument	accessibility_mode is null-pointer.

ta_accessibility_option_list_get_accessibility_options()

ta_e_result_code_t ta_accessibility_option_list_get_accessibility_options	(	ta_object_t	accessibility_option_list,
		ta_object_t *	accessibility_options
	)

Get List of Acessibility Options.

Parameters

[in]	accessibility_option_list	Object instance of type accessibility_option_list.
[out]	accessibility_options	Pointer to variable to write object instance to. Object instance is of type list.h "list" with elements of type accessibility_option. Object instance is not retained. Object instance is ta_object_invalid if no accessibility options are set in accessibility_option_list.

Return values

ta_c_rc_ok	Object instance written to accessibility_options.
ta_c_rc_invalid_argument	accessibility_option_list is ta_object_invalid.
ta_c_rc_invalid_argument	accessibility_option_list is not of type accessibility_option_list.
ta_c_rc_invalid_argument	accessibility_options is null-pointer.

ta_accessibility_option_list_set_accessibility_mode()

ta_e_result_code_t ta_accessibility_option_list_set_accessibility_mode	(	ta_object_t	accessibility_option_list,
		ta_object_t	accessibility_mode
	)

Set Accessibility Mode in Accessibility Option List.

Parameters

[in]	accessibility_option_list	Object instance of type accessibility_option_list.
[in]	accessibility_mode	Object instance to set. Object instance can be ta_object_invalid to clear the value in accessibility_option_list. If object instance is not ta_object_invalid is has to be of type integer.

Return values

ta_c_rc_ok	Value set in accessibility_option_list.
ta_c_rc_invalid_argument	accessibility_option_list is ta_object_invalid.
ta_c_rc_invalid_argument	accessibility_option_list is not of type accessibility_option_list.
ta_c_rc_invalid_argument	accessibility_mode is not of type integer.

ta_accessibility_option_list_set_accessibility_options()

ta_e_result_code_t ta_accessibility_option_list_set_accessibility_options	(	ta_object_t	accessibility_option_list,
		ta_object_t	accessibility_options
	)

Set List of Accessibility Options.

Parameters

[in]	accessibility_option_list	Object instance of type accessibility_option_list.
[in]	accessibility_options	Object instance to set. Object instance can be ta_object_invalid to clear the value in accessibility_option_list. If object instance is not ta_object_invalid it has to be of type list.h "list" with elements of type accessibility_options.h "accessibility_option".

Return values

ta_c_rc_ok	Value set in accessibility_option_list.
ta_c_rc_invalid_argument	accessibility_option_list is ta_object_invalid.
ta_c_rc_invalid_argument	accessibility_option_list is not of type accessibility_option_list.
ta_c_rc_invalid_argument	accessibility_options is not of type list.h "list" with elements of type accessibility_options.h "accessibility_option".