EESCHEMA_HELPERS Class Reference

Helper functions to do things like load schematics behind the scenes for special functions. More...

#include <eeschema_helpers.h>

Static Public Member Functions
static SETTINGS_MANAGER *	GetSettingsManager ()
static void	SetSchEditFrame (SCH_EDIT_FRAME *aSchEditFrame)
static PROJECT *	GetDefaultProject ()
static SCHEMATIC *	LoadSchematic (wxString &aFileName, bool aSetActive)
static SCHEMATIC *	LoadSchematic (wxString &aFileName, SCH_IO_MGR::SCH_FILE_T aFormat, bool aSetActive)

Static Private Attributes
static SCH_EDIT_FRAME *	s_SchEditFrame = nullptr
static SETTINGS_MANAGER *	s_SettingsManager = nullptr

Detailed Description

Helper functions to do things like load schematics behind the scenes for special functions.

Similar to the pcbnew scripting helpers, this is just to have one spot for these types of "hacky" solutions

Definition at line 41 of file eeschema_helpers.h.

Member Function Documentation

GetDefaultProject()

PROJECT * EESCHEMA_HELPERS::GetDefaultProject ( )

static

Definition at line 63 of file eeschema_helpers.cpp.

References dummy, SETTINGS_MANAGER::GetProject(), GetSettingsManager(), SETTINGS_MANAGER::LoadProject(), and project.

Referenced by LoadSchematic().

GetSettingsManager()

SETTINGS_MANAGER * EESCHEMA_HELPERS::GetSettingsManager ( )

static

Definition at line 45 of file eeschema_helpers.cpp.

References EDA_BASE_FRAME::GetSettingsManager(), s_SchEditFrame, and s_SettingsManager.

Referenced by GetDefaultProject(), and LoadSchematic().

LoadSchematic() [1/2]

SCHEMATIC * EESCHEMA_HELPERS::LoadSchematic ( wxString &  aFileName, bool  aSetActive  )

static

Definition at line 81 of file eeschema_helpers.cpp.

References FILEEXT::KiCadSchematicFileExtension, FILEEXT::LegacySchematicFileExtension, and LoadSchematic().

Referenced by EESCHEMA_JOBS_HANDLER::JobExportBom(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), EESCHEMA_JOBS_HANDLER::JobSchErc(), and LoadSchematic().

LoadSchematic() [2/2]

SCHEMATIC * EESCHEMA_HELPERS::LoadSchematic ( wxString &  aFileName, SCH_IO_MGR::SCH_FILE_T  aFormat, bool  aSetActive  )

static

Definition at line 93 of file eeschema_helpers.cpp.

References SCH_SHEET_LIST::AnnotatePowerSymbols(), EDA_TEXT::ClearBoundingBoxCache(), SCHEMATIC::ConnectionGraph(), dummy, SCH_SCREENS::FixLegacyPowerSymbolMismatches(), GetDefaultProject(), SCH_LABEL_BASE::GetFields(), SCH_SCREEN::GetFileFormatVersionAtLoad(), SCH_SCREENS::GetFirst(), SCH_SCREENS::GetNext(), SETTINGS_MANAGER::GetProject(), GetSettingsManager(), SCH_SCREEN::GetSheetInstances(), SCHEMATIC::GetSheets(), SCH_SCREEN::GetSymbolInstances(), SCH_SCREEN::GetUuid(), SETTINGS_MANAGER::LoadProject(), EDA_ITEM::m_Uuid, Prj(), project, FILEEXT::ProjectFileExtension, CONNECTION_GRAPH::Recalculate(), SCHEMATIC::RecomputeIntersheetRefs(), CONNECTION_GRAPH::Reset(), SCHEMATIC::Root(), SCHEMATIC::RootScreen(), s_SchEditFrame, SCH_EDIT_FRAME::Schematic(), SCH_SCREEN::SetFileName(), BASE_SCREEN::SetPageNumber(), SCHEMATIC::SetRoot(), SCH_SHEET::SetScreen(), SCHEMATIC::SetSheetNumberAndCount(), SCH_SHEET_LIST::UpdateSheetInstanceData(), and SCH_SHEET_LIST::UpdateSymbolInstanceData().

SetSchEditFrame()

void EESCHEMA_HELPERS::SetSchEditFrame ( SCH_EDIT_FRAME *  aSchEditFrame )

static

Definition at line 39 of file eeschema_helpers.cpp.

References s_SchEditFrame.

Referenced by SCH::IFACE::CreateKiWindow().

Member Data Documentation

s_SchEditFrame

SCH_EDIT_FRAME * EESCHEMA_HELPERS::s_SchEditFrame = nullptr

staticprivate

Definition at line 53 of file eeschema_helpers.h.

Referenced by GetSettingsManager(), LoadSchematic(), and SetSchEditFrame().

s_SettingsManager

SETTINGS_MANAGER * EESCHEMA_HELPERS::s_SettingsManager = nullptr

staticprivate

Definition at line 54 of file eeschema_helpers.h.

Referenced by GetSettingsManager().

---

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

• eeschema_helpers.h
• eeschema_helpers.cpp