Package schrodinger :: Package tasks :: Module mappers :: Class SettingsParamMapper

Class SettingsParamMapper

       object --+                
                |                
sip.simplewrapper --+            
                    |            
          sip.wrapper --+        
                        |        
     PyQt5.QtCore.QObject --+    
                            |    
          AbstractParamMapper --+
                                |
                               SettingsParamMapper

This class is now deprecated in favor of TargetParamMapper.

This mapper allows mapping via appframework2's settings module. Any object that can be "get" and "set" in the settings module can be mapped to a param. This includes most basic Qt widgets as well as any classes that support the af2 settings getter and setter API.

Instance Methods

[hide private]

getSignalsAndSlots(self, model)
Given a model object, return all signals and slots that need to be connected to support auto updating.

onModelValueChanged(self)

_getTargetValue(self, target_obj)
This virtual method should return a mapped object's value, however that is defined by the derived class.

_setTargetValue(self, target_obj, value)
This virtual method should set a mapped object's value, however that is defined by the derived class.

Inherited from AbstractParamMapper: __init__, addMapping, setModel, setModelClass, suspend_auto_update_target, updateModel, updateTarget

Inherited from AbstractParamMapper (private): _connectModel, _disconnectModel, _getModelValue, _setModelValue, _updateModelParam, _updateTargetParam

Inherited from PyQt5.QtCore.QObject: __getattr__, blockSignals, childEvent, children, connectNotify, customEvent, deleteLater, destroyed, disconnect, disconnectNotify, dumpObjectInfo, dumpObjectTree, dynamicPropertyNames, event, eventFilter, findChild, findChildren, inherits, installEventFilter, isSignalConnected, isWidgetType, isWindowType, killTimer, metaObject, moveToThread, objectName, objectNameChanged, parent, property, pyqtConfigure, receivers, removeEventFilter, sender, senderSignalIndex, setObjectName, setParent, setProperty, signalsBlocked, startTimer, thread, timerEvent, tr

Inherited from sip.simplewrapper: __new__

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

Class Variables

[hide private]

Inherited from PyQt5.QtCore.QObject: staticMetaObject

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

getSignalsAndSlots(self, model)

Given a model object, return all signals and slots that need to be connected to support auto updating. Override this method in subclasses.

Returns:: a list of 2-tuples where each tuple is a signal, slot pair
Overrides: AbstractParamMapper.getSignalsAndSlots: (inherited documentation)

onModelValueChanged(self)

Decorators:

@util.skip_if('auto_update_target', False)

_getTargetValue(self, target_obj)

This virtual method should return a mapped object's value, however that is defined by the derived class.

Parameters:

target_obj - the target object

Overrides: AbstractParamMapper._getTargetValue

(inherited documentation)

_setTargetValue(self, target_obj, value)

This virtual method should set a mapped object's value, however that is defined by the derived class.

Parameters:

target_obj - the target object

Overrides: AbstractParamMapper._setTargetValue

(inherited documentation)