Qt 4.8
Signals | Public Functions | Protected Functions | List of all members
QAbstractState Class Referenceabstract

The QAbstractState class is the base class of states of a QStateMachine. More...

#include <qabstractstate.h>

Inheritance diagram for QAbstractState:
QObject QFinalState QHistoryState QState QStateMachine

Signals

void entered ()
 This signal is emitted when the state has been entered (after onEntry() has been called). More...
 
void exited ()
 This signal is emitted when the state has been exited (after onExit() has been called). More...
 
- Signals inherited from QObject
void destroyed (QObject *=0)
 This signal is emitted immediately before the object obj is destroyed, and can not be blocked. More...
 

Public Functions

QStateMachinemachine () const
 Returns the state machine that this state is part of, or 0 if the state is not part of a state machine. More...
 
QStateparentState () const
 Returns this state's parent state, or 0 if the state has no parent state. More...
 
 ~QAbstractState ()
 Destroys this state. More...
 
- Public Functions inherited from QObject
bool blockSignals (bool b)
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). More...
 
const QObjectListchildren () const
 Returns a list of child objects. More...
 
bool connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=0, const QObject *receiver=0, const char *member=0)
 
bool disconnect (const QObject *receiver, const char *member=0)
 
void dumpObjectInfo ()
 Dumps information about signal connections, etc. More...
 
void dumpObjectTree ()
 Dumps a tree of children to the debug output. More...
 
QList< QByteArraydynamicPropertyNames () const
 Returns the names of all properties that were dynamically added to the object using setProperty(). More...
 
virtual bool eventFilter (QObject *, QEvent *)
 Filters events if this object has been installed as an event filter for the watched object. More...
 
template<typename T >
findChild (const QString &aName=QString()) const
 Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. More...
 
template<typename T >
QList< T > findChildren (const QString &aName=QString()) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. More...
 
template<typename T >
QList< T > findChildren (const QRegExp &re) const
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false. More...
 
void installEventFilter (QObject *)
 Installs an event filter filterObj on this object. More...
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false. More...
 
void killTimer (int id)
 Kills the timer with timer identifier, id. More...
 
virtual const QMetaObjectmetaObject () const
 Returns a pointer to the meta-object of this object. More...
 
void moveToThread (QThread *thread)
 Changes the thread affinity for this object and its children. More...
 
QString objectName () const
 
QObjectparent () const
 Returns a pointer to the parent object. More...
 
QVariant property (const char *name) const
 Returns the value of the object's name property. More...
 
Q_INVOKABLE QObject (QObject *parent=0)
 Constructs an object with parent object parent. More...
 
void removeEventFilter (QObject *)
 Removes an event filter object obj from this object. More...
 
void setObjectName (const QString &name)
 
void setParent (QObject *)
 Makes the object a child of parent. More...
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value. More...
 
void setUserData (uint id, QObjectUserData *data)
 
bool signalsBlocked () const
 Returns true if signals are blocked; otherwise returns false. More...
 
int startTimer (int interval)
 Starts a timer and returns a timer identifier, or returns zero if it could not start a timer. More...
 
QThreadthread () const
 Returns the thread in which the object lives. More...
 
QObjectUserDatauserData (uint id) const
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects. More...
 

Protected Functions

bool event (QEvent *e)
 Reimplemented Function More...
 
virtual void onEntry (QEvent *event)=0
 This function is called when the state is entered. More...
 
virtual void onExit (QEvent *event)=0
 This function is called when the state is exited. More...
 
 QAbstractState (QState *parent=0)
 Constructs a new state with the given parent state. More...
 
 QAbstractState (QAbstractStatePrivate &dd, QState *parent)
 
- Protected Functions inherited from QObject
virtual void childEvent (QChildEvent *)
 This event handler can be reimplemented in a subclass to receive child events. More...
 
virtual void connectNotify (const char *signal)
 This virtual function is called when something has been connected to signal in this object. More...
 
virtual void customEvent (QEvent *)
 This event handler can be reimplemented in a subclass to receive custom events. More...
 
virtual void disconnectNotify (const char *signal)
 This virtual function is called when something has been disconnected from signal in this object. More...
 
 QObject (QObjectPrivate &dd, QObject *parent=0)
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal. More...
 
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns 0. More...
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *)
 This event handler can be reimplemented in a subclass to receive timer events for the object. More...
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 Schedules this object for deletion. More...
 
- Static Public Functions inherited from QObject
static bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 Creates a connection of the given type from the signal in the sender object to the method in the receiver object. More...
 
static bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 Disconnects signal in object sender from method in object receiver. More...
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static uint registerUserData ()
 
static QString tr (const char *sourceText, const char *comment=0, int n=-1)
 
static QString trUtf8 (const char *sourceText, const char *comment=0, int n=-1)
 
- Static Public Variables inherited from QObject
static const QMetaObject staticMetaObject
 This variable stores the meta-object for the class. More...
 
- Protected Variables inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Static Protected Variables inherited from QObject
static const QMetaObject staticQtMetaObject
 

Detailed Description

The QAbstractState class is the base class of states of a QStateMachine.

Since
4.6

The QAbstractState class is the abstract base class of states that are part of a QStateMachine. It defines the interface that all state objects have in common. QAbstractState is part of The State Machine Framework.

The entered() signal is emitted when the state has been entered. The exited() signal is emitted when the state has been exited.

The parentState() function returns the state's parent state. The machine() function returns the state machine that the state is part of.

Subclassing

The onEntry() function is called when the state is entered; reimplement this function to perform custom processing when the state is entered.

The onExit() function is called when the state is exited; reimplement this function to perform custom processing when the state is exited.

Definition at line 59 of file qabstractstate.h.

Constructors and Destructors

◆ ~QAbstractState()

QAbstractState::~QAbstractState ( )

Destroys this state.

Definition at line 153 of file qabstractstate.cpp.

154 {
155 }

◆ QAbstractState() [1/2]

QAbstractState::QAbstractState ( QState parent = 0)
protected

Constructs a new state with the given parent state.

Definition at line 137 of file qabstractstate.cpp.

139 {
140 }
Q_INVOKABLE QObject(QObject *parent=0)
Constructs an object with parent object parent.
Definition: qobject.cpp:753

◆ QAbstractState() [2/2]

QAbstractState::QAbstractState ( QAbstractStatePrivate dd,
QState parent 
)
protected
Warning
This function is not part of the public interface.

Definition at line 145 of file qabstractstate.cpp.

146  : QObject(dd, parent)
147 {
148 }
Q_INVOKABLE QObject(QObject *parent=0)
Constructs an object with parent object parent.
Definition: qobject.cpp:753

Functions

◆ entered

QAbstractState::entered ( )
signal

This signal is emitted when the state has been entered (after onEntry() has been called).

◆ event()

bool QAbstractState::event ( QEvent e)
protectedvirtual

Reimplemented Function

Reimplemented from QObject.

Reimplemented in QStateMachine, QState, QHistoryState, and QFinalState.

Definition at line 217 of file qabstractstate.cpp.

Referenced by QFinalState::event(), QHistoryState::event(), and QState::event().

218 {
219  return QObject::event(e);
220 }
virtual bool event(QEvent *)
This virtual function receives events to an object and should return true if the event e was recogniz...
Definition: qobject.cpp:1200

◆ exited

QAbstractState::exited ( )
signal

This signal is emitted when the state has been exited (after onExit() has been called).

◆ machine()

QStateMachine * QAbstractState::machine ( ) const

Returns the state machine that this state is part of, or 0 if the state is not part of a state machine.

Definition at line 172 of file qabstractstate.cpp.

Referenced by QStateMachine::addState(), QStateMachinePrivate::addStatesToEnter(), QState::addTransition(), QAbstractTransitionPrivate::machine(), QSignalEventGenerator::qt_metacall(), QStateMachine::removeState(), QState::setErrorState(), QStateMachinePrivate::stateEntryLessThan(), and QStateMachinePrivate::stateExitLessThan().

173 {
174  Q_D(const QAbstractState);
175  return d->machine();
176 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QAbstractState class is the base class of states of a QStateMachine.

◆ onEntry()

QAbstractState::onEntry ( QEvent event)
protectedpure virtual

This function is called when the state is entered.

The given event is what caused the state to be entered. Reimplement this function to perform custom processing when the state is entered.

Implemented in QStateMachine, QState, QHistoryState, and QFinalState.

◆ onExit()

QAbstractState::onExit ( QEvent event)
protectedpure virtual

This function is called when the state is exited.

The given event is what caused the state to be exited. Reimplement this function to perform custom processing when the state is exited.

Implemented in QStateMachine, QState, QHistoryState, and QFinalState.

◆ parentState()

QState * QAbstractState::parentState ( ) const

Returns this state's parent state, or 0 if the state has no parent state.

Definition at line 160 of file qabstractstate.cpp.

Referenced by QStateMachinePrivate::addStatesToEnter(), QStateMachinePrivate::applyProperties(), QStateMachinePrivate::enterStates(), QStateMachinePrivate::exitStates(), QStateMachinePrivate::findErrorState(), QStateMachinePrivate::findLCA(), QStateMachinePrivate::isDescendantOf(), QStateMachinePrivate::properAncestors(), QHistoryState::setDefaultState(), and QState::setInitialState().

161 {
162  Q_D(const QAbstractState);
163  if (d->parentState != parent())
164  d->parentState = qobject_cast<QState*>(parent());
165  return d->parentState;
166 }
double d
Definition: qnumeric_p.h:62
T * qobject_cast(QObject *object)
Definition: qobject.h:375
#define Q_D(Class)
Definition: qglobal.h:2482
The QState class provides a general-purpose state for QStateMachine.
Definition: qstate.h:61
The QAbstractState class is the base class of states of a QStateMachine.
QObject * parent() const
Returns a pointer to the parent object.
Definition: qobject.h:273

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