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 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

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 ( SchematicEditor &  editor, Ui::SchematicEditor &  editorUi, GraphicsView &  editorGraphicsView, UndoStack &  undoStack  )

explicit

~SES_Base ( )

virtual

Member Function Documentation

virtual ProcRetVal process ( SEE_Base *  event )

pure virtualnoexcept

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

virtual bool entry ( SEE_Base *  event )

inlinevirtualnoexcept

Reimplemented in SES_AddComponent, SES_DrawWire, SES_Select, and SES_AddNetLabel.

virtual bool exit ( SEE_Base *  event )

inlinevirtualnoexcept

Reimplemented in SES_AddComponent, SES_DrawWire, SES_Select, and SES_AddNetLabel.

Member Data Documentation

workspace::Workspace& mWorkspace

protected

Project& mProject

protected

Circuit& mCircuit

protected

SchematicEditor& mEditor

protected

Ui::SchematicEditor& mEditorUi

protected

allows access to SchematicEditor UI

GraphicsView& mEditorGraphicsView

protected

allows access to the schematic editor graphics view

UndoStack& mUndoStack

protected

---

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

• /home/travis/build/LibrePCB/LibrePCB/libs/librepcb/projecteditor/schematiceditor/fsm/ses_base.h
• /home/travis/build/LibrePCB/LibrePCB/libs/librepcb/projecteditor/schematiceditor/fsm/ses_base.cpp