#include <symbol_tree_model_adapter.h>

Inheritance diagram for SYMBOL_TREE_MODEL_ADAPTER:

Public Types
enum	TREE_COLS { NAME_COL = 0 , DESC_COL , NUM_COLS }
	This enum defines the order of the default columns in the tree view. More...

enum	SORT_MODE { BEST_MATCH = 0 , ALPHABETIC }

Public Member Functions
	~SYMBOL_TREE_MODEL_ADAPTER ()
	Destructor.

void	AddLibraries (SCH_BASE_FRAME *aFrame)
	Add all the libraries in a SYMBOL_LIB_TABLE to the model.

void	AddLibrary (wxString const &aLibNickname, bool pinned)

wxString	GenerateInfo (LIB_ID const &aLibId, int aUnit) override

void	SaveSettings ()
	Save the column widths to the config file.

void	SetFilter (std::function< bool(LIB_TREE_NODE &aNode)> *aFilter)
	Set the filter.

std::function< bool(LIB_TREE_NODE &aNode)> *	GetFilter () const
	Return the active filter.

void	SetSortMode (SORT_MODE aMode)

SORT_MODE	GetSortMode () const

void	ShowUnits (bool aShow)
	Whether or not to show units.

void	SetPreselectNode (const LIB_ID &aLibId, int aUnit)
	Set the symbol name to be selected if there are no search results.

LIB_TREE_NODE_LIBRARY &	DoAddLibrary (const wxString &aNodeName, const wxString &aDesc, const std::vector< LIB_TREE_ITEM * > &aItemList, bool pinned, bool presorted)
	Add the given list of symbols by alias.

void	RemoveGroup (bool aRecentlyUsedGroup, bool aAlreadyPlacedGroup)
	Remove one of the system groups from the library.

std::vector< wxString >	GetAvailableColumns () const

std::vector< wxString >	GetShownColumns () const

std::vector< wxString >	GetOpenLibs () const

void	OpenLibs (const std::vector< wxString > &aLibs)

void	RegisterLazyLoadHandler (std::function< void()> &&aHandler)
	Registers a function to be called whenever new lazy-loaded library content is available.

void	SetShownColumns (const std::vector< wxString > &aColumnNames)
	Sets which columns are shown in the widget.

void	AssignIntrinsicRanks ()
	Sort the tree and assign ranks after adding libraries.

void	UpdateSearchString (const wxString &aSearch, bool aState)
	Set the search string provided by the user.

void	AttachTo (wxDataViewCtrl *aDataViewCtrl)
	Attach to a wxDataViewCtrl and initialize it.

void	FinishTreeInitialization ()
	A final-stage initialization to be called after the window hierarchy has been realized and the window sizes set.

LIB_ID	GetAliasFor (const wxDataViewItem &aSelection) const
	Return the alias for the given item.

int	GetUnitFor (const wxDataViewItem &aSelection) const
	Return the unit for the given item.

LIB_TREE_NODE::TYPE	GetTypeFor (const wxDataViewItem &aSelection) const
	Return node type for the given item.

LIB_TREE_NODE *	GetTreeNodeFor (const wxDataViewItem &aSelection) const

virtual bool	HasPreview (const wxDataViewItem &aItem)

virtual void	ShowPreview (wxWindow *aParent, const wxDataViewItem &aItem)

virtual void	ShutdownPreview (wxWindow *aParent)

TOOL_DISPATCHER *	GetToolDispatcher () const

int	GetItemCount () const
	Return the number of symbols loaded in the tree.

virtual int	GetLibrariesCount () const
	Return the number of libraries loaded in the tree.

wxDataViewItem	FindItem (const LIB_ID &aLibId)
	Returns tree item corresponding to part.

virtual wxDataViewItem	GetCurrentDataViewItem ()

unsigned int	GetChildren (const wxDataViewItem &aItem, wxDataViewItemArray &aChildren) const override
	Populate a list of all the children of an item.

void	Freeze ()

void	Thaw ()

bool	IsFrozen () const

void	RefreshTree ()

virtual TOOL_INTERACTIVE *	GetContextMenuTool ()

void	PinLibrary (LIB_TREE_NODE *aTreeNode)

void	UnpinLibrary (LIB_TREE_NODE *aTreeNode)

void	ShowChangedLanguage ()

Static Public Member Functions
static wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER >	Create (SCH_BASE_FRAME aParent, SYMBOL_LIBRARY_ADAPTER aLibs)
	Factory function: create a model adapter in a reference-counting container.

static const wxString	GetPinningSymbol ()

Protected Member Functions
	SYMBOL_TREE_MODEL_ADAPTER (SCH_BASE_FRAME aParent, SYMBOL_LIBRARY_ADAPTER aManager)
	Constructor; takes a set of libraries to be included in the search.

PROJECT::LIB_TYPE_T	getLibType () override

LIB_TREE_NODE_LIBRARY &	DoAddLibraryNode (const wxString &aNodeName, const wxString &aDesc, bool pinned)

bool	HasContainerColumns (const wxDataViewItem &aItem) const override
	Check whether a container has columns too.

bool	IsContainer (const wxDataViewItem &aItem) const override
	Check whether an item can have children.

wxDataViewItem	GetParent (const wxDataViewItem &aItem) const override
	Get the parent of an item.

unsigned int	GetColumnCount () const override

wxString	GetColumnType (unsigned int aCol) const override
	Return the type of data stored in the column as indicated by wxVariant::GetType()

void	GetValue (wxVariant &aVariant, const wxDataViewItem &aItem, unsigned int aCol) const override
	Get the value of an item.

bool	SetValue (const wxVariant &aVariant, const wxDataViewItem &aItem, unsigned int aCol) override
	Set the value of an item.

bool	GetAttr (const wxDataViewItem &aItem, unsigned int aCol, wxDataViewItemAttr &aAttr) const override
	Get any formatting for an item.

void	resortTree ()

void	addColumnIfNecessary (const wxString &aHeader)

void	recreateColumns ()

void	createMissingColumns ()

Static Protected Member Functions
static wxDataViewItem	ToItem (const LIB_TREE_NODE *aNode)
	Convert #SYM_TREE_NODE -> wxDataViewItem.

static LIB_TREE_NODE *	ToNode (wxDataViewItem aItem)
	Convert wxDataViewItem -> #SYM_TREE_NODE.

Protected Attributes
LIB_TREE_NODE_ROOT	m_tree

std::map< unsigned, wxString >	m_colIdxMap

std::vector< wxString >	m_availableColumns

wxDataViewCtrl *	m_widget

std::vector< wxString >	m_shownColumns

std::function< void()>	m_lazyLoadHandler

Private Member Functions
const LIB_TREE_NODE *	ShowResults ()
	Find and expand successful search results.

wxDataViewColumn *	doAddColumn (const wxString &aHeader, bool aTranslate=true)

Private Attributes
SYMBOL_LIBRARY_ADAPTER *	m_adapter

std::set< wxString >	m_pending_load_libraries

std::unique_ptr< wxTimer >	m_check_pending_libraries_timer

EDA_BASE_FRAME *	m_parent

APP_SETTINGS_BASE::LIB_TREE &	m_cfg

SORT_MODE	m_sort_mode

bool	m_show_units

LIB_ID	m_preselect_lib_id

int	m_preselect_unit

int	m_freeze

std::function< bool(LIB_TREE_NODE &aNode)> *	m_filter

std::vector< wxDataViewColumn * >	m_columns

std::map< wxString, wxDataViewColumn * >	m_colNameMap

std::map< wxString, int >	m_colWidths

Static Private Attributes
static bool	m_show_progress = true
	Flag to only show the symbol library table load progress dialog the first time.

Detailed Description

Definition at line 30 of file symbol_tree_model_adapter.h.

Member Enumeration Documentation

◆ SORT_MODE

enum LIB_TREE_MODEL_ADAPTER::SORT_MODE

inherited

Enumerator
BEST_MATCH
ALPHABETIC

Definition at line 132 of file lib_tree_model_adapter.h.

◆ TREE_COLS

enum LIB_TREE_MODEL_ADAPTER::TREE_COLS

inherited

This enum defines the order of the default columns in the tree view.

Enumerator
NAME_COL	Library or library item name column.
DESC_COL	Library or library description column.
NUM_COLS	The number of default tree columns.

Definition at line 125 of file lib_tree_model_adapter.h.

Constructor & Destructor Documentation

◆ ~SYMBOL_TREE_MODEL_ADAPTER()

SYMBOL_TREE_MODEL_ADAPTER::~SYMBOL_TREE_MODEL_ADAPTER ( )

Destructor.

Warning: Do not delete this class manually. It is reference-counted by wxObject.

Definition at line 71 of file symbol_tree_model_adapter.cpp.

◆ SYMBOL_TREE_MODEL_ADAPTER()

SYMBOL_TREE_MODEL_ADAPTER::SYMBOL_TREE_MODEL_ADAPTER	(	SCH_BASE_FRAME *	aParent,
		SYMBOL_LIBRARY_ADAPTER *	aManager )

protected

Constructor; takes a set of libraries to be included in the search.

Definition at line 53 of file symbol_tree_model_adapter.cpp.

References DATASHEET, FOOTPRINT, GetDefaultFieldName(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), m_adapter, LIB_TREE_MODEL_ADAPTER::m_availableColumns, m_check_pending_libraries_timer, and VALUE.

Referenced by Create().

Member Function Documentation

◆ addColumnIfNecessary()

void LIB_TREE_MODEL_ADAPTER::addColumnIfNecessary ( const wxString & aHeader )

protectedinherited

Definition at line 456 of file lib_tree_model_adapter.cpp.

References m_availableColumns, and m_colNameMap.

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibraries().

◆ AddLibraries()

void SYMBOL_TREE_MODEL_ADAPTER::AddLibraries ( SCH_BASE_FRAME * aFrame )

Add all the libraries in a SYMBOL_LIB_TABLE to the model.

Parameters

aFrame is the parent window to display the progress dialog

Definition at line 75 of file symbol_tree_model_adapter.cpp.

References LIB_TREE_MODEL_ADAPTER::addColumnIfNecessary(), AddLibraries(), alg::contains(), LIB_TREE_MODEL_ADAPTER::createMissingColumns(), LIB_TREE_MODEL_ADAPTER::DoAddLibrary(), PGM_BASE::GetCommonSettings(), PGM_BASE::GetLibraryManager(), PROJECT::GetProjectFile(), LIBRARY_MANAGER::GetRow(), m_adapter, m_check_pending_libraries_timer, LIB_TREE_MODEL_ADAPTER::m_lazyLoadHandler, m_pending_load_libraries, COMMON_SETTINGS::m_Session, LIB_TREE_MODEL_ADAPTER::m_shownColumns, LIB_TREE_MODEL_ADAPTER::m_tree, name, Pgm(), COMMON_SETTINGS::SESSION::pinned_symbol_libs, KIWAY_HOLDER::Prj(), project, LIBRARY_MANAGER::Rows(), SYMBOL, and traceLibraries.

Referenced by AddLibraries(), and PANEL_SYMBOL_CHOOSER::PANEL_SYMBOL_CHOOSER().

◆ AddLibrary()

void SYMBOL_TREE_MODEL_ADAPTER::AddLibrary	(	wxString const &	aLibNickname,
		bool	pinned )

Definition at line 201 of file symbol_tree_model_adapter.cpp.

References SYMBOL_LIBRARY_ADAPTER::ALL_SYMBOLS, LIB_TREE_MODEL_ADAPTER::DoAddLibrary(), LIB_TREE_MODEL_ADAPTER::GetFilter(), PGM_BASE::GetLibraryManager(), LIBRARY_MANAGER::GetRow(), m_adapter, Pgm(), SYMBOL_LIBRARY_ADAPTER::POWER_ONLY, and SYMBOL.

Referenced by PANEL_SYMBOL_CHOOSER::PANEL_SYMBOL_CHOOSER().

◆ AssignIntrinsicRanks()

void LIB_TREE_MODEL_ADAPTER::AssignIntrinsicRanks ( )

inlineinherited

Sort the tree and assign ranks after adding libraries.

Definition at line 213 of file lib_tree_model_adapter.h.

References m_shownColumns, and m_tree.

Referenced by PANEL_SYMBOL_CHOOSER::PANEL_SYMBOL_CHOOSER().

◆ AttachTo()

void LIB_TREE_MODEL_ADAPTER::AttachTo ( wxDataViewCtrl * aDataViewCtrl )

inherited

Attach to a wxDataViewCtrl and initialize it.

This will set up columns and associate the model via the adapter.

Parameters

aDataViewCtrl the view symbol in the dialog

Definition at line 349 of file lib_tree_model_adapter.cpp.

References kDataViewIndent, m_widget, and recreateColumns().

◆ Create()

wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > SYMBOL_TREE_MODEL_ADAPTER::Create	(	SCH_BASE_FRAME *	aParent,
		SYMBOL_LIBRARY_ADAPTER *	aLibs )

static

Factory function: create a model adapter in a reference-counting container.

Parameters

aLibs library set from which parts will be loaded

Definition at line 45 of file symbol_tree_model_adapter.cpp.

References SYMBOL_TREE_MODEL_ADAPTER().

Referenced by PANEL_SYMBOL_CHOOSER::PANEL_SYMBOL_CHOOSER().

◆ createMissingColumns()

void LIB_TREE_MODEL_ADAPTER::createMissingColumns ( )

protectedinherited

Definition at line 372 of file lib_tree_model_adapter.cpp.

References doAddColumn(), m_colNameMap, and m_shownColumns.

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), and recreateColumns().

◆ doAddColumn()

wxDataViewColumn * LIB_TREE_MODEL_ADAPTER::doAddColumn	(	const wxString &	aHeader,
		bool	aTranslate = true )

privateinherited

Definition at line 428 of file lib_tree_model_adapter.cpp.

References KIUI::GetTextSize(), m_colIdxMap, m_colNameMap, m_columns, m_colWidths, and m_widget.

Referenced by createMissingColumns(), and recreateColumns().

◆ DoAddLibrary()

LIB_TREE_NODE_LIBRARY & LIB_TREE_MODEL_ADAPTER::DoAddLibrary	(	const wxString &	aNodeName,
		const wxString &	aDesc,
		const std::vector< LIB_TREE_ITEM * > &	aItemList,
		bool	pinned,
		bool	presorted )

inherited

Add the given list of symbols by alias.

To be called in the setup phase.

Parameters

aNodeName	the parent node the symbols will appear under
aDesc	the description field of the parent node
aItemList	list of symbols

Definition at line 240 of file lib_tree_model_adapter.cpp.

References LIB_TREE_NODE_LIBRARY::AddItem(), LIB_TREE_NODE::AssignIntrinsicRanks(), DoAddLibraryNode(), and m_shownColumns.

Referenced by DESIGN_BLOCK_TREE_MODEL_ADAPTER::AddLibraries(), FP_TREE_MODEL_ADAPTER::AddLibraries(), SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), SYMBOL_TREE_MODEL_ADAPTER::AddLibrary(), PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER(), PANEL_SYMBOL_CHOOSER::PANEL_SYMBOL_CHOOSER(), and FP_TREE_SYNCHRONIZING_ADAPTER::Sync().

◆ DoAddLibraryNode()

LIB_TREE_NODE_LIBRARY & LIB_TREE_MODEL_ADAPTER::DoAddLibraryNode	(	const wxString &	aNodeName,
		const wxString &	aDesc,
		bool	pinned )

protectedinherited

Definition at line 228 of file lib_tree_model_adapter.cpp.

References LIB_TREE_NODE::m_Pinned, and m_tree.

Referenced by DoAddLibrary(), and SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync().

◆ FindItem()

wxDataViewItem LIB_TREE_MODEL_ADAPTER::FindItem ( const LIB_ID & aLibId )

inherited

Returns tree item corresponding to part.

Parameters

aLibId specifies the part and library name to be searched for.

Returns: Tree data item representing the part. Might be invalid if nothings was found.

Definition at line 519 of file lib_tree_model_adapter.cpp.

References LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), m_tree, ToItem(), and UTF8::wx_str().

Referenced by FP_TREE_SYNCHRONIZING_ADAPTER::GetCurrentDataViewItem(), GetCurrentDataViewItem(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetCurrentDataViewItem(), and OpenLibs().

◆ FinishTreeInitialization()

void LIB_TREE_MODEL_ADAPTER::FinishTreeInitialization ( )

inherited

A final-stage initialization to be called after the window hierarchy has been realized and the window sizes set.

Definition at line 573 of file lib_tree_model_adapter.cpp.

References m_colIdxMap, m_columns, m_colWidths, and m_widget.

◆ Freeze()

void LIB_TREE_MODEL_ADAPTER::Freeze ( )

inlineinherited

Definition at line 318 of file lib_tree_model_adapter.h.

References m_freeze.

Referenced by resortTree(), and UpdateSearchString().

◆ GenerateInfo()

wxString SYMBOL_TREE_MODEL_ADAPTER::GenerateInfo	(	LIB_ID const &	aLibId,
		int	aUnit )

overridevirtual

Reimplemented from LIB_TREE_MODEL_ADAPTER.

Definition at line 220 of file symbol_tree_model_adapter.cpp.

References GenerateAliasInfo(), and m_adapter.

◆ GetAliasFor()

LIB_ID LIB_TREE_MODEL_ADAPTER::GetAliasFor ( const wxDataViewItem & aSelection ) const

inherited

Return the alias for the given item.

Parameters

aSelection item from the wxDataViewCtrl (see wxDataViewCtrl::GetSelection())

Returns: alias, or nullptr if none is selected

Definition at line 481 of file lib_tree_model_adapter.cpp.

References LIB_TREE_NODE::m_LibId, and ToNode().

◆ GetAttr()

bool LIB_TREE_MODEL_ADAPTER::GetAttr	(	const wxDataViewItem &	aItem,
		unsigned int	aCol,
		wxDataViewItemAttr &	aAttr ) const

overrideprotectedinherited

Get any formatting for an item.

Parameters

aItem	item to get formatting for
aCol	column number of interest
aAttr	receiver for attributes

Returns: true if the item has non-default attributes

Definition at line 724 of file lib_tree_model_adapter.cpp.

References IsFrozen(), LIB_TREE_NODE::m_IsRoot, LIB_TREE_NODE::m_Type, and ToNode().

◆ GetAvailableColumns()

std::vector< wxString > LIB_TREE_MODEL_ADAPTER::GetAvailableColumns ( ) const

inlineinherited

Definition at line 191 of file lib_tree_model_adapter.h.

References m_availableColumns.

◆ GetChildren()

unsigned int LIB_TREE_MODEL_ADAPTER::GetChildren	(	const wxDataViewItem &	aItem,
		wxDataViewItemArray &	aChildren ) const

overrideinherited

Populate a list of all the children of an item.

Returns: number of children

Definition at line 549 of file lib_tree_model_adapter.cpp.

References LIB_TREE_NODE::m_Children, m_show_units, m_tree, LIB_TREE_NODE::m_Type, ToItem(), and ToNode().

Referenced by GetOpenLibs().

◆ GetColumnCount()

unsigned int LIB_TREE_MODEL_ADAPTER::GetColumnCount ( ) const

inlineoverrideprotectedinherited

Definition at line 373 of file lib_tree_model_adapter.h.

References m_columns.

◆ GetColumnType()

wxString LIB_TREE_MODEL_ADAPTER::GetColumnType ( unsigned int aCol ) const

inlineoverrideprotectedinherited

Return the type of data stored in the column as indicated by wxVariant::GetType()

Definition at line 378 of file lib_tree_model_adapter.h.

◆ GetContextMenuTool()

virtual TOOL_INTERACTIVE * LIB_TREE_MODEL_ADAPTER::GetContextMenuTool ( )

inlinevirtualinherited

Reimplemented in DESIGN_BLOCK_TREE_MODEL_ADAPTER, FP_TREE_SYNCHRONIZING_ADAPTER, and SYMBOL_TREE_SYNCHRONIZING_ADAPTER.

Definition at line 325 of file lib_tree_model_adapter.h.

◆ GetCurrentDataViewItem()

wxDataViewItem LIB_TREE_MODEL_ADAPTER::GetCurrentDataViewItem ( )

virtualinherited

Reimplemented in FP_TREE_SYNCHRONIZING_ADAPTER, and SYMBOL_TREE_SYNCHRONIZING_ADAPTER.

Definition at line 543 of file lib_tree_model_adapter.cpp.

References FindItem(), and m_preselect_lib_id.

◆ GetFilter()

std::function< bool(LIB_TREE_NODE &aNode)> * LIB_TREE_MODEL_ADAPTER::GetFilter ( ) const

inlineinherited

Return the active filter.

Definition at line 152 of file lib_tree_model_adapter.h.

References m_filter.

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibrary().

◆ GetItemCount()

int LIB_TREE_MODEL_ADAPTER::GetItemCount ( ) const

inherited

Return the number of symbols loaded in the tree.

Definition at line 508 of file lib_tree_model_adapter.cpp.

References m_tree.

◆ GetLibrariesCount()

virtual int LIB_TREE_MODEL_ADAPTER::GetLibrariesCount ( ) const

inlinevirtualinherited

Return the number of libraries loaded in the tree.

Reimplemented in FP_TREE_SYNCHRONIZING_ADAPTER, and SYMBOL_TREE_SYNCHRONIZING_ADAPTER.

Definition at line 292 of file lib_tree_model_adapter.h.

References m_tree.

Referenced by SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetLibrariesCount().

◆ getLibType()

PROJECT::LIB_TYPE_T SYMBOL_TREE_MODEL_ADAPTER::getLibType ( )

inlineoverrideprotectedvirtual

Implements LIB_TREE_MODEL_ADAPTER.

Definition at line 65 of file symbol_tree_model_adapter.h.

References PROJECT::SYMBOL_LIB.

◆ GetOpenLibs()

std::vector< wxString > LIB_TREE_MODEL_ADAPTER::GetOpenLibs ( ) const

inherited

Definition at line 165 of file lib_tree_model_adapter.cpp.

References GetChildren(), m_widget, and ToNode().

Referenced by SaveSettings().

◆ GetParent()

wxDataViewItem LIB_TREE_MODEL_ADAPTER::GetParent ( const wxDataViewItem & aItem ) const

overrideprotectedinherited

Get the parent of an item.

Returns: parent of aItem, or an invalid wxDataViewItem if parent is root

Definition at line 658 of file lib_tree_model_adapter.cpp.

References m_freeze, LIB_TREE_NODE::m_Parent, LIB_TREE_NODE::m_Type, ToItem(), and ToNode().

Referenced by UpdateSearchString().

◆ GetPinningSymbol()

static const wxString LIB_TREE_MODEL_ADAPTER::GetPinningSymbol ( )

inlinestaticinherited

Returns: a unicode string to mark a node name like a pinned library name. This is not an ASCII7 char, but a unicode char.

Definition at line 110 of file lib_tree_model_adapter.h.

Referenced by CVPCB_MAINFRAME::BuildLibrariesList(), WX_LISTBOX::FindString(), WX_LISTBOX::GetBaseString(), PCB_BASE_FRAME::GetLibraryItemsForListDialog(), SCH_BASE_FRAME::GetLibraryItemsForListDialog(), LIBRARY_LISTBOX::GetSelectedLibrary(), WX_LISTBOX::GetStringSelection(), EDA_LIST_DIALOG::GetTextSelection(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), GetValue(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue(), SYMBOL_VIEWER_FRAME::ReCreateLibList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), WX_LISTBOX::SetStringSelection(), and WX_LISTBOX::SetStringSelection().

◆ GetShownColumns()

std::vector< wxString > LIB_TREE_MODEL_ADAPTER::GetShownColumns ( ) const

inlineinherited

Definition at line 193 of file lib_tree_model_adapter.h.

References m_shownColumns.

Referenced by SaveSettings().

◆ GetSortMode()

SORT_MODE LIB_TREE_MODEL_ADAPTER::GetSortMode ( ) const

inlineinherited

Definition at line 155 of file lib_tree_model_adapter.h.

References m_sort_mode.

◆ GetToolDispatcher()

TOOL_DISPATCHER * LIB_TREE_MODEL_ADAPTER::GetToolDispatcher ( ) const

inlineinherited

Definition at line 282 of file lib_tree_model_adapter.h.

References m_parent.

◆ GetTreeNodeFor()

LIB_TREE_NODE * LIB_TREE_MODEL_ADAPTER::GetTreeNodeFor ( const wxDataViewItem & aSelection ) const

inherited

Definition at line 502 of file lib_tree_model_adapter.cpp.

References ToNode().

◆ GetTypeFor()

LIB_TREE_NODE::TYPE LIB_TREE_MODEL_ADAPTER::GetTypeFor ( const wxDataViewItem & aSelection ) const

inherited

Return node type for the given item.

Parameters

aSelection item from the wxDataViewCtrl (see wxDataViewCtrl::GetSelection())

Returns: Type of the selected node, might be INVALID.

Definition at line 495 of file lib_tree_model_adapter.cpp.

References LIB_TREE_NODE::m_Type, and ToNode().

◆ GetUnitFor()

int LIB_TREE_MODEL_ADAPTER::GetUnitFor ( const wxDataViewItem & aSelection ) const

inherited

Return the unit for the given item.

Parameters

aSelection item from the wxDataViewCtrl (see wxDataViewCtrl::GetSelection())

Returns: Unit, or zero if the alias itself is selected. Return valid is invalid if GetAliasFor() returns nullptr.

Definition at line 488 of file lib_tree_model_adapter.cpp.

References LIB_TREE_NODE::m_Unit, and ToNode().

◆ GetValue()

void LIB_TREE_MODEL_ADAPTER::GetValue	(	wxVariant &	aVariant,
		const wxDataViewItem &	aItem,
		unsigned int	aCol ) const

overrideprotectedinherited

Get the value of an item.

Parameters

aVariant	wxVariant to receive the data
aItem	item whose data will be placed into aVariant
aCol	column number of the data

Definition at line 678 of file lib_tree_model_adapter.cpp.

References GetPinningSymbol(), IsFrozen(), m_colIdxMap, LIB_TREE_NODE::m_Desc, LIB_TREE_NODE::m_Fields, LIB_TREE_NODE::m_Name, LIB_TREE_NODE::m_Pinned, NAME_COL, ToNode(), and UnescapeString().

◆ HasContainerColumns()

bool LIB_TREE_MODEL_ADAPTER::HasContainerColumns ( const wxDataViewItem & aItem ) const

overrideprotectedinherited

Check whether a container has columns too.

Definition at line 645 of file lib_tree_model_adapter.cpp.

References IsContainer().

◆ HasPreview()

virtual bool LIB_TREE_MODEL_ADAPTER::HasPreview ( const wxDataViewItem & aItem )

inlinevirtualinherited

Reimplemented in FP_TREE_SYNCHRONIZING_ADAPTER, and SYMBOL_TREE_SYNCHRONIZING_ADAPTER.

Definition at line 278 of file lib_tree_model_adapter.h.

◆ IsContainer()

bool LIB_TREE_MODEL_ADAPTER::IsContainer ( const wxDataViewItem & aItem ) const

overrideprotectedinherited

Check whether an item can have children.

Definition at line 651 of file lib_tree_model_adapter.cpp.

References LIB_TREE_NODE::m_Children, and ToNode().

Referenced by HasContainerColumns().

◆ IsFrozen()

bool LIB_TREE_MODEL_ADAPTER::IsFrozen ( ) const

inlineinherited

Definition at line 320 of file lib_tree_model_adapter.h.

References m_freeze.

Referenced by FP_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), GetAttr(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), GetValue(), and SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue().

◆ OpenLibs()

void LIB_TREE_MODEL_ADAPTER::OpenLibs ( const std::vector< wxString > & aLibs )

inherited

Definition at line 183 of file lib_tree_model_adapter.cpp.

References FindItem(), and m_widget.

◆ PinLibrary()

void LIB_TREE_MODEL_ADAPTER::PinLibrary ( LIB_TREE_NODE * aTreeNode )

inherited

Definition at line 394 of file lib_tree_model_adapter.cpp.

References LIB_ID::GetLibNickname(), getLibType(), LIB_TREE_NODE::m_LibId, m_parent, LIB_TREE_NODE::m_Pinned, m_widget, resortTree(), and ToItem().

◆ recreateColumns()

void LIB_TREE_MODEL_ADAPTER::recreateColumns ( )

protectedinherited

Definition at line 358 of file lib_tree_model_adapter.cpp.

References createMissingColumns(), doAddColumn(), m_colIdxMap, m_colNameMap, m_columns, and m_widget.

Referenced by AttachTo(), SetShownColumns(), and ShowChangedLanguage().

◆ RefreshTree()

void LIB_TREE_MODEL_ADAPTER::RefreshTree ( )

inherited

Definition at line 600 of file lib_tree_model_adapter.cpp.

References m_colNameMap, m_columns, and m_colWidths.

◆ RegisterLazyLoadHandler()

void LIB_TREE_MODEL_ADAPTER::RegisterLazyLoadHandler ( std::function< void()> && aHandler )

inlineinherited

Registers a function to be called whenever new lazy-loaded library content is available.

Definition at line 199 of file lib_tree_model_adapter.h.

References m_lazyLoadHandler.

◆ RemoveGroup()

void LIB_TREE_MODEL_ADAPTER::RemoveGroup	(	bool	aRecentlyUsedGroup,
		bool	aAlreadyPlacedGroup )

inherited

Remove one of the system groups from the library.

Definition at line 256 of file lib_tree_model_adapter.cpp.

References m_tree.

◆ resortTree()

void LIB_TREE_MODEL_ADAPTER::resortTree ( )

protectedinherited

Definition at line 382 of file lib_tree_model_adapter.cpp.

References BEST_MATCH, Freeze(), m_sort_mode, m_tree, and Thaw().

Referenced by PinLibrary(), and UnpinLibrary().

◆ SaveSettings()

void LIB_TREE_MODEL_ADAPTER::SaveSettings ( )

inherited

Save the column widths to the config file.

This requires the tree view to still be valid.

Definition at line 197 of file lib_tree_model_adapter.cpp.

References GetOpenLibs(), GetShownColumns(), m_cfg, m_colNameMap, and m_widget.

◆ SetFilter()

void LIB_TREE_MODEL_ADAPTER::SetFilter ( std::function< bool(LIB_TREE_NODE &aNode)> * aFilter )

inlineinherited

Set the filter.

Must be set before adding libraries.

Definition at line 147 of file lib_tree_model_adapter.h.

References m_filter.

Referenced by PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER(), and PANEL_SYMBOL_CHOOSER::PANEL_SYMBOL_CHOOSER().

◆ SetPreselectNode()

void LIB_TREE_MODEL_ADAPTER::SetPreselectNode	(	const LIB_ID &	aLibId,
		int	aUnit )

inherited

Set the symbol name to be selected if there are no search results.

May be set at any time; updates at the next UpdateSearchString().

Parameters

aLibId	symbol LIB_ID to be selected
aUnit	unit to be selected, if > 0 (0 selects the alias itself)

Definition at line 221 of file lib_tree_model_adapter.cpp.

References m_preselect_lib_id, and m_preselect_unit.

Referenced by PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER(), PANEL_SYMBOL_CHOOSER::PANEL_SYMBOL_CHOOSER(), and PANEL_DESIGN_BLOCK_CHOOSER::RefreshLibs().

◆ SetShownColumns()

void LIB_TREE_MODEL_ADAPTER::SetShownColumns ( const std::vector< wxString > & aColumnNames )

inherited

Sets which columns are shown in the widget.

Invalid column names are discarded.

Parameters

aColumnNames is an ordered list of column names to show

Definition at line 467 of file lib_tree_model_adapter.cpp.

References m_shownColumns, m_tree, m_widget, and recreateColumns().

◆ SetSortMode()

void LIB_TREE_MODEL_ADAPTER::SetSortMode ( SORT_MODE aMode )

inlineinherited

Definition at line 154 of file lib_tree_model_adapter.h.

References m_sort_mode.

◆ SetValue()

bool LIB_TREE_MODEL_ADAPTER::SetValue	(	const wxVariant &	aVariant,
		const wxDataViewItem &	aItem,
		unsigned int	aCol )

inlineoverrideprotectedinherited

Set the value of an item.

Does nothing - this model doesn't support editing.

Definition at line 395 of file lib_tree_model_adapter.h.

◆ ShowChangedLanguage()

void LIB_TREE_MODEL_ADAPTER::ShowChangedLanguage ( )

inherited

Definition at line 414 of file lib_tree_model_adapter.cpp.

References _, m_tree, and recreateColumns().

◆ ShowPreview()

virtual void LIB_TREE_MODEL_ADAPTER::ShowPreview	(	wxWindow *	aParent,
		const wxDataViewItem &	aItem )

inlinevirtualinherited

Reimplemented in FP_TREE_SYNCHRONIZING_ADAPTER, and SYMBOL_TREE_SYNCHRONIZING_ADAPTER.

Definition at line 279 of file lib_tree_model_adapter.h.

◆ ShowResults()

const LIB_TREE_NODE * LIB_TREE_MODEL_ADAPTER::ShowResults ( )

privateinherited

Find and expand successful search results.

Return the best match (if any).

Definition at line 764 of file lib_tree_model_adapter.cpp.

References LIB_TREE_NODE::m_Children, LIB_TREE_NODE::m_LibId, LIB_TREE_NODE::m_Name, LIB_TREE_NODE::m_Parent, m_preselect_lib_id, m_preselect_unit, LIB_TREE_NODE::m_Score, m_tree, LIB_TREE_NODE::m_Type, LIB_TREE_NODE::m_Unit, m_widget, recursiveDescent(), and ToItem().

Referenced by UpdateSearchString().

◆ ShowUnits()

void LIB_TREE_MODEL_ADAPTER::ShowUnits ( bool aShow )

inherited

Whether or not to show units.

May be set at any time; updates at the next UpdateSearchString()

Parameters

aShow if true, units are displayed

Definition at line 215 of file lib_tree_model_adapter.cpp.

References m_show_units.

◆ ShutdownPreview()

virtual void LIB_TREE_MODEL_ADAPTER::ShutdownPreview ( wxWindow * aParent )

inlinevirtualinherited

Reimplemented in FP_TREE_SYNCHRONIZING_ADAPTER, and SYMBOL_TREE_SYNCHRONIZING_ADAPTER.

Definition at line 280 of file lib_tree_model_adapter.h.

◆ Thaw()

void LIB_TREE_MODEL_ADAPTER::Thaw ( )

inlineinherited

Definition at line 319 of file lib_tree_model_adapter.h.

References m_freeze.

Referenced by resortTree(), and UpdateSearchString().

◆ ToItem()

wxDataViewItem LIB_TREE_MODEL_ADAPTER::ToItem ( const LIB_TREE_NODE * aNode )

staticprotectedinherited

Convert #SYM_TREE_NODE -> wxDataViewItem.

Definition at line 117 of file lib_tree_model_adapter.cpp.

Referenced by FindItem(), FP_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), GetChildren(), GetParent(), PinLibrary(), ShowResults(), and UpdateSearchString().

◆ ToNode()

LIB_TREE_NODE * LIB_TREE_MODEL_ADAPTER::ToNode ( wxDataViewItem aItem )

staticprotectedinherited

◆ UnpinLibrary()

void LIB_TREE_MODEL_ADAPTER::UnpinLibrary ( LIB_TREE_NODE * aTreeNode )

inherited

Definition at line 404 of file lib_tree_model_adapter.cpp.

References LIB_ID::GetLibNickname(), getLibType(), LIB_TREE_NODE::m_LibId, m_parent, LIB_TREE_NODE::m_Pinned, and resortTree().

◆ UpdateSearchString()

void LIB_TREE_MODEL_ADAPTER::UpdateSearchString	(	const wxString &	aSearch,
		bool	aState )

inherited

Set the search string provided by the user.

Parameters

aSearch	full, unprocessed search text
aState	if true, we are keeping the state and so we shouldn't collapse the tree

Definition at line 262 of file lib_tree_model_adapter.cpp.

References BEST_MATCH, CTX_LIBITEM, Freeze(), GetParent(), m_filter, m_sort_mode, m_tree, m_widget, ShowResults(), Thaw(), and ToItem().

Member Data Documentation

◆ m_adapter

SYMBOL_LIBRARY_ADAPTER* SYMBOL_TREE_MODEL_ADAPTER::m_adapter

private

Definition at line 73 of file symbol_tree_model_adapter.h.

Referenced by AddLibraries(), AddLibrary(), GenerateInfo(), and SYMBOL_TREE_MODEL_ADAPTER().

◆ m_availableColumns

std::vector<wxString> LIB_TREE_MODEL_ADAPTER::m_availableColumns

protectedinherited

Definition at line 431 of file lib_tree_model_adapter.h.

Referenced by addColumnIfNecessary(), GetAvailableColumns(), LIB_TREE_MODEL_ADAPTER(), and SYMBOL_TREE_MODEL_ADAPTER::SYMBOL_TREE_MODEL_ADAPTER().

◆ m_cfg

APP_SETTINGS_BASE::LIB_TREE& LIB_TREE_MODEL_ADAPTER::m_cfg

privateinherited

Definition at line 439 of file lib_tree_model_adapter.h.

Referenced by LIB_TREE_MODEL_ADAPTER(), and SaveSettings().

◆ m_check_pending_libraries_timer

std::unique_ptr<wxTimer> SYMBOL_TREE_MODEL_ADAPTER::m_check_pending_libraries_timer

private

Definition at line 76 of file symbol_tree_model_adapter.h.

Referenced by AddLibraries(), and SYMBOL_TREE_MODEL_ADAPTER().

◆ m_colIdxMap

std::map<unsigned, wxString> LIB_TREE_MODEL_ADAPTER::m_colIdxMap

protectedinherited

Definition at line 430 of file lib_tree_model_adapter.h.

Referenced by doAddColumn(), FinishTreeInitialization(), GetValue(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue(), and recreateColumns().

◆ m_colNameMap

std::map<wxString, wxDataViewColumn*> LIB_TREE_MODEL_ADAPTER::m_colNameMap

privateinherited

Definition at line 450 of file lib_tree_model_adapter.h.

Referenced by addColumnIfNecessary(), createMissingColumns(), doAddColumn(), recreateColumns(), RefreshTree(), and SaveSettings().

◆ m_columns

std::vector<wxDataViewColumn*> LIB_TREE_MODEL_ADAPTER::m_columns

privateinherited

Definition at line 449 of file lib_tree_model_adapter.h.

Referenced by doAddColumn(), FinishTreeInitialization(), GetColumnCount(), recreateColumns(), and RefreshTree().

◆ m_colWidths

std::map<wxString, int> LIB_TREE_MODEL_ADAPTER::m_colWidths

privateinherited

Definition at line 451 of file lib_tree_model_adapter.h.

Referenced by doAddColumn(), FinishTreeInitialization(), LIB_TREE_MODEL_ADAPTER(), and RefreshTree().

◆ m_filter

std::function<bool( LIB_TREE_NODE& aNode )>* LIB_TREE_MODEL_ADAPTER::m_filter

privateinherited

Definition at line 447 of file lib_tree_model_adapter.h.

Referenced by GetFilter(), LIB_TREE_MODEL_ADAPTER(), SetFilter(), and UpdateSearchString().

◆ m_freeze

int LIB_TREE_MODEL_ADAPTER::m_freeze

privateinherited

Definition at line 445 of file lib_tree_model_adapter.h.

Referenced by Freeze(), GetParent(), IsFrozen(), LIB_TREE_MODEL_ADAPTER(), and Thaw().

◆ m_lazyLoadHandler

std::function<void()> LIB_TREE_MODEL_ADAPTER::m_lazyLoadHandler

protectedinherited

Definition at line 435 of file lib_tree_model_adapter.h.

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), LIB_TREE_MODEL_ADAPTER(), and RegisterLazyLoadHandler().

◆ m_parent

EDA_BASE_FRAME* LIB_TREE_MODEL_ADAPTER::m_parent

privateinherited

Definition at line 438 of file lib_tree_model_adapter.h.

Referenced by GetToolDispatcher(), LIB_TREE_MODEL_ADAPTER(), PinLibrary(), and UnpinLibrary().

◆ m_pending_load_libraries

std::set<wxString> SYMBOL_TREE_MODEL_ADAPTER::m_pending_load_libraries

private

Definition at line 75 of file symbol_tree_model_adapter.h.

Referenced by AddLibraries().

◆ m_preselect_lib_id

LIB_ID LIB_TREE_MODEL_ADAPTER::m_preselect_lib_id

privateinherited

Definition at line 443 of file lib_tree_model_adapter.h.

Referenced by GetCurrentDataViewItem(), SetPreselectNode(), and ShowResults().

◆ m_preselect_unit

int LIB_TREE_MODEL_ADAPTER::m_preselect_unit

privateinherited

Definition at line 444 of file lib_tree_model_adapter.h.

Referenced by LIB_TREE_MODEL_ADAPTER(), SetPreselectNode(), and ShowResults().

◆ m_show_progress

bool SYMBOL_TREE_MODEL_ADAPTER::m_show_progress = true

staticprivate

Flag to only show the symbol library table load progress dialog the first time.

Definition at line 71 of file symbol_tree_model_adapter.h.

◆ m_show_units

bool LIB_TREE_MODEL_ADAPTER::m_show_units

privateinherited

Definition at line 442 of file lib_tree_model_adapter.h.

Referenced by GetChildren(), LIB_TREE_MODEL_ADAPTER(), and ShowUnits().

◆ m_shownColumns

std::vector<wxString> LIB_TREE_MODEL_ADAPTER::m_shownColumns

protectedinherited

Definition at line 434 of file lib_tree_model_adapter.h.

Referenced by DESIGN_BLOCK_TREE_MODEL_ADAPTER::AddLibraries(), FP_TREE_MODEL_ADAPTER::AddLibraries(), SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), AssignIntrinsicRanks(), createMissingColumns(), DoAddLibrary(), GetShownColumns(), LIB_TREE_MODEL_ADAPTER(), SetShownColumns(), FP_TREE_SYNCHRONIZING_ADAPTER::Sync(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FP_TREE_SYNCHRONIZING_ADAPTER::updateLibrary(), and SYMBOL_TREE_SYNCHRONIZING_ADAPTER::updateLibrary().

◆ m_sort_mode

SORT_MODE LIB_TREE_MODEL_ADAPTER::m_sort_mode

privateinherited

Definition at line 441 of file lib_tree_model_adapter.h.

Referenced by GetSortMode(), LIB_TREE_MODEL_ADAPTER(), resortTree(), SetSortMode(), and UpdateSearchString().

◆ m_tree

◆ m_widget

wxDataViewCtrl* LIB_TREE_MODEL_ADAPTER::m_widget

protectedinherited

Definition at line 433 of file lib_tree_model_adapter.h.

Referenced by AttachTo(), doAddColumn(), FinishTreeInitialization(), FP_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), GetOpenLibs(), LIB_TREE_MODEL_ADAPTER(), OpenLibs(), PinLibrary(), recreateColumns(), SaveSettings(), SetShownColumns(), ShowResults(), and UpdateSearchString().

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ SORT_MODE

◆ TREE_COLS

Constructor & Destructor Documentation

◆ ~SYMBOL_TREE_MODEL_ADAPTER()

◆ SYMBOL_TREE_MODEL_ADAPTER()

Member Function Documentation

◆ addColumnIfNecessary()

◆ AddLibraries()

◆ AddLibrary()

◆ AssignIntrinsicRanks()

◆ AttachTo()

◆ Create()

◆ createMissingColumns()

◆ doAddColumn()

◆ DoAddLibrary()

◆ DoAddLibraryNode()

◆ FindItem()

◆ FinishTreeInitialization()

◆ Freeze()

◆ GenerateInfo()

◆ GetAliasFor()

◆ GetAttr()

◆ GetAvailableColumns()

◆ GetChildren()

◆ GetColumnCount()

◆ GetColumnType()

◆ GetContextMenuTool()

◆ GetCurrentDataViewItem()

◆ GetFilter()

◆ GetItemCount()

◆ GetLibrariesCount()

◆ getLibType()

◆ GetOpenLibs()

◆ GetParent()

◆ GetPinningSymbol()

◆ GetShownColumns()

◆ GetSortMode()

◆ GetToolDispatcher()

◆ GetTreeNodeFor()

◆ GetTypeFor()

◆ GetUnitFor()

◆ GetValue()

◆ HasContainerColumns()

◆ HasPreview()

◆ IsContainer()

◆ IsFrozen()

◆ OpenLibs()

◆ PinLibrary()

◆ recreateColumns()

◆ RefreshTree()

◆ RegisterLazyLoadHandler()

◆ RemoveGroup()

◆ resortTree()

◆ SaveSettings()

◆ SetFilter()

◆ SetPreselectNode()

◆ SetShownColumns()

◆ SetSortMode()

◆ SetValue()

◆ ShowChangedLanguage()

◆ ShowPreview()

◆ ShowResults()

◆ ShowUnits()

◆ ShutdownPreview()

◆ Thaw()

◆ ToItem()

◆ ToNode()

◆ UnpinLibrary()

◆ UpdateSearchString()