PANEL_FP_LIB_TABLE Class Reference

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, FP_LIB_TABLE *aGlobal, const wxString &aGlobalTblPath, FP_LIB_TABLE *aProject, const wxString &aProjectTblPath, const wxString &aProjectBasePath)
	~PANEL_FP_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
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. More...
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	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. More...
FP_LIB_TABLE_GRID *	global_model () const
FP_LIB_TABLE_GRID *	project_model () const
FP_LIB_TABLE_GRID *	cur_model () const

Private Attributes
FP_LIB_TABLE *	m_global
FP_LIB_TABLE *	m_project
wxString	m_projectBasePath
DIALOG_EDIT_LIBRARY_TABLES *	m_parent
WX_GRID *	m_cur_grid
wxString	m_lastProjectLibDir

Static Private Attributes
static size_t	m_pageNdx = 0

Detailed Description

Dialog to show and edit symbol library tables.

Definition at line 33 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,
		FP_LIB_TABLE *	aGlobal,
		const wxString &	aGlobalTblPath,
		FP_LIB_TABLE *	aProject,
		const wxString &	aProjectTblPath,
		const wxString &	aProjectBasePath
	)

Definition at line 342 of file panel_fp_lib_table.cpp.

References _, IO_MGR::ALTIUM_DESIGNER, browseLibrariesHandler(), IO_MGR::CADSTAR_PCB_ARCHIVE, COL_DESCR, COL_ENABLED, COL_NICKNAME, COL_TYPE, COL_URI, COL_VISIBLE, IO_MGR::EAGLE, fileType(), fileTypes(), IO_MGR::GEDA_PCB, PATHS::GetDefaultUserFootprintsPath(), SPLIT_BUTTON::GetSplitButtonMenu(), KiBitmap(), IO_MGR::KICAD_SEXP, IO_MGR::LEGACY, PANEL_FP_LIB_TABLE_BASE::m_append_button, PANEL_FP_LIB_TABLE_BASE::m_browseButton, m_cur_grid, PANEL_FP_LIB_TABLE_BASE::m_delete_button, PANEL_FP_LIB_TABLE_BASE::m_global_grid, PCBNEW_SETTINGS::m_lastFootprintLibDir, m_lastProjectLibDir, PANEL_FP_LIB_TABLE_BASE::m_move_down_button, PANEL_FP_LIB_TABLE_BASE::m_move_up_button, PANEL_FP_LIB_TABLE_BASE::m_notebook, m_pageNdx, m_parent, PANEL_FP_LIB_TABLE_BASE::m_path_subs_grid, PANEL_FP_LIB_TABLE_BASE::m_project_grid, m_projectBasePath, Pgm(), populateEnvironReadOnlyTable(), SPLIT_BUTTON::SetBitmap(), STD_BITMAP_BUTTON::SetBitmap(), DIALOG_SHIM::SetInitialFocus(), SPLIT_BUTTON::SetMinSize(), WX_GRID::SetTable(), SPLIT_BUTTON::SetWidthPadding(), and IO_MGR::ShowType().

~PANEL_FP_LIB_TABLE()

PANEL_FP_LIB_TABLE::~PANEL_FP_LIB_TABLE ( )

override

Definition at line 491 of file panel_fp_lib_table.cpp.

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

Member Function Documentation

adjustPathSubsGridColumns()

void PANEL_FP_LIB_TABLE::adjustPathSubsGridColumns ( int  aWidth )

private

Definition at line 941 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 622 of file panel_fp_lib_table.cpp.

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

browseLibrariesHandler()

void PANEL_FP_LIB_TABLE::browseLibrariesHandler ( wxCommandEvent &  event )

private

Definition at line 760 of file panel_fp_lib_table.cpp.

References _, COL_NICKNAME, COL_TYPE, COL_URI, WX_GRID::CommitPendingChanges(), cur_model(), DisplayErrorMessage(), fileType(), fileTypes(), LIB_ID::FixIllegalChars(), LIBRARY_TRAVERSER::GetPaths(), LIBRARY_TRAVERSER::HasDirectoryOpenFailures(), ID_PANEL_FPLIB_ADD_KICADMOD, IO_MGR::KICAD_SEXP, KiCadFootprintLibPathExtension, m_cur_grid, PANEL_FP_LIB_TABLE_BASE::m_global_grid, PCBNEW_SETTINGS::m_lastFootprintLibDir, m_lastProjectLibDir, m_pageNdx, PANEL_FP_LIB_TABLE_BASE::m_project_grid, m_projectBasePath, NormalizePath(), OKOrCancelDialog(), path, Pgm(), and IO_MGR::ShowType().

Referenced by PANEL_FP_LIB_TABLE().

cur_model()

FP_LIB_TABLE_GRID * PANEL_FP_LIB_TABLE::cur_model ( ) const

inlineprivate

Definition at line 77 of file panel_fp_lib_table.h.

References m_cur_grid.

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

deleteRowHandler()

void PANEL_FP_LIB_TABLE::deleteRowHandler ( wxCommandEvent &  event )

overrideprivatevirtual

Reimplemented from PANEL_FP_LIB_TABLE_BASE.

Definition at line 640 of file panel_fp_lib_table.cpp.

References WX_GRID::CommitPendingChanges(), and m_cur_grid.

global_model()

FP_LIB_TABLE_GRID * PANEL_FP_LIB_TABLE::global_model ( ) const

inlineprivate

Definition at line 67 of file panel_fp_lib_table.h.

References PANEL_FP_LIB_TABLE_BASE::m_global_grid.

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

moveDownHandler()

void PANEL_FP_LIB_TABLE::moveDownHandler ( wxCommandEvent &  event )

overrideprivatevirtual

Reimplemented from PANEL_FP_LIB_TABLE_BASE.

Definition at line 730 of file panel_fp_lib_table.cpp.

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

moveUpHandler()

void PANEL_FP_LIB_TABLE::moveUpHandler ( wxCommandEvent &  event )

overrideprivatevirtual

Reimplemented from PANEL_FP_LIB_TABLE_BASE.

Definition at line 700 of file panel_fp_lib_table.cpp.

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

onSizeGrid()

void PANEL_FP_LIB_TABLE::onSizeGrid ( wxSizeEvent &  event )

overrideprivatevirtual

Reimplemented from PANEL_FP_LIB_TABLE_BASE.

Definition at line 952 of file panel_fp_lib_table.cpp.

References adjustPathSubsGridColumns().

OnUpdateUI()

void PANEL_FP_LIB_TABLE::OnUpdateUI ( wxUpdateUIEvent &  event )

overrideprivatevirtual

Reimplemented from PANEL_FP_LIB_TABLE_BASE.

Definition at line 615 of file panel_fp_lib_table.cpp.

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

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 996 of file panel_fp_lib_table.cpp.

References adjustPathSubsGridColumns(), WX_GRID::ClearRows(), COL_URI, global_model(), FP_LIB_TABLE::GlobalPathEnvVariableName(), KICAD7_3DMODEL_DIR, PANEL_FP_LIB_TABLE_BASE::m_path_subs_grid, project_model(), and PROJECT_VAR_NAME.

Referenced by PANEL_FP_LIB_TABLE().

project_model()

FP_LIB_TABLE_GRID * PANEL_FP_LIB_TABLE::project_model ( ) const

inlineprivate

Definition at line 72 of file panel_fp_lib_table.h.

References PANEL_FP_LIB_TABLE_BASE::m_project_grid.

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

TransferDataFromWindow()

bool PANEL_FP_LIB_TABLE::TransferDataFromWindow ( )

overrideprivate

Definition at line 960 of file panel_fp_lib_table.cpp.

References FP_LIB_TABLE_GRID::begin(), LIB_TABLE::Clear(), WX_GRID::CommitPendingChanges(), global_model(), m_cur_grid, m_global, DIALOG_EDIT_LIBRARY_TABLES::m_GlobalTableChanged, m_parent, m_project, DIALOG_EDIT_LIBRARY_TABLES::m_ProjectTableChanged, LIB_TABLE::m_rows, project_model(), LIB_TABLE::reindex(), and verifyTables().

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 504 of file panel_fp_lib_table.cpp.

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

Referenced by TransferDataFromWindow().

Member Data Documentation

m_append_button

STD_BITMAP_BUTTON* PANEL_FP_LIB_TABLE_BASE::m_append_button

protectedinherited

Definition at line 49 of file panel_fp_lib_table_base.h.

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

m_browseButton

SPLIT_BUTTON* PANEL_FP_LIB_TABLE_BASE::m_browseButton

protectedinherited

Definition at line 50 of file panel_fp_lib_table_base.h.

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

m_cur_grid

WX_GRID* PANEL_FP_LIB_TABLE::m_cur_grid

private

Definition at line 89 of file panel_fp_lib_table.h.

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

m_delete_button

STD_BITMAP_BUTTON* PANEL_FP_LIB_TABLE_BASE::m_delete_button

protectedinherited

Definition at line 53 of file panel_fp_lib_table_base.h.

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

m_global

FP_LIB_TABLE* PANEL_FP_LIB_TABLE::m_global

private

Definition at line 83 of file panel_fp_lib_table.h.

Referenced by TransferDataFromWindow().

m_global_grid

WX_GRID* PANEL_FP_LIB_TABLE_BASE::m_global_grid

protectedinherited

Definition at line 46 of file panel_fp_lib_table_base.h.

Referenced by browseLibrariesHandler(), global_model(), OnUpdateUI(), PANEL_FP_LIB_TABLE(), PANEL_FP_LIB_TABLE_BASE::PANEL_FP_LIB_TABLE_BASE(), and ~PANEL_FP_LIB_TABLE().

m_global_panel

wxPanel* PANEL_FP_LIB_TABLE_BASE::m_global_panel

protectedinherited

Definition at line 45 of file panel_fp_lib_table_base.h.

Referenced by PANEL_FP_LIB_TABLE_BASE::PANEL_FP_LIB_TABLE_BASE().

m_lastProjectLibDir

wxString PANEL_FP_LIB_TABLE::m_lastProjectLibDir

private

Definition at line 93 of file panel_fp_lib_table.h.

Referenced by browseLibrariesHandler(), and PANEL_FP_LIB_TABLE().

m_move_down_button

STD_BITMAP_BUTTON* PANEL_FP_LIB_TABLE_BASE::m_move_down_button

protectedinherited

Definition at line 52 of file panel_fp_lib_table_base.h.

Referenced by PANEL_FP_LIB_TABLE(), PANEL_FP_LIB_TABLE_BASE::PANEL_FP_LIB_TABLE_BASE(), and PANEL_FP_LIB_TABLE_BASE::~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 51 of file panel_fp_lib_table_base.h.

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

m_notebook

wxNotebook* PANEL_FP_LIB_TABLE_BASE::m_notebook

protectedinherited

Definition at line 44 of file panel_fp_lib_table_base.h.

Referenced by OnUpdateUI(), PANEL_FP_LIB_TABLE(), PANEL_FP_LIB_TABLE_BASE::PANEL_FP_LIB_TABLE_BASE(), and verifyTables().

m_pageNdx

size_t PANEL_FP_LIB_TABLE::m_pageNdx = 0

staticprivate

Definition at line 90 of file panel_fp_lib_table.h.

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

m_parent

DIALOG_EDIT_LIBRARY_TABLES* PANEL_FP_LIB_TABLE::m_parent

private

Definition at line 87 of file panel_fp_lib_table.h.

Referenced by PANEL_FP_LIB_TABLE(), and TransferDataFromWindow().

m_path_subs_grid

WX_GRID* PANEL_FP_LIB_TABLE_BASE::m_path_subs_grid

protectedinherited

Definition at line 54 of file panel_fp_lib_table_base.h.

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

m_project

FP_LIB_TABLE* PANEL_FP_LIB_TABLE::m_project

private

Definition at line 84 of file panel_fp_lib_table.h.

Referenced by TransferDataFromWindow().

m_project_grid

WX_GRID* PANEL_FP_LIB_TABLE_BASE::m_project_grid

protectedinherited

Definition at line 48 of file panel_fp_lib_table_base.h.

Referenced by browseLibrariesHandler(), OnUpdateUI(), PANEL_FP_LIB_TABLE(), PANEL_FP_LIB_TABLE_BASE::PANEL_FP_LIB_TABLE_BASE(), project_model(), and ~PANEL_FP_LIB_TABLE().

m_project_panel

wxPanel* PANEL_FP_LIB_TABLE_BASE::m_project_panel

protectedinherited

Definition at line 47 of file panel_fp_lib_table_base.h.

Referenced by PANEL_FP_LIB_TABLE_BASE::PANEL_FP_LIB_TABLE_BASE().

m_projectBasePath

wxString PANEL_FP_LIB_TABLE::m_projectBasePath

private

Definition at line 85 of file panel_fp_lib_table.h.

Referenced by browseLibrariesHandler(), and PANEL_FP_LIB_TABLE().

---

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

• panel_fp_lib_table.h
• panel_fp_lib_table.cpp