gear::xsi::XSIPreferences Class Reference
XSI Preferences wraper.
More...
Public Member Functions |
| def | __init__ |
| | Init Method.
|
| def | setPrefValue |
| | Set the preference value and return the original value.
|
| def | listUserPref |
| | List user preferences.
|
| def | listCategories |
| | List all the categories of preference.
|
| def | listParameters |
| | List all the parameter of given category.
|
Data Fields |
|
| root |
|
| categories |
Detailed Description
XSI Preferences wraper.
Member Function Documentation
| def gear::xsi::XSIPreferences::__init__ |
( |
|
self |
) |
|
| def gear::xsi::XSIPreferences::setPrefValue |
( |
|
self, |
|
|
|
category, |
|
|
|
parameter, |
|
|
|
value | |
|
) |
| | |
Set the preference value and return the original value.
- Parameters:
-
| self | |
| category | String - category of preference. |
| parameter | String - parameter of category. |
| value | Variant - new value of the parameter. |
- Returns:
- Variant - The original value of the parameter.
| def gear::xsi::XSIPreferences::listUserPref |
( |
|
self |
) |
|
List user preferences.
- Parameters:
-
| def gear::xsi::XSIPreferences::listCategories |
( |
|
self |
) |
|
List all the categories of preference.
- Parameters:
-
| def gear::xsi::XSIPreferences::listParameters |
( |
|
self, |
|
|
|
category | |
|
) |
| | |
List all the parameter of given category.
- Parameters:
-
| self | |
| category | String - category to list. |
The documentation for this class was generated from the following file:
- modules/gear/xsi/__init__.py
