PythonQt.Qt.QHistoryState
QHistoryState
PythonQtInstanceWrapper object
Native bases: PythonQtInstanceWrapper
Supplemental documentation: Qt 5 reference:
Detailed Description
A history state is a pseudo-state that represents the child state that the parent state was in the last time the parent state was exited. A transition with a history state as its target is in fact a transition to one or more other child states of the parent state. QHistoryState is part of The State Machine Framework.
Use the setDefaultState() function to set the state that should be entered if the parent state has never been entered. Example:
QStateMachine machine;
QState *s1 = new QState();
QState *s11 = new QState(s1);
QState *s12 = new QState(s1);
QHistoryState *s1h = new QHistoryState(s1);
s1h->setDefaultState(s11);
machine.addState(s1);
QState *s2 = new QState();
machine.addState(s2);
QPushButton *button = new QPushButton();
// Clicking the button will cause the state machine to enter the child state
// that s1 was in the last time s1 was exited, or the history state's default
// state if s1 has never been entered.
s1->addTransition(button, SIGNAL(clicked()), s1h);
If more than one default state has to be entered, or if the transition to the default state(s) has to be acted upon, the defaultTransition should be set instead. Note that the eventTest() method of that transition will never be called: the selection and execution of the transition is done automatically when entering the history state.
By default a history state is shallow, meaning that it won't remember nested states. This can be configured through the historyType property.
Source: https://doc.qt.io/archives/qt-5.15/qhistorystate.html
Complete member index
Every captured member retains its own identity. Identical captured declaration text is linked once; this does not establish native inheritance or interchangeable objects.
| Member | Kind | Signature | Summary |
|---|---|---|---|
DeepHistory |
attribute | Any |
(shared captured text) |
HistoryType |
attribute | type |
Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text) |
ShallowHistory |
attribute | Any |
(shared captured text) |
__init__ |
function | (self, *args: Any, **kwargs: Any) -> None |
Native constructor; consult class documentation for supported overloads. (shared captured text) |
active |
attribute | Any |
(shared captured text) |
activeChanged |
function | (self, *args: Any, **kwargs: Any) -> Any |
Native PythonQt.Qt.QHistoryState.activeChanged; argument details are not documented. |
blockSignals |
function | (self, b: Any) -> bool |
X.blockSignals(b) -> bool (shared captured text) |
childEvent |
function | (self, event: Any) -> Any |
(shared captured text) |
children |
function | (self) -> tuple |
X.children() -> tuple (shared captured text) |
className |
function | (self, *args: Any, **kwargs: Any) -> Any |
Return the classname of the object (shared captured text) |
connect |
function | (self, signal: Any, receiver: Any, slot: Any, type: Any) -> bool |
X.connect(signal, receiver, slot, type) -> bool (shared captured text) |
customEvent |
function | (self, event: Any) -> Any |
(shared captured text) |
defaultState |
attribute | QAbstractState |
This property holds the default state of this history state (shared captured text) |
defaultStateChanged |
function | (self, *args: Any, **kwargs: Any) -> Any |
Native PythonQt.Qt.QHistoryState.defaultStateChanged; argument details are not documented. |
defaultTransition |
attribute | QAbstractTransition |
This property holds the default transition of this history state (shared captured text) |
defaultTransitionChanged |
function | (self, *args: Any, **kwargs: Any) -> Any |
Native PythonQt.Qt.QHistoryState.defaultTransitionChanged; argument details are not documented. |
delete |
function | (self, *args: Any, **kwargs: Any) -> Any |
Deletes the C++ object (at your own risk, my friend!) (shared captured text) |
deleteLater |
function | (self) -> Any |
(shared captured text) |
destroyed |
function | (self, *args: Any, **kwargs: Any) -> Any |
Native PythonQt.Qt.QHistoryState.destroyed; argument details are not documented. |
disconnect |
function | (self, signal: Any, receiver: Any, slot: Any) -> bool |
X.disconnect(signal, receiver, slot) -> bool (shared captured text) |
dumpObjectInfo |
function | (self) -> Any |
(shared captured text) |
dumpObjectTree |
function | (self) -> Any |
(shared captured text) |
dynamicPropertyNames |
function | (self) -> Any |
(shared captured text) |
entered |
function | (self, *args: Any, **kwargs: Any) -> Any |
Native PythonQt.Qt.QHistoryState.entered; argument details are not documented. |
event |
function | (self, e: Any) -> bool |
X.event(e) -> bool (shared captured text) |
eventFilter |
function | (self, watched: Any, event: Any) -> bool |
X.eventFilter(watched, event) -> bool (shared captured text) |
exited |
function | (self, *args: Any, **kwargs: Any) -> Any |
Native PythonQt.Qt.QHistoryState.exited; argument details are not documented. |
findChild |
function | (self, type: Any, name: Any) -> Any |
X.findChild(type, name) -> PythonQt.private.QObject (shared captured text) |
findChildren |
function | (self, type: Any, name: Any) -> tuple |
X.findChildren(type, name) -> tuple (shared captured text) |
help |
function | (self, *args: Any, **kwargs: Any) -> Any |
Shows the help of available methods for this class (shared captured text) |
historyType |
attribute | Any |
This property holds the type of history that this history state records (shared captured text) |
historyTypeChanged |
function | (self, *args: Any, **kwargs: Any) -> Any |
Native PythonQt.Qt.QHistoryState.historyTypeChanged; argument details are not documented. |
inherits |
function | (self, *args: Any, **kwargs: Any) -> Any |
Returns if the class inherits or is of given type name (shared captured text) |
installEventFilter |
function | (self, filterObj: Any) -> Any |
(shared captured text) |
isSignalConnected |
function | (self, signal: Any) -> bool |
X.isSignalConnected(signal) -> bool (shared captured text) |
isWidgetType |
function | (self) -> bool |
X.isWidgetType() -> bool (shared captured text) |
isWindowType |
function | (self) -> bool |
X.isWindowType() -> bool (shared captured text) |
killTimer |
function | (self, id: Any) -> Any |
(shared captured text) |
machine |
function | (self) -> Any |
X.machine() -> PythonQt.QtCore.QStateMachine (shared captured text) |
metaObject |
function | (self) -> Any |
X.metaObject() -> PythonQt.QtCore.QMetaObject (shared captured text) |
moveToThread |
function | (self, thread: Any) -> Any |
(shared captured text) |
objectName |
attribute | Any |
(shared captured text) |
objectNameChanged |
function | (self, *args: Any, **kwargs: Any) -> Any |
Native PythonQt.Qt.QHistoryState.objectNameChanged; argument details are not documented. |
onEntry |
function | (self, event: Any) -> None |
Reimplements: [QAbstractState::onEntry](https://doc.qt.io/archives/qt-5.15/qabstractstate.html#onEntry)(QEvent *event). (shared captured text) |
onExit |
function | (self, event: Any) -> None |
Reimplements: [QAbstractState::onExit](https://doc.qt.io/archives/qt-5.15/qabstractstate.html#onExit)(QEvent *event). (shared captured text) |
parent |
function | (self) -> Any |
X.parent() -> PythonQt.private.QObject (shared captured text) |
parentState |
function | (self) -> Any |
X.parentState() -> PythonQt.QtCore.QState (shared captured text) |
property |
function | (self, name: Any) -> Any |
X.property(name) -> object (shared captured text) |
removeEventFilter |
function | (self, obj: Any) -> Any |
(shared captured text) |
sender |
function | (self) -> Any |
X.sender() -> PythonQt.private.QObject (shared captured text) |
senderSignalIndex |
function | (self) -> int |
X.senderSignalIndex() -> int (shared captured text) |
setDefaultState |
function | (self, state: Any) -> None |
Sets this history state's default state to be the given state. state must be a sibling of this history state. (shared captured text) |
setDefaultTransition |
function | (self, transition: Any) -> None |
Sets this history state's default transition to be the given transition. (shared captured text) |
setHistoryType |
function | (self, type: Any) -> None |
Sets the type of history that this history state records. (shared captured text) |
setObjectName |
function | (self, name: Any) -> Any |
(shared captured text) |
setParent |
function | (self, parent: Any) -> Any |
(shared captured text) |
setProperty |
function | (self, name: Any, value: Any) -> bool |
X.setProperty(name, value) -> bool (shared captured text) |
signalsBlocked |
function | (self) -> bool |
X.signalsBlocked() -> bool (shared captured text) |
startTimer |
function | (self, interval: Any, timerType: Any) -> int |
X.startTimer(interval, timerType) -> int (shared captured text) |
thread |
function | (self) -> Any |
(shared captured text) |
timerEvent |
function | (self, event: Any) -> Any |
(shared captured text) |
tr |
function | (self, text: Any, ambig: Any, n: Any) -> str |
X.tr(text, ambig, n) -> str (shared captured text) |