zim.config.dicts.ControlledDict

class documentation

Sub-class of DefinitionOrderedDict that tracks modified state. This modified state is recursive for nested ControlledDicts.

Used as base class for SectionedConfigDict and ConfigDict.

Unknown Field: signal
`changed ()`: emitted when content of this dict changed, or a nested `ControlledDict` changed

Method	`__delitem__`	Undocumented
Method	`__init__`	Undocumented
Method	`__setitem__`	Undocumented
Method	`changed`	Undocumented
Method	`do_changed`	Undocumented
Method	`on_child_changed`	Undocumented
Method	`set_modified`	Set the modified state. Used to reset modified to `False` after the configuration has been saved to file. @param modified: `True` or `False`
Method	`update`	Undocumented
Class Variable	`__signals__`	Undocumented
Property	`modified`	`True` when the values were modified, used to e.g. track when a config needs to be written back to file
Instance Variable	`_modified`	Undocumented

Inherited from SignalEmitter:

Method	`__new__`	Undocumented
Method	`block_signals`	Returns a context manager for blocking one or more signals
Method	`connect`	Register a handler for a specific object.
Method	`connect_after`	Like `connect()` but handler will be called after default handler
Method	`disconnect`	Undocumented
Method	`emit`	Undocumented
Method	`emit_return_first`	Emits a signal and stops emission on the first handler that returns a not-None value.
Method	`emit_return_iter`	Returns an generator that calls one handler on each iteration and yields the return values. This allows aggregating return values.
Method	`_connect`	Undocumented
Method	`_setup_signal`	Undocumented
Method	`_teardown_signal`	Undocumented

Inherited from ConnectorMixin:

Method	`connectto`	Connect to signals of another object E.g.:
Method	`connectto_all`	Convenience method to combine multiple calls to `connectto()`.
Method	`disconnect_all`	Disconnect all signals that have been connected with `connectto` and friends. Typically called when you want to destroy this object.
Method	`disconnect_from`	Disc all signals that have been connected with `connectto` and friends to a specific object.
Method	`_disconnect_from`	Undocumented
Instance Variable	`_connected_signals`	Undocumented

def __delitem__(self, k): (source)

overridden in zim.config.dicts.ConfigDict

Undocumented

def __init__(self, E=(), **F): (source)

overridden in zim.config.dicts.ConfigDict, zim.config.dicts.INIConfigFile

Undocumented

def __setitem__(self, k, v): (source)

overrides zim.utils.DefinitionOrderedDict.__setitem__

overridden in zim.config.dicts.ConfigDict, zim.config.dicts.SectionedConfigDict

Undocumented

def changed(self): (source)

Undocumented

def do_changed(self): (source)

Undocumented

def on_child_changed(self, v): (source)

Undocumented

def set_modified(self, modified): (source)

Set the modified state. Used to reset modified to False after the configuration has been saved to file.

Parameters
modified	`True` or `False`

def update(self, E=(), **F): (source)

overridden in zim.config.dicts.ConfigDict

Undocumented

__signals__ = (source)

overrides zim.signals.SignalEmitter.__signals__

Undocumented

True when the values were modified, used to e.g. track when a config needs to be written back to file

_modified: bool = (source)

Undocumented