#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 &aLibName=wxEmptyString, const wxString &aProposedName=wxEmptyString)
	If a library name is given, creates a new design block library in the project folder with the given name.

bool	AddDesignBlockLibrary (const wxString &aFilename, DESIGN_BLOCK_LIB_TABLE *aTable)
	Add an existing library to either the global or project library 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)

DESIGN_BLOCK_LIB_TABLE *	selectDesignBlockLibTable (bool aOptional=false)

wxString	createNewDesignBlockLibrary (const wxString &aLibName, const wxString &aProposedName, DESIGN_BLOCK_LIB_TABLE *aTable)

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 38 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 47 of file design_block_pane.cpp.

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

◆ ~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 &	aFilename,
		DESIGN_BLOCK_LIB_TABLE *	aTable
	)

Add an existing library to either the global or project library table.

Parameters

aFileName the library to add; a file open dialog will be displayed if empty.

Returns: true if successfully added.

Definition at line 245 of file design_block_pane.cpp.

References _, PROJECT::DesignBlockLibs(), PROJECT::DesignBlockLibTblName(), DisplayError(), DESIGN_BLOCK_IO_MGR::FILE_TYPE_NONE, PATHS::GetDefaultUserDesignBlocksPath(), DESIGN_BLOCK_LIB_TABLE::GetGlobalLibTable(), DESIGN_BLOCK_LIB_TABLE::GetGlobalTableFileName(), DESIGN_BLOCK_IO_MGR::GuessPluginTypeFromLibPath(), LIB_TABLE::InsertRow(), DESIGN_BLOCK_IO_MGR::KICAD_SEXP, FILEEXT::KiCadDesignBlockLibPathExtension, FILEEXT::KiCadDesignBlockLibPathWildcard(), EDA_DRAW_FRAME::LibraryFileBrowser(), m_frame, NormalizePath(), Pgm(), KIWAY_HOLDER::Prj(), RefreshLibs(), LIB_TABLE::Save(), selectDesignBlockLibTable(), SelectLibId(), DESIGN_BLOCK_IO_MGR::ShowType(), and IO_ERROR::What().

Referenced by createNewDesignBlockLibrary().

◆ checkOverwrite()

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

private

Definition at line 456 of file design_block_pane.cpp.

References _, and OKOrCancelDialog().

Referenced by EditDesignBlockProperties().

◆ createNewDesignBlockLibrary()

wxString DESIGN_BLOCK_PANE::createNewDesignBlockLibrary	(	const wxString &	aLibName,
		const wxString &	aProposedName,
		DESIGN_BLOCK_LIB_TABLE *	aTable
	)

private

◆ CreateNewDesignBlockLibrary()

wxString DESIGN_BLOCK_PANE::CreateNewDesignBlockLibrary	(	const wxString &	aLibName = `wxEmptyString`,
		const wxString &	aProposedName = `wxEmptyString`
	)

If a library name is given, creates a new design block library in the project folder with the given name.

If no library name is given it prompts user for a library path, then creates a new design block library at that location. If library exists, user is warned about that, and is given a chance to abort the new creation, and in that case existing library is first deleted.

Parameters

aProposedName is the initial path and filename shown in the file chooser dialog.

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(), and selectDesignBlockLibTable().

◆ DeleteDesignBlockFromLibrary()

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

Definition at line 359 of file design_block_pane.cpp.

References _, DESIGN_BLOCK_LIB_TABLE::DesignBlockDelete(), PROJECT::DesignBlockLibs(), DisplayError(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), DESIGN_BLOCK_LIB_TABLE::IsDesignBlockLibWritable(), IsOK(), LIB_ID::IsValid(), m_frame, KIWAY_HOLDER::Prj(), RefreshLibs(), EDA_BASE_FRAME::ShowInfoBarError(), and IO_ERROR::What().

◆ DeleteDesignBlockLibrary()

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

Definition at line 317 of file design_block_pane.cpp.

References _, DESIGN_BLOCK_LIB_TABLE::DesignBlockLibDelete(), PROJECT::DesignBlockLibs(), DisplayError(), DisplayErrorMessage(), DESIGN_BLOCK_LIB_TABLE::IsDesignBlockLibWritable(), IsOK(), m_frame, KIWAY_HOLDER::Prj(), RefreshLibs(), EDA_BASE_FRAME::ShowInfoBarError(), and IO_ERROR::What().

◆ EditDesignBlockProperties()

bool DESIGN_BLOCK_PANE::EditDesignBlockProperties ( const LIB_ID & aLibId )

◆ 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.