diff options
Diffstat (limited to 'src')
| -rw-r--r-- | src/corelib/statemachine/qabstractstate.cpp | 1 | ||||
| -rw-r--r-- | src/corelib/statemachine/qabstracttransition.cpp | 1 | ||||
| -rw-r--r-- | src/corelib/statemachine/qactionstate.cpp | 1 | ||||
| -rw-r--r-- | src/corelib/statemachine/qeventtransition.cpp | 5 | ||||
| -rw-r--r-- | src/corelib/statemachine/qfinalstate.cpp | 1 | ||||
| -rw-r--r-- | src/corelib/statemachine/qhistorystate.cpp | 1 | ||||
| -rw-r--r-- | src/corelib/statemachine/qsignaltransition.cpp | 1 | ||||
| -rw-r--r-- | src/corelib/statemachine/qstate.cpp | 4 | ||||
| -rw-r--r-- | src/corelib/statemachine/qstateaction.cpp | 8 | ||||
| -rw-r--r-- | src/corelib/statemachine/qstatemachine.cpp | 5 | ||||
| -rw-r--r-- | src/corelib/statemachine/qtransition.cpp | 1 | ||||
| -rw-r--r-- | src/gui/statemachine/qkeyeventtransition.cpp | 1 | ||||
| -rw-r--r-- | src/gui/statemachine/qmouseeventtransition.cpp | 1 |
13 files changed, 25 insertions, 6 deletions
diff --git a/src/corelib/statemachine/qabstractstate.cpp b/src/corelib/statemachine/qabstractstate.cpp index c85fd09..89dcff9 100644 --- a/src/corelib/statemachine/qabstractstate.cpp +++ b/src/corelib/statemachine/qabstractstate.cpp @@ -52,6 +52,7 @@ QT_BEGIN_NAMESPACE \brief The QAbstractState class is the base class of states of a QStateMachine. + \since 4.6 \ingroup statemachine The QAbstractState class is the abstract base class of states that are part diff --git a/src/corelib/statemachine/qabstracttransition.cpp b/src/corelib/statemachine/qabstracttransition.cpp index 36de7f5..aff7475 100644 --- a/src/corelib/statemachine/qabstracttransition.cpp +++ b/src/corelib/statemachine/qabstracttransition.cpp @@ -52,6 +52,7 @@ QT_BEGIN_NAMESPACE \brief The QAbstractTransition class is the base class of transitions between QAbstractState objects. + \since 4.6 \ingroup statemachine The QAbstractTransition class is the abstract base class of transitions diff --git a/src/corelib/statemachine/qactionstate.cpp b/src/corelib/statemachine/qactionstate.cpp index 7f44994..1da0350 100644 --- a/src/corelib/statemachine/qactionstate.cpp +++ b/src/corelib/statemachine/qactionstate.cpp @@ -51,6 +51,7 @@ QT_BEGIN_NAMESPACE \brief The QActionState class provides an action-based state. + \since 4.6 \ingroup statemachine QActionState executes \l{QStateAction}{state actions} when the state is diff --git a/src/corelib/statemachine/qeventtransition.cpp b/src/corelib/statemachine/qeventtransition.cpp index b03074d..078253a 100644 --- a/src/corelib/statemachine/qeventtransition.cpp +++ b/src/corelib/statemachine/qeventtransition.cpp @@ -55,10 +55,11 @@ QT_BEGIN_NAMESPACE \brief The QEventTransition class provides a QObject-specific transition for Qt events. + \since 4.6 \ingroup statemachine - A QEventTransition object binds an event or transition to a particular - QObject. QEventTransition is part of \l{The State Machine Framework}. + A QEventTransition object binds an event to a particular QObject. + QEventTransition is part of \l{The State Machine Framework}. Example: diff --git a/src/corelib/statemachine/qfinalstate.cpp b/src/corelib/statemachine/qfinalstate.cpp index 5219b1b..abf9d2e 100644 --- a/src/corelib/statemachine/qfinalstate.cpp +++ b/src/corelib/statemachine/qfinalstate.cpp @@ -49,6 +49,7 @@ QT_BEGIN_NAMESPACE \brief The QFinalState class provides a final state. + \since 4.6 \ingroup statemachine A final state is used to communicate that (part of) a QStateMachine has diff --git a/src/corelib/statemachine/qhistorystate.cpp b/src/corelib/statemachine/qhistorystate.cpp index a0c933c..8143d41 100644 --- a/src/corelib/statemachine/qhistorystate.cpp +++ b/src/corelib/statemachine/qhistorystate.cpp @@ -49,6 +49,7 @@ QT_BEGIN_NAMESPACE \brief The QHistoryState class provides a means of returning to a previously active substate. + \since 4.6 \ingroup statemachine A history state is a pseudo-state that represents the child state that the diff --git a/src/corelib/statemachine/qsignaltransition.cpp b/src/corelib/statemachine/qsignaltransition.cpp index 9c03b94..83733cf 100644 --- a/src/corelib/statemachine/qsignaltransition.cpp +++ b/src/corelib/statemachine/qsignaltransition.cpp @@ -55,6 +55,7 @@ QT_BEGIN_NAMESPACE \brief The QSignalTransition class provides a transition based on a Qt signal. + \since 4.6 \ingroup statemachine Typically you would use the overload of QState::addTransition() that takes a diff --git a/src/corelib/statemachine/qstate.cpp b/src/corelib/statemachine/qstate.cpp index 944ca2c..e3da1c5 100644 --- a/src/corelib/statemachine/qstate.cpp +++ b/src/corelib/statemachine/qstate.cpp @@ -57,6 +57,7 @@ QT_BEGIN_NAMESPACE \brief The QState class provides a general-purpose state for QStateMachine. + \since 4.6 \ingroup statemachine QState objects can have child states, and can have transitions to other @@ -74,6 +75,9 @@ QT_BEGIN_NAMESPACE The addHistoryState() function adds a history state. + The addFinishedTransition() function creates and adds a transition that's + triggered when a final child state is entered. + The setErrorState() sets the state's error state. The error state is the state that the state machine will transition to if an error is detected when attempting to enter the state (e.g. because no initial state has been set). diff --git a/src/corelib/statemachine/qstateaction.cpp b/src/corelib/statemachine/qstateaction.cpp index b03aa19..569d5d5 100644 --- a/src/corelib/statemachine/qstateaction.cpp +++ b/src/corelib/statemachine/qstateaction.cpp @@ -71,11 +71,12 @@ void QStateActionPrivate::callExecute() \brief The QStateAction class is the base class of QState actions. + \since 4.6 \ingroup statemachine - A state action is added to a state by calling QState::addEntryAction() or - QState::addExitAction(). QStateAction is part of \l{The State Machine - Framework}. + A state action is added to a state by calling QActionState::addEntryAction() + or QActionState::addExitAction(). QStateAction is part of \l{The State + Machine Framework}. \section1 Subclassing @@ -152,6 +153,7 @@ QStateInvokeMethodActionPrivate *QStateInvokeMethodActionPrivate::get(QStateInvo \brief The QStateInvokeMethodAction class provides an invoke method action for QObjects. + \since 4.6 \ingroup statemachine The QStateInvokeMethodAction class provides an action that calls a method of diff --git a/src/corelib/statemachine/qstatemachine.cpp b/src/corelib/statemachine/qstatemachine.cpp index f1fc8a0..77c2a12 100644 --- a/src/corelib/statemachine/qstatemachine.cpp +++ b/src/corelib/statemachine/qstatemachine.cpp @@ -92,6 +92,7 @@ QT_BEGIN_NAMESPACE \brief The QStateMachine class provides a hierarchical finite state machine. + \since 4.6 \ingroup statemachine The QStateMachine class provides a hierarchical finite state machine based @@ -110,7 +111,7 @@ QT_BEGIN_NAMESPACE invoke methods on QObjects when the state is entered or exited. This is typically used in conjunction with \l{Signals and Slots}{signals}; the signals determine the flow of the state graph, whereas the states' property - assigments and method invocations are the actions. + assignments and method invocations are the actions. Use the addState() function to add a state to the state machine; alternatively, pass the machine's rootState() to the state constructor. Use @@ -1907,6 +1908,7 @@ QSignalEventGenerator::QSignalEventGenerator( \brief The QSignalEvent class represents a Qt signal event. + \since 4.6 \ingroup statemachine A signal event is generated by a QStateMachine in response to a Qt @@ -1972,6 +1974,7 @@ QSignalEvent::~QSignalEvent() \brief The QStateFinishedEvent class contains parameters that describe a state that has finished. + \since 4.6 \ingroup statemachine A state is finished when one of its final child states (a QFinalState) is diff --git a/src/corelib/statemachine/qtransition.cpp b/src/corelib/statemachine/qtransition.cpp index debfd21..ec9cc81 100644 --- a/src/corelib/statemachine/qtransition.cpp +++ b/src/corelib/statemachine/qtransition.cpp @@ -51,6 +51,7 @@ QT_BEGIN_NAMESPACE \brief The QTransition class provides an action-based transition. + \since 4.6 \ingroup statemachine QTransition provides an action-based transition; you add actions with the diff --git a/src/gui/statemachine/qkeyeventtransition.cpp b/src/gui/statemachine/qkeyeventtransition.cpp index a4e882d..88e4add 100644 --- a/src/gui/statemachine/qkeyeventtransition.cpp +++ b/src/gui/statemachine/qkeyeventtransition.cpp @@ -25,6 +25,7 @@ QT_BEGIN_NAMESPACE \brief The QKeyEventTransition class provides a transition for key events. + \since 4.6 \ingroup statemachine QKeyEventTransition is part of \l{The State Machine Framework}. diff --git a/src/gui/statemachine/qmouseeventtransition.cpp b/src/gui/statemachine/qmouseeventtransition.cpp index e16cb38..f5df904 100644 --- a/src/gui/statemachine/qmouseeventtransition.cpp +++ b/src/gui/statemachine/qmouseeventtransition.cpp @@ -26,6 +26,7 @@ QT_BEGIN_NAMESPACE \brief The QMouseEventTransition class provides a transition for mouse events. + \since 4.6 \ingroup statemachine QMouseEventTransition is part of \l{The State Machine Framework}. |