BOARD_CONTEXT Class Reference

Base interface for board-level API contexts; shared by PCB editor and footprint editor. More...

#include <board_context.h>

Inheritance diagram for BOARD_CONTEXT:

Public Member Functions
virtual	~BOARD_CONTEXT ()=default
virtual BOARD *	GetBoard () const =0
virtual PROJECT &	Prj () const =0
virtual TOOL_MANAGER *	GetToolManager () const =0
virtual KIWAY *	GetKiway () const =0
virtual bool	CanAcceptApiCommands () const =0

Detailed Description

Base interface for board-level API contexts; shared by PCB editor and footprint editor.

Definition at line 31 of file board_context.h.

Constructor & Destructor Documentation

~BOARD_CONTEXT()

virtual BOARD_CONTEXT::~BOARD_CONTEXT ( )

virtualdefault

Member Function Documentation

CanAcceptApiCommands()

virtual bool BOARD_CONTEXT::CanAcceptApiCommands ( ) const

pure virtual

Implemented in FOOTPRINT_EDIT_FRAME_CONTEXT, HEADLESS_FOOTPRINT_CONTEXT, HEADLESS_PCB_CONTEXT, and PCB_EDIT_FRAME_CONTEXT.

GetBoard()

virtual BOARD * BOARD_CONTEXT::GetBoard ( ) const

pure virtual

Implemented in FOOTPRINT_EDIT_FRAME_CONTEXT, HEADLESS_FOOTPRINT_CONTEXT, HEADLESS_PCB_CONTEXT, and PCB_EDIT_FRAME_CONTEXT.

Referenced by API_HANDLER_BOARD::board(), API_HANDLER_PCB::getPageSettings(), API_HANDLER_PCB::getTitleBlock(), API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_PCB::handleGetCustomDesignRules(), API_HANDLER_PCB::handleSetCustomDesignRules(), and API_HANDLER_PCB::setPageSettings().

GetKiway()

virtual KIWAY * BOARD_CONTEXT::GetKiway ( ) const

pure virtual

Implemented in FOOTPRINT_EDIT_FRAME_CONTEXT, HEADLESS_FOOTPRINT_CONTEXT, HEADLESS_PCB_CONTEXT, and PCB_EDIT_FRAME_CONTEXT.

Referenced by ExecuteBoardJob().

GetToolManager()

virtual TOOL_MANAGER * BOARD_CONTEXT::GetToolManager ( ) const

pure virtual

Implemented in FOOTPRINT_EDIT_FRAME_CONTEXT, HEADLESS_FOOTPRINT_CONTEXT, HEADLESS_PCB_CONTEXT, and PCB_EDIT_FRAME_CONTEXT.

Referenced by API_HANDLER_BOARD::toolManager().

Prj()

virtual PROJECT & BOARD_CONTEXT::Prj ( ) const

pure virtual

Implemented in FOOTPRINT_EDIT_FRAME_CONTEXT, HEADLESS_FOOTPRINT_CONTEXT, HEADLESS_PCB_CONTEXT, and PCB_EDIT_FRAME_CONTEXT.

Referenced by API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_PCB::handleGetCustomDesignRules(), API_HANDLER_PCB::handleSetCustomDesignRules(), and API_HANDLER_BOARD::project().

---

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

• board_context.h