SES_Base Class Reference

The SES_Base (SchematicEditorState Base) class. More...

#include <ses_base.h>

Inheritance diagram for SES_Base:

Collaboration diagram for SES_Base:

Public Types
enum	ProcRetVal
	process() return values More...

Public Member Functions
	SES_Base (SchematicEditor &editor, Ui::SchematicEditor &editorUi, GraphicsView &editorGraphicsView, UndoStack &undoStack)
virtual	~SES_Base ()
virtual ProcRetVal	process (SEE_Base *event) noexcept=0
virtual bool	entry (SEE_Base *event) noexcept
virtual bool	exit (SEE_Base *event) noexcept

Protected Member Functions
const LengthUnit &	getDefaultLengthUnit () const noexcept

Protected Attributes
workspace::Workspace &	mWorkspace
Project &	mProject
Circuit &	mCircuit
SchematicEditor &	mEditor
Ui::SchematicEditor &	mEditorUi
	allows access to SchematicEditor UI More...
GraphicsView &	mEditorGraphicsView
UndoStack &	mUndoStack

Detailed Description

The SES_Base (SchematicEditorState Base) class.

Member Enumeration Documentation

ProcRetVal

enum ProcRetVal

process() return values

Enumerator
ForceStayInState	event handled, stay in the current state
ForceLeaveState	event handled, leave the current state
PassToParentState	event unhandled, pass it to the parent

Constructor & Destructor Documentation

SES_Base()

SES_Base ( SchematicEditor &  editor, Ui::SchematicEditor &  editorUi, GraphicsView &  editorGraphicsView, UndoStack &  undoStack  )

explicit

~SES_Base()

~SES_Base ( )

virtual

Member Function Documentation

process()

virtual ProcRetVal process ( SEE_Base *  event )

pure virtualnoexcept

Implemented in SES_AddComponent, SES_FSM, SES_Select, SES_AddNetLabel, and SES_DrawWire.

entry()

virtual bool entry ( SEE_Base *  event )

inlinevirtualnoexcept

Reimplemented in SES_AddComponent, SES_Select, SES_AddNetLabel, and SES_DrawWire.

Here is the caller graph for this function:

exit()

virtual bool exit ( SEE_Base *  event )

inlinevirtualnoexcept

Reimplemented in SES_AddComponent, SES_Select, SES_AddNetLabel, and SES_DrawWire.

Here is the caller graph for this function:

getDefaultLengthUnit()

const LengthUnit & getDefaultLengthUnit ( ) const

protectednoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mWorkspace

workspace::Workspace& mWorkspace

protected

mProject

Project& mProject

protected

mCircuit

Circuit& mCircuit

protected

mEditor

SchematicEditor& mEditor

protected

mEditorUi

Ui::SchematicEditor& mEditorUi

protected

allows access to SchematicEditor UI

mEditorGraphicsView

GraphicsView& mEditorGraphicsView

protected

allows access to the schematic editor graphics view

mUndoStack

UndoStack& mUndoStack

protected

---

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

• /__w/1/s/libs/librepcb/projecteditor/schematiceditor/fsm/ses_base.h
• /__w/1/s/libs/librepcb/projecteditor/schematiceditor/fsm/ses_base.cpp