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

#include <panel_design_block_lib_table.h>

Inheritance diagram for PANEL_DESIGN_BLOCK_LIB_TABLE:

Public Member Functions
	PANEL_DESIGN_BLOCK_LIB_TABLE (DIALOG_EDIT_LIBRARY_TABLES aParent, PROJECT aProject, DESIGN_BLOCK_LIB_TABLE aGlobalTable, const wxString &aGlobalTblPath, DESIGN_BLOCK_LIB_TABLE aProjectTable, const wxString &aProjectTblPath, const wxString &aProjectBasePath)

	~PANEL_DESIGN_BLOCK_LIB_TABLE () override

Protected Attributes
wxNotebook *	m_notebook

wxPanel *	m_global_panel

WX_GRID *	m_global_grid

wxPanel *	m_project_panel

WX_GRID *	m_project_grid

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_migrate_libs_button

WX_GRID *	m_path_subs_grid

Private Member Functions
bool	TransferDataFromWindow () override

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

void	OnUpdateUI (wxUpdateUIEvent &event) override

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	adjustPathSubsGridColumns (int aWidth)

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

void	populatePluginList ()

DESIGN_BLOCK_LIB_TABLE_GRID *	global_model () const

DESIGN_BLOCK_LIB_TABLE_GRID *	project_model () const

DESIGN_BLOCK_LIB_TABLE_GRID *	cur_model () const

Private Attributes
DESIGN_BLOCK_LIB_TABLE *	m_globalTable

DESIGN_BLOCK_LIB_TABLE *	m_projectTable

PROJECT *	m_project

wxString	m_projectBasePath

DIALOG_EDIT_LIBRARY_TABLES *	m_parent

WX_GRID *	m_cur_grid

wxString	m_lastProjectLibDir

std::map< DESIGN_BLOCK_IO_MGR::DESIGN_BLOCK_FILE_T, IO_BASE::IO_FILE_DESC >	m_supportedDesignBlockFiles

Static Private Attributes
static size_t	m_pageNdx = 0

Detailed Description

Dialog to show and edit symbol library tables.

Definition at line 36 of file panel_design_block_lib_table.h.

Constructor & Destructor Documentation

◆ PANEL_DESIGN_BLOCK_LIB_TABLE()

PANEL_DESIGN_BLOCK_LIB_TABLE::PANEL_DESIGN_BLOCK_LIB_TABLE	(	DIALOG_EDIT_LIBRARY_TABLES *	aParent,
		PROJECT *	aProject,
		DESIGN_BLOCK_LIB_TABLE *	aGlobalTable,
		const wxString &	aGlobalTblPath,
		DESIGN_BLOCK_LIB_TABLE *	aProjectTable,
		const wxString &	aProjectTblPath,
		const wxString &	aProjectBasePath
	)

Definition at line 293 of file panel_design_block_lib_table.cpp.

◆ ~PANEL_DESIGN_BLOCK_LIB_TABLE()

PANEL_DESIGN_BLOCK_LIB_TABLE::~PANEL_DESIGN_BLOCK_LIB_TABLE ( )

override

Definition at line 478 of file panel_design_block_lib_table.cpp.

References browseLibrariesHandler(), SPLIT_BUTTON::GetSplitButtonMenu(), PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_browseButton, PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_global_grid, PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_path_subs_grid, PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_project_grid, and m_supportedDesignBlockFiles.

Member Function Documentation

◆ adjustPathSubsGridColumns()

void PANEL_DESIGN_BLOCK_LIB_TABLE::adjustPathSubsGridColumns ( int aWidth )

private

Definition at line 1039 of file panel_design_block_lib_table.cpp.

References PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_path_subs_grid.

Referenced by onSizeGrid(), and populateEnvironReadOnlyTable().

◆ appendRowHandler()

void PANEL_DESIGN_BLOCK_LIB_TABLE::appendRowHandler ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PANEL_DESIGN_BLOCK_LIB_TABLE_BASE.

Definition at line 640 of file panel_design_block_lib_table.cpp.

References COL_ENABLED, COL_NICKNAME, WX_GRID::CommitPendingChanges(), and m_cur_grid.

◆ browseLibrariesHandler()

void PANEL_DESIGN_BLOCK_LIB_TABLE::browseLibrariesHandler ( wxCommandEvent & event )

private

Definition at line 892 of file panel_design_block_lib_table.cpp.

References _, COL_NICKNAME, COL_TYPE, COL_URI, WX_GRID::CommitPendingChanges(), cur_model(), DESIGN_BLOCK_IO_MGR::FILE_TYPE_NONE, IO_BASE::IO_FILE_DESC::FileFilter(), fileType(), LIB_ID::FixIllegalChars(), SETTINGS_MANAGER::GetAppSettings(), PGM_BASE::GetLocalEnvVariables(), PGM_BASE::GetSettingsManager(), DESIGN_BLOCK_IO_MGR::KICAD_SEXP, FILEEXT::KiCadDesignBlockLibPathExtension, m_cur_grid, PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_global_grid, IO_BASE::IO_FILE_DESC::m_IsFile, KICAD_SETTINGS::m_lastDesignBlockLibDir, m_lastProjectLibDir, m_pageNdx, PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_project_grid, m_projectBasePath, m_supportedDesignBlockFiles, NormalizePath(), OKOrCancelDialog(), path, Pgm(), DESIGN_BLOCK_IO_MGR::ShowType(), and UTF8::wx_str().

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

◆ cur_model()

DESIGN_BLOCK_LIB_TABLE_GRID * PANEL_DESIGN_BLOCK_LIB_TABLE::cur_model ( ) const

inlineprivate

Definition at line 83 of file panel_design_block_lib_table.h.

References m_cur_grid.

Referenced by browseLibrariesHandler(), moveDownHandler(), moveUpHandler(), and verifyTables().

◆ deleteRowHandler()

void PANEL_DESIGN_BLOCK_LIB_TABLE::deleteRowHandler ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PANEL_DESIGN_BLOCK_LIB_TABLE_BASE.

Definition at line 658 of file panel_design_block_lib_table.cpp.

References WX_GRID::CommitPendingChanges(), and m_cur_grid.

◆ global_model()

DESIGN_BLOCK_LIB_TABLE_GRID * PANEL_DESIGN_BLOCK_LIB_TABLE::global_model ( ) const

inlineprivate

Definition at line 73 of file panel_design_block_lib_table.h.

References PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_global_grid.

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

◆ moveDownHandler()

void PANEL_DESIGN_BLOCK_LIB_TABLE::moveDownHandler ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PANEL_DESIGN_BLOCK_LIB_TABLE_BASE.

Definition at line 754 of file panel_design_block_lib_table.cpp.

References WX_GRID::CommitPendingChanges(), cur_model(), m_cur_grid, and LIB_TABLE::m_rows.

◆ moveUpHandler()

void PANEL_DESIGN_BLOCK_LIB_TABLE::moveUpHandler ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PANEL_DESIGN_BLOCK_LIB_TABLE_BASE.

Definition at line 724 of file panel_design_block_lib_table.cpp.

References WX_GRID::CommitPendingChanges(), cur_model(), m_cur_grid, and LIB_TABLE::m_rows.

◆ onMigrateLibraries()

void PANEL_DESIGN_BLOCK_LIB_TABLE::onMigrateLibraries ( wxCommandEvent & event )

overrideprivatevirtual

◆ onSizeGrid()

void PANEL_DESIGN_BLOCK_LIB_TABLE::onSizeGrid ( wxSizeEvent & event )

overrideprivatevirtual

Reimplemented from PANEL_DESIGN_BLOCK_LIB_TABLE_BASE.

Definition at line 1050 of file panel_design_block_lib_table.cpp.

References adjustPathSubsGridColumns().

◆ OnUpdateUI()

void PANEL_DESIGN_BLOCK_LIB_TABLE::OnUpdateUI ( wxUpdateUIEvent & event )

overrideprivatevirtual

Reimplemented from PANEL_DESIGN_BLOCK_LIB_TABLE_BASE.

Definition at line 633 of file panel_design_block_lib_table.cpp.

References m_cur_grid, PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_global_grid, PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_notebook, m_pageNdx, and PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_project_grid.

◆ populateEnvironReadOnlyTable()

void PANEL_DESIGN_BLOCK_LIB_TABLE::populateEnvironReadOnlyTable ( )

private

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

Definition at line 1088 of file panel_design_block_lib_table.cpp.

References adjustPathSubsGridColumns(), WX_GRID::ClearRows(), COL_URI, ENV_VAR::GetVersionedEnvVarName(), global_model(), DESIGN_BLOCK_LIB_TABLE::GlobalPathEnvVariableName(), PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_path_subs_grid, project_model(), and PROJECT_VAR_NAME.

Referenced by PANEL_DESIGN_BLOCK_LIB_TABLE().

◆ populatePluginList()

void PANEL_DESIGN_BLOCK_LIB_TABLE::populatePluginList ( )

private

Definition at line 500 of file panel_design_block_lib_table.cpp.

References DESIGN_BLOCK_IO_MGR::FindPlugin(), DESIGN_BLOCK_IO_MGR::KICAD_SEXP, and m_supportedDesignBlockFiles.

Referenced by PANEL_DESIGN_BLOCK_LIB_TABLE().

◆ project_model()

DESIGN_BLOCK_LIB_TABLE_GRID * PANEL_DESIGN_BLOCK_LIB_TABLE::project_model ( ) const

inlineprivate

Definition at line 78 of file panel_design_block_lib_table.h.

References PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_project_grid.

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

◆ TransferDataFromWindow()

bool PANEL_DESIGN_BLOCK_LIB_TABLE::TransferDataFromWindow ( )

overrideprivate

Definition at line 1058 of file panel_design_block_lib_table.cpp.

References WX_GRID::CommitPendingChanges(), global_model(), m_cur_grid, m_globalTable, DIALOG_EDIT_LIBRARY_TABLES::m_GlobalTableChanged, m_parent, m_projectTable, DIALOG_EDIT_LIBRARY_TABLES::m_ProjectTableChanged, project_model(), LIB_TABLE::TransferRows(), and verifyTables().

◆ verifyTables()

bool PANEL_DESIGN_BLOCK_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 516 of file panel_design_block_lib_table.cpp.

References _, COL_NICKNAME, COL_URI, COL_VISIBLE, cur_model(), LIB_ID::FindIllegalLibraryNameChar(), global_model(), m_cur_grid, PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_notebook, and project_model().

Referenced by TransferDataFromWindow().

Member Data Documentation

◆ m_append_button

STD_BITMAP_BUTTON* PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_append_button

protectedinherited

Definition at line 49 of file panel_design_block_lib_table_base.h.

Referenced by PANEL_DESIGN_BLOCK_LIB_TABLE(), PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::PANEL_DESIGN_BLOCK_LIB_TABLE_BASE(), and PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::~PANEL_DESIGN_BLOCK_LIB_TABLE_BASE().

◆ m_browseButton

SPLIT_BUTTON* PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_browseButton

protectedinherited

Definition at line 50 of file panel_design_block_lib_table_base.h.

Referenced by PANEL_DESIGN_BLOCK_LIB_TABLE(), PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::PANEL_DESIGN_BLOCK_LIB_TABLE_BASE(), and ~PANEL_DESIGN_BLOCK_LIB_TABLE().

◆ m_cur_grid

WX_GRID* PANEL_DESIGN_BLOCK_LIB_TABLE::m_cur_grid

private

Definition at line 96 of file panel_design_block_lib_table.h.

Referenced by appendRowHandler(), browseLibrariesHandler(), cur_model(), deleteRowHandler(), moveDownHandler(), moveUpHandler(), onMigrateLibraries(), OnUpdateUI(), PANEL_DESIGN_BLOCK_LIB_TABLE(), TransferDataFromWindow(), and verifyTables().

◆ m_delete_button

STD_BITMAP_BUTTON* PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_delete_button

protectedinherited

Definition at line 53 of file panel_design_block_lib_table_base.h.

Referenced by PANEL_DESIGN_BLOCK_LIB_TABLE(), PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::PANEL_DESIGN_BLOCK_LIB_TABLE_BASE(), and PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::~PANEL_DESIGN_BLOCK_LIB_TABLE_BASE().

◆ m_global_grid

WX_GRID* PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_global_grid

protectedinherited

Definition at line 46 of file panel_design_block_lib_table_base.h.

Referenced by browseLibrariesHandler(), global_model(), onMigrateLibraries(), OnUpdateUI(), PANEL_DESIGN_BLOCK_LIB_TABLE(), PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::PANEL_DESIGN_BLOCK_LIB_TABLE_BASE(), and ~PANEL_DESIGN_BLOCK_LIB_TABLE().

◆ m_global_panel

wxPanel* PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_global_panel

protectedinherited

Definition at line 45 of file panel_design_block_lib_table_base.h.

Referenced by PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::PANEL_DESIGN_BLOCK_LIB_TABLE_BASE().

◆ m_globalTable

DESIGN_BLOCK_LIB_TABLE* PANEL_DESIGN_BLOCK_LIB_TABLE::m_globalTable

private

Definition at line 89 of file panel_design_block_lib_table.h.

Referenced by TransferDataFromWindow().

◆ m_lastProjectLibDir

wxString PANEL_DESIGN_BLOCK_LIB_TABLE::m_lastProjectLibDir

private

Definition at line 100 of file panel_design_block_lib_table.h.

Referenced by browseLibrariesHandler(), and PANEL_DESIGN_BLOCK_LIB_TABLE().

◆ m_migrate_libs_button

wxButton* PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_migrate_libs_button

protectedinherited

Definition at line 54 of file panel_design_block_lib_table_base.h.

Referenced by PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::PANEL_DESIGN_BLOCK_LIB_TABLE_BASE(), and PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::~PANEL_DESIGN_BLOCK_LIB_TABLE_BASE().

◆ m_move_down_button

STD_BITMAP_BUTTON* PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_move_down_button

protectedinherited

Definition at line 52 of file panel_design_block_lib_table_base.h.

Referenced by PANEL_DESIGN_BLOCK_LIB_TABLE(), PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::PANEL_DESIGN_BLOCK_LIB_TABLE_BASE(), and PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::~PANEL_DESIGN_BLOCK_LIB_TABLE_BASE().

◆ m_move_up_button

STD_BITMAP_BUTTON* PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_move_up_button

protectedinherited

Definition at line 51 of file panel_design_block_lib_table_base.h.

Referenced by PANEL_DESIGN_BLOCK_LIB_TABLE(), PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::PANEL_DESIGN_BLOCK_LIB_TABLE_BASE(), and PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::~PANEL_DESIGN_BLOCK_LIB_TABLE_BASE().

◆ m_notebook

wxNotebook* PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_notebook

protectedinherited

Definition at line 44 of file panel_design_block_lib_table_base.h.

Referenced by OnUpdateUI(), PANEL_DESIGN_BLOCK_LIB_TABLE(), PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::PANEL_DESIGN_BLOCK_LIB_TABLE_BASE(), and verifyTables().

◆ m_pageNdx

size_t PANEL_DESIGN_BLOCK_LIB_TABLE::m_pageNdx = 0

staticprivate

Definition at line 97 of file panel_design_block_lib_table.h.

Referenced by browseLibrariesHandler(), OnUpdateUI(), and PANEL_DESIGN_BLOCK_LIB_TABLE().

◆ m_parent

DIALOG_EDIT_LIBRARY_TABLES* PANEL_DESIGN_BLOCK_LIB_TABLE::m_parent

private

Definition at line 94 of file panel_design_block_lib_table.h.

Referenced by onMigrateLibraries(), PANEL_DESIGN_BLOCK_LIB_TABLE(), and TransferDataFromWindow().

◆ m_path_subs_grid

WX_GRID* PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_path_subs_grid

protectedinherited

Definition at line 55 of file panel_design_block_lib_table_base.h.

Referenced by adjustPathSubsGridColumns(), PANEL_DESIGN_BLOCK_LIB_TABLE(), PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::PANEL_DESIGN_BLOCK_LIB_TABLE_BASE(), populateEnvironReadOnlyTable(), ~PANEL_DESIGN_BLOCK_LIB_TABLE(), and PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::~PANEL_DESIGN_BLOCK_LIB_TABLE_BASE().

◆ m_project

PROJECT* PANEL_DESIGN_BLOCK_LIB_TABLE::m_project

private

Definition at line 91 of file panel_design_block_lib_table.h.

Referenced by onMigrateLibraries().

◆ m_project_grid

WX_GRID* PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_project_grid

protectedinherited

Definition at line 48 of file panel_design_block_lib_table_base.h.

Referenced by browseLibrariesHandler(), OnUpdateUI(), PANEL_DESIGN_BLOCK_LIB_TABLE(), PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::PANEL_DESIGN_BLOCK_LIB_TABLE_BASE(), project_model(), and ~PANEL_DESIGN_BLOCK_LIB_TABLE().

◆ m_project_panel

wxPanel* PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_project_panel

protectedinherited

Definition at line 47 of file panel_design_block_lib_table_base.h.

Referenced by PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::PANEL_DESIGN_BLOCK_LIB_TABLE_BASE().

◆ m_projectBasePath

wxString PANEL_DESIGN_BLOCK_LIB_TABLE::m_projectBasePath

private

Definition at line 92 of file panel_design_block_lib_table.h.

Referenced by browseLibrariesHandler(), and PANEL_DESIGN_BLOCK_LIB_TABLE().

◆ m_projectTable

DESIGN_BLOCK_LIB_TABLE* PANEL_DESIGN_BLOCK_LIB_TABLE::m_projectTable

private

Definition at line 90 of file panel_design_block_lib_table.h.

Referenced by TransferDataFromWindow().

◆ m_supportedDesignBlockFiles

std::map<DESIGN_BLOCK_IO_MGR::DESIGN_BLOCK_FILE_T, IO_BASE::IO_FILE_DESC> PANEL_DESIGN_BLOCK_LIB_TABLE::m_supportedDesignBlockFiles

private

Definition at line 103 of file panel_design_block_lib_table.h.

Referenced by browseLibrariesHandler(), PANEL_DESIGN_BLOCK_LIB_TABLE(), populatePluginList(), and ~PANEL_DESIGN_BLOCK_LIB_TABLE().

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

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PANEL_DESIGN_BLOCK_LIB_TABLE()

◆ ~PANEL_DESIGN_BLOCK_LIB_TABLE()

Member Function Documentation

◆ adjustPathSubsGridColumns()

◆ appendRowHandler()

◆ browseLibrariesHandler()

◆ cur_model()

◆ deleteRowHandler()

◆ global_model()

◆ moveDownHandler()

◆ moveUpHandler()

◆ onMigrateLibraries()

◆ onSizeGrid()

◆ OnUpdateUI()

◆ populateEnvironReadOnlyTable()

◆ populatePluginList()

◆ project_model()

◆ TransferDataFromWindow()

◆ verifyTables()

Member Data Documentation

◆ m_append_button

◆ m_browseButton

◆ m_cur_grid

◆ m_delete_button

◆ m_global_grid

◆ m_global_panel

◆ m_globalTable

◆ m_lastProjectLibDir

◆ m_migrate_libs_button

◆ m_move_down_button

◆ m_move_up_button

◆ m_notebook

◆ m_pageNdx

◆ m_parent

◆ m_path_subs_grid

◆ m_project

◆ m_project_grid

◆ m_project_panel

◆ m_projectBasePath

◆ m_projectTable

◆ m_supportedDesignBlockFiles