gear_mc
 All Classes Namespaces Functions Variables
Public Member Functions | Public Attributes | List of all members
gear.xsi.XSIPreferences Class Reference

PREFERENCES. More...

Inheritance diagram for gear.xsi.XSIPreferences:

Public Member Functions

def __init__
 Init Method. More...
 
def setPrefValue
 Set the preference value and return the original value. More...
 
def listUserPref
 List user preferences. More...
 
def listCategories
 List all the categories of preference. More...
 
def listParameters
 List all the parameter of given category. More...
 

Public Attributes

 root
 
 categories
 

Detailed Description

PREFERENCES.

XSI Preferences wraper.

Constructor & Destructor Documentation

def gear.xsi.XSIPreferences.__init__ (   self)

Init Method.

Parameters
self

Member Function Documentation

def gear.xsi.XSIPreferences.listCategories (   self)

List all the categories of preference.

Parameters
self
def gear.xsi.XSIPreferences.listParameters (   self,
  category 
)

List all the parameter of given category.

Parameters
self
categoryString - category to list.
def gear.xsi.XSIPreferences.listUserPref (   self)

List user preferences.

Parameters
self
def gear.xsi.XSIPreferences.setPrefValue (   self,
  category,
  parameter,
  value 
)

Set the preference value and return the original value.

Parameters
self
categoryString - category of preference.
parameterString - parameter of category.
valueVariant - new value of the parameter.
Returns
Variant - The original value of the parameter.

The documentation for this class was generated from the following file: