spellcheck-procs.tcl

Spell-check library for OpenACS templating system.

Location:
packages/acs-templating/tcl/spellcheck-procs.tcl
Created:
2003-09-21
Author:
Ola Hansson <ola@polyxena.net>
CVS Identification:
$Id: spellcheck-procs.tcl,v 1.30 2024/09/11 06:15:48 gustafn Exp $

Procedures in this file

Detailed information

template::data::transform::spellcheck (public)

 template::data::transform::spellcheck -element_ref element_ref \
    -values values

Transform submitted and previously validated input into a spellcheck datastructure.

Switches:
-element_ref (required)
Reference variable to the form element.
-values (required)
The set of values for that element.

Partial Call Graph (max 5 caller/called nodes):
%3 template::element::querygetall template::element::querygetall (public) template::data::transform::spellcheck template::data::transform::spellcheck template::element::querygetall->template::data::transform::spellcheck template::data::transform::richtext template::data::transform::richtext (public) template::data::transform::spellcheck->template::data::transform::richtext template::element::set_error template::element::set_error (public) template::data::transform::spellcheck->template::element::set_error template::element::set_properties template::element::set_properties (public) template::data::transform::spellcheck->template::element::set_properties template::util::richtext::get_property template::util::richtext::get_property (public) template::data::transform::spellcheck->template::util::richtext::get_property template::util::richtext::set_property template::util::richtext::set_property (public) template::data::transform::spellcheck->template::util::richtext::set_property

Testcases:
No testcase defined.

template::util::spellcheck (public)

 template::util::spellcheck command [ args... ]

Dispatch procedure for the spellcheck object

Parameters:
command (required)

Partial Call Graph (max 5 caller/called nodes):
%3

Testcases:
No testcase defined.

template::util::spellcheck::get_element_formtext (public)

 template::util::spellcheck::get_element_formtext -text text [ -html ] \
    -var_to_spellcheck var_to_spellcheck [ -language language ] \
    -error_num_ref error_num_ref [ -no_abort ] \
    -formtext_to_display_ref formtext_to_display_ref \
    [ -just_the_errwords_ref just_the_errwords_ref ]
Switches:
-text (required)
The string to check for spelling errors.
-html (optional, boolean, defaults to "0")
-var_to_spellcheck (required)
The name of the text input type or textarea that holds this text (e.g., "email_body")
-language (optional)
-error_num_ref (required)
-no_abort (optional, boolean, defaults to "0")
-formtext_to_display_ref (required)
-just_the_errwords_ref (optional)

Partial Call Graph (max 5 caller/called nodes):
%3 test_spellcheck__get_element_formtext spellcheck__get_element_formtext (test acs-templating) template::util::spellcheck::get_element_formtext template::util::spellcheck::get_element_formtext test_spellcheck__get_element_formtext->template::util::spellcheck::get_element_formtext acs_package_root_dir acs_package_root_dir (public) template::util::spellcheck::get_element_formtext->acs_package_root_dir ad_return_error ad_return_error (public) template::util::spellcheck::get_element_formtext->ad_return_error ad_script_abort ad_script_abort (public) template::util::spellcheck::get_element_formtext->ad_script_abort ad_tmpdir ad_tmpdir (public) template::util::spellcheck::get_element_formtext->ad_tmpdir template::data::transform::spellcheck template::data::transform::spellcheck (public) template::data::transform::spellcheck->template::util::spellcheck::get_element_formtext

Testcases:
spellcheck__get_element_formtext

template::util::spellcheck::get_sorted_list_with_unique_elements (public)

 template::util::spellcheck::get_sorted_list_with_unique_elements \
    -the_list the_list

Converts a list of possibly duplicate elements (words) into a sorted list where no duplicates exist.

Switches:
-the_list (required)
The list of possibly duplicate elements.

Partial Call Graph (max 5 caller/called nodes):
%3

Testcases:
No testcase defined.

template::util::spellcheck::merge_text (public)

 template::util::spellcheck::merge_text element_id

Returns the merged (possibly corrected) text or the empty string if it is not time to merge.

Parameters:
element_id (required)

Partial Call Graph (max 5 caller/called nodes):
%3 template::data::transform::spellcheck template::data::transform::spellcheck (public) template::util::spellcheck::merge_text template::util::spellcheck::merge_text template::data::transform::spellcheck->template::util::spellcheck::merge_text

Testcases:
No testcase defined.

template::util::spellcheck::spellcheck_properties (public)

 template::util::spellcheck::spellcheck_properties \
    -element_ref element_ref

Returns a list of spellcheck properties in array setable format.

Switches:
-element_ref (required)

Partial Call Graph (max 5 caller/called nodes):
%3 test_spellcheck__spellcheck_properties spellcheck__spellcheck_properties (test acs-templating) template::util::spellcheck::spellcheck_properties template::util::spellcheck::spellcheck_properties test_spellcheck__spellcheck_properties->template::util::spellcheck::spellcheck_properties parameter::get_from_package_key parameter::get_from_package_key (public) template::util::spellcheck::spellcheck_properties->parameter::get_from_package_key template::element::querygetall template::element::querygetall (public) template::element::querygetall->template::util::spellcheck::spellcheck_properties template::widget::richtext template::widget::richtext (public) template::widget::richtext->template::util::spellcheck::spellcheck_properties template::widget::text template::widget::text (public) template::widget::text->template::util::spellcheck::spellcheck_properties template::widget::textarea template::widget::textarea (public) template::widget::textarea->template::util::spellcheck::spellcheck_properties

Testcases:
spellcheck__spellcheck_properties
[ show source ]