Inherits from
- HasTraits: enthought.traits.has_traits.HasTraits
Attributes
- filename
The default name of the file used to persist the preferences (if no filename is passed in to the 'load' and 'save' methods, then this is used instead).
filename = Str
- name
The name of the node relative to its parent (the empty string if this node is the root node).
name = Str
- parent
The parent node (None if this node is the root node).
parent = Instance(IPreferences)
- path
The absolute path to this node from the root node (the empty string if this node is the root node).
path = Property(Str)
Inherited from base classes
Method summary
- __init__(self, **traits)
- add_preferences_listener(self, listener, path = '')
- clear(self, path = '')
- dump(self, indent = '')
- flush(self)
- get(self, path, default = None, inherit = False)
- keys(self, path = '')
- load(self, file_or_filename = None)
- node(self, path = '')
- node_exists(self, path = '')
- node_names(self, path = '')
- remove(self, path)
- remove_preferences_listener(self, listener, path = '')
- save(self, file_or_filename = None)
- set(self, path, value)
Inherited from base classes
- __deepcopy__(self, memo)
- __getstate__(self)
- __prefix_trait__(self, name, is_set)
- __reduce_ex__(self, protocol)
- __setstate__(self, state, trait_change_notify = True)
- add_class_trait(cls, name, *trait)
- add_trait(self, name, *trait)
- add_trait_category(cls, category)
- add_trait_listener(self, object, prefix = '')
- all_trait_names(self)
- base_trait(self, name)
- class_default_traits_view(cls)
- class_editable_traits(cls)
- class_trait_names(cls, **metadata)
- class_trait_view(cls, name = None, view_element = None)
- class_trait_view_elements(cls)
- class_traits(cls, **metadata)
- clone_traits(self, traits = None, memo = None, copy = None, **metadata)
- configure_traits(self, filename = None, view = None, kind = None, edit = True, context = None, handler = None, id = '', scrollable = None, **args)
- copy_traits(self, other, traits = None, memo = None, copy = None, **metadata)
- copyable_trait_names(self, **metadata)
- default_traits_view(self)
- edit_traits(self, view = None, parent = None, kind = None, context = None, handler = None, id = '', scrollable = None, **args)
- editable_traits(self)
- has_traits_interface(self, *interfaces)
- on_trait_change(self, handler, name = None, remove = False, dispatch = 'same', priority = False, deferred = False)
- print_traits(self, show_help = False, **metadata)
- remove_trait(self, name)
- remove_trait_listener(self, object, prefix = '')
- reset_traits(self, traits = None, **metadata)
- set_trait_dispatch_handler(cls, name, klass, override = False)
- sync_trait(self, trait_name, object, alias = None, mutual = True, remove = False)
- trait(self, name, force = False, copy = False)
- trait_context(self)
- trait_get(self, *names, **metadata)
- trait_monitor(cls, handler, remove = False)
- trait_names(self, **metadata)
- trait_set(self, trait_change_notify = True, **traits)
- trait_setq(self, **traits)
- trait_subclasses(cls, all = False)
- trait_view(self, name = None, view_element = None)
- trait_view_elements(self)
- trait_views(self, klass = None)
- traits(self, **metadata)
- validate_trait(self, name, value)
Methods
- __init__(self, **traits)
Constructor.
- add_preferences_listener(self, listener, path = '')
Add a listener for changes to a node's preferences.
- clear(self, path = '')
Remove all preferences from the node at the specified path.
- dump(self, indent = '')
Dump the preferences hierarchy to stdout.
- flush(self)
Force any changes in the node to the backing store.
This includes any changes to the node's descendants.
- get(self, path, default = None, inherit = False)
Get the value of the preference at the specified path.
- keys(self, path = '')
Return the preference keys of the node at the specified path.
- load(self, file_or_filename = None)
Load preferences from a file.
This is a merge operation i.e. the contents of the file are added to the node.
This implementation uses 'ConfigObj' files.
- node(self, path = '')
Return the node at the specified path.
- node_exists(self, path = '')
Return True if the node at the specified path exists.
- node_names(self, path = '')
Return the names of the children of the node at the specified path.
- remove(self, path)
Remove the preference at the specified path.
- remove_preferences_listener(self, listener, path = '')
Remove a listener for changes to a node's preferences.
- save(self, file_or_filename = None)
Save the node's preferences to a file.
This implementation uses 'ConfigObj' files.
- set(self, path, value)
Set the value of the preference at the specified path.