Public Member Functions

Koo::Common::Settings::Settings Class Reference

The ConfigurationManager class handles Koo settings information. More...

List of all members.

Public Member Functions

def saveToFile
 Stores current settings in the appropiate config file.
def loadFromFile
 Loads settings from the appropiate config file.
def loadFromRegistry
 Loads settings from Windows registry.
def setValue
 Sets the value for the given key.
def value
 Returns the value for the given key.
def get
 Returns the value associated with the given key.
def loadFromServer
 Tries to load settings from koo server module.

Detailed Description

The ConfigurationManager class handles Koo settings information.

Those settings can be specified in the command line, .koorc configuration file or koo server module.

Definition at line 40 of file Settings.py.


Member Function Documentation

def Koo::Common::Settings::Settings::get (   key,
  defaultValue = None 
)

Returns the value associated with the given key.

If the key has no valu returns defaultValue

Definition at line 160 of file Settings.py.

def Koo::Common::Settings::Settings::loadFromFile (  ) 

Loads settings from the appropiate config file.

Definition at line 99 of file Settings.py.

def Koo::Common::Settings::Settings::loadFromRegistry (  ) 

Loads settings from Windows registry.

Definition at line 124 of file Settings.py.

def Koo::Common::Settings::Settings::loadFromServer (  ) 

Tries to load settings from koo server module.

If the module is not installed, no exception or error is thrown.

Definition at line 166 of file Settings.py.

def Koo::Common::Settings::Settings::saveToFile (  ) 

Stores current settings in the appropiate config file.

Definition at line 71 of file Settings.py.

def Koo::Common::Settings::Settings::setValue (   key,
  value 
)

Sets the value for the given key.

Definition at line 143 of file Settings.py.

def Koo::Common::Settings::Settings::value (   key,
  defaultValue = None,
  toType = None 
)

Returns the value for the given key.

If defaultValue parameter is given, defaultValue is returned if the key does not exist. If type is given, it will convert the value to the given type.

Definition at line 151 of file Settings.py.


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