BOARD_CONTEXT Class Reference

An interface for the frame surface that the API handlers need; to enable headless mode. 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 wxString	GetCurrentFileName () const =0
virtual bool	CanAcceptApiCommands () const =0
virtual bool	SaveBoard ()=0
virtual bool	SavePcbCopy (const wxString &aFileName, bool aCreateProject, bool aHeadless)=0

Detailed Description

An interface for the frame surface that the API handlers need; to enable headless mode.

Definition at line 36 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 HEADLESS_BOARD_CONTEXT, and PCB_EDIT_FRAME_CONTEXT.

GetBoard()

virtual BOARD * BOARD_CONTEXT::GetBoard ( ) const

pure virtual

Implemented in HEADLESS_BOARD_CONTEXT, and PCB_EDIT_FRAME_CONTEXT.

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

GetCurrentFileName()

virtual wxString BOARD_CONTEXT::GetCurrentFileName ( ) const

pure virtual

Implemented in HEADLESS_BOARD_CONTEXT, and PCB_EDIT_FRAME_CONTEXT.

Referenced by API_HANDLER_PCB::handleRunBoardJobExport3D(), API_HANDLER_PCB::handleRunBoardJobExportDrill(), API_HANDLER_PCB::handleRunBoardJobExportDxf(), API_HANDLER_PCB::handleRunBoardJobExportGencad(), API_HANDLER_PCB::handleRunBoardJobExportGerbers(), API_HANDLER_PCB::handleRunBoardJobExportIpc2581(), API_HANDLER_PCB::handleRunBoardJobExportIpcD356(), API_HANDLER_PCB::handleRunBoardJobExportODB(), API_HANDLER_PCB::handleRunBoardJobExportPdf(), API_HANDLER_PCB::handleRunBoardJobExportPosition(), API_HANDLER_PCB::handleRunBoardJobExportPs(), API_HANDLER_PCB::handleRunBoardJobExportRender(), API_HANDLER_PCB::handleRunBoardJobExportStats(), and API_HANDLER_PCB::handleRunBoardJobExportSvg().

GetKiway()

virtual KIWAY * BOARD_CONTEXT::GetKiway ( ) const

pure virtual

Implemented in HEADLESS_BOARD_CONTEXT, and PCB_EDIT_FRAME_CONTEXT.

Referenced by ExecuteBoardJob().

GetToolManager()

virtual TOOL_MANAGER * BOARD_CONTEXT::GetToolManager ( ) const

pure virtual

Implemented in HEADLESS_BOARD_CONTEXT, and PCB_EDIT_FRAME_CONTEXT.

Referenced by API_HANDLER_PCB::toolManager().

Prj()

virtual PROJECT & BOARD_CONTEXT::Prj ( ) const

pure virtual

Implemented in HEADLESS_BOARD_CONTEXT, and PCB_EDIT_FRAME_CONTEXT.

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

SaveBoard()

virtual bool BOARD_CONTEXT::SaveBoard ( )

pure virtual

Implemented in HEADLESS_BOARD_CONTEXT, and PCB_EDIT_FRAME_CONTEXT.

Referenced by API_HANDLER_PCB::handleSaveCopyOfDocument(), and API_HANDLER_PCB::handleSaveDocument().

SavePcbCopy()

virtual bool BOARD_CONTEXT::SavePcbCopy ( const wxString & aFileName, bool aCreateProject, bool aHeadless )

pure virtual

Implemented in HEADLESS_BOARD_CONTEXT, and PCB_EDIT_FRAME_CONTEXT.

Referenced by API_HANDLER_PCB::handleSaveCopyOfDocument().

---

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

• board_context.h