Класс QState

Класс QState предоставляет универсальное состояние для QStateMachine. Подробнее...

• Список всех членов, включая унаследованные

Типы публичного доступа

Свойства

• childMode : ChildMode
• errorState : QAbstractState*
• initialState : QAbstractState*

Публичные функции

Сигналы

Переопределённые защищённые функции

Подробное описание

Объекты QState могут иметь дочерние состояния и переходы в другие состояния. QState входит в состав Фреймворка Qt State Machine.

Функция addTransition() добавляет переход. Функция removeTransition() удаляет переход. Функция transitions() возвращает исходящие переходы состояния.

Функция assignProperty() используется для определения назначений свойств, которые должны быть выполнены при входе в состояние.

Состояния верхнего уровня должны получить объект QStateMachine в качестве родительского состояния или быть добавлены в машину состояний с помощью QStateMachine::addState().

Состояния с дочерними состояниями

Свойство childMode определяет, как обрабатываются дочерние состояния. Для непараллельных групп состояний функция setInitialState() должна быть вызвана для задания начального состояния. Дочерние состояния являются взаимоисключающими состояниями, и машина состояний должна знать, какое дочернее состояние войти, когда родительское состояние является целью перехода.

Состояние излучает сигнал QState::finished() при входе в конечное дочернее состояние (QFinalState).

Функция setErrorState() устанавливает состояние ошибки состояния. Состояние ошибки — это состояние, в которое машина состояний перейдет, если при попытке перехода в состояние будет обнаружена ошибка (например, из-за того, что начальное состояние не было установлено).

Документация по типам членов

Перечисление QState::ChildMode

Это перечисление определяет, как обрабатываются дочерние состояния состояния.

Перечисление QState::RestorePolicy

Это перечисление определяет тип политики восстановления. Политика восстановления вступает в силу при входе в состояние, которое устанавливает одно или несколько свойств. Если политика восстановления установлена в RestoreProperties, машина состояний сохранит исходное значение свойства перед установкой нового значения.

Позже, когда машина войдёт в состояние, которое не устанавливает значение для данного свойства, свойство автоматически восстановится до своего начального значения.

Для любого данного свойства будет сохранено только одно начальное значение. Если машина состояний уже сохранила значение свойства, оно не будет перезаписано, пока свойство не будет успешно восстановлено.

См. также QStateMachine::globalRestorePolicy и QState::assignProperty().

Документация по членам-функциям

QState::QState(QState::ChildMode childMode, QState *parent = nullptr)

Создает новое состояние с заданным childMode и заданным состоянием parent.

QState::QState(QState *parent = nullptr)

Создает новое состояние с заданным состоянием parent.

[private signal, since 5.4] void QState::childModeChanged()

Этот сигнал излучается при изменении свойства childMode.

Примечание: Это частный сигнал. Он может использоваться в соединениях сигналов, но не может излучаться пользователем.

Примечание: Сигнал-уведомление для свойства childMode.

Эта функция была добавлена в Qt 5.4.

См. также QState::childMode.

[private signal, since 5.4] void QState::errorStateChanged()

Этот сигнал излучается при изменении свойства errorState.

Примечание: Это частный сигнал. Он может использоваться в соединениях сигналов, но не может излучаться пользователем.

Примечание: Сигнал-уведомление для свойства errorState.

Эта функция была добавлена в Qt 5.4.

См. также QState::errorState.

[private signal] void QState::finished()

Этот сигнал излучается, когда вводится конечное дочернее состояние этого состояния.

Примечание: Это частный сигнал. Он может использоваться в соединениях сигналов, но не может излучаться пользователем.

См. также QFinalState.

[private signal, since 5.4] void QState::initialStateChanged()

Этот сигнал излучается при изменении свойства initialState.

Примечание: Это частный сигнал. Он может использоваться в соединениях сигналов, но не может излучаться пользователем.

Примечание: Сигнал-уведомление для свойства initialState.

Эта функция была добавлена в Qt 5.4.

См. также QState::initialState.

[private signal] void QState::propertiesAssigned()

Этот сигнал излучается, когда все свойства получили свое окончательное значение. Если состояние присваивает значение одному или нескольким свойствам, для которых существует анимация (установленная на переходе или по умолчанию в машине состояний), сигнал будет излучен только после завершения всех таких анимаций.

Если соответствующие анимации отсутствуют или для состояния не заданы присвоения свойств, сигнал будет излучен непосредственно перед входом в состояние.

См. также QState::assignProperty() и QAbstractTransition::addAnimation()

Примечание: Это частный сигнал. Он может использоваться в соединениях сигналов, но не может излучаться пользователем.

[virtual] QState::~QState()

Уничтожает это состояние.

void QState::addTransition(QAbstractTransition *transition)

Добавляет заданный transition. Переход имеет это состояние в качестве источника. Это состояние берет на себя владение переходом.

QSignalTransition *QState::addTransition(const QObject *sender, const char *signal, QAbstractState *target)

Добавляет переход, связанный с заданным signal объекта sender, и возвращает новый объект QSignalTransition. Переход имеет это состояние в качестве источника и заданное target в качестве целевого состояния.

[since 5.5] template <typename PointerToMemberFunction> QSignalTransition *QState::addTransition(const QObject *sender, PointerToMemberFunction signal, QAbstractState *target)

Это перегруженная функция.

Добавляет переход, связанный с заданным signal объекта sender, и возвращает новый объект QSignalTransition. Переход имеет это состояние в качестве источника и заданное target в качестве целевого состояния.

Эта функция была добавлена в Qt 5.5.

QAbstractTransition *QState::addTransition(QAbstractState *target)

Добавляет безусловный переход из этого состояния в заданное target состояние и возвращает объект нового перехода.

void QState::assignProperty(QObject *object, const char *name, const QVariant &value)

Указывает этому состоянию установить свойство с заданным name заданного object на заданное value при входе в состояние.

См. также propertiesAssigned().

QState::ChildMode QState::childMode() const

Возвращает режим дочерних состояний этого состояния.

Примечание: Функция-получатель для свойства childMode.

См. также setChildMode().

QAbstractState *QState::errorState() const

Возвращает состояние ошибки этого состояния.

Примечание: Функция-получатель для свойства errorState.

См. также setErrorState() и QStateMachine::error().

[override virtual protected] bool QState::event(QEvent *e)

Переопределяет: QAbstractState::event(QEvent *e).

QAbstractState *QState::initialState() const

Возвращает начальное состояние этого состояния, или nullptr если состояние не имеет начального состояния.

Примечание: Функция-получатель для свойства initialState.

См. также setInitialState().

[override virtual protected] void QState::onEntry(QEvent *event)

Переопределяет: QAbstractState::onEntry(QEvent *event).

[override virtual protected] void QState::onExit(QEvent *event)

Переопределяет: QAbstractState::onExit(QEvent *event).

void QState::removeTransition(QAbstractTransition *transition)

Удаляет заданный transition из этого состояния. Состояние высвобождает владение переходом.

См. также addTransition().

void QState::setChildMode(QState::ChildMode mode)

Устанавливает режим дочерних состояний этого состояния.

Примечание: Функция-установщик для свойства childMode.

См. также childMode().

void QState::setErrorState(QAbstractState *state)

Устанавливает состояние ошибки этого состояния в заданное state. Если состояние ошибки не установлено или установлено в nullptr, состояние унаследует состояние ошибки родителя рекурсивно. Если для самого состояния или любого из его предков состояние ошибки не установлено, ошибка приведёт к остановке выполнения машины и выводу ошибки в консоль.

Примечание: Функция-установщик для свойства errorState.

См. также errorState().

void QState::setInitialState(QAbstractState *state)

Устанавливает начальное состояние этого состояния в заданное state. state должен быть дочерним состоянием этого состояния.

Примечание: Функция-сеттер для свойства initialState.

См. также initialState().

QList<QAbstractTransition *> QState::transitions() const

Возвращает исходящие переходы данного состояния (т.е. переходы, где это состояние является исходным состоянием), или пустой список, если у этого состояния нет исходящих переходов.

См. также addTransition().