preference-procs.tcl

Publicity: Public Only All

preference-procs.tcl

User Preferences

Location:

packages/user-preferences/tcl/preference-procs.tcl
Created:

2002-05-24
Author:

Ben Adida
CVS Identification:

$Id: preference-procs.tcl,v 1.2 2004/02/25 17:27:29 jeffd Exp $

Procedures in this file

preference::get_preference_type_id (public)
preference::get_user_pref (public)
preference::set_package_default (public)
preference::set_user_pref (public)

Detailed information

preference::get_preference_type_id (public)

 preference::get_preference_type_id -preference_type preference_type

Get the preference ID given the short name

Switches:

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

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

Testcases:
No testcase defined.

preference::get_user_pref (public)

 preference::get_user_pref -preference_type preference_type \
    -package_id package_id -user_id user_id

Get a user, package, or default preference. The preference can be obtained at four different levels:

package_id user_id Returns

package_id user_id User preference for package_id (set with set_user_pref)

null user_id User preference for all packages (set with set_user_pref)

package_id null Package default (set with set_package_default)

null null System default (set with preference::type::new)

Note: null == empty string (""), ...

Switches:

-preference_type (required)
A short string that identifies the preference. This corresponds to the short_name parameter passed to preference::type::new.
-package_id (required)
This can be the real package id, or an empty string.
-user_id (required)
This can be the real user id, or an empty string.

See Also:

preference::type::new
preference::set_package_default
preference::set_user_pref

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

Testcases:
No testcase defined.

package_id	user_id	Returns
package_id	user_id	User preference for package_id (set with set_user_pref)
null	user_id	User preference for all packages (set with set_user_pref)
package_id	null	Package default (set with set_package_default)
null	null	System default (set with preference::type::new)

preference::set_package_default (public)

 preference::set_package_default -preference_type preference_type \
    -package_id package_id -default_value default_value

Sets the default preference value for a package ID

Switches:

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

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

Testcases:
No testcase defined.

preference::set_user_pref (public)

 preference::set_user_pref -preference_type preference_type \
    [ -package_id package_id ] -user_id user_id -value value

Set a user preference.

Switches:

-preference_type (required)
Corresponds to the short_name parameter to preference::type::new
-package_id (optional)
-user_id (required)
-value (required)

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

Testcases:
No testcase defined.

[ show source ]