LibrePCB Developers Documentation
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 Member Functions

const LengthUnitgetDefaultLengthUnit () const 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

◆ 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

◆ BES_Base()

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

◆ ~BES_Base()

~BES_Base ( )
virtual

Member Function Documentation

◆ process()

virtual ProcRetVal process ( BEE_Base event)
pure virtualnoexcept

◆ entry()

virtual bool entry ( BEE_Base event)
inlinevirtualnoexcept

Reimplemented in BES_Select, BES_DrawTrace, BES_DrawPlane, BES_DrawPolygon, BES_AddStrokeText, BES_AddVia, BES_AddHole, and BES_AddDevice.

+ Here is the caller graph for this function:

◆ exit()

virtual bool exit ( BEE_Base event)
inlinevirtualnoexcept

Reimplemented in BES_Select, BES_DrawTrace, BES_DrawPlane, BES_DrawPolygon, BES_AddStrokeText, BES_AddVia, BES_AddHole, and BES_AddDevice.

+ 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

BoardEditor& mEditor
protected

◆ mEditorUi

Ui::BoardEditor& mEditorUi
protected

allows access to BoardEditor UI

◆ mEditorGraphicsView

GraphicsView& mEditorGraphicsView
protected

allows access to the board editor graphics view

◆ mUndoStack

UndoStack& mUndoStack
protected

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