Qt 4.8
qstate.h
Go to the documentation of this file.
1 /****************************************************************************
2 **
3 ** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
5 **
6 ** This file is part of the QtCore module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and Digia. For licensing terms and
14 ** conditions see http://qt.digia.com/licensing. For further information
15 ** use the contact form at http://qt.digia.com/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24 **
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights. These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28 **
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file. Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
36 **
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41 
42 #ifndef QSTATE_H
43 #define QSTATE_H
44 
45 #include <QtCore/qabstractstate.h>
46 
47 #include <QtCore/qlist.h>
48 
50 
52 
53 QT_MODULE(Core)
54 
55 #ifndef QT_NO_STATEMACHINE
56 
58 class QSignalTransition;
59 
60 class QStatePrivate;
62 {
63  Q_OBJECT
68 public:
69  enum ChildMode {
71  ParallelStates
72  };
73 
74  QState(QState *parent = 0);
75  QState(ChildMode childMode, QState *parent = 0);
76  ~QState();
77 
78  QAbstractState *errorState() const;
79  void setErrorState(QAbstractState *state);
80 
81  void addTransition(QAbstractTransition *transition);
82  QSignalTransition *addTransition(QObject *sender, const char *signal, QAbstractState *target);
83  QAbstractTransition *addTransition(QAbstractState *target);
84  void removeTransition(QAbstractTransition *transition);
85  QList<QAbstractTransition*> transitions() const;
86 
87  QAbstractState *initialState() const;
88  void setInitialState(QAbstractState *state);
89 
90  ChildMode childMode() const;
91  void setChildMode(ChildMode mode);
92 
93 #ifndef QT_NO_PROPERTIES
94  void assignProperty(QObject *object, const char *name,
95  const QVariant &value);
96 #endif
97 
98 Q_SIGNALS:
99  void finished();
100  void propertiesAssigned();
101 
102 protected:
103  void onEntry(QEvent *event);
104  void onExit(QEvent *event);
105 
106  bool event(QEvent *e);
107 
108 protected:
109  QState(QStatePrivate &dd, QState *parent);
110 
111 private:
114 };
115 
116 #endif //QT_NO_STATEMACHINE
117 
119 
121 
122 #endif
The QVariant class acts like a union for the most common Qt data types.
Definition: qvariant.h:92
#define QT_END_NAMESPACE
This macro expands to.
Definition: qglobal.h:90
EventRef event
#define QT_MODULE(x)
Definition: qglobal.h:2783
The QAbstractTransition class is the base class of transitions between QAbstractState objects...
#define QT_BEGIN_HEADER
Definition: qglobal.h:136
#define Q_DISABLE_COPY(Class)
Disables the use of copy constructors and assignment operators for the given Class.
Definition: qglobal.h:2523
The QObject class is the base class of all Qt objects.
Definition: qobject.h:111
#define Q_SIGNALS
Definition: qobjectdefs.h:72
The QState class provides a general-purpose state for QStateMachine.
Definition: qstate.h:61
#define Q_ENUMS(x)
Definition: qobjectdefs.h:84
bool event(QEvent *e)
Reimplemented Function
#define QT_BEGIN_NAMESPACE
This macro expands to.
Definition: qglobal.h:89
The QAbstractState class is the base class of states of a QStateMachine.
The QSignalTransition class provides a transition based on a Qt signal.
const char * name
QAbstractState * initialState
the initial state of this state (one of its child states)
Definition: qstate.h:64
ChildMode
This enum specifies how a state&#39;s child states are treated.
Definition: qstate.h:69
#define Q_OBJECT
Definition: qobjectdefs.h:157
virtual void onExit(QEvent *event)=0
This function is called when the state is exited.
virtual void onEntry(QEvent *event)=0
This function is called when the state is entered.
#define Q_CORE_EXPORT
Definition: qglobal.h:1449
#define Q_DECLARE_PRIVATE(Class)
Definition: qglobal.h:2467
The QEvent class is the base class of all event classes.
Definition: qcoreevent.h:56
#define QT_END_HEADER
Definition: qglobal.h:137
The QList class is a template class that provides lists.
Definition: qdatastream.h:62
ChildMode childMode
the child mode of this state
Definition: qstate.h:66
QAbstractState * errorState
the error state of this state
Definition: qstate.h:65