Package screenlets :: Package options :: Module base :: Class EditableOptions
[hide private]
[frames] | no frames]

Class EditableOptions

source code

object --+
         |
        EditableOptions
Known Subclasses:

The EditableOptions can be inherited from to allow objects to export editable options for editing them with the OptionsEditor-class. NOTE: This could use some improvement and is very poorly coded :) ...

Instance Methods [hide private]
 
__init__(self)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
add_option(self, option, callback=None, realtime=True)
Add an editable option to this object.
source code
 
add_options_group(self, name, group_info)
Add a new options-group to this Options-object
source code
 
disable_option(self, name)
Disable the inputs for a certain Option.
source code
 
enable_option(self, name)
Enable the inputs for a certain Option.
source code
 
export_options_as_list(self)
Returns all editable options within a list (without groups) as key/value tuples.
source code
 
callback_value_changed(self, sender, option)
Called when a widget has updated and this needs calling.
source code
 
get_option_by_name(self, name)
Returns an option in this Options by it's name (or None).
source code
 
remove_option(self, name)
Remove an option from this Options.
source code
 
add_options_from_file(self, filename)
This function creates options from an XML-file with option-metadata.
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)

add_option(self, option, callback=None, realtime=True)

source code 

Add an editable option to this object. Editable Options can be edited and configured using the OptionsDialog. The optional callback-arg can be used to set a callback that gets notified when the option changes its value.

get_option_by_name(self, name)

source code 

Returns an option in this Options by it's name (or None). TODO: this gives wrong results in childclasses ... maybe access as class-attribute??

add_options_from_file(self, filename)

source code 

This function creates options from an XML-file with option-metadata. TODO: make this more reusable and place it into module (once the groups are own objects)