KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
PANEL_SYM_LIB_TABLE Class Reference

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

#include <panel_sym_lib_table.h>

Inheritance diagram for PANEL_SYM_LIB_TABLE:
PANEL_SYM_LIB_TABLE_BASE

Public Member Functions

 PANEL_SYM_LIB_TABLE (DIALOG_EDIT_LIBRARY_TABLES *aParent, PROJECT *m_project, SYMBOL_LIB_TABLE *aGlobal, const wxString &aGlobalTablePath, SYMBOL_LIB_TABLE *aProject, const wxString &aProjectTablePath)
 
virtual ~PANEL_SYM_LIB_TABLE ()
 

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_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
 
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

SYMBOL_LIB_TABLE * m_globalTable
 
SYMBOL_LIB_TABLE * m_projectTable
 
PROJECT * m_project
 
DIALOG_EDIT_LIBRARY_TABLES * m_parent
 
WX_GRID * m_cur_grid
 changed based on tab choice
 
wxString m_lastProjectLibDir
 

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 35 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,
SYMBOL_LIB_TABLE *  aGlobal,
const wxString &  aGlobalTablePath,
SYMBOL_LIB_TABLE *  aProject,
const wxString &  aProjectTablePath 
)

Definition at line 232 of file panel_sym_lib_table.cpp.

References _, COL_DESCR, COL_ENABLED, COL_NICKNAME, COL_TYPE, COL_URI, COL_VISIBLE, IO_BASE::IO_FILE_DESC::FileFilter(), SETTINGS_MANAGER::GetAppSettings(), PATHS::GetDefaultUserSymbolsPath(), PROJECT::GetProjectPath(), PGM_BASE::GetSettingsManager(), grid, KiBitmapBundle(), PANEL_SYM_LIB_TABLE_BASE::m_append_button, PANEL_SYM_LIB_TABLE_BASE::m_browse_button, m_cur_grid, PANEL_SYM_LIB_TABLE_BASE::m_delete_button, PANEL_SYM_LIB_TABLE_BASE::m_global_grid, m_globalTable, IO_BASE::IO_FILE_DESC::m_IsFile, m_lastProjectLibDir, EESCHEMA_SETTINGS::m_lastSymbolLibDir, PANEL_SYM_LIB_TABLE_BASE::m_move_down_button, PANEL_SYM_LIB_TABLE_BASE::m_move_up_button, PANEL_SYM_LIB_TABLE_BASE::m_notebook, m_pageNdx, m_parent, PANEL_SYM_LIB_TABLE_BASE::m_path_subs_grid, m_project, PANEL_SYM_LIB_TABLE_BASE::m_project_grid, m_projectTable, Pgm(), populateEnvironReadOnlyTable(), STD_BITMAP_BUTTON::SetBitmap(), DIALOG_SHIM::SetInitialFocus(), WX_GRID::SetTable(), and SCH_IO_MGR::ShowType().

◆ ~PANEL_SYM_LIB_TABLE()

PANEL_SYM_LIB_TABLE::~PANEL_SYM_LIB_TABLE ( )
virtual

Definition at line 382 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 1033 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 395 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 695 of file panel_sym_lib_table.cpp.

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

◆ browseLibrariesHandler()

void PANEL_SYM_LIB_TABLE::browseLibrariesHandler ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from PANEL_SYM_LIB_TABLE_BASE.

Definition at line 581 of file panel_sym_lib_table.cpp.

References _, COL_ENABLED, COL_NICKNAME, COL_TYPE, COL_URI, cur_model(), IO_BASE::IO_FILE_DESC::FileFilter(), fileType(), LIB_ID::FixIllegalChars(), formatWildcardExt(), SETTINGS_MANAGER::GetAppSettings(), PGM_BASE::GetLocalEnvVariables(), PROJECT::GetProjectPath(), PGM_BASE::GetSettingsManager(), SCH_IO_MGR::GuessPluginTypeFromLibPath(), m_cur_grid, IO_BASE::IO_FILE_DESC::m_FileExtensions, PANEL_SYM_LIB_TABLE_BASE::m_global_grid, m_lastProjectLibDir, EESCHEMA_SETTINGS::m_lastSymbolLibDir, m_pageNdx, m_project, PANEL_SYM_LIB_TABLE_BASE::m_project_grid, NormalizePath(), OKOrCancelDialog(), path, Pgm(), and SCH_IO_MGR::ShowType().

◆ cur_model()

SYMBOL_LIB_TABLE_GRID * PANEL_SYM_LIB_TABLE::cur_model ( ) const
private

Definition at line 1064 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 713 of file panel_sym_lib_table.cpp.

References WX_GRID::CommitPendingChanges(), and m_cur_grid.

◆ global_model()

SYMBOL_LIB_TABLE_GRID * PANEL_SYM_LIB_TABLE::global_model ( ) const
private

Definition at line 1052 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 803 of file panel_sym_lib_table.cpp.

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

◆ moveUpHandler()

void PANEL_SYM_LIB_TABLE::moveUpHandler ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from PANEL_SYM_LIB_TABLE_BASE.

Definition at line 777 of file panel_sym_lib_table.cpp.

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

◆ onConvertLegacyLibraries()

void PANEL_SYM_LIB_TABLE::onConvertLegacyLibraries ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from PANEL_SYM_LIB_TABLE_BASE.

Definition at line 829 of file panel_sym_lib_table.cpp.

References _, COL_NICKNAME, COL_OPTIONS, COL_TYPE, COL_URI, WX_GRID::CommitPendingChanges(), 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().

◆ onSizeGrid()

void PANEL_SYM_LIB_TABLE::onSizeGrid ( wxSizeEvent &  event)
overrideprivatevirtual

Reimplemented from PANEL_SYM_LIB_TABLE_BASE.

Definition at line 1044 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 574 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, and PANEL_SYM_LIB_TABLE_BASE::m_project_grid.

◆ 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 969 of file panel_sym_lib_table.cpp.

References adjustPathSubsGridColumns(), WX_GRID::ClearRows(), COL_URI, global_model(), SYMBOL_LIB_TABLE::GlobalPathEnvVariableName(), 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 1058 of file panel_sym_lib_table.cpp.

References PANEL_SYM_LIB_TABLE_BASE::m_project_grid.

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

◆ TransferDataFromWindow()

bool PANEL_SYM_LIB_TABLE::TransferDataFromWindow ( )
overrideprivate

Definition at line 941 of file panel_sym_lib_table.cpp.

References LIB_TABLE::Clear(), 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_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 412 of file panel_sym_lib_table.cpp.

References _, allowAutomaticPluginTypeSelection(), COL_NICKNAME, COL_TYPE, COL_URI, cur_model(), LIB_ID::FindIllegalLibraryNameChar(), LIB_TABLE_ROW::GetIsEnabled(), LIB_TABLE_ROW::GetNickName(), global_model(), m_cur_grid, DIALOG_EDIT_LIBRARY_TABLES::m_GlobalTableChanged, PANEL_SYM_LIB_TABLE_BASE::m_notebook, m_parent, DIALOG_EDIT_LIBRARY_TABLES::m_ProjectTableChanged, project_model(), SYMBOL_LIB_TABLE_ROW::Refresh(), LIB_TABLE_ROW::SetParent(), and IO_ERROR::What().

Referenced by TransferDataFromWindow().

Member Data Documentation

◆ m_append_button

STD_BITMAP_BUTTON* PANEL_SYM_LIB_TABLE_BASE::m_append_button
protectedinherited

Definition at line 48 of file panel_sym_lib_table_base.h.

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

◆ m_browse_button

STD_BITMAP_BUTTON* PANEL_SYM_LIB_TABLE_BASE::m_browse_button
protectedinherited

Definition at line 49 of file panel_sym_lib_table_base.h.

Referenced by PANEL_SYM_LIB_TABLE(), PANEL_SYM_LIB_TABLE_BASE::PANEL_SYM_LIB_TABLE_BASE(), and PANEL_SYM_LIB_TABLE_BASE::~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::PANEL_SYM_LIB_TABLE_BASE(), and PANEL_SYM_LIB_TABLE_BASE::~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 90 of file panel_sym_lib_table.h.

Referenced by appendRowHandler(), browseLibrariesHandler(), cur_model(), deleteRowHandler(), moveDownHandler(), moveUpHandler(), onConvertLegacyLibraries(), OnUpdateUI(), 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 52 of file panel_sym_lib_table_base.h.

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

◆ m_global_grid

WX_GRID* PANEL_SYM_LIB_TABLE_BASE::m_global_grid
protectedinherited

Definition at line 45 of file panel_sym_lib_table_base.h.

Referenced by browseLibrariesHandler(), global_model(), onConvertLegacyLibraries(), OnUpdateUI(), PANEL_SYM_LIB_TABLE(), PANEL_SYM_LIB_TABLE_BASE::PANEL_SYM_LIB_TABLE_BASE(), and ~PANEL_SYM_LIB_TABLE().

◆ m_global_panel

wxPanel* PANEL_SYM_LIB_TABLE_BASE::m_global_panel
protectedinherited

Definition at line 44 of file panel_sym_lib_table_base.h.

Referenced by PANEL_SYM_LIB_TABLE_BASE::PANEL_SYM_LIB_TABLE_BASE().

◆ m_globalTable

SYMBOL_LIB_TABLE* PANEL_SYM_LIB_TABLE::m_globalTable
private

Definition at line 84 of file panel_sym_lib_table.h.

Referenced by PANEL_SYM_LIB_TABLE(), and TransferDataFromWindow().

◆ m_lastProjectLibDir

wxString PANEL_SYM_LIB_TABLE::m_lastProjectLibDir
private

Definition at line 92 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 51 of file panel_sym_lib_table_base.h.

Referenced by PANEL_SYM_LIB_TABLE(), PANEL_SYM_LIB_TABLE_BASE::PANEL_SYM_LIB_TABLE_BASE(), and PANEL_SYM_LIB_TABLE_BASE::~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 50 of file panel_sym_lib_table_base.h.

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

◆ m_notebook

wxNotebook* PANEL_SYM_LIB_TABLE_BASE::m_notebook
protectedinherited

Definition at line 43 of file panel_sym_lib_table_base.h.

Referenced by OnUpdateUI(), PANEL_SYM_LIB_TABLE(), PANEL_SYM_LIB_TABLE_BASE::PANEL_SYM_LIB_TABLE_BASE(), and verifyTables().

◆ m_pageNdx

size_t PANEL_SYM_LIB_TABLE::m_pageNdx = 0
staticprivate

Remember the last notebook page selected.

Definition at line 91 of file panel_sym_lib_table.h.

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

◆ m_parent

DIALOG_EDIT_LIBRARY_TABLES* PANEL_SYM_LIB_TABLE::m_parent
private

Definition at line 88 of file panel_sym_lib_table.h.

Referenced by onConvertLegacyLibraries(), PANEL_SYM_LIB_TABLE(), TransferDataFromWindow(), and verifyTables().

◆ 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 adjustPathSubsGridColumns(), PANEL_SYM_LIB_TABLE(), PANEL_SYM_LIB_TABLE_BASE::PANEL_SYM_LIB_TABLE_BASE(), populateEnvironReadOnlyTable(), ~PANEL_SYM_LIB_TABLE(), and PANEL_SYM_LIB_TABLE_BASE::~PANEL_SYM_LIB_TABLE_BASE().

◆ m_project

PROJECT* PANEL_SYM_LIB_TABLE::m_project
private

Definition at line 86 of file panel_sym_lib_table.h.

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

◆ m_project_grid

WX_GRID* PANEL_SYM_LIB_TABLE_BASE::m_project_grid
protectedinherited

Definition at line 47 of file panel_sym_lib_table_base.h.

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

◆ m_project_panel

wxPanel* PANEL_SYM_LIB_TABLE_BASE::m_project_panel
protectedinherited

Definition at line 46 of file panel_sym_lib_table_base.h.

Referenced by PANEL_SYM_LIB_TABLE_BASE::PANEL_SYM_LIB_TABLE_BASE().

◆ m_projectTable

SYMBOL_LIB_TABLE* PANEL_SYM_LIB_TABLE::m_projectTable
private

Definition at line 85 of file panel_sym_lib_table.h.

Referenced by PANEL_SYM_LIB_TABLE(), and TransferDataFromWindow().

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