Presents a detailed state of a component based on the interpretation of a string. More...

#include <CutWidgets.h>

Inheritance diagram for QeStateDetailed:

Public Slots
void	setStateString (QString newValue)
	Main setter of the QeState widget.

void	setOrthogonalSep (QString newValue)
	Defines which separator is to be used between Orthogonal regions.

Signals
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	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	popupModeChanged (bool popupMode)
	Indicates when the popupMode has changed.

Public Member Functions
	QeStateDetailed (QWidget *parent=nullptr)
	Constructor for the QeStateDetailed 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.

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.

bool	getPopupMode () const
	Returns if this instance of the widget is acting as a popup.

void	setSubstateSep (QString newValue)
	Defines which separator is to be used between Substates.

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	setPopupMode (bool popupMode)
	Sets the operation mode for the widget.

Properties
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.

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.

bool	popupMode
	Identifies this widget as a popup to a particular QeState.

Detailed Description

Presents a detailed state of a component based on the interpretation of a string.

Uses two separators to know where to cut the string.

Todo: Refactor QeState and QeStateDetailed common parts

Constructor & Destructor Documentation

◆ QeStateDetailed()

QeStateDetailed::QeStateDetailed ( QWidget * parent = nullptr )

explicit

Constructor for the QeStateDetailed class.

Parameters

parent QWidget that will be the parent to this newly constructure object.

Member Function Documentation

◆ getInitialisingWords()

QString QeStateDetailed::getInitialisingWords ( ) const

Gets the list of initialiasing words.

Returns: QString that contains a comma separated list of words.

See also: initialisingWords initialisingWordsChanged

◆ getNegativeWords()

QString QeStateDetailed::getNegativeWords ( ) const

Gets the list of negative words.

Returns: QString that contains a comma separated list of words.

See also: negativeWords negativeWordsChanged

◆ getNeutralWords()

QString QeStateDetailed::getNeutralWords ( ) const

Gets the list of neutral words.

Returns: QString that contains a comma separated list of words.

See also: neutralWords neutralWordsChanged

◆ getOffWords()

QString QeStateDetailed::getOffWords ( ) const

Gets the list of off words.

Returns: QString that contains a comma separated list of words.

See also: offWords offWordsChanged

◆ getOrthogonalSep()

QString QeStateDetailed::getOrthogonalSep ( )

Returns the separator used to parse between Orthogonal regions.

Returns: QString with the separator

See also: orthogonalSep setOrthogonalSep

◆ getOrthogonalStates()

QStringList QeStateDetailed::getOrthogonalStates ( )

Returns a list of strings that contains the separated orthogonal state.

Returns: QStringList List of parsed states

See also: orthogonalStates orthogonalStatesChanged

◆ getPopupMode()

bool QeStateDetailed::getPopupMode ( ) const

Returns if this instance of the widget is acting as a popup.

Returns: bool that indicates true if this will behave as a popup.

◆ getPositiveWords()

QString QeStateDetailed::getPositiveWords ( ) const

Gets the list of positive words.

Returns: QString that contains a comma separated list of words.

See also: positiveWords positiveWordsChanged

◆ getState()

QString QeStateDetailed::getState ( )

Returns the parsed state.

Returns: QString with the parsed state

See also: state stateChanged

◆ getStateString()

QString QeStateDetailed::getStateString ( )

Gets the stateString property.

Returns: The QString that represents the stateString property.

See also: stateString setStateString stateStringChanged

◆ getSubStates()

QStringList QeStateDetailed::getSubStates ( ) const

Returns list of parsed sub states.

Returns: QStringList with each of the parsed sub states.

See also: subStates subStatesChanged

◆ getSubstateSep()

QString QeStateDetailed::getSubstateSep ( )

Returns the separator used to parse between States whithin an orthogonal region.

Returns: QString with the separator

See also: substateSep setSubstateSep substateSepChanged

◆ getWarningWords()

QString QeStateDetailed::getWarningWords ( ) const

Gets the list of warning words.

Returns: QString that contains a comma separated list of words.

See also: warningWords warningWordsChanged

◆ popupModeChanged

void QeStateDetailed::popupModeChanged ( bool popupMode )

signal

Indicates when the popupMode has changed.

Parameters

popupMode true when the widget is operating under popupMode.

◆ setInitialisingWords()

void QeStateDetailed::setInitialisingWords ( QString initialisingWords )

Sets the initialising words property.

Parameters

initialisingWords Comma separated string of words considered initiliasing.

See also: initialisingWords getInitialisingWords initialisingWordsChanged

◆ setNegativeWords()

void QeStateDetailed::setNegativeWords ( QString negativeWords )

Sets the negative words property.

Parameters

negativeWords Comma separated string of words considered negative.

See also: negativeWords getNegativeWords negativeWordsChanged

◆ setNeutralWords()

void QeStateDetailed::setNeutralWords ( QString neutralWords )

Sets the neutral words property.

Parameters

neutralWords Comma separated string of words considered neutral.

See also: neutralWords getNeutralWords neutralWordsChanged

◆ setOffWords()

void QeStateDetailed::setOffWords ( QString offWords )

Sets the off words property.

Parameters

offWords Comma separated string of words considered off.

See also: offWords getOffWords offWordsChanged

◆ setOrthogonalSep

void QeStateDetailed::setOrthogonalSep ( QString newValue )

slot

Defines which separator is to be used between Orthogonal regions.

Parameters

newValue String to be used as orthogonal regions separator

See also: orthogonalSep getOrthogonalSep orthogonalSepChanged

◆ setPopupMode()

void QeStateDetailed::setPopupMode ( bool popupMode )

Sets the operation mode for the widget.

If true, the widget will act as a popup on top of the parent widget.

Parameters

popupMode bool that determines the new mode of operation for the widget

◆ setPositiveWords()

void QeStateDetailed::setPositiveWords ( QString positiveWords )

Sets the positve words property.

Parameters

positiveWords Comma separated string of words considered positive.

See also: positiveWords getPositiveWords positiveWordsChanged

◆ setSpacing()

void QeStateDetailed::setSpacing ( int spacing )

Sets the spacing property.

Parameters

spacing ammount of space between states.

See also: spacing

◆ setStateString

void QeStateDetailed::setStateString ( QString newValue )

slot

Main setter of the QeState widget.

It accepts newValue as the state information to be processed.

Parameters

newValue A double-separated string that carries the State information of a RAD component. Separators are set by QeState::orthogonalSep and QeState::substateSep.

See also: stateString getStateString stateStringChanged

◆ setSubstateSep()

void QeStateDetailed::setSubstateSep ( QString newValue )

Defines which separator is to be used between Substates.

Parameters

newValue String to be used as substate separator

See also: substateSep getSubstateSep

◆ setWarningWords()

void QeStateDetailed::setWarningWords ( QString warningWords )

Sets the warning words property.

Parameters

warningWords Comma separated string of words considered warning.

See also: warningWords getWarningWords warningWordsChanged

◆ spacing()

int QeStateDetailed::spacing ( ) const

Returns the ammount of pixels left as spacing between states.

Returns: int with the number of pixels between states.

See also: spacing setSpacing

Property Documentation

◆ initialisingWords

QString QeStateDetailed::initialisingWords

readwrite

Words considered for Initialising color (normally yellow), space separated.

Accessors:: getInitialisingWords(), setInitialisingWords(QString)

◆ negativeWords

QString QeStateDetailed::negativeWords

readwrite

Words considered for Negative color (normally red), space separated.

Accessors:: getNegativeWords(), setNegativeWords(QString)

◆ neutralWords

QString QeStateDetailed::neutralWords

readwrite

Words considered for Neutral color (normally blue), space separated.

Accessors:: getNeutralWords(), setNeutralWords(QString)

◆ offWords

QString QeStateDetailed::offWords

readwrite

Words considered for Off color (normally grey), space separated.

Accessors:: getOffWords(), setOffWords(QString)

◆ orthogonalSep

QString QeStateDetailed::orthogonalSep

readwrite

Orthogonal Regions separator.

Default ';'

Accessors:: getOrthogonalSep(), setOrthogonalSep(QString)

◆ orthogonalStates

QStringList QeStateDetailed::orthogonalStates

read

Orthogonal regions states, in a list.

Accessors:: getOrthogonalStates()

◆ popupMode

bool QeStateDetailed::popupMode

readwrite

Identifies this widget as a popup to a particular QeState.

Accessors:: getPopupMode(), setPopupMode(bool)

◆ positiveWords

QString QeStateDetailed::positiveWords

readwrite

Words considered for Positive color (normally green), space separated.

Accessors:: getPositiveWords(), setPositiveWords(QString)

◆ spacing

int QeStateDetailed::spacing

readwrite

Separation in pixels between one state and the next.

Accessors:: spacing(), setSpacing(bool)

◆ state

QString QeStateDetailed::state

read

Read-only property that contains the state of the component/application after interpretation of the stateString.

Accessors:: getState()

◆ stateString

QString QeStateDetailed::stateString

readwrite

Communicates the widget of the string that contains the state information.

Accessors:: getStateString(), setStateString(QString)

◆ subStates

QStringList QeStateDetailed::subStates

read

Substates in a list.

Accessors:: getSubStates()

◆ substateSep

QString QeStateDetailed::substateSep

readwrite

Substates separator.

Default ':'

Accessors:: getSubstateSep(), setSubstateSep(QString)

◆ warningWords

QString QeStateDetailed::warningWords

readwrite

Words considered for Warning color (normally orange), space separated.

Accessors:: getWarningWords(), setWarningWords(QString)

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

widgets/widgets/src/include/elt/cut/widgets/widgets/QeStateDetailed.hpp
widgets/widgets/src/QeStateDetailed.cpp

Public Slots

Signals

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ QeStateDetailed()

Member Function Documentation

◆ getInitialisingWords()

◆ getNegativeWords()

◆ getNeutralWords()

◆ getOffWords()

◆ getOrthogonalSep()

◆ getOrthogonalStates()

◆ getPopupMode()

◆ getPositiveWords()

◆ getState()

◆ getStateString()

◆ getSubStates()

◆ getSubstateSep()

◆ getWarningWords()

◆ popupModeChanged

◆ setInitialisingWords()

◆ setNegativeWords()

◆ setNeutralWords()

◆ setOffWords()

◆ setOrthogonalSep

◆ setPopupMode()

◆ setPositiveWords()

◆ setSpacing()

◆ setStateString

◆ setSubstateSep()

◆ setWarningWords()

◆ spacing()

Property Documentation

◆ initialisingWords

◆ negativeWords

◆ neutralWords

◆ offWords

◆ orthogonalSep

◆ orthogonalStates

◆ popupMode

◆ positiveWords

◆ spacing

◆ state

◆ stateString

◆ subStates

◆ substateSep

◆ warningWords