taurus.taurusstate.TaurusState Class Reference

Taurus widget for QeState that implementes Taurus databinding. More...

Inheritance diagram for taurus.taurusstate.TaurusState:

Public Member Functions
	__init__ (self, Qt.QWidget parent=None)
	Initializes the TaurusState widget.
TaurusBaseController	controller (self)
	Returns the controller object for this widget.
	handleEvent (self, Attribute evt_src, TaurusEventType evt_type, TaurusAttrValue evt_value)
	Events sent to the widget are checked for the value, and set as the stateString of the QeState widget.
bool	isReadOnly (self)
	This widget is read only.
	getModelIndexValue (self)
	Gets the value of the modelIndex property.
	getModelIndex (self)
	Getter for the modelIndex property.
	setModelIndex (self, modelIndex)
	Getter for the modelIndex property.
	resetModelIndex (self)
	Getter for the bgRole property.
	getBgRole (self)
	Getter for the bgRole property.
	setBgRole (self, bgRole)
	Setter for the bgRole property.
	resetBgRole (self)
	Resets to the default value the bgRole property.
	getFgRole (self)
	Getter for the fgRole property.
	setFgRole (self, fgRole)
	Setter for the fgRole property.
	resetFgRole (self)
	Resets to the default value the fgRole property.
	getQtDesignerPluginInfo (cls)
	Provides Qt Designer with widget information.
Public Member Functions inherited from QeState
	QeState (QWidget *parent=nullptr)
	Constructor for the QeState class.
QString	getStateString ()
	Gets the stateString property.
QString	getState ()
	Returns the parsed state.
QStringList	getOrthogonalStates ()
	Returns a list of strings that contains the separated orthogonal state.
QString	getOrthogonalSep ()
	Returns the separator used to parse between Orthogonal regions.
QString	getSubstateSep ()
	Returns the separator used to parse between States whithin an orthogonal region.
QStringList	getSubStates () const
	Returns list of parsed sub states.
bool	showsAll () const
	Indicates when the widget shows all orthogonal regions instead of just one.
bool	isAutoCompacting () const
	Indicates if the widget is set to automatically summarize states is horizontal space is not enough.
int	spacing () const
	Returns the ammount of pixels left as spacing between states.
QString	getPositiveWords () const
	Gets the list of positive words.
QString	getWarningWords () const
	Gets the list of warning words.
QString	getNegativeWords () const
	Gets the list of negative words.
QString	getNeutralWords () const
	Gets the list of neutral words.
QString	getOffWords () const
	Gets the list of off words.
QString	getInitialisingWords () const
	Gets the list of initialiasing words.
int	getShowOnlyIndex () const
	Gets the currently shown orthogonal region index.

Static Public Attributes
	model = Qt.Property("QString", TaurusBaseWidget.getModel, setModel, TaurusBaseWidget.resetModel)
	This property holds the unique URI string representing the model name with which this widget will get its data from.
	fgRole = Qt.Property("QString", getFgRole, setFgRole, resetFgRole, doc="foreground role")
	This property holds the foreground role.
	bgRole = Qt.Property("QString", getBgRole, setBgRole, resetBgRole, doc="background role")
	This property holds the background role.

Additional Inherited Members
Public Slots inherited from QeState
void	setStateString (QString newValue)
	Main setter of the QeState widget.
void	setOrthogonalSep (QString newValue)
	Defines which separator is to be used between Orthogonal regions.
void	setSubstateSep (QString newValue)
	Defines which separator is to be used between Substates.
void	setShowAll (bool showAll)
	When true configures the widget to show the complete Substates string.
void	setAutoCompact (bool autoCompact)
	Sets the autoCompact property.
void	setSpacing (int spacing)
	Sets the spacing property.
void	setPositiveWords (QString positiveWords)
	Sets the positve words property.
void	setWarningWords (QString warningWords)
	Sets the warning words property.
void	setNegativeWords (QString negativeWords)
	Sets the negative words property.
void	setNeutralWords (QString neutralWords)
	Sets the neutral words property.
void	setOffWords (QString offWords)
	Sets the off words property.
void	setInitialisingWords (QString initialisingWords)
	Sets the initialising words property.
void	setShowOnlyIndex (int showOnlyIndex)
	Sets the showOnlyIndex property.
Signals inherited from QeState
void	stateStringChanged (QString newValue)
	Indicates a change in the stateString property.
void	stateChanged (QString newValue)
	Indicates a change in the state property.
void	orthogonalStatesChanged (QStringList newValue)
	Indicates a change in the orthogonalStates property.
void	orthogonalSepChanged (QString newValue)
	Indicates a change in the orthogonal separator property.
void	substateSepChanged (QString newValue)
	Indicates a change in the substate separator property.
void	subStatesChanged (QStringList subStates)
	Indicates a change in the substates property.
void	showAllChanged (bool showAll)
	Indicates a change in the showAll property.
void	autoCompactChanged (bool autoCompact)
	Indicates a change in the autoCompact property.
void	positiveWordsChanged (QString positiveWords)
	Indicates a change in the positiveWords property.
void	warningWordsChanged (QString warningWords)
	Indicates a change in the warningWords property.
void	negativeWordsChanged (QString negativeWords)
	Indicates a change in the negativeWords property.
void	neutralWordsChanged (QString neutralWords)
	Indicates a change in the neutralWords property.
void	offWordsChanged (QString offWords)
	Indicates a change in the offWords property.
void	initialisingWordsChanged (QString initialisingWords)
	Indicates a change in the initialisingWords property.
void	clicked ()
	Emitted when a mouse click is done in the widget.
void	showOnlyIndexChanged (int showOnlyIndex)
	Signal emitted when the showOnlyIndex property changes.
Properties inherited from QeState
QString	stateString
	Communicates the widget of the string that contains the state information.
QString	state
	Read-only property that contains the state of the component/application after interpretation of the stateString.
QStringList	orthogonalStates
	Orthogonal regions states, in a list.
QStringList	subStates
	Substates in a list.
QString	orthogonalSep
	Orthogonal Regions separator.
QString	substateSep
	Substates separator.
bool	showAll
	Shows states and substates for first region.
bool	autoCompact
	Automatically compact representation to Initials when no space is available.
int	spacing
	Separation in pixels between one state and the next.
QString	initialisingWords
	Words considered for Initialising color (normally yellow), space separated.
QString	positiveWords
	Words considered for Positive color (normally green), space separated.
QString	warningWords
	Words considered for Warning color (normally orange), space separated.
QString	negativeWords
	Words considered for Negative color (normally red), space separated.
QString	neutralWords
	Words considered for Neutral color (normally blue), space separated.
QString	offWords
	Words considered for Off color (normally grey), space separated.
int	showOnlyIndex
	Shows only the state for the orthogonal region in the index N.

Detailed Description

Taurus widget for QeState that implementes Taurus databinding.

The bgRole (background color) is automatically assign to the quality of the attribute.

Constructor & Destructor Documentation

__init__()

taurus.taurusstate.TaurusState.__init__	(		self,
		Qt.QWidget	parent = None )

Initializes the TaurusState widget.

Parameters

parent

Parent QWidget

Member Function Documentation

controller()

TaurusBaseController taurus.taurusstate.TaurusState.controller

(

self

)

Returns the controller object for this widget.

See also

TaurusBaseController

Returns

TaurusBaseController controller of the widget

getQtDesignerPluginInfo()

taurus.taurusstate.TaurusState.getQtDesignerPluginInfo

(

cls

)

Provides Qt Designer with widget information.

Return: dict Dictionary with values for keys: icon, module, container, tool_tip and xml.

handleEvent()

taurus.taurusstate.TaurusState.handleEvent	(		self,
		Attribute	evt_src,
		TaurusEventType	evt_type,
		TaurusAttrValue	evt_value )

Events sent to the widget are checked for the value, and set as the stateString of the QeState widget.

Overrides TaurusBaseWidget.handleEvent()

Parameters

evt_src	Source of the event (taurus.Attribute)
evt_type	Type of the event
evt_value	Value of the event

Member Data Documentation

bgRole

taurus.taurusstate.TaurusState.bgRole = Qt.Property("QString", getBgRole, setBgRole, resetBgRole, doc="background role")

static

This property holds the background role.

Valid values are None, "quality", "state"

Access functions:

• getBgRole
• setBgRole
• resetBgRole

fgRole

taurus.taurusstate.TaurusState.fgRole = Qt.Property("QString", getFgRole, setFgRole, resetFgRole, doc="foreground role")

static

This property holds the foreground role.

Valid values are:

• None - no value is displayed
• "value" - the value is displayed
• "w_value" - the write value is displayed

Access functions:

• getFgRole
• setFgRole
• resetFgRole

model

taurus.taurusstate.TaurusState.model = Qt.Property("QString", TaurusBaseWidget.getModel, setModel, TaurusBaseWidget.resetModel)

static

This property holds the unique URI string representing the model name with which this widget will get its data from.

Access functions:

• TaurusBaseWidget.getModel
• setModel
• TaurusBaseWidget.resetModel

---

The documentation for this class was generated from the following file:

• widgets/taurus/src/elt/cut/widgets/taurus/taurusstate.py