PCB_CONTEXT Class Reference

PCB-editor-specific context; extends BOARD_CONTEXT with save/filename operations. More...

#include <pcb_context.h>

Inheritance diagram for PCB_CONTEXT:

Public Member Functions
virtual wxString	GetCurrentFileName () const =0
virtual bool	SaveBoard ()=0
virtual bool	SavePcbCopy (const wxString &aFileName, bool aCreateProject, bool aHeadless)=0
virtual bool	ReadNetlistFromFile (const wxString &aFilename, NETLIST &aNetlist, REPORTER &aReporter)=0
	Read a netlist file and preload component footprints.
virtual std::unique_ptr< BOARD_NETLIST_UPDATER >	MakeNetlistUpdater ()=0
	Create a netlist updater bound to this context's board.
virtual void	OnNetlistChanged (BOARD_NETLIST_UPDATER &aUpdater)=0
	Post-import board sync (nets, classes, DRC, ratsnest, new footprint placement).
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

PCB-editor-specific context; extends BOARD_CONTEXT with save/filename operations.

Definition at line 37 of file pcb_context.h.

Member Function Documentation

CanAcceptApiCommands()

virtual bool BOARD_CONTEXT::CanAcceptApiCommands ( ) const

pure virtualinherited

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 virtualinherited

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(), and API_HANDLER_PCB::setPageSettings().

GetCurrentFileName()

virtual wxString PCB_CONTEXT::GetCurrentFileName ( ) const

pure virtual

Implemented in HEADLESS_PCB_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 virtualinherited

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 virtualinherited

Implemented in FOOTPRINT_EDIT_FRAME_CONTEXT, HEADLESS_FOOTPRINT_CONTEXT, HEADLESS_PCB_CONTEXT, and PCB_EDIT_FRAME_CONTEXT.

Referenced by API_HANDLER_BOARD::toolManager().

MakeNetlistUpdater()

virtual std::unique_ptr< BOARD_NETLIST_UPDATER > PCB_CONTEXT::MakeNetlistUpdater ( )

pure virtual

Create a netlist updater bound to this context's board.

Implemented in HEADLESS_PCB_CONTEXT, and PCB_EDIT_FRAME_CONTEXT.

Referenced by API_HANDLER_PCB::handleImportNetlist().

OnNetlistChanged()

virtual void PCB_CONTEXT::OnNetlistChanged ( BOARD_NETLIST_UPDATER & aUpdater )

pure virtual

Post-import board sync (nets, classes, DRC, ratsnest, new footprint placement).

Implemented in HEADLESS_PCB_CONTEXT, and PCB_EDIT_FRAME_CONTEXT.

Referenced by API_HANDLER_PCB::handleImportNetlist().

Prj()

virtual PROJECT & BOARD_CONTEXT::Prj ( ) const

pure virtualinherited

Implemented in FOOTPRINT_EDIT_FRAME_CONTEXT, HEADLESS_FOOTPRINT_CONTEXT, HEADLESS_PCB_CONTEXT, and PCB_EDIT_FRAME_CONTEXT.

Referenced by API_HANDLER_BOARD::project().

ReadNetlistFromFile()

virtual bool PCB_CONTEXT::ReadNetlistFromFile ( const wxString & aFilename, NETLIST & aNetlist, REPORTER & aReporter )

pure virtual

Read a netlist file and preload component footprints.

Implemented in HEADLESS_PCB_CONTEXT, and PCB_EDIT_FRAME_CONTEXT.

Referenced by API_HANDLER_PCB::handleImportNetlist().

SaveBoard()

virtual bool PCB_CONTEXT::SaveBoard ( )

pure virtual

Implemented in HEADLESS_PCB_CONTEXT, and PCB_EDIT_FRAME_CONTEXT.

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

SavePcbCopy()

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

pure virtual

Implemented in HEADLESS_PCB_CONTEXT, and PCB_EDIT_FRAME_CONTEXT.

Referenced by API_HANDLER_PCB::handleSaveCopyOfDocument().

---

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

• pcb_context.h