TaurusValue
¶

-
class
TaurusValue
(parent=None, designMode=False, customWidgetMap=None)[source]¶ Bases:
PyQt4.QtGui.QWidget
,taurus.qt.qtgui.base.taurusbase.TaurusBaseWidget
Internal TaurusValue class
Warning
TaurusValue
(and any derived class from it) should never be instantiated directly. It is designed to be instantiated by aTaurusForm
class, since it breaks some conventions on the way it manages layouts of its parent model.-
allowWrite
¶
-
applyConfig
(configdict, **kwargs)[source]¶ extending
TaurusBaseWidget.applyConfig()
to restore the subwidget’s classesParameters: configdict ( dict
) –See also
TaurusBaseWidget.applyConfig()
,createConfig()
-
createConfig
(allowUnpickable=False)[source]¶ extending
TaurusBaseWidget.createConfig()
to store also the class names for subwidgetsParameters: alllowUnpickable ( bool
) –Return type: dict
<str
,object
>Returns: configurations (which can be loaded with applyConfig()
).
-
extraWidgetClass
¶
-
getCustomWidgetMap
()[source]¶ Returns the map used to create custom widgets.
Return type: dict
<str
,QWidget
>Returns: a dictionary whose keys are device type strings (i.e. see PyTango.DeviceInfo
) and whose values are widgets to be used
-
getDefaultReadWidgetClass
(returnAll=False)[source]¶ Returns the default class (or classes) to use as read widget for the current model.
Parameters: returnAll ( bool
) – if True, the return value is a list of valid classes instead of just one classReturn type: class
orlist
<class
>Returns: the default class to use for the read widget (or, if returnAll==True, a list of classes that can show the attribute ). If a list is returned, it will be loosely ordered by preference, being the first element always the default one.
-
getDefaultWriteWidgetClass
(returnAll=False)[source]¶ Returns the default class (or classes) to use as write widget for the current model.
Parameters: returnAll ( bool
) – if True, the return value is a list of valid classes instead of just one classReturn type: class
orlist
<class
>Returns: the default class to use for the write widget (or, if returnAll==True, a list of classes that can show the attribute ). If a list is returned, it will be loosely ordered by preference, being the first element always the default one.
-
getModelClass
()[source]¶ Return the class object for the widget. Default behavior is to do a ‘best effort’ to determine which model type corresponds to the current model name. Overwrite as necessary.
Return type: class TaurusModel
orNone
Returns: The class object corresponding to the type of Taurus model this widget handles or None if no valid class is found.
-
classmethod
getQtDesignerPluginInfo
()[source]¶ Returns pertinent information in order to be able to build a valid QtDesigner widget plugin.
The dictionary returned by this method should contain at least the following keys and values: - ‘module’ : a string representing the full python module name (ex.: ‘taurus.qt.qtgui.base’) - ‘icon’ : a string representing valid resource icon (ex.: ‘designer:combobox.png’) - ‘container’ : a bool telling if this widget is a container widget or not.
This default implementation returns the following dictionary:
{ 'group' : 'Taurus [Unclassified]', 'icon' : 'logos:taurus.png', 'container' : False }
Return type: dict
Returns: a map with pertinent designer information
-
getSwitcherClass
()[source]¶ Returns the TaurusValue switcher class (used in compact mode). Override this method if you want to use a custom switcher in TaurusValue subclasses.
-
handleEvent
(evt_src, evt_type, evt_value)[source]¶ Reimplemented from
TaurusBaseWidget.handleEvent()
to update subwidgets on config events
-
hasPendingOperations
()[source]¶ self.getPendingOperations will always return an empty list, but still self.hasPendingOperations will look at the writeWidget’s operations. If you want to ask the TaurusValue for its pending operations, call self.writeWidget().getPendingOperations()
-
isReadOnly
()[source]¶ Determines if this component is read-only or not in the sense that the user can interact with it. Default implementation returns True.
Override when necessary.
Return type: bool
Returns: whether or not this component is read-only
-
labelConfig
¶
-
labelWidgetClass
¶
-
model
¶ Returns the model name for this component.
Return type: str
Returns: the model name.
-
modifiableByUser
¶ whether the user can change the contents of the widget
Return type: bool
Returns: True if the user is allowed to modify the look&feel
-
parentModelChanged
(parentmodel_name)[source]¶ Invoked when the parent model changes
Parameters: parentmodel_name ( str
) – the new name of the parent model
-
preferredRow
¶
-
readWidget
(followCompact=False)[source]¶ Returns the read widget. If followCompact=True, and compact mode is used, it returns the switcher’s readWidget instead of the switcher itself.
-
readWidgetClass
¶
-
setCustomWidgetClass
(classID)[source]¶ substitutes the current widget by a new one. classID can be one of: None, ‘Auto’, a TaurusWidget class name, or any class
-
setCustomWidgetMap
(cwmap)[source]¶ Sets a map map for custom widgets.
Parameters: cwmap ( dict
<str
,QWidget
>) – a dictionary whose keys are device class strings (seePyTango.DeviceInfo
) and whose values are widget classes to be used
-
setDangerMessage
(dangerMessage=None)[source]¶ Sets the danger message when applying an operation. If dangerMessage is None, the apply operation is considered safe
Parameters: dangerMessage ( str
orNone
) – the danger message. If None is given (default) the apply operation is considered safe
-
setExtraWidgetClass
(classID)[source]¶ substitutes the current widget by a new one. classID can be one of: None, ‘Auto’, a TaurusWidget class name, or any class
-
setForceDangerousOperations
(yesno)[source]¶ Forces/clears the dangerous operations
Parameters: yesno ( bool
) – force or not the dangerous operations
-
setLabelConfig
(config)[source]¶ Sets fragment configuration to the label widget.
Parameters: config (str) – fragment
-
setLabelWidgetClass
(classID)[source]¶ substitutes the current widget by a new one. classID can be one of: None, ‘Auto’, a TaurusWidget class name, or any class
-
setModel
(model)[source]¶ extending
TaurusBaseWidget.setModel()
to change the modelclass dynamically and to update the subwidgets
-
setReadWidgetClass
(classID)[source]¶ substitutes the current widget by a new one. classID can be one of: None, ‘Auto’, a TaurusWidget class name, or any class
-
setUnitsWidgetClass
(classID)[source]¶ substitutes the current widget by a new one. classID can be one of: None, ‘Auto’, a TaurusWidget class name, or any class
-
setWriteWidgetClass
(classID)[source]¶ substitutes the current widget by a new one. classID can be one of: None, ‘Auto’, a TaurusWidget class name, or any class
-
unitsWidgetClass
¶
-
updatePendingOpsStyle
()[source]¶ This method should be reimplemented by derived classes that want to change their appearance depending whether there are pending operations or not
-
writeWidget
(followCompact=False)[source]¶ Returns the write widget. If followCompact=True, and compact mode is used, it returns the switcher’s writeWidget instead of None.
-
writeWidgetClass
¶
-