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

#include <panel_sym_lib_table.h>

Inheritance diagram for PANEL_SYM_LIB_TABLE:

Public Member Functions
	PANEL_SYM_LIB_TABLE (DIALOG_EDIT_LIBRARY_TABLES aParent, PROJECT m_project)

virtual	~PANEL_SYM_LIB_TABLE ()

Protected Member Functions
virtual void	onPageChange (wxNotebookEvent &event)

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

STD_BITMAP_BUTTON *	m_browse_button

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_convertLegacy

WX_GRID *	m_path_subs_grid

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

void	OnUpdateUI (wxUpdateUIEvent &event) override

void	browseLibrariesHandler (wxCommandEvent &event) override

void	appendRowHandler (wxCommandEvent &event) override

void	deleteRowHandler (wxCommandEvent &event) override

void	moveUpHandler (wxCommandEvent &event) override

void	moveDownHandler (wxCommandEvent &event) override

void	onSizeGrid (wxSizeEvent &event) override

void	adjustPathSubsGridColumns (int aWidth)

void	onConvertLegacyLibraries (wxCommandEvent &event) override

void	onPageChange (wxBookCtrlEvent &event) override

void	onReset (wxCommandEvent &event) override

void	setupGrid (WX_GRID *aGrid)

bool	TransferDataFromWindow () override

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

SYMBOL_LIB_TABLE_GRID *	global_model () const

SYMBOL_LIB_TABLE_GRID *	project_model () const

SYMBOL_LIB_TABLE_GRID *	cur_model () const

bool	allowAutomaticPluginTypeSelection (wxString &aLibraryPath)

Private Attributes
PROJECT *	m_project

DIALOG_EDIT_LIBRARY_TABLES *	m_parent

wxArrayString	m_pluginChoices

WX_GRID *	m_cur_grid
	changed based on tab choice

wxString	m_lastProjectLibDir
	Transient (unsaved) last browsed folder when adding a project level library.

Static Private Attributes
static size_t	m_pageNdx = 0
	Remember the last notebook page selected.

Detailed Description

Dialog to show and edit symbol library tables.

Definition at line 34 of file panel_sym_lib_table.h.

Constructor & Destructor Documentation

◆ PANEL_SYM_LIB_TABLE()

PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE	(	DIALOG_EDIT_LIBRARY_TABLES *	aParent,
		PROJECT *	m_project )

Definition at line 410 of file panel_sym_lib_table.cpp.

◆ ~PANEL_SYM_LIB_TABLE()

PANEL_SYM_LIB_TABLE::~PANEL_SYM_LIB_TABLE ( )

virtual

Definition at line 489 of file panel_sym_lib_table.cpp.

References PANEL_SYM_LIB_TABLE_BASE::m_global_grid, PANEL_SYM_LIB_TABLE_BASE::m_path_subs_grid, and PANEL_SYM_LIB_TABLE_BASE::m_project_grid.

Member Function Documentation

◆ adjustPathSubsGridColumns()

void PANEL_SYM_LIB_TABLE::adjustPathSubsGridColumns ( int aWidth )

private

Definition at line 1156 of file panel_sym_lib_table.cpp.

References PANEL_SYM_LIB_TABLE_BASE::m_path_subs_grid.

Referenced by onSizeGrid(), and populateEnvironReadOnlyTable().

◆ allowAutomaticPluginTypeSelection()

bool PANEL_SYM_LIB_TABLE::allowAutomaticPluginTypeSelection ( wxString & aLibraryPath )

private

Returns: true if the plugin type can be selected from the library path only (i.e. only from its extension) if the type needs an access to the file itself, return false because the file can be not (at least temporary) available

Definition at line 502 of file panel_sym_lib_table.cpp.

References FILEEXT::LegacySymbolLibFileExtension.

Referenced by verifyTables().

◆ appendRowHandler()

void PANEL_SYM_LIB_TABLE::appendRowHandler ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PANEL_SYM_LIB_TABLE_BASE.

Definition at line 770 of file panel_sym_lib_table.cpp.

References COL_NICKNAME, and m_cur_grid.

◆ browseLibrariesHandler()

void PANEL_SYM_LIB_TABLE::browseLibrariesHandler ( wxCommandEvent & event )

overrideprivatevirtual

◆ cur_model()

SYMBOL_LIB_TABLE_GRID * PANEL_SYM_LIB_TABLE::cur_model ( ) const

private

Definition at line 1187 of file panel_sym_lib_table.cpp.

References m_cur_grid.

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

◆ deleteRowHandler()

void PANEL_SYM_LIB_TABLE::deleteRowHandler ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PANEL_SYM_LIB_TABLE_BASE.

Definition at line 781 of file panel_sym_lib_table.cpp.

References m_cur_grid.

◆ global_model()

SYMBOL_LIB_TABLE_GRID * PANEL_SYM_LIB_TABLE::global_model ( ) const

private

Definition at line 1175 of file panel_sym_lib_table.cpp.

References PANEL_SYM_LIB_TABLE_BASE::m_global_grid.

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

◆ moveDownHandler()

void PANEL_SYM_LIB_TABLE::moveDownHandler ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PANEL_SYM_LIB_TABLE_BASE.

Definition at line 869 of file panel_sym_lib_table.cpp.

References cur_model(), m_cur_grid, next(), LIBRARY_TABLE::Rows(), and LIB_TABLE_GRID::Table().

◆ moveUpHandler()

void PANEL_SYM_LIB_TABLE::moveUpHandler ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PANEL_SYM_LIB_TABLE_BASE.

Definition at line 847 of file panel_sym_lib_table.cpp.

References cur_model(), m_cur_grid, LIBRARY_TABLE::Rows(), and LIB_TABLE_GRID::Table().

◆ onConvertLegacyLibraries()

void PANEL_SYM_LIB_TABLE::onConvertLegacyLibraries ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PANEL_SYM_LIB_TABLE_BASE.

Definition at line 949 of file panel_sym_lib_table.cpp.

References _, COL_NICKNAME, COL_OPTIONS, COL_TYPE, COL_URI, SCH_IO_MGR::ConvertLibrary(), DisplayErrorMessage(), ExpandEnvVarSubstitutions(), IsOK(), m_cur_grid, PANEL_SYM_LIB_TABLE_BASE::m_global_grid, m_parent, m_project, NormalizePath(), LIB_TABLE::ParseOptions(), Pgm(), and SCH_IO_MGR::ShowType().

◆ onPageChange() [1/2]

void PANEL_SYM_LIB_TABLE::onPageChange ( wxBookCtrlEvent & event )

overrideprivate

Definition at line 932 of file panel_sym_lib_table.cpp.

References m_cur_grid, PANEL_SYM_LIB_TABLE_BASE::m_global_grid, PANEL_SYM_LIB_TABLE_BASE::m_notebook, m_pageNdx, PANEL_SYM_LIB_TABLE_BASE::m_project_grid, and PANEL_SYM_LIB_TABLE_BASE::m_resetGlobal.

◆ onPageChange() [2/2]

virtual void PANEL_SYM_LIB_TABLE_BASE::onPageChange ( wxNotebookEvent & event )

inlineprotectedvirtualinherited

Definition at line 58 of file panel_sym_lib_table_base.h.

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

◆ onReset()

void PANEL_SYM_LIB_TABLE::onReset ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PANEL_SYM_LIB_TABLE_BASE.

Definition at line 890 of file panel_sym_lib_table.cpp.

References _, LIBRARY_MANAGER::CreateGlobalTable(), KIWAY::FACE_SCH, PGM_BASE::GetLibraryManager(), GLOBAL, IsOK(), LIBRARY_MANAGER::LoadGlobalTables(), m_cur_grid, PANEL_SYM_LIB_TABLE_BASE::m_global_grid, m_parent, Pgm(), setupGrid(), SYMBOL, PROJECT_SCH::SymbolLibAdapter(), LIBRARY_MANAGER::Table(), and table.

◆ onSizeGrid()

void PANEL_SYM_LIB_TABLE::onSizeGrid ( wxSizeEvent & event )

overrideprivatevirtual

Reimplemented from PANEL_SYM_LIB_TABLE_BASE.

Definition at line 1167 of file panel_sym_lib_table.cpp.

References adjustPathSubsGridColumns().

◆ OnUpdateUI()

void PANEL_SYM_LIB_TABLE::OnUpdateUI ( wxUpdateUIEvent & event )

overrideprivatevirtual

Reimplemented from PANEL_SYM_LIB_TABLE_BASE.

Definition at line 653 of file panel_sym_lib_table.cpp.

◆ populateEnvironReadOnlyTable()

void PANEL_SYM_LIB_TABLE::populateEnvironReadOnlyTable ( )

private

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

Definition at line 1096 of file panel_sym_lib_table.cpp.

References adjustPathSubsGridColumns(), COL_URI, ENV_VAR::GetVersionedEnvVarName(), global_model(), PANEL_SYM_LIB_TABLE_BASE::m_path_subs_grid, project_model(), and PROJECT_VAR_NAME.

Referenced by PANEL_SYM_LIB_TABLE().

◆ project_model()

SYMBOL_LIB_TABLE_GRID * PANEL_SYM_LIB_TABLE::project_model ( ) const

private

Definition at line 1181 of file panel_sym_lib_table.cpp.

References PANEL_SYM_LIB_TABLE_BASE::m_project_grid.

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

◆ setupGrid()

void PANEL_SYM_LIB_TABLE::setupGrid ( WX_GRID * aGrid )

private

Definition at line 282 of file panel_sym_lib_table.cpp.

References _, COL_STATUS, config, GetAppSettings(), grid, LIBRARY_TABLE_ROW::IsOk(), KiBitmapBundle(), SYMBOL_LIBRARY_ADAPTER::LibraryError(), m_parent, m_project, small_warning, SYMBOL_LIBRARY_ADAPTER::SupportsConfigurationDialog(), PROJECT_SCH::SymbolLibAdapter(), and LIBRARY_TABLE_ROW::TABLE_TYPE_NAME.

Referenced by onReset(), and PANEL_SYM_LIB_TABLE().

◆ TransferDataFromWindow()

bool PANEL_SYM_LIB_TABLE::TransferDataFromWindow ( )

overrideprivate

Definition at line 1059 of file panel_sym_lib_table.cpp.

References PGM_BASE::GetLibraryManager(), GLOBAL, global_model(), m_cur_grid, m_parent, Pgm(), PROJECT, project_model(), SYMBOL, LIB_TABLE_GRID::Table(), LIBRARY_MANAGER::Table(), and verifyTables().

◆ verifyTables()

bool PANEL_SYM_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 519 of file panel_sym_lib_table.cpp.

References _, allowAutomaticPluginTypeSelection(), COL_NICKNAME, COL_TYPE, COL_URI, cur_model(), LIB_ID::FindIllegalLibraryNameChar(), global_model(), m_cur_grid, PANEL_SYM_LIB_TABLE_BASE::m_notebook, and project_model().

Referenced by TransferDataFromWindow().

Member Data Documentation

◆ m_append_button

STD_BITMAP_BUTTON* PANEL_SYM_LIB_TABLE_BASE::m_append_button

protectedinherited

Definition at line 47 of file panel_sym_lib_table_base.h.

Referenced by PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), PANEL_SYM_LIB_TABLE_BASE(), and ~PANEL_SYM_LIB_TABLE_BASE().

◆ m_browse_button

STD_BITMAP_BUTTON* PANEL_SYM_LIB_TABLE_BASE::m_browse_button

protectedinherited

Definition at line 48 of file panel_sym_lib_table_base.h.

Referenced by PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), PANEL_SYM_LIB_TABLE_BASE(), and ~PANEL_SYM_LIB_TABLE_BASE().

◆ m_convertLegacy

wxButton* PANEL_SYM_LIB_TABLE_BASE::m_convertLegacy

protectedinherited

Definition at line 53 of file panel_sym_lib_table_base.h.

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

◆ m_cur_grid

WX_GRID* PANEL_SYM_LIB_TABLE::m_cur_grid

private

changed based on tab choice

Definition at line 89 of file panel_sym_lib_table.h.

Referenced by appendRowHandler(), browseLibrariesHandler(), cur_model(), deleteRowHandler(), moveDownHandler(), moveUpHandler(), onConvertLegacyLibraries(), onPageChange(), onReset(), PANEL_SYM_LIB_TABLE(), TransferDataFromWindow(), and verifyTables().

◆ m_delete_button

STD_BITMAP_BUTTON* PANEL_SYM_LIB_TABLE_BASE::m_delete_button

protectedinherited

Definition at line 51 of file panel_sym_lib_table_base.h.

Referenced by PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), PANEL_SYM_LIB_TABLE_BASE(), and ~PANEL_SYM_LIB_TABLE_BASE().

◆ m_global_grid

WX_GRID* PANEL_SYM_LIB_TABLE_BASE::m_global_grid

protectedinherited

Definition at line 44 of file panel_sym_lib_table_base.h.

Referenced by PANEL_SYM_LIB_TABLE::global_model(), PANEL_SYM_LIB_TABLE::onConvertLegacyLibraries(), PANEL_SYM_LIB_TABLE::onPageChange(), PANEL_SYM_LIB_TABLE::onReset(), PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), PANEL_SYM_LIB_TABLE_BASE(), and PANEL_SYM_LIB_TABLE::~PANEL_SYM_LIB_TABLE().

◆ m_global_panel

wxPanel* PANEL_SYM_LIB_TABLE_BASE::m_global_panel

protectedinherited

Definition at line 43 of file panel_sym_lib_table_base.h.

Referenced by PANEL_SYM_LIB_TABLE_BASE().

◆ m_lastProjectLibDir

wxString PANEL_SYM_LIB_TABLE::m_lastProjectLibDir

private

Transient (unsaved) last browsed folder when adding a project level library.

Definition at line 93 of file panel_sym_lib_table.h.

Referenced by browseLibrariesHandler(), and PANEL_SYM_LIB_TABLE().

◆ m_move_down_button

STD_BITMAP_BUTTON* PANEL_SYM_LIB_TABLE_BASE::m_move_down_button

protectedinherited

Definition at line 50 of file panel_sym_lib_table_base.h.

Referenced by PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), PANEL_SYM_LIB_TABLE_BASE(), and ~PANEL_SYM_LIB_TABLE_BASE().

◆ m_move_up_button

STD_BITMAP_BUTTON* PANEL_SYM_LIB_TABLE_BASE::m_move_up_button

protectedinherited

Definition at line 49 of file panel_sym_lib_table_base.h.

Referenced by PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), PANEL_SYM_LIB_TABLE_BASE(), and ~PANEL_SYM_LIB_TABLE_BASE().

◆ m_notebook

wxNotebook* PANEL_SYM_LIB_TABLE_BASE::m_notebook

protectedinherited

Definition at line 42 of file panel_sym_lib_table_base.h.

Referenced by PANEL_SYM_LIB_TABLE::onPageChange(), PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), PANEL_SYM_LIB_TABLE_BASE(), PANEL_SYM_LIB_TABLE::verifyTables(), and ~PANEL_SYM_LIB_TABLE_BASE().

◆ m_pageNdx

size_t PANEL_SYM_LIB_TABLE::m_pageNdx = 0

staticprivate

Remember the last notebook page selected.

Definition at line 90 of file panel_sym_lib_table.h.

Referenced by browseLibrariesHandler(), onPageChange(), and PANEL_SYM_LIB_TABLE().

◆ m_parent

DIALOG_EDIT_LIBRARY_TABLES* PANEL_SYM_LIB_TABLE::m_parent

private

Definition at line 86 of file panel_sym_lib_table.h.

Referenced by onConvertLegacyLibraries(), onReset(), PANEL_SYM_LIB_TABLE(), setupGrid(), and TransferDataFromWindow().

◆ m_path_subs_grid

WX_GRID* PANEL_SYM_LIB_TABLE_BASE::m_path_subs_grid

protectedinherited

Definition at line 54 of file panel_sym_lib_table_base.h.

Referenced by PANEL_SYM_LIB_TABLE::adjustPathSubsGridColumns(), PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), PANEL_SYM_LIB_TABLE_BASE(), PANEL_SYM_LIB_TABLE::populateEnvironReadOnlyTable(), PANEL_SYM_LIB_TABLE::~PANEL_SYM_LIB_TABLE(), and ~PANEL_SYM_LIB_TABLE_BASE().

◆ m_pluginChoices

wxArrayString PANEL_SYM_LIB_TABLE::m_pluginChoices

private

Definition at line 87 of file panel_sym_lib_table.h.

Referenced by PANEL_SYM_LIB_TABLE().

◆ m_project

PROJECT* PANEL_SYM_LIB_TABLE::m_project

private

Definition at line 84 of file panel_sym_lib_table.h.

Referenced by browseLibrariesHandler(), onConvertLegacyLibraries(), PANEL_SYM_LIB_TABLE(), and setupGrid().

◆ m_project_grid

WX_GRID* PANEL_SYM_LIB_TABLE_BASE::m_project_grid

protectedinherited

Definition at line 46 of file panel_sym_lib_table_base.h.

Referenced by PANEL_SYM_LIB_TABLE::browseLibrariesHandler(), PANEL_SYM_LIB_TABLE::onPageChange(), PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), PANEL_SYM_LIB_TABLE_BASE(), PANEL_SYM_LIB_TABLE::project_model(), and PANEL_SYM_LIB_TABLE::~PANEL_SYM_LIB_TABLE().

◆ m_project_panel

wxPanel* PANEL_SYM_LIB_TABLE_BASE::m_project_panel

protectedinherited

Definition at line 45 of file panel_sym_lib_table_base.h.

Referenced by PANEL_SYM_LIB_TABLE_BASE().

◆ m_resetGlobal

wxButton* PANEL_SYM_LIB_TABLE_BASE::m_resetGlobal

protectedinherited

Definition at line 52 of file panel_sym_lib_table_base.h.

Referenced by PANEL_SYM_LIB_TABLE::onPageChange(), PANEL_SYM_LIB_TABLE_BASE(), and ~PANEL_SYM_LIB_TABLE_BASE().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PANEL_SYM_LIB_TABLE()

◆ ~PANEL_SYM_LIB_TABLE()

Member Function Documentation

◆ adjustPathSubsGridColumns()

◆ allowAutomaticPluginTypeSelection()

◆ appendRowHandler()

◆ browseLibrariesHandler()

◆ cur_model()

◆ deleteRowHandler()

◆ global_model()

◆ moveDownHandler()

◆ moveUpHandler()

◆ onConvertLegacyLibraries()

◆ onPageChange() [1/2]

◆ onPageChange() [2/2]

◆ onReset()

◆ onSizeGrid()

◆ OnUpdateUI()

◆ populateEnvironReadOnlyTable()

◆ project_model()

◆ setupGrid()

◆ TransferDataFromWindow()

◆ verifyTables()

Member Data Documentation

◆ m_append_button

◆ m_browse_button

◆ m_convertLegacy

◆ m_cur_grid

◆ m_delete_button

◆ m_global_grid

◆ m_global_panel

◆ m_lastProjectLibDir

◆ m_move_down_button

◆ m_move_up_button

◆ m_notebook

◆ m_pageNdx

◆ m_parent

◆ m_path_subs_grid

◆ m_pluginChoices

◆ m_project

◆ m_project_grid

◆ m_project_panel

◆ m_resetGlobal