richtext-or-file-procs.tcl

Rich text input widget and datatype for OpenACS templating system.

Location:
packages/acs-templating/tcl/richtext-or-file-procs.tcl
Created:
2003-01-27
Author:
Lars Pind <lars@pinds.com>
CVS Identification:
$Id: richtext-or-file-procs.tcl,v 1.15 2024/09/11 06:15:48 gustafn Exp $

Procedures in this file

Detailed information

template::data::transform::richtext_or_file (public)

 template::data::transform::richtext_or_file element_ref

Transform submitted data into a valid richtext_or_file data structure (list)

Parameters:
element_ref (required)
Reference variable to the form element
Returns:
Submitted data in the richtext_or_datafile list form

Partial Call Graph (max 5 caller/called nodes):
%3 template::util::file::get_property template::util::file::get_property (public) template::util::file_transform template::util::file_transform (public) template::data::transform::richtext_or_file template::data::transform::richtext_or_file template::data::transform::richtext_or_file->template::util::file::get_property template::data::transform::richtext_or_file->template::util::file_transform

Testcases:
No testcase defined.

template::data::validate::richtext_or_file (public)

 template::data::validate::richtext_or_file value_ref message_ref

Validate submitted richtext_or_file by checking that the format is valid, HTML doesn't contain illegal tags, etc.

Parameters:
value_ref (required)
Reference variable to the submitted value
message_ref (required)
Reference variable for returning an error message
Returns:
True (1) if the submitted value is valid, false (0) otherwise

Partial Call Graph (max 5 caller/called nodes):
%3 ad_html_security_check ad_html_security_check (public) template::data::validate::text template::data::validate::text (public) template::util::richtext_or_file::formats template::util::richtext_or_file::formats (public) template::data::validate::richtext_or_file template::data::validate::richtext_or_file template::data::validate::richtext_or_file->ad_html_security_check template::data::validate::richtext_or_file->template::data::validate::text template::data::validate::richtext_or_file->template::util::richtext_or_file::formats

Testcases:
No testcase defined.

template::util::richtext_or_file (public)

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

Dispatch procedure for the richtext_or_file object

Parameters:
command (required)

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

Testcases:
No testcase defined.

template::util::richtext_or_file::acquire (public)

 template::util::richtext_or_file::acquire type [ value ]

Create a new richtext_or_file value with some predefined value Basically, create and set the richtext_or_file value

Parameters:
type (required)
value (optional)

Partial Call Graph (max 5 caller/called nodes):
%3 template::util::richtext_or_file::create template::util::richtext_or_file::create (public) template::util::richtext_or_file::set_property template::util::richtext_or_file::set_property (public) template::util::richtext_or_file::acquire template::util::richtext_or_file::acquire template::util::richtext_or_file::acquire->template::util::richtext_or_file::create template::util::richtext_or_file::acquire->template::util::richtext_or_file::set_property

Testcases:
No testcase defined.

template::util::richtext_or_file::create (public)

 template::util::richtext_or_file::create [ storage_type ] \
    [ mime_type ] [ text ] [ filename ] [ tmp_filename ] \
    [ content_url ]

Create a richtext_or_file datastructure.

Parameters:
storage_type (optional)
mime_type (optional)
text (optional)
filename (optional)
tmp_filename (optional)
content_url (optional)

Partial Call Graph (max 5 caller/called nodes):
%3 template::util::richtext_or_file::acquire template::util::richtext_or_file::acquire (public) template::util::richtext_or_file::create template::util::richtext_or_file::create template::util::richtext_or_file::acquire->template::util::richtext_or_file::create

Testcases:
No testcase defined.

template::util::richtext_or_file::format_options (public)

 template::util::richtext_or_file::format_options

Returns a formatting option list

Partial Call Graph (max 5 caller/called nodes):
%3 template::widget::richtext_or_file template::widget::richtext_or_file (public) template::util::richtext_or_file::format_options template::util::richtext_or_file::format_options template::widget::richtext_or_file->template::util::richtext_or_file::format_options

Testcases:
No testcase defined.

template::util::richtext_or_file::formats (public)

 template::util::richtext_or_file::formats

Returns a list of valid richtext_or_file formats

Partial Call Graph (max 5 caller/called nodes):
%3 template::data::validate::richtext_or_file template::data::validate::richtext_or_file (public) template::util::richtext_or_file::formats template::util::richtext_or_file::formats template::data::validate::richtext_or_file->template::util::richtext_or_file::formats

Testcases:
No testcase defined.

template::util::richtext_or_file::get_property (public)

 template::util::richtext_or_file::get_property what \
    richtext_or_file_list

Get a property of the richtext_or_file datatype. Valid properties are:

  • storage_type
  • mime_type
  • text
  • filename
  • tmp_filename
  • content_url

Parameters:
what (required)
richtext_or_file_list (required)

Partial Call Graph (max 5 caller/called nodes):
%3 template::widget::richtext_or_file template::widget::richtext_or_file (public) template::util::richtext_or_file::get_property template::util::richtext_or_file::get_property template::widget::richtext_or_file->template::util::richtext_or_file::get_property ad_html_text_convert ad_html_text_convert (public) template::util::richtext_or_file::get_property->ad_html_text_convert

Testcases:
No testcase defined.

template::util::richtext_or_file::set_property (public)

 template::util::richtext_or_file::set_property what \
    richtext_or_file_list value

Set a property of the richtext_or_file datatype. Valid properties are:

  • storage_type
  • mime_type
  • text
  • filename
  • tmp_filename
  • content_url

Parameters:
what (required)
richtext_or_file_list (required)
value (required)

Partial Call Graph (max 5 caller/called nodes):
%3 template::util::richtext_or_file::acquire template::util::richtext_or_file::acquire (public) template::util::richtext_or_file::set_property template::util::richtext_or_file::set_property template::util::richtext_or_file::acquire->template::util::richtext_or_file::set_property

Testcases:
No testcase defined.

template::widget::richtext_or_file (public)

 template::widget::richtext_or_file element_reference tag_attributes

Render a richtext_or_file widget

Parameters:
element_reference (required)
Reference variable to the form element
tag_attributes (required)
Attributes to include in the generated HTML
Returns:
Form HTML for the widget

Partial Call Graph (max 5 caller/called nodes):
%3 security::csp::nonce security::csp::nonce (public) template::add_event_listener template::add_event_listener (public) template::head::add_javascript template::head::add_javascript (public) template::util::richtext_or_file::format_options template::util::richtext_or_file::format_options (public) template::util::richtext_or_file::get_property template::util::richtext_or_file::get_property (public) template::widget::richtext_or_file template::widget::richtext_or_file template::widget::richtext_or_file->security::csp::nonce template::widget::richtext_or_file->template::add_event_listener template::widget::richtext_or_file->template::head::add_javascript template::widget::richtext_or_file->template::util::richtext_or_file::format_options template::widget::richtext_or_file->template::util::richtext_or_file::get_property

Testcases:
No testcase defined.
[ show source ]