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

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 ( bool  aSetActive )

static

Definition at line 67 of file eeschema_helpers.cpp.

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

GetSettingsManager()

SETTINGS_MANAGER * EESCHEMA_HELPERS::GetSettingsManager ( )

static

Definition at line 49 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 ( const wxString &  aFileName, bool  aSetActive, bool  aForceDefaultProject, PROJECT *  aProject = nullptr  )

static

Definition at line 85 of file eeschema_helpers.cpp.

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

Referenced by BOOST_AUTO_TEST_CASE(), 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  )

static

Definition at line 100 of file eeschema_helpers.cpp.

References SCH_SHEET_LIST::AnnotatePowerSymbols(), SCHEMATIC::BuildSheetListSortedByPageNumbers(), 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(), 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 43 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