KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
HEADLESS_SCH_CONTEXT Class Reference

#include <headless_sch_context.h>

Inheritance diagram for HEADLESS_SCH_CONTEXT:
SCH_CONTEXT

Public Member Functions

 HEADLESS_SCH_CONTEXT (SCHEMATIC **aSchematicSlot, PROJECT *aProject, KIWAY *aKiway=nullptr)
 
 ~HEADLESS_SCH_CONTEXT () override
 
SCHEMATIC * GetSchematic () const override
 
PROJECT & Prj () const override
 
TOOL_MANAGER * GetToolManager () const override
 
KIWAY * GetKiway () const override
 
wxString GetCurrentFileName () const override
 
bool CanAcceptApiCommands () const override
 
std::optional< SCH_SHEET_PATH > GetCurrentSheet () const override
 
bool SaveSchematic () override
 
bool SaveSchematicCopy (const wxString &aFileName, bool aCreateProject) override
 
bool RevertToSaved () override
 

Private Attributes

SCHEMATIC ** m_schematicSlot
 
PROJECT * m_project
 
KIWAY * m_kiway
 
std::unique_ptr< TOOL_MANAGER > m_toolManager
 

Detailed Description

Definition at line 37 of file headless_sch_context.h.

Constructor & Destructor Documentation

◆ HEADLESS_SCH_CONTEXT()

HEADLESS_SCH_CONTEXT::HEADLESS_SCH_CONTEXT ( SCHEMATIC ** aSchematicSlot,
PROJECT * aProject,
KIWAY * aKiway = nullptr )

Definition at line 32 of file headless_sch_context.cpp.

References Kiface(), m_kiway, m_project, m_schematicSlot, and m_toolManager.

◆ ~HEADLESS_SCH_CONTEXT()

HEADLESS_SCH_CONTEXT::~HEADLESS_SCH_CONTEXT ( )
overridedefault

Member Function Documentation

◆ CanAcceptApiCommands()

bool HEADLESS_SCH_CONTEXT::CanAcceptApiCommands ( ) const
inlineoverridevirtual

Implements SCH_CONTEXT.

Definition at line 54 of file headless_sch_context.h.

◆ GetCurrentFileName()

wxString HEADLESS_SCH_CONTEXT::GetCurrentFileName ( ) const
overridevirtual

Implements SCH_CONTEXT.

Definition at line 69 of file headless_sch_context.cpp.

References SCHEMATIC::GetFileName(), and m_schematicSlot.

◆ GetCurrentSheet()

std::optional< SCH_SHEET_PATH > HEADLESS_SCH_CONTEXT::GetCurrentSheet ( ) const
inlineoverridevirtual

Implements SCH_CONTEXT.

Definition at line 56 of file headless_sch_context.h.

◆ GetKiway()

KIWAY * HEADLESS_SCH_CONTEXT::GetKiway ( ) const
inlineoverridevirtual

Implements SCH_CONTEXT.

Definition at line 50 of file headless_sch_context.h.

References m_kiway.

◆ GetSchematic()

SCHEMATIC * HEADLESS_SCH_CONTEXT::GetSchematic ( ) const
overridevirtual

Implements SCH_CONTEXT.

Definition at line 50 of file headless_sch_context.cpp.

References m_schematicSlot.

◆ GetToolManager()

TOOL_MANAGER * HEADLESS_SCH_CONTEXT::GetToolManager ( ) const
overridevirtual

Implements SCH_CONTEXT.

Definition at line 63 of file headless_sch_context.cpp.

References m_toolManager.

◆ Prj()

PROJECT & HEADLESS_SCH_CONTEXT::Prj ( ) const
overridevirtual

Implements SCH_CONTEXT.

Definition at line 56 of file headless_sch_context.cpp.

References m_project.

◆ RevertToSaved()

bool HEADLESS_SCH_CONTEXT::RevertToSaved ( )
overridevirtual

Implements SCH_CONTEXT.

Definition at line 94 of file headless_sch_context.cpp.

References SCHEMATIC::GetFileName(), Kiface(), EESCHEMA_HELPERS::LoadSchematic(), m_project, m_schematicSlot, and m_toolManager.

◆ SaveSchematic()

bool HEADLESS_SCH_CONTEXT::SaveSchematic ( )
overridevirtual

Implements SCH_CONTEXT.

Definition at line 80 of file headless_sch_context.cpp.

References m_project, m_schematicSlot, and SCH_API_SAVE::SaveSchematic().

◆ SaveSchematicCopy()

bool HEADLESS_SCH_CONTEXT::SaveSchematicCopy ( const wxString & aFileName,
bool aCreateProject )
overridevirtual

Implements SCH_CONTEXT.

Definition at line 87 of file headless_sch_context.cpp.

References m_project, m_schematicSlot, and SCH_API_SAVE::SaveSchematicCopy().

Member Data Documentation

◆ m_kiway

KIWAY* HEADLESS_SCH_CONTEXT::m_kiway
private

Definition at line 69 of file headless_sch_context.h.

Referenced by GetKiway(), and HEADLESS_SCH_CONTEXT().

◆ m_project

PROJECT* HEADLESS_SCH_CONTEXT::m_project
private

Definition at line 68 of file headless_sch_context.h.

Referenced by HEADLESS_SCH_CONTEXT(), Prj(), RevertToSaved(), SaveSchematic(), and SaveSchematicCopy().

◆ m_schematicSlot

SCHEMATIC** HEADLESS_SCH_CONTEXT::m_schematicSlot
private

Definition at line 67 of file headless_sch_context.h.

Referenced by GetCurrentFileName(), GetSchematic(), HEADLESS_SCH_CONTEXT(), RevertToSaved(), SaveSchematic(), and SaveSchematicCopy().

◆ m_toolManager

std::unique_ptr<TOOL_MANAGER> HEADLESS_SCH_CONTEXT::m_toolManager
private

Definition at line 70 of file headless_sch_context.h.

Referenced by GetToolManager(), HEADLESS_SCH_CONTEXT(), and RevertToSaved().

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