• Publicity: Public Only All

preference-types-procs.tcl

User Preferences Types

Location:
packages/user-preferences/tcl/preference-types-procs.tcl
Created:
2002-05-24
Author:
Ben Adida
CVS Identification:
$Id: preference-types-procs.tcl,v 1.2 2004/02/25 17:27:29 jeffd Exp $

Procedures in this file

Detailed information

preference::type::delete (public)

 preference::type::delete -preference_type preference_type

This deletes a preference type. This is not yet implemented.

Switches:
-preference_type (required)
Corresponds to the short_name parameter to preference::type::new

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

Testcases:
No testcase defined.

preference::type::new (public)

 preference::type::new [ -preference_type_id preference_type_id ] \
    -package_key package_key -short_name short_name \
    -pretty_name pretty_name [ -datatype datatype ] \
    [ -options options ] [ -default_value default_value ]

Create a new preference type. The preference can be set at four different levels. See get_user_pref for more details.

Switches:
-preference_type_id (optional)
-package_key (required)
-short_name (required)
This is the name that will be used to set or retrieve the preference using set_user_pref or get_user_pref.
-pretty_name (required)
-datatype (optional, defaults to "text")
-options (optional)
-default_value (optional)
See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 oacs_util::vars_to_ns_set oacs_util::vars_to_ns_set (public, deprecated) package_instantiate_object package_instantiate_object (public) preference::type::new preference::type::new preference::type::new->oacs_util::vars_to_ns_set preference::type::new->package_instantiate_object

Testcases:
No testcase defined.
[ show source ]