HEADLESS_FOOTPRINT_CONTEXT Class Reference

#include <headless_footprint_context.h>

Inheritance diagram for HEADLESS_FOOTPRINT_CONTEXT:

Public Member Functions
	HEADLESS_FOOTPRINT_CONTEXT (std::unique_ptr< FOOTPRINT > aFootprint, const LIB_ID &aFPID, PROJECT *aProject, APP_SETTINGS_BASE *aSettings, KIWAY *aKiway=nullptr)
	~HEADLESS_FOOTPRINT_CONTEXT () override
BOARD *	GetBoard () const override
PROJECT &	Prj () const override
TOOL_MANAGER *	GetToolManager () const override
KIWAY *	GetKiway () const override
bool	CanAcceptApiCommands () const override
LIB_ID	GetLoadedFPID () const override
bool	SaveFootprint (FOOTPRINT *aFootprint) override
bool	SaveFootprintInLibrary (FOOTPRINT *aFootprint, const wxString &aLibraryName) override

Private Attributes
std::unique_ptr< BOARD >	m_board
LIB_ID	m_fpid
PROJECT *	m_project
KIWAY *	m_kiway
std::unique_ptr< TOOL_MANAGER >	m_toolManager

Detailed Description

Definition at line 36 of file headless_footprint_context.h.

Constructor & Destructor Documentation

HEADLESS_FOOTPRINT_CONTEXT()

HEADLESS_FOOTPRINT_CONTEXT::HEADLESS_FOOTPRINT_CONTEXT	(	std::unique_ptr< FOOTPRINT >	aFootprint,
		const LIB_ID &	aFPID,
		PROJECT *	aProject,
		APP_SETTINGS_BASE *	aSettings,
		KIWAY *	aKiway = nullptr )

Definition at line 30 of file headless_footprint_context.cpp.

References FPHOLDER, m_board, m_fpid, m_kiway, m_project, and m_toolManager.

~HEADLESS_FOOTPRINT_CONTEXT()

HEADLESS_FOOTPRINT_CONTEXT::~HEADLESS_FOOTPRINT_CONTEXT ( )

overridedefault

Member Function Documentation

CanAcceptApiCommands()

bool HEADLESS_FOOTPRINT_CONTEXT::CanAcceptApiCommands ( ) const

inlineoverridevirtual

Implements BOARD_CONTEXT.

Definition at line 53 of file headless_footprint_context.h.

GetBoard()

BOARD * HEADLESS_FOOTPRINT_CONTEXT::GetBoard ( ) const

overridevirtual

Implements BOARD_CONTEXT.

Definition at line 55 of file headless_footprint_context.cpp.

References m_board.

GetKiway()

KIWAY * HEADLESS_FOOTPRINT_CONTEXT::GetKiway ( ) const

inlineoverridevirtual

Implements BOARD_CONTEXT.

Definition at line 51 of file headless_footprint_context.h.

References m_kiway.

GetLoadedFPID()

LIB_ID HEADLESS_FOOTPRINT_CONTEXT::GetLoadedFPID ( ) const

overridevirtual

Implements FOOTPRINT_CONTEXT.

Definition at line 74 of file headless_footprint_context.cpp.

References m_fpid.

GetToolManager()

TOOL_MANAGER * HEADLESS_FOOTPRINT_CONTEXT::GetToolManager ( ) const

overridevirtual

Implements BOARD_CONTEXT.

Definition at line 68 of file headless_footprint_context.cpp.

References m_toolManager.

Prj()

PROJECT & HEADLESS_FOOTPRINT_CONTEXT::Prj ( ) const

overridevirtual

Implements BOARD_CONTEXT.

Definition at line 61 of file headless_footprint_context.cpp.

References m_project.

SaveFootprint()

bool HEADLESS_FOOTPRINT_CONTEXT::SaveFootprint ( FOOTPRINT * aFootprint )

overridevirtual

Implements FOOTPRINT_CONTEXT.

Definition at line 80 of file headless_footprint_context.cpp.

References m_fpid, and SaveFootprintInLibrary().

SaveFootprintInLibrary()

bool HEADLESS_FOOTPRINT_CONTEXT::SaveFootprintInLibrary ( FOOTPRINT * aFootprint, const wxString & aLibraryName )

overridevirtual

Implements FOOTPRINT_CONTEXT.

Definition at line 94 of file headless_footprint_context.cpp.

References EDA_ITEM::ClearFlags(), PROJECT_PCB::FootprintLibAdapter(), FOOTPRINT::GetFPID(), LIB_ID::GetLibItemName(), m_fpid, m_project, RECURSE, FOOTPRINT::RunOnChildren(), FOOTPRINT_LIBRARY_ADAPTER::SaveFootprint(), and FOOTPRINT::SetFPID().

Referenced by SaveFootprint().

Member Data Documentation

m_board

std::unique_ptr<BOARD> HEADLESS_FOOTPRINT_CONTEXT::m_board

private

Definition at line 62 of file headless_footprint_context.h.

Referenced by GetBoard(), and HEADLESS_FOOTPRINT_CONTEXT().

m_fpid

LIB_ID HEADLESS_FOOTPRINT_CONTEXT::m_fpid

private

Definition at line 63 of file headless_footprint_context.h.

Referenced by GetLoadedFPID(), HEADLESS_FOOTPRINT_CONTEXT(), SaveFootprint(), and SaveFootprintInLibrary().

m_kiway

KIWAY* HEADLESS_FOOTPRINT_CONTEXT::m_kiway

private

Definition at line 65 of file headless_footprint_context.h.

Referenced by GetKiway(), and HEADLESS_FOOTPRINT_CONTEXT().

m_project

PROJECT* HEADLESS_FOOTPRINT_CONTEXT::m_project

private

Definition at line 64 of file headless_footprint_context.h.

Referenced by HEADLESS_FOOTPRINT_CONTEXT(), Prj(), and SaveFootprintInLibrary().

m_toolManager

std::unique_ptr<TOOL_MANAGER> HEADLESS_FOOTPRINT_CONTEXT::m_toolManager

private

Definition at line 66 of file headless_footprint_context.h.

Referenced by GetToolManager(), and HEADLESS_FOOTPRINT_CONTEXT().

---

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

• headless_footprint_context.h
• headless_footprint_context.cpp