KDStateMachineEditor API Documentation 2.1
Loading...
Searching...
No Matches
Signals | Public Member Functions | Protected Member Functions | Properties | List of all members
KDSME::StateMachineView Class Reference

Widget for displaying a KDSME::StateMachine in a Qt Quick based view. More...

#include <statemachineview.h>

Inheritance diagram for KDSME::StateMachineView:
Inheritance graph
[legend]
Collaboration diagram for KDSME::StateMachineView:
Collaboration graph
[legend]

Signals

void sceneChanged (KDSME::StateMachineScene *scene)
 
void themeNameChanged (const QString &themeName)
 

Public Member Functions

 StateMachineView (QWidget *parent=nullptr)
 
 ~StateMachineView ()
 
Q_INVOKABLE void changeStateMachine (KDSME::StateMachine *stateMachine)
 
CommandControllercommandController () const
 
QString defaultThemeName () const
 
Q_INVOKABLE void deleteElement (KDSME::Element *element)
 
EditControllereditController () const
 
Q_INVOKABLE void fitInView ()
 
StateMachineScenescene () const
 
Q_INVOKABLE void sendCommand (KDSME::Command *cmd) const
 
void setThemeName (const QString &themeName)
 
QString themeName () const
 

Protected Member Functions

QQuickItem * sceneObject () const
 
QQuickItem * viewPortObject () const
 

Properties

KDSME::CommandControllercommandController
 
KDSME::EditControllereditController
 
KDSME::StateMachineScenescene
 
QString themeName
 

Detailed Description

Widget for displaying a KDSME::StateMachine in a Qt Quick based view.

Simple example building up and display a state machine in a view:

StateMachine machine;
State s1(&machine);
s1.setLabel(QStringLiteral("s1"));
State s2(&machine);
s2.setLabel(QStringLiteral("s2"));
s1.addSignalTransition(&s2);
view.scene()->setRootState(&machine);
view.scene()->layout();
view.resize(800, 600);
view.show();
void setRootState(State *rootState)
Widget for displaying a KDSME::StateMachine in a Qt Quick based view.
KDSME::StateMachineScene * scene
Examples
scxmlimport/main.cpp, and simplestatemachine/main.cpp.

Definition at line 39 of file statemachineview.h.

Constructor & Destructor Documentation

◆ StateMachineView()

StateMachineView::StateMachineView ( QWidget *  parent = nullptr)
explicit

Definition at line 114 of file statemachineview.cpp.

References KDSME_QML_NAMESPACE.

◆ ~StateMachineView()

StateMachineView::~StateMachineView ( )

Definition at line 186 of file statemachineview.cpp.

Member Function Documentation

◆ changeStateMachine()

void StateMachineView::changeStateMachine ( KDSME::StateMachine stateMachine)

Definition at line 274 of file statemachineview.cpp.

References commandController, and KDSME::CommandController::push().

◆ commandController()

CommandController * StateMachineView::commandController ( ) const

Definition at line 215 of file statemachineview.cpp.

◆ defaultThemeName()

QString StateMachineView::defaultThemeName ( ) const

Definition at line 225 of file statemachineview.cpp.

Referenced by setThemeName().

◆ deleteElement()

void StateMachineView::deleteElement ( KDSME::Element element)

Definition at line 287 of file statemachineview.cpp.

References commandController, and KDSME::CommandController::push().

◆ editController()

EditController * StateMachineView::editController ( ) const

Definition at line 220 of file statemachineview.cpp.

◆ fitInView()

void StateMachineView::fitInView ( )

◆ scene()

StateMachineScene * StateMachineView::scene ( ) const

Definition at line 191 of file statemachineview.cpp.

◆ sceneChanged

void KDSME::StateMachineView::sceneChanged ( KDSME::StateMachineScene scene)
signal

◆ sceneObject()

QQuickItem * StateMachineView::sceneObject ( ) const
protected

Definition at line 262 of file statemachineview.cpp.

◆ sendCommand()

void StateMachineView::sendCommand ( KDSME::Command cmd) const

◆ setThemeName()

void StateMachineView::setThemeName ( const QString &  themeName)

Definition at line 235 of file statemachineview.cpp.

References defaultThemeName(), themeName, and themeNameChanged().

◆ themeName()

QString StateMachineView::themeName ( ) const

Definition at line 230 of file statemachineview.cpp.

◆ themeNameChanged

void KDSME::StateMachineView::themeNameChanged ( const QString &  themeName)
signal

Referenced by setThemeName().

◆ viewPortObject()

QQuickItem * StateMachineView::viewPortObject ( ) const
protected

Definition at line 255 of file statemachineview.cpp.

Property Documentation

◆ commandController

KDSME::CommandController * KDSME::StateMachineView::commandController
read

◆ editController

KDSME::EditController * KDSME::StateMachineView::editController
read

Definition at line 44 of file statemachineview.h.

◆ scene

KDSME::StateMachineScene * KDSME::StateMachineView::scene
readwrite

◆ themeName

QString KDSME::StateMachineView::themeName
readwrite

Definition at line 46 of file statemachineview.h.

Referenced by setThemeName().


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
Generated on Tue Jul 15 2025 15:21:47 for KDStateMachineEditor API Documentation by doxygen 1.9.8