KDStateMachineEditor API Documentation  1.2.9
A framework for creating Qt State Machine metacode using a graphical user interface
Classes | Public Types | Signals | Public Member Functions | Protected Member Functions | Properties | List of all members
KDSME::State Class Reference
Inheritance diagram for KDSME::State:
Inheritance graph
[legend]

Classes

struct  Private
 

Public Types

enum  ChildMode { ExclusiveStates, ParallelStates }
 
- Public Types inherited from KDSME::Element
enum  Type {
  ElementType, TransitionType, SignalTransitionType, TimeoutTransitionType,
  StateType, StateMachineType, HistoryStateType, FinalStateType,
  PseudoStateType
}
 
enum  Flag { NoFlags = 0x0, ElementIsDragEnabled = 0x1, ElementIsSelectable = 0x2, ElementIsEditable = 0x4 }
 

Signals

void onEntryChanged (const QString &onEntry)
 
void onExitChanged (const QString &onExit)
 
void childModeChanged (ChildMode childMode)
 
void isCompositeChanged (bool isComposite)
 
void expandedChanged (bool expanded)
 
- Signals inherited from KDSME::Element
void parentChanged (Element *parent)
 
void flagsChanged (Flags flags)
 
void labelChanged (const QString &label)
 
void posChanged (const QPointF &pos)
 
void heightChanged (qreal height)
 
void widthChanged (qreal width)
 
void visibleChanged (bool visible)
 
void selectedChanged (bool selected)
 

Public Member Functions

 State (State *parent=nullptr)
 
Type type () const override
 
Q_INVOKABLE KDSME::StateparentState () const
 
StateinitialState () const
 
void setInitialState (State *initialState)
 
QList< State * > childStates () const
 
QList< Transition * > transitions () const
 
void addTransition (Transition *transition)
 
SignalTransitionaddSignalTransition (State *target, const QString &silgnal=QString())
 
TimeoutTransitionaddTimeoutTransition (State *target, int timeout)
 
QString onEntry () const
 
void setOnEntry (const QString &onEntry)
 
QString onExit () const
 
void setOnExit (const QString &onExit)
 
ChildMode childMode () const
 
void setChildMode (ChildMode childMode)
 
bool isComposite () const
 
bool isExpanded () const
 
void setExpanded (bool expanded)
 
Q_INVOKABLE KDSME::StateMachinemachine () const
 
- Public Member Functions inherited from KDSME::Element
 Element (QObject *parent=nullptr)
 
Flags flags () const
 
void setFlags (Flags flags)
 
QString label () const
 
void setLabel (const QString &label)
 
quintptr internalId () const
 
void setInternalId (quintptr id)
 
void setInternalPointer (void *ptr)
 
void * internalPointer () const
 
QPointF pos () const
 
void setPos (const QPointF &pos)
 
qreal height () const
 
void setHeight (qreal height)
 
qreal width () const
 
void setWidth (qreal width)
 
QPointF absolutePos () const
 
bool isVisible () const
 
void setVisible (bool visible)
 
bool isSelected () const
 
void setSelected (bool selected)
 
QSizeF preferredSize () const
 
virtual QRectF boundingRect () const
 
ElementparentElement () const
 
void setParentElement (Element *parent)
 
void setParent (QObject *object)
 
QList< Element * > childElements () const
 
virtual QString toDisplayString () const
 
- Public Member Functions inherited from QObject
virtual const QMetaObjectmetaObject () const const
 
virtual void * qt_metacast (const char *)
 
virtual int qt_metacall (QMetaObject::Call, int, void **)
 
 QObject (QObject *parent)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
QString objectName () const const
 
void setObjectName (const QString &name)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
bool signalsBlocked () const const
 
bool blockSignals (bool block)
 
QThreadthread () const const
 
void moveToThread (QThread *targetThread)
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
void killTimer (int id)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
const QObjectList & children () const const
 
void setParent (QObject *parent)
 
void installEventFilter (QObject *filterObj)
 
void removeEventFilter (QObject *obj)
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectTree ()
 
void dumpObjectInfo ()
 
void dumpObjectTree () const const
 
void dumpObjectInfo () const const
 
bool setProperty (const char *name, const QVariant &value)
 
QVariant property (const char *name) const const
 
QList< QByteArraydynamicPropertyNames () const const
 
void destroyed (QObject *obj)
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
bool inherits (const char *className) const const
 
void deleteLater ()
 

Protected Member Functions

bool event (QEvent *event) override
 
- Protected Member Functions inherited from QObject
QObjectsender () const const
 
int senderSignalIndex () const const
 
int receivers (const char *signal) const const
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
virtual void timerEvent (QTimerEvent *event)
 
virtual void childEvent (QChildEvent *event)
 
virtual void customEvent (QEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 

Properties

QString onEntry
 
QString onExit
 
ChildMode childMode
 
bool isComposite
 
bool expanded
 
- Properties inherited from KDSME::Element
KDSME::Element parent
 
Type type
 
Flags flags
 
QString label
 
QPointF pos
 The position of the element from the top-left corner.
 
qreal width
 
qreal height
 
bool visible
 Whether this item is visible in the scene.
 
bool selected
 Whether this item is marked as selected.
 
- Properties inherited from QObject
 objectName
 

Additional Inherited Members

- Static Public Member Functions inherited from KDSME::Element
static Q_INVOKABLE const char * typeToString (Type type)
 
static Q_INVOKABLE Type stringToType (const char *type)
 
- Static Public Member Functions inherited from QObject
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 

Detailed Description

Examples:
export/main.cpp, and simplestatemachine/main.cpp.

Member Function Documentation

bool KDSME::State::isComposite ( ) const
Returns
True in case this state contains other states, otherwise false
QString KDSME::State::onEntry ( ) const

Executable content to be executed when the state is entered

QString KDSME::State::onExit ( ) const

Executable content to be executed when the state is exited.


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

Klarälvdalens Datakonsult AB (KDAB)
"The Qt, C++ and OpenGL Experts"
https://www.kdab.com/
KDStateMachineEditor
Create Qt State Machine metacode using a graphical user interface
https://github.com/KDAB/KDStateMachineEditor