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)

	~PANEL_DESIGN_BLOCK_LIB_TABLE () override

bool	TransferDataFromWindow () override

void	AddTable (LIBRARY_TABLE *table, const wxString &aTitle, bool aClosable)

Protected Attributes
wxAuiNotebook *	m_notebook

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	verifyTables ()
	Trim important fields, removes blank row entries, and checks for duplicates.

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	onNotebookPageCloseRequest (wxAuiNotebookEvent &aEvent)

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_DATA_MODEL *	get_model (int aPage) const

DESIGN_BLOCK_LIB_TABLE_GRID_DATA_MODEL *	cur_model () const

WX_GRID *	get_grid (int aPage) const

WX_GRID *	cur_grid () const

Private Attributes
PROJECT *	m_project

DIALOG_EDIT_LIBRARY_TABLES *	m_parent

wxArrayString	m_pluginChoices

wxString	m_lastProjectLibDir

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

Detailed Description

Dialog to show and edit symbol library tables.

Definition at line 37 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 308 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 393 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_path_subs_grid, and m_supportedDesignBlockFiles.

Member Function Documentation

◆ AddTable()

void PANEL_DESIGN_BLOCK_LIB_TABLE::AddTable	(	LIBRARY_TABLE *	table,
		const wxString &	aTitle,
		bool	aClosable )

Definition at line 248 of file panel_design_block_lib_table.cpp.

References LIB_TABLE_NOTEBOOK_PANEL::AddTable(), COL_DESCR, COL_NICKNAME, COL_TYPE, COL_URI, get_grid(), GetAppSettings(), PATHS::GetDefaultUserDesignBlocksPath(), grid, m_lastProjectLibDir, PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_notebook, m_parent, m_pluginChoices, m_project, m_supportedDesignBlockFiles, and table.

Referenced by PANEL_DESIGN_BLOCK_LIB_TABLE().

◆ adjustPathSubsGridColumns()

void PANEL_DESIGN_BLOCK_LIB_TABLE::adjustPathSubsGridColumns ( int aWidth )

private

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

References LIB_TABLE_GRID_TRICKS::AppendRowHandler(), and cur_grid().

◆ browseLibrariesHandler()

void PANEL_DESIGN_BLOCK_LIB_TABLE::browseLibrariesHandler ( wxCommandEvent & event )

private

◆ cur_grid()

WX_GRID * PANEL_DESIGN_BLOCK_LIB_TABLE::cur_grid ( ) const

inlineprivate

Definition at line 76 of file panel_design_block_lib_table.h.

References get_grid(), and PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_notebook.

Referenced by appendRowHandler(), browseLibrariesHandler(), deleteRowHandler(), moveDownHandler(), moveUpHandler(), onMigrateLibraries(), and TransferDataFromWindow().

◆ cur_model()

DESIGN_BLOCK_LIB_TABLE_GRID_DATA_MODEL * PANEL_DESIGN_BLOCK_LIB_TABLE::cur_model ( ) const

inlineprivate

Definition at line 73 of file panel_design_block_lib_table.h.

References get_model(), and PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_notebook.

Referenced by browseLibrariesHandler().

◆ deleteRowHandler()

void PANEL_DESIGN_BLOCK_LIB_TABLE::deleteRowHandler ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PANEL_DESIGN_BLOCK_LIB_TABLE_BASE.

Definition at line 471 of file panel_design_block_lib_table.cpp.

References cur_grid(), and LIB_TABLE_GRID_TRICKS::DeleteRowHandler().

◆ get_grid()

WX_GRID * PANEL_DESIGN_BLOCK_LIB_TABLE::get_grid ( int aPage ) const

private

Definition at line 432 of file panel_design_block_lib_table.cpp.

References LIB_TABLE_NOTEBOOK_PANEL::GetGrid(), and PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_notebook.

Referenced by AddTable(), cur_grid(), get_model(), and verifyTables().

◆ get_model()

DESIGN_BLOCK_LIB_TABLE_GRID_DATA_MODEL * PANEL_DESIGN_BLOCK_LIB_TABLE::get_model ( int aPage ) const

private

Definition at line 426 of file panel_design_block_lib_table.cpp.

References get_grid().

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

◆ moveDownHandler()

void PANEL_DESIGN_BLOCK_LIB_TABLE::moveDownHandler ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PANEL_DESIGN_BLOCK_LIB_TABLE_BASE.

Definition at line 483 of file panel_design_block_lib_table.cpp.

References cur_grid(), and LIB_TABLE_GRID_TRICKS::MoveDownHandler().

◆ moveUpHandler()

void PANEL_DESIGN_BLOCK_LIB_TABLE::moveUpHandler ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PANEL_DESIGN_BLOCK_LIB_TABLE_BASE.

Definition at line 477 of file panel_design_block_lib_table.cpp.

References cur_grid(), and LIB_TABLE_GRID_TRICKS::MoveUpHandler().

◆ onMigrateLibraries()

void PANEL_DESIGN_BLOCK_LIB_TABLE::onMigrateLibraries ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PANEL_DESIGN_BLOCK_LIB_TABLE_BASE.

Definition at line 510 of file panel_design_block_lib_table.cpp.

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

◆ onNotebookPageCloseRequest()

void PANEL_DESIGN_BLOCK_LIB_TABLE::onNotebookPageCloseRequest ( wxAuiNotebookEvent & aEvent )

private

Definition at line 489 of file panel_design_block_lib_table.cpp.

Referenced by PANEL_DESIGN_BLOCK_LIB_TABLE().

◆ onSizeGrid()

void PANEL_DESIGN_BLOCK_LIB_TABLE::onSizeGrid ( wxSizeEvent & event )

overrideprivatevirtual

Reimplemented from PANEL_DESIGN_BLOCK_LIB_TABLE_BASE.

Definition at line 738 of file panel_design_block_lib_table.cpp.

References adjustPathSubsGridColumns().

◆ 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 810 of file panel_design_block_lib_table.cpp.

References adjustPathSubsGridColumns(), COL_URI, get_model(), LIB_TABLE_GRID_DATA_MODEL::GetNumberRows(), LIB_TABLE_GRID_DATA_MODEL::GetValue(), ENV_VAR::GetVersionedEnvVarName(), DESIGN_BLOCK_LIBRARY_ADAPTER::GlobalPathEnvVariableName(), PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_notebook, PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_path_subs_grid, and PROJECT_VAR_NAME.

Referenced by PANEL_DESIGN_BLOCK_LIB_TABLE().

◆ populatePluginList()

void PANEL_DESIGN_BLOCK_LIB_TABLE::populatePluginList ( )

private

Definition at line 411 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().

◆ TransferDataFromWindow()

bool PANEL_DESIGN_BLOCK_LIB_TABLE::TransferDataFromWindow ( )

override

◆ 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 438 of file panel_design_block_lib_table.cpp.

References get_grid(), grid, PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_notebook, and LIB_TABLE_GRID_TRICKS::VerifyTable().

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 44 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 45 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_delete_button

STD_BITMAP_BUTTON* PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_delete_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_lastProjectLibDir

wxString PANEL_DESIGN_BLOCK_LIB_TABLE::m_lastProjectLibDir

private

Definition at line 83 of file panel_design_block_lib_table.h.

Referenced by AddTable(), 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 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_BASE().

◆ m_move_down_button

STD_BITMAP_BUTTON* PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_move_down_button

protectedinherited

Definition at line 47 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 46 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

wxAuiNotebook* PANEL_DESIGN_BLOCK_LIB_TABLE_BASE::m_notebook

protectedinherited

Definition at line 43 of file panel_design_block_lib_table_base.h.

◆ m_parent

DIALOG_EDIT_LIBRARY_TABLES* PANEL_DESIGN_BLOCK_LIB_TABLE::m_parent

private

Definition at line 80 of file panel_design_block_lib_table.h.

Referenced by AddTable(), browseLibrariesHandler(), 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 50 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_pluginChoices

wxArrayString PANEL_DESIGN_BLOCK_LIB_TABLE::m_pluginChoices

private

Definition at line 81 of file panel_design_block_lib_table.h.

Referenced by AddTable(), and PANEL_DESIGN_BLOCK_LIB_TABLE().

◆ m_project

PROJECT* PANEL_DESIGN_BLOCK_LIB_TABLE::m_project

private

Definition at line 79 of file panel_design_block_lib_table.h.

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

◆ 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 86 of file panel_design_block_lib_table.h.

Referenced by AddTable(), 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

Detailed Description

Constructor & Destructor Documentation

◆ PANEL_DESIGN_BLOCK_LIB_TABLE()

◆ ~PANEL_DESIGN_BLOCK_LIB_TABLE()

Member Function Documentation

◆ AddTable()

◆ adjustPathSubsGridColumns()

◆ appendRowHandler()

◆ browseLibrariesHandler()

◆ cur_grid()

◆ cur_model()

◆ deleteRowHandler()

◆ get_grid()

◆ get_model()

◆ moveDownHandler()

◆ moveUpHandler()

◆ onMigrateLibraries()

◆ onNotebookPageCloseRequest()

◆ onSizeGrid()

◆ populateEnvironReadOnlyTable()

◆ populatePluginList()

◆ TransferDataFromWindow()

◆ verifyTables()

Member Data Documentation

◆ m_append_button

◆ m_browseButton

◆ m_delete_button

◆ m_lastProjectLibDir

◆ m_migrate_libs_button

◆ m_move_down_button

◆ m_move_up_button

◆ m_notebook

◆ m_parent

◆ m_path_subs_grid

◆ m_pluginChoices

◆ m_project

◆ m_supportedDesignBlockFiles