KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
PCB_EDIT_FRAME_CONTEXT Class Reference
Inheritance diagram for PCB_EDIT_FRAME_CONTEXT:
PCB_CONTEXT BOARD_CONTEXT

Public Member Functions

 PCB_EDIT_FRAME_CONTEXT (PCB_EDIT_FRAME *aFrame)
 
BOARD * GetBoard () const override
 
PROJECT & Prj () const override
 
TOOL_MANAGER * GetToolManager () const override
 
KIWAY * GetKiway () const override
 
wxString GetCurrentFileName () const override
 
bool CanAcceptApiCommands () const override
 
bool SaveBoard () override
 
bool SavePcbCopy (const wxString &aFileName, bool aCreateProject, bool aHeadless) override
 
bool ReadNetlistFromFile (const wxString &aFilename, NETLIST &aNetlist, REPORTER &aReporter) override
 Read a netlist file and preload component footprints.
 
std::unique_ptr< BOARD_NETLIST_UPDATER > MakeNetlistUpdater () override
 Create a netlist updater bound to this context's board.
 
void OnNetlistChanged (BOARD_NETLIST_UPDATER &aUpdater) override
 Post-import board sync (nets, classes, DRC, ratsnest, new footprint placement).
 

Private Attributes

PCB_EDIT_FRAME * m_frame
 

Detailed Description

Definition at line 29 of file pcb_context.cpp.

Constructor & Destructor Documentation

◆ PCB_EDIT_FRAME_CONTEXT()

PCB_EDIT_FRAME_CONTEXT::PCB_EDIT_FRAME_CONTEXT ( PCB_EDIT_FRAME * aFrame)
inlineexplicit

Definition at line 32 of file pcb_context.cpp.

References m_frame.

Member Function Documentation

◆ CanAcceptApiCommands()

bool PCB_EDIT_FRAME_CONTEXT::CanAcceptApiCommands ( ) const
inlineoverridevirtual

Implements BOARD_CONTEXT.

Definition at line 62 of file pcb_context.cpp.

References m_frame.

◆ GetBoard()

BOARD * PCB_EDIT_FRAME_CONTEXT::GetBoard ( ) const
inlineoverridevirtual

Implements BOARD_CONTEXT.

Definition at line 37 of file pcb_context.cpp.

References m_frame.

Referenced by MakeNetlistUpdater().

◆ GetCurrentFileName()

wxString PCB_EDIT_FRAME_CONTEXT::GetCurrentFileName ( ) const
inlineoverridevirtual

Implements PCB_CONTEXT.

Definition at line 57 of file pcb_context.cpp.

References m_frame.

◆ GetKiway()

KIWAY * PCB_EDIT_FRAME_CONTEXT::GetKiway ( ) const
inlineoverridevirtual

Implements BOARD_CONTEXT.

Definition at line 52 of file pcb_context.cpp.

References m_frame.

◆ GetToolManager()

TOOL_MANAGER * PCB_EDIT_FRAME_CONTEXT::GetToolManager ( ) const
inlineoverridevirtual

Implements BOARD_CONTEXT.

Definition at line 47 of file pcb_context.cpp.

References m_frame.

◆ MakeNetlistUpdater()

std::unique_ptr< BOARD_NETLIST_UPDATER > PCB_EDIT_FRAME_CONTEXT::MakeNetlistUpdater ( )
inlineoverridevirtual

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

Implements PCB_CONTEXT.

Definition at line 82 of file pcb_context.cpp.

References GetBoard(), and m_frame.

◆ OnNetlistChanged()

void PCB_EDIT_FRAME_CONTEXT::OnNetlistChanged ( BOARD_NETLIST_UPDATER & aUpdater)
inlineoverridevirtual

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

Implements PCB_CONTEXT.

Definition at line 87 of file pcb_context.cpp.

References m_frame.

◆ Prj()

PROJECT & PCB_EDIT_FRAME_CONTEXT::Prj ( ) const
inlineoverridevirtual

Implements BOARD_CONTEXT.

Definition at line 42 of file pcb_context.cpp.

References m_frame.

◆ ReadNetlistFromFile()

bool PCB_EDIT_FRAME_CONTEXT::ReadNetlistFromFile ( const wxString & aFilename,
NETLIST & aNetlist,
REPORTER & aReporter )
inlineoverridevirtual

Read a netlist file and preload component footprints.

Implements PCB_CONTEXT.

Definition at line 77 of file pcb_context.cpp.

References m_frame.

◆ SaveBoard()

bool PCB_EDIT_FRAME_CONTEXT::SaveBoard ( )
inlineoverridevirtual

Implements PCB_CONTEXT.

Definition at line 67 of file pcb_context.cpp.

References m_frame.

◆ SavePcbCopy()

bool PCB_EDIT_FRAME_CONTEXT::SavePcbCopy ( const wxString & aFileName,
bool aCreateProject,
bool aHeadless )
inlineoverridevirtual

Implements PCB_CONTEXT.

Definition at line 72 of file pcb_context.cpp.

References m_frame.

Member Data Documentation

◆ m_frame

PCB_EDIT_FRAME* PCB_EDIT_FRAME_CONTEXT::m_frame
private

Definition at line 94 of file pcb_context.cpp.

Referenced by CanAcceptApiCommands(), GetBoard(), GetCurrentFileName(), GetKiway(), GetToolManager(), MakeNetlistUpdater(), OnNetlistChanged(), PCB_EDIT_FRAME_CONTEXT(), Prj(), ReadNetlistFromFile(), SaveBoard(), and SavePcbCopy().

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