Package lyntin :: Module config :: Class CharConfig
[show private | hide private]
[frames | no frames]

Class CharConfig

ConfigBase --+
             |
            CharConfig


Holds a single character.
Method Summary
varies check(self, value)
Checks the value to verify that it's a valid value for this config data item.
string toString(self)
Retrieves a textual representation of the value and the type of the config item.
    Inherited from ConfigBase
  __init__(self, name, originalvalue, persist, description)
Sets the name and original value.
varies get(self)
Retrieves the value in question.
string getDescription(self)
Gets the description of the config item.
varies set(self, newvalue)
Sets the value.

Method Details

check(self, value)

Checks the value to verify that it's a valid value for this config data item. Override this so that it checks the incoming value and if it's not a valid type, it kicks up a TypeError. If it's not a valid value (different than not being a valid type) it kicks up a ValueError. If everything is ok, it should return the converted argument.
Parameters:
value - the value to check (and convert)
           (type=string)
Returns:
the converted value if everything is kosher
           (type=varies)
Raises:
TypeError - if it's not a valid type
ValueError - if it's not a valid value
Overrides:
lyntin.config.ConfigBase.check (inherited documentation)

toString(self)

Retrieves a textual representation of the value and the type of the config item.
Returns:
string
           (type=string)
Overrides:
lyntin.config.ConfigBase.toString (inherited documentation)

Generated by Epydoc 2.1 on Mon Aug 9 09:17:42 2004 http://epydoc.sf.net