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 void	SetSchEditFrame (SCH_EDIT_FRAME *aSchEditFrame)
static SCHEMATIC *	LoadSchematic (const wxString &aFileName, bool aSetActive, bool aForceDefaultProject, PROJECT *aProject=nullptr, bool aCalculateConnectivity=true)
static SCHEMATIC *	LoadSchematic (const wxString &aFileName, SCH_IO_MGR::SCH_FILE_T aFormat, bool aSetActive, bool aForceDefaultProject, PROJECT *aProject=nullptr, bool aCalculateConnectivity=true)

Static Private Attributes
static SCH_EDIT_FRAME *	s_SchEditFrame = 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

LoadSchematic() [1/2]

SCHEMATIC * EESCHEMA_HELPERS::LoadSchematic ( const wxString & aFileName, bool aSetActive, bool aForceDefaultProject, PROJECT * aProject = nullptr, bool aCalculateConnectivity = true )

static

Definition at line 51 of file eeschema_helpers.cpp.

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

Referenced by BOOST_AUTO_TEST_CASE(), SCH_DESIGN_BLOCK_PREVIEW_WIDGET::DisplayDesignBlock(), EESCHEMA_JOBS_HANDLER::getSchematic(), and LoadSchematic().

LoadSchematic() [2/2]

SCHEMATIC * EESCHEMA_HELPERS::LoadSchematic ( const wxString & aFileName, SCH_IO_MGR::SCH_FILE_T aFormat, bool aSetActive, bool aForceDefaultProject, PROJECT * aProject = nullptr, bool aCalculateConnectivity = true )

static

Definition at line 67 of file eeschema_helpers.cpp.

References SCH_SHEET_LIST::AnnotatePowerSymbols(), SCHEMATIC::BuildSheetListSortedByPageNumbers(), SCHEMATIC::ConnectionGraph(), SCHEMATIC::CreateDefaultScreens(), dummy, SCH_SCREENS::FixLegacyPowerSymbolMismatches(), SCH_SCREEN::GetFileFormatVersionAtLoad(), SCH_SCREENS::GetFirst(), SCH_SCREENS::GetNext(), SETTINGS_MANAGER::GetProject(), PGM_BASE::GetSettingsManager(), SCH_SCREEN::GetSheetInstances(), SCH_SCREEN::GetSymbolInstances(), GLOBAL_CLEANUP, Kiface(), SETTINGS_MANAGER::LoadProject(), Pgm(), SETTINGS_MANAGER::Prj(), project, FILEEXT::ProjectFileExtension, CONNECTION_GRAPH::Recalculate(), SCHEMATIC::RecalculateConnections(), SCHEMATIC::RecomputeIntersheetRefs(), CONNECTION_GRAPH::Reset(), SCHEMATIC::ResolveERCExclusionsPostUpdate(), SCHEMATIC::Root(), SCHEMATIC::RootScreen(), s_SchEditFrame, SCHEMATIC, TOOL_MANAGER::SetEnvironment(), SCHEMATIC::SetSheetNumberAndCount(), SCHEMATIC::SetTopLevelSheets(), SCH_SHEET_LIST::UpdateSheetInstanceData(), and SCH_SHEET_LIST::UpdateSymbolInstanceData().

SetSchEditFrame()

void EESCHEMA_HELPERS::SetSchEditFrame ( SCH_EDIT_FRAME * aSchEditFrame )

static

Definition at line 45 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 56 of file eeschema_helpers.h.

Referenced by LoadSchematic(), and SetSchEditFrame().

---

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

• eeschema_helpers.h
• eeschema_helpers.cpp