#include <design_block_pane.h>

Inheritance diagram for DESIGN_BLOCK_PANE:

Public Member Functions
	DESIGN_BLOCK_PANE (EDA_DRAW_FRAME aParent, const LIB_ID aPreselect, std::vector< LIB_ID > &aHistoryList)

	~DESIGN_BLOCK_PANE () override

void	SaveSettings ()

LIB_ID	GetSelectedLibId (int *aUnit=nullptr) const

void	SelectLibId (const LIB_ID &aLibId)

DESIGN_BLOCK *	GetDesignBlock (const LIB_ID &aLibId, bool aUseCacheLib, bool aShowErrorMsg)
	Load design block from design block library table.

DESIGN_BLOCK *	GetSelectedDesignBlock (bool aUseCacheLib, bool aShowErrorMsg)

void	RefreshLibs ()

wxString	CreateNewDesignBlockLibrary (const wxString &aDialogTitle)
	Creates a new design block library.

bool	AddDesignBlockLibrary (const wxString &aDialogTitle, const wxString &aFilename, LIBRARY_TABLE_SCOPE aScope)
	Add an existing library to a library table (presumed to be either the global or project design block table).

bool	DeleteDesignBlockLibrary (const wxString &aLibName, bool aConfirm)

bool	DeleteDesignBlockFromLibrary (const LIB_ID &aLibId, bool aConfirm)

bool	EditDesignBlockProperties (const LIB_ID &aLibId)

PANEL_DESIGN_BLOCK_CHOOSER *	GetDesignBlockPanel () const

void	SetBorders (bool aLeft, bool aRight, bool aTop, bool aBottom)

void	SetBorderColor (const KIGFX::COLOR4D &aColor)

Protected Member Functions
virtual void	setLabelsAndTooltips ()=0

virtual void	OnLanguageChanged (wxCommandEvent &aEvent)

void	OnClosed (wxAuiManagerEvent &aEvent)

Protected Attributes
EDA_DRAW_FRAME *	m_frame = nullptr

PANEL_DESIGN_BLOCK_CHOOSER *	m_chooserPanel = nullptr

Private Member Functions
bool	checkOverwrite (wxWindow *aFrame, wxString &libname, wxString &newName)

wxString	createNewDesignBlockLibrary (const wxString &aDialogTitle)

void	OnPaint (wxPaintEvent &event)

Private Attributes
bool	m_leftBorder

bool	m_rightBorder

bool	m_topBorder

bool	m_bottomBorder

KIGFX::COLOR4D	m_borderColor

Detailed Description

Definition at line 39 of file design_block_pane.h.

Constructor & Destructor Documentation

◆ DESIGN_BLOCK_PANE()

DESIGN_BLOCK_PANE::DESIGN_BLOCK_PANE	(	EDA_DRAW_FRAME *	aParent,
		const LIB_ID *	aPreselect,
		std::vector< LIB_ID > &	aHistoryList )

Definition at line 45 of file design_block_pane.cpp.

References m_frame, OnClosed(), OnLanguageChanged(), and WX_PANEL::WX_PANEL().

Referenced by PCB_DESIGN_BLOCK_PANE::PCB_DESIGN_BLOCK_PANE(), and SCH_DESIGN_BLOCK_PANE::SCH_DESIGN_BLOCK_PANE().

◆ ~DESIGN_BLOCK_PANE()

DESIGN_BLOCK_PANE::~DESIGN_BLOCK_PANE ( )

override

Definition at line 55 of file design_block_pane.cpp.

References m_frame, OnClosed(), and OnLanguageChanged().

Member Function Documentation

◆ AddDesignBlockLibrary()

bool DESIGN_BLOCK_PANE::AddDesignBlockLibrary	(	const wxString &	aDialogTitle,
		const wxString &	aFilename,
		LIBRARY_TABLE_SCOPE	aScope )

Add an existing library to a library table (presumed to be either the global or project design block table).

Returns: true if successfully added.

Definition at line 224 of file design_block_pane.cpp.

References _, DESIGN_BLOCK, DisplayError(), DESIGN_BLOCK_IO_MGR::FILE_TYPE_NONE, PGM_BASE::GetLibraryManager(), GLOBAL, DESIGN_BLOCK_IO_MGR::GuessPluginTypeFromLibPath(), DESIGN_BLOCK_IO_MGR::KICAD_SEXP, FILEEXT::KiCadDesignBlockLibPathExtension, LIBRARY_MANAGER::LoadGlobalTables(), m_frame, LIBRARY_ERROR::message, NormalizePath(), Pgm(), LIBRARY_MANAGER::ProjectChanged(), RefreshLibs(), SelectLibId(), LIBRARY_TABLE_ROW::SetDescription(), LIBRARY_TABLE_ROW::SetNickname(), LIBRARY_TABLE_ROW::SetType(), LIBRARY_TABLE_ROW::SetURI(), DESIGN_BLOCK_IO_MGR::ShowType(), LIBRARY_MANAGER::Table(), and table.

Referenced by createNewDesignBlockLibrary().

◆ checkOverwrite()

bool DESIGN_BLOCK_PANE::checkOverwrite	(	wxWindow *	aFrame,
		wxString &	libname,
		wxString &	newName )

private

Definition at line 431 of file design_block_pane.cpp.

References _, and OKOrCancelDialog().

Referenced by EditDesignBlockProperties().

◆ CreateNewDesignBlockLibrary()

wxString DESIGN_BLOCK_PANE::CreateNewDesignBlockLibrary ( const wxString & aDialogTitle )

Creates a new design block library.

Returns: The newly created library path if library was successfully created, else wxEmptyString because user aborted or error.

Definition at line 144 of file design_block_pane.cpp.

References createNewDesignBlockLibrary().

◆ createNewDesignBlockLibrary()

wxString DESIGN_BLOCK_PANE::createNewDesignBlockLibrary ( const wxString & aDialogTitle )

private

Definition at line 150 of file design_block_pane.cpp.

References _, AddDesignBlockLibrary(), DisplayError(), KIDIALOG::DoNotShowCheckbox(), DESIGN_BLOCK_IO_MGR::FindPlugin(), FILEDLG_HOOK_NEW_LIBRARY::GetUseGlobalTable(), GLOBAL, DESIGN_BLOCK_IO_MGR::KICAD_SEXP, FILEEXT::KiCadDesignBlockLibPathExtension, FILEEXT::KiCadDesignBlockLibPathWildcard(), m_frame, PROJECT, KIDIALOG::ShowModal(), and IO_ERROR::What().

Referenced by CreateNewDesignBlockLibrary().

◆ DeleteDesignBlockFromLibrary()

bool DESIGN_BLOCK_PANE::DeleteDesignBlockFromLibrary	(	const LIB_ID &	aLibId,
		bool	aConfirm )

Definition at line 330 of file design_block_pane.cpp.

References _, DisplayError(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), IsOK(), LIB_ID::IsValid(), m_frame, RefreshLibs(), and IO_ERROR::What().

◆ DeleteDesignBlockLibrary()

bool DESIGN_BLOCK_PANE::DeleteDesignBlockLibrary	(	const wxString &	aLibName,
		bool	aConfirm )

Definition at line 288 of file design_block_pane.cpp.

References _, DisplayError(), DisplayErrorMessage(), IsOK(), m_frame, RefreshLibs(), and IO_ERROR::What().

◆ EditDesignBlockProperties()

bool DESIGN_BLOCK_PANE::EditDesignBlockProperties ( const LIB_ID & aLibId )

Definition at line 372 of file design_block_pane.cpp.

References _, checkOverwrite(), DisplayError(), GetDesignBlock(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), LIB_ID::IsValid(), m_frame, RefreshLibs(), SelectLibId(), DIALOG_SHIM::ShowModal(), and IO_ERROR::What().

◆ GetDesignBlock()

DESIGN_BLOCK * DESIGN_BLOCK_PANE::GetDesignBlock	(	const LIB_ID &	aLibId,
		bool	aUseCacheLib,
		bool	aShowErrorMsg )

Load design block from design block library table.

Parameters

aLibId	is the design block library identifier to load.
aUseCacheLib	set to true to fall back to cache library if design block is not found in design block library table.
aShowErrorMessage	set to true to show any error messages.