LibrePCB Developers Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
SES_Base Class Referenceabstract

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::WorkspacemWorkspace
 
ProjectmProject
 
CircuitmCircuit
 
SchematicEditormEditor
 
Ui::SchematicEditor & mEditorUi
 allows access to SchematicEditor UI More...
 
GraphicsViewmEditorGraphicsView
 
UndoStackmUndoStack
 

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
virtual bool entry ( SEE_Base event)
inlinevirtualnoexcept
virtual bool exit ( SEE_Base event)
inlinevirtualnoexcept

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: