qubx :: settings :: Settings :: Class Settings
[hide private]
[frames] | no frames]

Class Settings

source code

object --+
         |
        Settings

The settings for one category.

Instance Methods [hide private]
 
__init__(self, mgr, name)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
_defOnSet(self, settings, updates) source code
 
_setOnSet(self, onSet) source code
 
_getOnSet(self) source code
 
setProperties(self, updates)
Requests that .active include settings from updates, by calling .OnSet(updates)
source code
 
setPropertiesDict(self, **kw)
Requests that .active use settings by keyword.
source code
 
listNames(self)
Returns a list of available preset names
source code
 
save(self, name)
Saves the active settings as a named preset
source code
 
load(self, name)
calls setProperties(named preset)
source code
 
read(self, name)
Returns the qubx.tree.Node() for a named preset
source code
 
exportFile(self, path)
Saves the active settings at path
source code
 
importFile(self, path)
Calls setProperties(Open(path))
source code
 
saveActive(self)
Writes the active settings to disk; e.g.
source code
 
as_pairs(self, keys=None, enums=[]) source code

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

Instance Variables [hide private]
  OnSet
function(Settings, updates_node); this is where you are given requested changes to .active
  active
qubx.tree.Node(), root of settings tree; you must keep it up to date.
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, mgr, name)
(Constructor)

source code 

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

Overrides: object.__init__
(inherited documentation)

setPropertiesDict(self, **kw)

source code 

Requests that .active use settings by keyword. Converted to a tree and passed to OnSet.

saveActive(self)

source code 

Writes the active settings to disk; e.g. before quitting or risking a crash.


Instance Variable Details [hide private]

OnSet

function(Settings, updates_node); this is where you are given requested changes to .active
Get Method:
unreachable(s)
Set Method:
unreachable(s, x)

active

qubx.tree.Node(), root of settings tree; you must keep it up to date. it is restored across sessions.