LibrePCB Developers Documentation
BoardEditor Class Referencefinal

The BoardEditor class. More...

#include <boardeditor.h>

+ Inheritance diagram for BoardEditor:
+ Collaboration diagram for BoardEditor:

Public Slots

void boardAdded (int newIndex)
 
void boardRemoved (int oldIndex)
 

Public Member Functions

 BoardEditor (ProjectEditor &projectEditor, Project &project)
 
 ~BoardEditor ()
 
ProjectEditorgetProjectEditor () const noexcept
 
ProjectgetProject () const noexcept
 
BoardgetActiveBoard () const noexcept
 
void setActiveBoardIndex (int index) noexcept
 
void abortAllCommands () noexcept
 
- Public Member Functions inherited from IF_GraphicsViewEventHandler
 IF_GraphicsViewEventHandler () noexcept
 
virtual ~IF_GraphicsViewEventHandler () noexcept
 

Protected Member Functions

void closeEvent (QCloseEvent *event)
 

Private Slots

void on_actionProjectClose_triggered ()
 
void on_actionNewBoard_triggered ()
 
void on_actionCopyBoard_triggered ()
 
void on_actionRemoveBoard_triggered ()
 
void on_actionGrid_triggered ()
 
void on_actionPrint_triggered ()
 
void on_actionExportAsPdf_triggered ()
 
void on_actionExportAsSvg_triggered ()
 
void on_actionGenerateFabricationData_triggered ()
 
void on_actionGenerateBom_triggered ()
 
void on_actionGeneratePickPlace_triggered ()
 
void on_actionProjectProperties_triggered ()
 
void on_actionUpdateLibrary_triggered ()
 
void on_actionLayerStackSetup_triggered ()
 
void on_actionModifyDesignRules_triggered ()
 
void on_actionDesignRuleCheck_triggered ()
 
void on_actionRebuildPlanes_triggered ()
 
void on_actionShowAllPlanes_triggered ()
 
void on_actionHideAllPlanes_triggered ()
 
void on_tabBar_currentChanged (int index)
 
void on_lblUnplacedComponentsNote_linkActivated ()
 
void boardListActionGroupTriggered (QAction *action)
 

Private Member Functions

 BoardEditor ()=delete
 
 BoardEditor (const BoardEditor &other)=delete
 
BoardEditoroperator= (const BoardEditor &rhs)=delete
 
bool graphicsViewEventHandler (QEvent *event)
 The event handler method. More...
 
void toolActionGroupChangeTriggered (const QVariant &newTool) noexcept
 
void unplacedComponentsCountChanged (int count) noexcept
 
void highlightDrcMessage (const BoardDesignRuleCheckMessage &msg, bool zoomTo) noexcept
 
void clearDrcMarker () noexcept
 
QStringList getSearchToolBarCompleterList () noexcept
 
void goToDevice (const QString &name) noexcept
 

Private Attributes

ProjectEditormProjectEditor
 
ProjectmProject
 
Ui::BoardEditor * mUi
 
GraphicsViewmGraphicsView
 
QScopedPointer< UndoStackActionGroupmUndoStackActionGroup
 
QScopedPointer< ExclusiveActionGroupmToolsActionGroup
 
BoardDesignRuleCheck::Options mDrcOptions
 
QHash< Uuid, QList< BoardDesignRuleCheckMessage > > mDrcMessages
 Key: Board UUID. More...
 
QScopedPointer< QGraphicsPathItem > mDrcLocationGraphicsItem
 
QPointer< BoardmActiveBoard
 
QList< QAction * > mBoardListActions
 
QActionGroup mBoardListActionGroup
 
ErcMsgDockmErcMsgDock
 
UnplacedComponentsDockmUnplacedComponentsDock
 
BoardLayersDockmBoardLayersDock
 
QScopedPointer< BoardDesignRuleCheckMessagesDockmDrcMessagesDock
 
BES_FSMmFsm
 

Detailed Description

The BoardEditor class.

Constructor & Destructor Documentation

◆ BoardEditor() [1/3]

BoardEditor ( ProjectEditor projectEditor,
Project project 
)
explicit
+ Here is the call graph for this function:

◆ ~BoardEditor()

◆ BoardEditor() [2/3]

BoardEditor ( )
privatedelete

◆ BoardEditor() [3/3]

BoardEditor ( const BoardEditor other)
privatedelete

Member Function Documentation

◆ getProjectEditor()

ProjectEditor& getProjectEditor ( ) const
inlinenoexcept

◆ getProject()

Project& getProject ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getActiveBoard()

Board* getActiveBoard ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ setActiveBoardIndex()

void setActiveBoardIndex ( int  index)
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ abortAllCommands()

void abortAllCommands ( )
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ closeEvent()

void closeEvent ( QCloseEvent *  event)
protected
+ Here is the call graph for this function:

◆ boardAdded

void boardAdded ( int  newIndex)
slot
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ boardRemoved

void boardRemoved ( int  oldIndex)
slot
+ Here is the caller graph for this function:

◆ on_actionProjectClose_triggered

void on_actionProjectClose_triggered ( )
privateslot
+ Here is the call graph for this function:

◆ on_actionNewBoard_triggered

void on_actionNewBoard_triggered ( )
privateslot
+ Here is the call graph for this function:

◆ on_actionCopyBoard_triggered

void on_actionCopyBoard_triggered ( )
privateslot
+ Here is the call graph for this function:

◆ on_actionRemoveBoard_triggered

void on_actionRemoveBoard_triggered ( )
privateslot
+ Here is the call graph for this function:

◆ on_actionGrid_triggered

void on_actionGrid_triggered ( )
privateslot
+ Here is the call graph for this function:

◆ on_actionPrint_triggered

void on_actionPrint_triggered ( )
privateslot
+ Here is the call graph for this function:

◆ on_actionExportAsPdf_triggered

void on_actionExportAsPdf_triggered ( )
privateslot
+ Here is the call graph for this function:

◆ on_actionExportAsSvg_triggered

void on_actionExportAsSvg_triggered ( )
privateslot
+ Here is the call graph for this function:

◆ on_actionGenerateFabricationData_triggered

void on_actionGenerateFabricationData_triggered ( )
privateslot
+ Here is the call graph for this function:

◆ on_actionGenerateBom_triggered

void on_actionGenerateBom_triggered ( )
privateslot
+ Here is the call graph for this function:

◆ on_actionGeneratePickPlace_triggered

void on_actionGeneratePickPlace_triggered ( )
privateslot
+ Here is the call graph for this function:

◆ on_actionProjectProperties_triggered

void on_actionProjectProperties_triggered ( )
privateslot
+ Here is the call graph for this function:

◆ on_actionUpdateLibrary_triggered

void on_actionUpdateLibrary_triggered ( )
privateslot
+ Here is the call graph for this function:

◆ on_actionLayerStackSetup_triggered

void on_actionLayerStackSetup_triggered ( )
privateslot
+ Here is the call graph for this function:

◆ on_actionModifyDesignRules_triggered

void on_actionModifyDesignRules_triggered ( )
privateslot
+ Here is the call graph for this function:

◆ on_actionDesignRuleCheck_triggered

void on_actionDesignRuleCheck_triggered ( )
privateslot
+ Here is the call graph for this function:

◆ on_actionRebuildPlanes_triggered

void on_actionRebuildPlanes_triggered ( )
privateslot
+ Here is the call graph for this function:

◆ on_actionShowAllPlanes_triggered

void on_actionShowAllPlanes_triggered ( )
privateslot
+ Here is the call graph for this function:

◆ on_actionHideAllPlanes_triggered

void on_actionHideAllPlanes_triggered ( )
privateslot
+ Here is the call graph for this function:

◆ on_tabBar_currentChanged

void on_tabBar_currentChanged ( int  index)
privateslot
+ Here is the call graph for this function:

◆ on_lblUnplacedComponentsNote_linkActivated

void on_lblUnplacedComponentsNote_linkActivated ( )
privateslot

◆ boardListActionGroupTriggered

void boardListActionGroupTriggered ( QAction *  action)
privateslot
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ operator=()

BoardEditor& operator= ( const BoardEditor rhs)
privatedelete

◆ graphicsViewEventHandler()

bool graphicsViewEventHandler ( QEvent *  event)
privatevirtual

The event handler method.

Implements IF_GraphicsViewEventHandler.

+ Here is the call graph for this function:

◆ toolActionGroupChangeTriggered()

void toolActionGroupChangeTriggered ( const QVariant &  newTool)
privatenoexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ unplacedComponentsCountChanged()

void unplacedComponentsCountChanged ( int  count)
privatenoexcept
+ Here is the caller graph for this function:

◆ highlightDrcMessage()

void highlightDrcMessage ( const BoardDesignRuleCheckMessage msg,
bool  zoomTo 
)
privatenoexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ clearDrcMarker()

void clearDrcMarker ( )
privatenoexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getSearchToolBarCompleterList()

QStringList getSearchToolBarCompleterList ( )
privatenoexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ goToDevice()

void goToDevice ( const QString &  name)
privatenoexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ mProjectEditor

ProjectEditor& mProjectEditor
private

◆ mProject

Project& mProject
private

◆ mUi

Ui::BoardEditor* mUi
private

◆ mGraphicsView

GraphicsView* mGraphicsView
private

◆ mUndoStackActionGroup

QScopedPointer<UndoStackActionGroup> mUndoStackActionGroup
private

◆ mToolsActionGroup

QScopedPointer<ExclusiveActionGroup> mToolsActionGroup
private

◆ mDrcOptions

BoardDesignRuleCheck::Options mDrcOptions
private

◆ mDrcMessages

QHash<Uuid, QList<BoardDesignRuleCheckMessage> > mDrcMessages
private

Key: Board UUID.

◆ mDrcLocationGraphicsItem

QScopedPointer<QGraphicsPathItem> mDrcLocationGraphicsItem
private

◆ mActiveBoard

QPointer<Board> mActiveBoard
private

◆ mBoardListActions

QList<QAction*> mBoardListActions
private

◆ mBoardListActionGroup

QActionGroup mBoardListActionGroup
private

◆ mErcMsgDock

ErcMsgDock* mErcMsgDock
private

◆ mUnplacedComponentsDock

UnplacedComponentsDock* mUnplacedComponentsDock
private

◆ mBoardLayersDock

BoardLayersDock* mBoardLayersDock
private

◆ mDrcMessagesDock

QScopedPointer<BoardDesignRuleCheckMessagesDock> mDrcMessagesDock
private

◆ mFsm

BES_FSM* mFsm
private

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