#include <startwizard_provider_libraries.h>

Inheritance diagram for STARTWIZARD_PROVIDER_LIBRARIES:

Public Member Functions
	STARTWIZARD_PROVIDER_LIBRARIES ()

virtual	~STARTWIZARD_PROVIDER_LIBRARIES ()

wxString	Name () const override

bool	NeedsUserInput () const override

wxPanel *	GetWizardPanel (wxWindow aParent, STARTWIZARD aWizard) override

void	Finish () override

void	ApplyDefaults () override
	Apply whatever actions and settings should happen if the user cancels the startup wizard.

const wxString &	GetPageName () const

bool	WasShown () const

void	SetWasShown (bool aShown)

Static Public Member Functions
static KICOMMON_API bool	MigrateBuiltInLibraries (LIBRARY_TABLE &aTable, LIBRARY_TABLE_TYPE aType, const wxString &aStockPath, bool aStockPathValid)
	Migrates built-in (stock) library references in an imported global library table to the current version.

Private Attributes
std::shared_ptr< STARTWIZARD_PROVIDER_LIBRARIES_MODEL >	m_model

wxString	m_pageName

bool	m_wasShown

Detailed Description

Definition at line 44 of file startwizard_provider_libraries.h.

Constructor & Destructor Documentation

◆ STARTWIZARD_PROVIDER_LIBRARIES()

STARTWIZARD_PROVIDER_LIBRARIES::STARTWIZARD_PROVIDER_LIBRARIES ( )

Definition at line 224 of file startwizard_provider_libraries.cpp.

References _, and STARTWIZARD_PROVIDER::STARTWIZARD_PROVIDER().

◆ ~STARTWIZARD_PROVIDER_LIBRARIES()

virtual STARTWIZARD_PROVIDER_LIBRARIES::~STARTWIZARD_PROVIDER_LIBRARIES ( )

inlinevirtual

Definition at line 49 of file startwizard_provider_libraries.h.

Member Function Documentation

◆ ApplyDefaults()

void STARTWIZARD_PROVIDER_LIBRARIES::ApplyDefaults ( )

overridevirtual

Apply whatever actions and settings should happen if the user cancels the startup wizard.

Reimplemented from STARTWIZARD_PROVIDER.

Definition at line 356 of file startwizard_provider_libraries.cpp.

References LIBRARY_MANAGER::CreateGlobalTable(), and LIBRARY_MANAGER::InvalidGlobalTables().

◆ Finish()

void STARTWIZARD_PROVIDER_LIBRARIES::Finish ( )

overridevirtual

Reimplemented from STARTWIZARD_PROVIDER.

Definition at line 322 of file startwizard_provider_libraries.cpp.

References LIBRARY_MANAGER::CreateGlobalTable(), LIBRARY_MANAGER::DefaultGlobalTablePath(), FOOTPRINT, GLOBAL, IMPORT, LIBRARY_MANAGER::InvalidGlobalTables(), LIBRARY_MANAGER::IsTableValid(), m_model, MigrateBuiltInLibraries(), LIBRARY_MANAGER::StockTablePath(), SYMBOL, table, traceLibraries, and USE_DEFAULTS.

◆ GetPageName()

const wxString & STARTWIZARD_PROVIDER::GetPageName ( ) const

inlineinherited

Definition at line 47 of file startwizard_provider.h.

References m_pageName.

◆ GetWizardPanel()

wxPanel * STARTWIZARD_PROVIDER_LIBRARIES::GetWizardPanel	(	wxWindow *	aParent,
		STARTWIZARD *	aWizard )

overridevirtual

Reimplemented from STARTWIZARD_PROVIDER.

Definition at line 236 of file startwizard_provider_libraries.cpp.

References LIBRARY_MANAGER::InvalidGlobalTables(), and m_model.

◆ MigrateBuiltInLibraries()

bool STARTWIZARD_PROVIDER_LIBRARIES::MigrateBuiltInLibraries	(	LIBRARY_TABLE &	aTable,
		LIBRARY_TABLE_TYPE	aType,
		const wxString &	aStockPath,
		bool	aStockPathValid )

static

Migrates built-in (stock) library references in an imported global library table to the current version.

Direct stock rows are removed and re-added as a single chained reference, and an existing chained reference is repointed at the latest stock table. If the imported table referenced no stock libraries, none are added.

Parameters

aTable	is the imported table to migrate in place
aType	is the table type (symbol or footprint)
aStockPath	is the (unexpanded) URI of the current stock library table
aStockPathValid	is true if aStockPath resolves to a valid table on disk