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

The BES_Base (BoardEditorState Base) class. More...

#include <bes_base.h>

+ Inheritance diagram for BES_Base:
+ Collaboration diagram for BES_Base:

Public Types

enum  ProcRetVal
 process() return values More...
 

Public Member Functions

 BES_Base (BoardEditor &editor, Ui::BoardEditor &editorUi, GraphicsView &editorGraphicsView, UndoStack &undoStack)
 
virtual ~BES_Base ()
 
virtual ProcRetVal process (BEE_Base *event) noexcept=0
 
virtual bool entry (BEE_Base *event) noexcept
 
virtual bool exit (BEE_Base *event) noexcept
 

Protected Attributes

workspace::WorkspacemWorkspace
 
ProjectmProject
 
CircuitmCircuit
 
BoardEditormEditor
 
Ui::BoardEditor & mEditorUi
 allows access to BoardEditor UI More...
 
GraphicsViewmEditorGraphicsView
 allows access to the board editor graphics view More...
 
UndoStackmUndoStack
 

Detailed Description

The BES_Base (BoardEditorState 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

BES_Base ( BoardEditor editor,
Ui::BoardEditor &  editorUi,
GraphicsView editorGraphicsView,
UndoStack undoStack 
)
explicit
~BES_Base ( )
virtual

Member Function Documentation

virtual ProcRetVal process ( BEE_Base event)
pure virtualnoexcept
virtual bool entry ( BEE_Base event)
inlinevirtualnoexcept
virtual bool exit ( BEE_Base event)
inlinevirtualnoexcept

Member Data Documentation

workspace::Workspace& mWorkspace
protected
Project& mProject
protected
Circuit& mCircuit
protected
BoardEditor& mEditor
protected
Ui::BoardEditor& mEditorUi
protected

allows access to BoardEditor UI

GraphicsView& mEditorGraphicsView
protected

allows access to the board editor graphics view

UndoStack& mUndoStack
protected

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