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_DESIGN_BLOCK_LIB_TABLE Class Reference

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

#include <panel_design_block_lib_table.h>

Inheritance diagram for PANEL_DESIGN_BLOCK_LIB_TABLE:
PANEL_DESIGN_BLOCK_LIB_TABLE_BASE

Public Member Functions

 PANEL_DESIGN_BLOCK_LIB_TABLE (DIALOG_EDIT_LIBRARY_TABLES *aParent, PROJECT *aProject)
 
 ~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

PROJECT * m_project
 
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 )

Definition at line 261 of file panel_design_block_lib_table.cpp.

References _, browseLibrariesHandler(), COL_DESCR, COL_ENABLED, COL_NICKNAME, COL_TYPE, COL_URI, COL_VISIBLE, DESIGN_BLOCK, fileType(), GetAppSettings(), PATHS::GetDefaultUserDesignBlocksPath(), PGM_BASE::GetLibraryManager(), GLOBAL, grid, KiBitmapBundle(), PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_append_button, PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_browseButton, m_cur_grid, PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_delete_button, PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_global_grid, KICAD_SETTINGS::m_lastDesignBlockLibDir, m_lastProjectLibDir, PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_migrate_libs_button, PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_move_down_button, PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_move_up_button, PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_notebook, m_pageNdx, m_parent, PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_path_subs_grid, m_project, PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_project_grid, m_supportedDesignBlockFiles, PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::PANEL_DESIGN_BLOCK_LIB_TABLE_BASE(), Pgm(), populateEnvironReadOnlyTable(), populatePluginList(), PROJECT, DESIGN_BLOCK_IO_MGR::ShowType(), small_down, small_folder, small_plus, small_trash, small_up, LIBRARY_MANAGER::Table(), and table.

◆ ~PANEL_DESIGN_BLOCK_LIB_TABLE()

PANEL_DESIGN_BLOCK_LIB_TABLE::~PANEL_DESIGN_BLOCK_LIB_TABLE ( )
override

Definition at line 451 of file panel_design_block_lib_table.cpp.

References browseLibrariesHandler(), 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 967 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 611 of file panel_design_block_lib_table.cpp.

References COL_NICKNAME, and m_cur_grid.

◆ browseLibrariesHandler()

void PANEL_DESIGN_BLOCK_LIB_TABLE::browseLibrariesHandler ( wxCommandEvent & event)
private

Definition at line 834 of file panel_design_block_lib_table.cpp.

References _, COL_NICKNAME, COL_TYPE, COL_URI, cur_model(), dummy, DESIGN_BLOCK_IO_MGR::FILE_TYPE_NONE, IO_BASE::IO_FILE_DESC::FileFilter(), fileType(), LIB_ID::FixIllegalChars(), GetAppSettings(), PGM_BASE::GetLocalEnvVariables(), DESIGN_BLOCK_IO_MGR::KICAD_SEXP, FILEEXT::KiCadDesignBlockLibPathExtension, m_cur_grid, IO_BASE::IO_FILE_DESC::m_IsFile, KICAD_SETTINGS::m_lastDesignBlockLibDir, m_lastProjectLibDir, m_pageNdx, m_project, PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_project_grid, 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 78 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 622 of file panel_design_block_lib_table.cpp.

References m_cur_grid.

◆ global_model()

DESIGN_BLOCK_LIB_TABLE_GRID * PANEL_DESIGN_BLOCK_LIB_TABLE::global_model ( ) const
inlineprivate

Definition at line 68 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 710 of file panel_design_block_lib_table.cpp.

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

◆ moveUpHandler()

void PANEL_DESIGN_BLOCK_LIB_TABLE::moveUpHandler ( wxCommandEvent & event)
overrideprivatevirtual

Reimplemented from PANEL_DESIGN_BLOCK_LIB_TABLE_BASE.

Definition at line 688 of file panel_design_block_lib_table.cpp.

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

◆ onMigrateLibraries()

void PANEL_DESIGN_BLOCK_LIB_TABLE::onMigrateLibraries ( wxCommandEvent & event)
overrideprivatevirtual

Reimplemented from PANEL_DESIGN_BLOCK_LIB_TABLE_BASE.

Definition at line 732 of file panel_design_block_lib_table.cpp.

References _, COL_NICKNAME, COL_OPTIONS, COL_TYPE, COL_URI, DESIGN_BLOCK_IO_MGR::ConvertLibrary(), DisplayErrorMessage(), ExpandEnvVarSubstitutions(), IsOK(), DESIGN_BLOCK_IO_MGR::KICAD_SEXP, FILEEXT::KiCadDesignBlockLibPathExtension, m_cur_grid, PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_global_grid, m_parent, m_project, NormalizePath(), LIB_TABLE::ParseOptions(), Pgm(), and DESIGN_BLOCK_IO_MGR::ShowType().

◆ onSizeGrid()

void PANEL_DESIGN_BLOCK_LIB_TABLE::onSizeGrid ( wxSizeEvent & event)
overrideprivatevirtual

Reimplemented from PANEL_DESIGN_BLOCK_LIB_TABLE_BASE.

Definition at line 978 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 604 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 1024 of file panel_design_block_lib_table.cpp.

References adjustPathSubsGridColumns(), COL_URI, ENV_VAR::GetVersionedEnvVarName(), global_model(), DESIGN_BLOCK_LIBRARY_ADAPTER::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 474 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 73 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 986 of file panel_design_block_lib_table.cpp.

References DESIGN_BLOCK, PGM_BASE::GetLibraryManager(), GLOBAL, global_model(), m_cur_grid, m_parent, Pgm(), PROJECT, project_model(), LIB_TABLE_GRID::Table(), LIBRARY_MANAGER::Table(), 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 489 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 48 of file panel_design_block_lib_table_base.h.

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

◆ m_browseButton

SPLIT_BUTTON* PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_browseButton
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(), PANEL_DESIGN_BLOCK_LIB_TABLE_BASE(), and PANEL_DESIGN_BLOCK_LIB_TABLE::~PANEL_DESIGN_BLOCK_LIB_TABLE().

◆ m_cur_grid

WX_GRID* PANEL_DESIGN_BLOCK_LIB_TABLE::m_cur_grid
private

Definition at line 87 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 52 of file panel_design_block_lib_table_base.h.

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

◆ m_global_grid

WX_GRID* PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_global_grid
protectedinherited

Definition at line 45 of file panel_design_block_lib_table_base.h.

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

◆ m_global_panel

wxPanel* PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_global_panel
protectedinherited

Definition at line 44 of file panel_design_block_lib_table_base.h.

Referenced by PANEL_DESIGN_BLOCK_LIB_TABLE_BASE().

◆ m_lastProjectLibDir

wxString PANEL_DESIGN_BLOCK_LIB_TABLE::m_lastProjectLibDir
private

Definition at line 91 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 53 of file panel_design_block_lib_table_base.h.

Referenced by PANEL_DESIGN_BLOCK_LIB_TABLE::PANEL_DESIGN_BLOCK_LIB_TABLE(), PANEL_DESIGN_BLOCK_LIB_TABLE_BASE(), and ~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 51 of file panel_design_block_lib_table_base.h.

Referenced by PANEL_DESIGN_BLOCK_LIB_TABLE::PANEL_DESIGN_BLOCK_LIB_TABLE(), PANEL_DESIGN_BLOCK_LIB_TABLE_BASE(), and ~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 50 of file panel_design_block_lib_table_base.h.

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

◆ m_notebook

wxNotebook* PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_notebook
protectedinherited

Definition at line 43 of file panel_design_block_lib_table_base.h.

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

◆ m_pageNdx

size_t PANEL_DESIGN_BLOCK_LIB_TABLE::m_pageNdx = 0
staticprivate

Definition at line 88 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 85 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 54 of file panel_design_block_lib_table_base.h.

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

◆ m_project

PROJECT* PANEL_DESIGN_BLOCK_LIB_TABLE::m_project
private

Definition at line 83 of file panel_design_block_lib_table.h.

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

◆ m_project_grid

WX_GRID* PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_project_grid
protectedinherited

Definition at line 47 of file panel_design_block_lib_table_base.h.

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

◆ m_project_panel

wxPanel* PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_project_panel
protectedinherited

Definition at line 46 of file panel_design_block_lib_table_base.h.

Referenced by PANEL_DESIGN_BLOCK_LIB_TABLE_BASE().

◆ 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 94 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: