Dialog to show and edit symbol library tables. More...

#include <panel_fp_lib_table.h>

Inheritance diagram for PANEL_FP_LIB_TABLE:

Public Member Functions
	PANEL_FP_LIB_TABLE (DIALOG_EDIT_LIBRARY_TABLES aParent, PROJECT aProject)

	~PANEL_FP_LIB_TABLE () override

bool	TransferDataToWindow () override

bool	TransferDataFromWindow () override

void	AddTable (LIBRARY_TABLE *table, const wxString &aTitle, bool aClosable)

Protected Attributes
wxAuiNotebook *	m_notebook

STD_BITMAP_BUTTON *	m_append_button

SPLIT_BUTTON *	m_browseButton

STD_BITMAP_BUTTON *	m_move_up_button

STD_BITMAP_BUTTON *	m_move_down_button

STD_BITMAP_BUTTON *	m_delete_button

wxButton *	m_resetGlobal

wxButton *	m_migrate_libs_button

WX_GRID *	m_path_subs_grid

Private Member Functions
bool	verifyTables ()
	Trim important fields, removes blank row entries, and checks for duplicates.

void	appendRowHandler (wxCommandEvent &event) override

void	browseLibrariesHandler (wxCommandEvent &event)

void	deleteRowHandler (wxCommandEvent &event) override

void	moveUpHandler (wxCommandEvent &event) override

void	moveDownHandler (wxCommandEvent &event) override

void	onMigrateLibraries (wxCommandEvent &event) override

void	onSizeGrid (wxSizeEvent &event) override

void	onPageChange (wxAuiNotebookEvent &event) override

void	onReset (wxCommandEvent &event) override

void	onNotebookPageCloseRequest (wxAuiNotebookEvent &aEvent)

void	adjustPathSubsGridColumns (int aWidth)

void	populateEnvironReadOnlyTable ()
	Populate the readonly environment variable table with names and values by examining all the full_uri columns.

void	populatePluginList ()

FP_LIB_TABLE_GRID_DATA_MODEL *	get_model (int aPage) const

FP_LIB_TABLE_GRID_DATA_MODEL *	cur_model () const

WX_GRID *	get_grid (int aPage) const

WX_GRID *	cur_grid () const

Private Attributes
PROJECT *	m_project

DIALOG_EDIT_LIBRARY_TABLES *	m_parent

wxArrayString	m_pluginChoices

wxString	m_lastProjectLibDir

std::map< PCB_IO_MGR::PCB_FILE_T, IO_BASE::IO_FILE_DESC >	m_supportedFpFiles

Detailed Description

Dialog to show and edit symbol library tables.

Definition at line 35 of file panel_fp_lib_table.h.

Constructor & Destructor Documentation

◆ PANEL_FP_LIB_TABLE()

PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE	(	DIALOG_EDIT_LIBRARY_TABLES *	aParent,
		PROJECT *	aProject )

Definition at line 242 of file panel_fp_lib_table.cpp.

◆ ~PANEL_FP_LIB_TABLE()

PANEL_FP_LIB_TABLE::~PANEL_FP_LIB_TABLE ( )

override

Definition at line 322 of file panel_fp_lib_table.cpp.

References browseLibrariesHandler(), PANEL_FP_LIB_TABLE_BASE::m_browseButton, PANEL_FP_LIB_TABLE_BASE::m_path_subs_grid, and m_supportedFpFiles.

Member Function Documentation

◆ AddTable()

void PANEL_FP_LIB_TABLE::AddTable	(	LIBRARY_TABLE *	table,
		const wxString &	aTitle,
		bool	aClosable )

Definition at line 180 of file panel_fp_lib_table.cpp.

References LIB_TABLE_NOTEBOOK_PANEL::AddTable(), appendRowHandler(), COL_DESCR, COL_NICKNAME, COL_TYPE, COL_URI, PROJECT_PCB::FootprintLibAdapter(), get_grid(), GetAppSettings(), PATHS::GetDefaultUserFootprintsPath(), grid, m_lastProjectLibDir, PANEL_FP_LIB_TABLE_BASE::m_notebook, m_parent, m_pluginChoices, m_project, m_supportedFpFiles, and LIBRARY_TABLE::Path().

Referenced by PANEL_FP_LIB_TABLE().

◆ adjustPathSubsGridColumns()

void PANEL_FP_LIB_TABLE::adjustPathSubsGridColumns ( int aWidth )

private

Definition at line 688 of file panel_fp_lib_table.cpp.

References PANEL_FP_LIB_TABLE_BASE::m_path_subs_grid.

Referenced by onSizeGrid(), and populateEnvironReadOnlyTable().

◆ appendRowHandler()

void PANEL_FP_LIB_TABLE::appendRowHandler ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PANEL_FP_LIB_TABLE_BASE.

Definition at line 412 of file panel_fp_lib_table.cpp.

References LIB_TABLE_GRID_TRICKS::AppendRowHandler(), and cur_grid().

Referenced by AddTable().

◆ browseLibrariesHandler()

void PANEL_FP_LIB_TABLE::browseLibrariesHandler ( wxCommandEvent & event )

private

◆ cur_grid()

WX_GRID * PANEL_FP_LIB_TABLE::cur_grid ( ) const

inlineprivate

Definition at line 79 of file panel_fp_lib_table.h.

References get_grid(), and PANEL_FP_LIB_TABLE_BASE::m_notebook.

Referenced by appendRowHandler(), browseLibrariesHandler(), deleteRowHandler(), moveDownHandler(), moveUpHandler(), onMigrateLibraries(), onReset(), TransferDataFromWindow(), and TransferDataToWindow().

◆ cur_model()

FP_LIB_TABLE_GRID_DATA_MODEL * PANEL_FP_LIB_TABLE::cur_model ( ) const

inlineprivate

Definition at line 76 of file panel_fp_lib_table.h.

References get_model(), and PANEL_FP_LIB_TABLE_BASE::m_notebook.

Referenced by browseLibrariesHandler().

◆ deleteRowHandler()

void PANEL_FP_LIB_TABLE::deleteRowHandler ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PANEL_FP_LIB_TABLE_BASE.

Definition at line 418 of file panel_fp_lib_table.cpp.

References cur_grid(), and LIB_TABLE_GRID_TRICKS::DeleteRowHandler().

◆ get_grid()

WX_GRID * PANEL_FP_LIB_TABLE::get_grid ( int aPage ) const

private

Definition at line 343 of file panel_fp_lib_table.cpp.

References LIB_TABLE_NOTEBOOK_PANEL::GetGrid(), and PANEL_FP_LIB_TABLE_BASE::m_notebook.

Referenced by AddTable(), cur_grid(), get_model(), onReset(), TransferDataToWindow(), and verifyTables().

◆ get_model()

FP_LIB_TABLE_GRID_DATA_MODEL * PANEL_FP_LIB_TABLE::get_model ( int aPage ) const

private

Definition at line 337 of file panel_fp_lib_table.cpp.

References get_grid().

Referenced by cur_model(), populateEnvironReadOnlyTable(), and TransferDataFromWindow().

◆ moveDownHandler()

void PANEL_FP_LIB_TABLE::moveDownHandler ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PANEL_FP_LIB_TABLE_BASE.

Definition at line 430 of file panel_fp_lib_table.cpp.

References cur_grid(), and LIB_TABLE_GRID_TRICKS::MoveDownHandler().

◆ moveUpHandler()

void PANEL_FP_LIB_TABLE::moveUpHandler ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PANEL_FP_LIB_TABLE_BASE.

Definition at line 424 of file panel_fp_lib_table.cpp.

References cur_grid(), and LIB_TABLE_GRID_TRICKS::MoveUpHandler().

◆ onMigrateLibraries()

void PANEL_FP_LIB_TABLE::onMigrateLibraries ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PANEL_FP_LIB_TABLE_BASE.

Definition at line 437 of file panel_fp_lib_table.cpp.

References _, COL_NICKNAME, COL_OPTIONS, COL_TYPE, COL_URI, PCB_IO_MGR::ConvertLibrary(), cur_grid(), DisplayErrorMessage(), ExpandEnvVarSubstitutions(), WX_HTML_REPORT_BOX::Flush(), WX_HTML_REPORT_BOX::HasMessage(), IsOK(), PCB_IO_MGR::KICAD_SEXP, FILEEXT::KiCadFootprintLibPathExtension, m_parent, m_project, DIALOG_HTML_REPORTER::m_Reporter, NormalizePath(), LIBRARY_TABLE::ParseOptions(), Pgm(), DIALOG_SHIM::ShowModal(), and PCB_IO_MGR::ShowType().

◆ onNotebookPageCloseRequest()

void PANEL_FP_LIB_TABLE::onNotebookPageCloseRequest ( wxAuiNotebookEvent & aEvent )

private

Definition at line 668 of file panel_fp_lib_table.cpp.

Referenced by PANEL_FP_LIB_TABLE().

◆ onPageChange()

void PANEL_FP_LIB_TABLE::onPageChange ( wxAuiNotebookEvent & event )

overrideprivatevirtual

Reimplemented from PANEL_FP_LIB_TABLE_BASE.

Definition at line 766 of file panel_fp_lib_table.cpp.

References PANEL_FP_LIB_TABLE_BASE::m_notebook, and PANEL_FP_LIB_TABLE_BASE::m_resetGlobal.

◆ onReset()

void PANEL_FP_LIB_TABLE::onReset ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PANEL_FP_LIB_TABLE_BASE.

Definition at line 707 of file panel_fp_lib_table.cpp.

References _, COL_NICKNAME, LIBRARY_MANAGER::CreateGlobalTable(), cur_grid(), KIWAY::FACE_PCB, FOOTPRINT, PROJECT_PCB::FootprintLibAdapter(), get_grid(), GetAppSettings(), PATHS::GetDefaultUserFootprintsPath(), PGM_BASE::GetLibraryManager(), GLOBAL, grid, IsOK(), LIBRARY_MANAGER::LoadGlobalTables(), m_parent, m_pluginChoices, m_project, m_supportedFpFiles, Pgm(), LIBRARY_MANAGER::Table(), and table.

◆ onSizeGrid()

void PANEL_FP_LIB_TABLE::onSizeGrid ( wxSizeEvent & event )

overrideprivatevirtual

Reimplemented from PANEL_FP_LIB_TABLE_BASE.

Definition at line 699 of file panel_fp_lib_table.cpp.

References adjustPathSubsGridColumns().

◆ populateEnvironReadOnlyTable()

void PANEL_FP_LIB_TABLE::populateEnvironReadOnlyTable ( )

private

Populate the readonly environment variable table with names and values by examining all the full_uri columns.

Definition at line 836 of file panel_fp_lib_table.cpp.

References adjustPathSubsGridColumns(), COL_URI, get_model(), LIB_TABLE_GRID_DATA_MODEL::GetNumberRows(), LIB_TABLE_GRID_DATA_MODEL::GetValue(), ENV_VAR::GetVersionedEnvVarName(), PANEL_FP_LIB_TABLE_BASE::m_notebook, PANEL_FP_LIB_TABLE_BASE::m_path_subs_grid, and PROJECT_VAR_NAME.

Referenced by PANEL_FP_LIB_TABLE().

◆ populatePluginList()

void PANEL_FP_LIB_TABLE::populatePluginList ( )

private

Definition at line 367 of file panel_fp_lib_table.cpp.

References _, PCB_IO_MGR::PLUGIN_REGISTRY::Instance(), m_supportedFpFiles, and PCB_IO_MGR::NESTED_TABLE.

Referenced by PANEL_FP_LIB_TABLE().

◆ TransferDataFromWindow()

bool PANEL_FP_LIB_TABLE::TransferDataFromWindow ( )

override

◆ TransferDataToWindow()

bool PANEL_FP_LIB_TABLE::TransferDataToWindow ( )

override

Definition at line 349 of file panel_fp_lib_table.cpp.

References COL_VISIBLE, cur_grid(), get_grid(), grid, PANEL_FP_LIB_TABLE_BASE::m_notebook, and m_parent.

◆ verifyTables()

bool PANEL_FP_LIB_TABLE::verifyTables ( )

private

Trim important fields, removes blank row entries, and checks for duplicates.

Returns: bool - true if tables are OK, else false.

Definition at line 385 of file panel_fp_lib_table.cpp.

References get_grid(), grid, PANEL_FP_LIB_TABLE_BASE::m_notebook, and LIB_TABLE_GRID_TRICKS::VerifyTable().

Referenced by TransferDataFromWindow().

Member Data Documentation

◆ m_append_button

STD_BITMAP_BUTTON* PANEL_FP_LIB_TABLE_BASE::m_append_button

protectedinherited

Definition at line 44 of file panel_fp_lib_table_base.h.

Referenced by PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), PANEL_FP_LIB_TABLE_BASE(), and ~PANEL_FP_LIB_TABLE_BASE().

◆ m_browseButton

SPLIT_BUTTON* PANEL_FP_LIB_TABLE_BASE::m_browseButton

protectedinherited

Definition at line 45 of file panel_fp_lib_table_base.h.

Referenced by PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), PANEL_FP_LIB_TABLE_BASE(), and PANEL_FP_LIB_TABLE::~PANEL_FP_LIB_TABLE().

◆ m_delete_button

STD_BITMAP_BUTTON* PANEL_FP_LIB_TABLE_BASE::m_delete_button

protectedinherited

Definition at line 48 of file panel_fp_lib_table_base.h.

Referenced by PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), PANEL_FP_LIB_TABLE_BASE(), and ~PANEL_FP_LIB_TABLE_BASE().

◆ m_lastProjectLibDir

wxString PANEL_FP_LIB_TABLE::m_lastProjectLibDir

private

Definition at line 86 of file panel_fp_lib_table.h.

Referenced by AddTable(), browseLibrariesHandler(), and PANEL_FP_LIB_TABLE().

◆ m_migrate_libs_button

wxButton* PANEL_FP_LIB_TABLE_BASE::m_migrate_libs_button

protectedinherited

Definition at line 50 of file panel_fp_lib_table_base.h.

Referenced by PANEL_FP_LIB_TABLE_BASE(), and ~PANEL_FP_LIB_TABLE_BASE().

◆ m_move_down_button

STD_BITMAP_BUTTON* PANEL_FP_LIB_TABLE_BASE::m_move_down_button

protectedinherited

Definition at line 47 of file panel_fp_lib_table_base.h.

Referenced by PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), PANEL_FP_LIB_TABLE_BASE(), and ~PANEL_FP_LIB_TABLE_BASE().

◆ m_move_up_button

STD_BITMAP_BUTTON* PANEL_FP_LIB_TABLE_BASE::m_move_up_button

protectedinherited

Definition at line 46 of file panel_fp_lib_table_base.h.

Referenced by PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), PANEL_FP_LIB_TABLE_BASE(), and ~PANEL_FP_LIB_TABLE_BASE().

◆ m_notebook

wxAuiNotebook* PANEL_FP_LIB_TABLE_BASE::m_notebook

protectedinherited

Definition at line 43 of file panel_fp_lib_table_base.h.

◆ m_parent

DIALOG_EDIT_LIBRARY_TABLES* PANEL_FP_LIB_TABLE::m_parent

private

Definition at line 83 of file panel_fp_lib_table.h.

Referenced by AddTable(), browseLibrariesHandler(), onMigrateLibraries(), onReset(), PANEL_FP_LIB_TABLE(), TransferDataFromWindow(), and TransferDataToWindow().

◆ m_path_subs_grid

WX_GRID* PANEL_FP_LIB_TABLE_BASE::m_path_subs_grid

protectedinherited

Definition at line 51 of file panel_fp_lib_table_base.h.

Referenced by PANEL_FP_LIB_TABLE::adjustPathSubsGridColumns(), PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), PANEL_FP_LIB_TABLE_BASE(), PANEL_FP_LIB_TABLE::populateEnvironReadOnlyTable(), PANEL_FP_LIB_TABLE::~PANEL_FP_LIB_TABLE(), and ~PANEL_FP_LIB_TABLE_BASE().

◆ m_pluginChoices

wxArrayString PANEL_FP_LIB_TABLE::m_pluginChoices

private

Definition at line 84 of file panel_fp_lib_table.h.

Referenced by AddTable(), onReset(), and PANEL_FP_LIB_TABLE().

◆ m_project

PROJECT* PANEL_FP_LIB_TABLE::m_project

private

Definition at line 82 of file panel_fp_lib_table.h.

Referenced by AddTable(), browseLibrariesHandler(), onMigrateLibraries(), onReset(), and PANEL_FP_LIB_TABLE().

◆ m_resetGlobal

wxButton* PANEL_FP_LIB_TABLE_BASE::m_resetGlobal

protectedinherited

Definition at line 49 of file panel_fp_lib_table_base.h.

Referenced by PANEL_FP_LIB_TABLE::onPageChange(), PANEL_FP_LIB_TABLE_BASE(), and ~PANEL_FP_LIB_TABLE_BASE().

◆ m_supportedFpFiles

std::map<PCB_IO_MGR::PCB_FILE_T, IO_BASE::IO_FILE_DESC> PANEL_FP_LIB_TABLE::m_supportedFpFiles

private

Definition at line 89 of file panel_fp_lib_table.h.

Referenced by AddTable(), browseLibrariesHandler(), onReset(), PANEL_FP_LIB_TABLE(), populatePluginList(), and ~PANEL_FP_LIB_TABLE().

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

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PANEL_FP_LIB_TABLE()

◆ ~PANEL_FP_LIB_TABLE()

Member Function Documentation

◆ AddTable()

◆ adjustPathSubsGridColumns()

◆ appendRowHandler()

◆ browseLibrariesHandler()

◆ cur_grid()

◆ cur_model()

◆ deleteRowHandler()

◆ get_grid()

◆ get_model()

◆ moveDownHandler()

◆ moveUpHandler()

◆ onMigrateLibraries()

◆ onNotebookPageCloseRequest()

◆ onPageChange()

◆ onReset()

◆ onSizeGrid()

◆ populateEnvironReadOnlyTable()

◆ populatePluginList()

◆ TransferDataFromWindow()

◆ TransferDataToWindow()

◆ verifyTables()

Member Data Documentation

◆ m_append_button

◆ m_browseButton

◆ m_delete_button

◆ m_lastProjectLibDir

◆ m_migrate_libs_button

◆ m_move_down_button

◆ m_move_up_button

◆ m_notebook

◆ m_parent

◆ m_path_subs_grid

◆ m_pluginChoices

◆ m_project

◆ m_resetGlobal

◆ m_supportedFpFiles