#include <fp_tree_model_adapter.h>

Inheritance diagram for FP_TREE_MODEL_ADAPTER:

Public Types
enum	SYM_FILTER_TYPE { SYM_FILTER_NONE , SYM_FILTER_POWER }
	This enum allows a selective filtering of symbols to list. More...

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
void	AddLibraries (EDA_BASE_FRAME *aParent)

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

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

void	SetFilter (SYM_FILTER_TYPE aFilter)
	Set the symbol filter type. More...

SYM_FILTER_TYPE	GetFilter () const
	Return the active filter. More...

void	SetSortMode (SORT_MODE aMode)

SORT_MODE	GetSortMode () const

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

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

void	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. More...

std::vector< wxString >	GetAvailableColumns () const

std::vector< wxString >	GetShownColumns () const

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

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

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

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

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

void	OnSize (wxSizeEvent &aEvent)

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

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

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

LIB_TREE_NODE *	GetTreeNodeFor (const wxDataViewItem &aSelection) const

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

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

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

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

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 (EDA_BASE_FRAME aParent, LIB_TABLE aLibs)
	Factory function: create a model adapter in a reference-counting container. More...

static const wxString	GetPinningSymbol ()

Protected Member Functions
	FP_TREE_MODEL_ADAPTER (EDA_BASE_FRAME aParent, LIB_TABLE aLibs)
	Constructor; takes a set of libraries to be included in the search. More...

std::vector< LIB_TREE_ITEM * >	getFootprints (const wxString &aLibName)

bool	isSymbolModel () override

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

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

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

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

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() More...

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

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

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

void	resortTree ()

void	addColumnIfNecessary (const wxString &aHeader)

void	recreateColumns ()

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

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

static unsigned int	IntoArray (const LIB_TREE_NODE &aNode, wxDataViewItemArray &aChildren)
	Convert SYM_TREE_NODE's children to wxDataViewItemArray. More...

Protected Attributes
FP_LIB_TABLE *	m_libs

LIB_TREE_NODE_ROOT	m_tree

std::map< unsigned, wxString >	m_colIdxMap

std::vector< wxString >	m_availableColumns

Private Member Functions
void	Find (LIB_TREE_NODE &aNode, std::function< bool(const LIB_TREE_NODE *)> aFunc)
	Find any results worth highlighting and expand them. More...

const LIB_TREE_NODE *	ShowResults ()
	Find and expand successful search results. More...

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

Private Attributes
EDA_BASE_FRAME *	m_parent

SYM_FILTER_TYPE	m_filter

SORT_MODE	m_sort_mode

bool	m_show_units

LIB_ID	m_preselect_lib_id

int	m_preselect_unit

int	m_freeze

wxDataViewCtrl *	m_widget

std::vector< wxDataViewColumn * >	m_columns

std::map< wxString, wxDataViewColumn * >	m_colNameMap

std::map< wxString, int >	m_colWidths

std::vector< wxString >	m_shownColumns

Detailed Description

Definition at line 31 of file fp_tree_model_adapter.h.

Member Enumeration Documentation

◆ SORT_MODE

enum LIB_TREE_MODEL_ADAPTER::SORT_MODE

inherited

Enumerator
BEST_MATCH
ALPHABETIC

Definition at line 136 of file lib_tree_model_adapter.h.

◆ SYM_FILTER_TYPE

enum LIB_TREE_MODEL_ADAPTER::SYM_FILTER_TYPE

inherited

This enum allows a selective filtering of symbols to list.

Enumerator
SYM_FILTER_NONE	no filtering
SYM_FILTER_POWER	list symbols flagged PWR

Definition at line 120 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 129 of file lib_tree_model_adapter.h.

Constructor & Destructor Documentation

◆ FP_TREE_MODEL_ADAPTER()

FP_TREE_MODEL_ADAPTER::FP_TREE_MODEL_ADAPTER	(	EDA_BASE_FRAME *	aParent,
		LIB_TABLE *	aLibs
	)

protected

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

Definition at line 44 of file fp_tree_model_adapter.cpp.

Member Function Documentation

◆ addColumnIfNecessary()

void LIB_TREE_MODEL_ADAPTER::addColumnIfNecessary ( const wxString & aHeader )

protectedinherited

Definition at line 330 of file lib_tree_model_adapter.cpp.

References LIB_TREE_MODEL_ADAPTER::m_availableColumns, and LIB_TREE_MODEL_ADAPTER::m_colNameMap.

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibraries().

◆ AddLibraries()

void FP_TREE_MODEL_ADAPTER::AddLibraries ( EDA_BASE_FRAME * aParent )

Definition at line 50 of file fp_tree_model_adapter.cpp.

References LIB_TREE_NODE::AssignIntrinsicRanks(), alg::contains(), LIB_TREE_MODEL_ADAPTER::DoAddLibrary(), FP_LIB_TABLE::FindRow(), getFootprints(), LIB_TABLE::GetLogicalLibs(), PROJECT::GetProjectFile(), library, m_libs, COMMON_SETTINGS::m_Session, LIB_TREE_MODEL_ADAPTER::m_tree, Pgm(), COMMON_SETTINGS::SESSION::pinned_fp_libs, KIWAY_HOLDER::Prj(), and project.

Referenced by FOOTPRINT_EDIT_FRAME::initLibraryTree(), and PCB_BASE_FRAME::SelectFootprintFromLibTree().

◆ AssignIntrinsicRanks()

void LIB_TREE_MODEL_ADAPTER::AssignIntrinsicRanks ( )

inlineinherited

Sort the tree and assign ranks after adding libraries.

Definition at line 205 of file lib_tree_model_adapter.h.

References LIB_TREE_NODE::AssignIntrinsicRanks(), and LIB_TREE_MODEL_ADAPTER::m_tree.

Referenced by SCH_BASE_FRAME::PickSymbolFromLibTree().

◆ 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 244 of file lib_tree_model_adapter.cpp.

References kDataViewIndent, LIB_TREE_MODEL_ADAPTER::m_widget, and LIB_TREE_MODEL_ADAPTER::recreateColumns().

◆ Create()

wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > FP_TREE_MODEL_ADAPTER::Create	(	EDA_BASE_FRAME *	aParent,
		LIB_TABLE *	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 37 of file fp_tree_model_adapter.cpp.

Referenced by PCB_BASE_FRAME::SelectFootprintFromLibTree().

◆ doAddColumn()

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

privateinherited

Definition at line 304 of file lib_tree_model_adapter.cpp.

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

Referenced by LIB_TREE_MODEL_ADAPTER::recreateColumns().

◆ DoAddLibrary()

void 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 147 of file lib_tree_model_adapter.cpp.

References LIB_TREE_NODE_LIB::AddItem(), LIB_TREE_NODE::AssignIntrinsicRanks(), and LIB_TREE_MODEL_ADAPTER::DoAddLibraryNode().

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), AddLibraries(), SYMBOL_TREE_MODEL_ADAPTER::AddLibrary(), SCH_BASE_FRAME::PickSymbolFromLibTree(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), and FP_TREE_SYNCHRONIZING_ADAPTER::Sync().

◆ DoAddLibraryNode()

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

protectedinherited

Definition at line 136 of file lib_tree_model_adapter.cpp.

References LIB_TREE_NODE_ROOT::AddLib(), LIB_TREE_NODE::m_Pinned, and LIB_TREE_MODEL_ADAPTER::m_tree.

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

◆ Find()

void LIB_TREE_MODEL_ADAPTER::Find	(	LIB_TREE_NODE &	aNode,
		std::function< bool(const LIB_TREE_NODE *)>	aFunc
	)

privateinherited

Find any results worth highlighting and expand them.

◆ 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 396 of file lib_tree_model_adapter.cpp.

References LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), LIB_TREE_NODE::m_Children, LIB_TREE_MODEL_ADAPTER::m_tree, and LIB_TREE_MODEL_ADAPTER::ToItem().

◆ 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 439 of file lib_tree_model_adapter.cpp.

References LIB_TREE_MODEL_ADAPTER::m_colIdxMap, LIB_TREE_MODEL_ADAPTER::m_columns, LIB_TREE_MODEL_ADAPTER::m_colWidths, and LIB_TREE_MODEL_ADAPTER::m_widget.

◆ Freeze()

void LIB_TREE_MODEL_ADAPTER::Freeze ( )

inlineinherited

Definition at line 297 of file lib_tree_model_adapter.h.

References LIB_TREE_MODEL_ADAPTER::m_freeze.

Referenced by LIB_TREE_MODEL_ADAPTER::resortTree(), and LIB_TREE_MODEL_ADAPTER::UpdateSearchString().

◆ GenerateInfo()

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

overridevirtual

Reimplemented from LIB_TREE_MODEL_ADAPTER.

Definition at line 91 of file fp_tree_model_adapter.cpp.

References GenerateFootprintInfo(), and m_libs.

◆ 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 352 of file lib_tree_model_adapter.cpp.

References LIB_TREE_NODE::m_LibId, and LIB_TREE_MODEL_ADAPTER::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 588 of file lib_tree_model_adapter.cpp.

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

◆ GetAvailableColumns()

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

inlineinherited

Definition at line 192 of file lib_tree_model_adapter.h.

References LIB_TREE_MODEL_ADAPTER::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 420 of file lib_tree_model_adapter.cpp.

References LIB_TREE_MODEL_ADAPTER::IntoArray(), LIB_TREE_NODE::LIB, LIB_TREE_MODEL_ADAPTER::m_show_units, LIB_TREE_MODEL_ADAPTER::m_tree, LIB_TREE_NODE::m_Type, and LIB_TREE_MODEL_ADAPTER::ToNode().

◆ GetColumnCount()

unsigned int LIB_TREE_MODEL_ADAPTER::GetColumnCount ( ) const

inlineoverrideprotectedinherited

Definition at line 358 of file lib_tree_model_adapter.h.

References LIB_TREE_MODEL_ADAPTER::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 363 of file lib_tree_model_adapter.h.

◆ GetContextMenuTool()

virtual TOOL_INTERACTIVE * LIB_TREE_MODEL_ADAPTER::GetContextMenuTool ( )

inlinevirtualinherited

Reimplemented in SYMBOL_TREE_SYNCHRONIZING_ADAPTER, and FP_TREE_SYNCHRONIZING_ADAPTER.

Definition at line 304 of file lib_tree_model_adapter.h.

◆ GetFilter()

SYM_FILTER_TYPE LIB_TREE_MODEL_ADAPTER::GetFilter ( ) const

inlineinherited

Return the active filter.

Definition at line 158 of file lib_tree_model_adapter.h.

References LIB_TREE_MODEL_ADAPTER::m_filter.

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), SYMBOL_TREE_MODEL_ADAPTER::AddLibrary(), and SCH_BASE_FRAME::PickSymbolFromLibTree().

◆ getFootprints()

std::vector< LIB_TREE_ITEM * > FP_TREE_MODEL_ADAPTER::getFootprints ( const wxString & aLibName )

protected

Definition at line 68 of file fp_tree_model_adapter.cpp.

References dummy, FOOTPRINT_LIST::GetList(), GFootprintList, and StrNumCmp().

Referenced by AddLibraries(), FP_TREE_SYNCHRONIZING_ADAPTER::Sync(), and FP_TREE_SYNCHRONIZING_ADAPTER::updateLibrary().

◆ GetItemCount()

int LIB_TREE_MODEL_ADAPTER::GetItemCount ( ) const

inherited

Return the number of symbols loaded in the tree.

Definition at line 385 of file lib_tree_model_adapter.cpp.

References LIB_TREE_NODE::m_Children, and LIB_TREE_MODEL_ADAPTER::m_tree.

Referenced by SYMBOL_VIEWER_FRAME::OnSelectSymbol(), and PCB_BASE_FRAME::SelectFootprintFromLibTree().

◆ GetLibrariesCount()

virtual int LIB_TREE_MODEL_ADAPTER::GetLibrariesCount ( ) const

inlinevirtualinherited

Return the number of libraries loaded in the tree.

Reimplemented in SYMBOL_TREE_SYNCHRONIZING_ADAPTER, and FP_TREE_SYNCHRONIZING_ADAPTER.

Definition at line 273 of file lib_tree_model_adapter.h.

References LIB_TREE_NODE::m_Children, and LIB_TREE_MODEL_ADAPTER::m_tree.

Referenced by SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetLibrariesCount().

◆ 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 530 of file lib_tree_model_adapter.cpp.

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

Referenced by LIB_TREE_MODEL_ADAPTER::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 105 of file lib_tree_model_adapter.h.

Referenced by CVPCB_MAINFRAME::BuildLibrariesListBox(), FOOTPRINT_EDIT_FRAME::buildSaveAsDialog(), SYMBOL_EDIT_FRAME::buildSaveAsDialog(), WX_LISTBOX::FindString(), WX_LISTBOX::GetBaseString(), LIBRARY_LISTBOX::GetSelectedLibrary(), WX_LISTBOX::GetStringSelection(), EDA_LIST_DIALOG::GetTextSelection(), LIB_TREE_MODEL_ADAPTER::GetValue(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), SYMBOL_VIEWER_FRAME::ReCreateLibList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), PCB_BASE_FRAME::SelectLibrary(), SCH_BASE_FRAME::SelectLibraryFromList(), and WX_LISTBOX::SetStringSelection().

◆ GetShownColumns()

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

inlineinherited

Definition at line 194 of file lib_tree_model_adapter.h.

References LIB_TREE_MODEL_ADAPTER::m_shownColumns.

Referenced by LIB_TREE_MODEL_ADAPTER::SaveSettings().

◆ GetSortMode()

SORT_MODE LIB_TREE_MODEL_ADAPTER::GetSortMode ( ) const

inlineinherited

Definition at line 161 of file lib_tree_model_adapter.h.

References LIB_TREE_MODEL_ADAPTER::m_sort_mode.

◆ GetTreeNodeFor()

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

inherited

Definition at line 379 of file lib_tree_model_adapter.cpp.

References LIB_TREE_MODEL_ADAPTER::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 372 of file lib_tree_model_adapter.cpp.

References LIB_TREE_NODE::INVALID, LIB_TREE_NODE::m_Type, and LIB_TREE_MODEL_ADAPTER::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 365 of file lib_tree_model_adapter.cpp.

References LIB_TREE_NODE::m_Unit, and LIB_TREE_MODEL_ADAPTER::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 547 of file lib_tree_model_adapter.cpp.

References LIB_TREE_MODEL_ADAPTER::GetPinningSymbol(), LIB_TREE_MODEL_ADAPTER::IsFrozen(), LIB_TREE_MODEL_ADAPTER::m_colIdxMap, LIB_TREE_NODE::m_Desc, LIB_TREE_NODE::m_Fields, LIB_TREE_NODE::m_Name, LIB_TREE_NODE::m_Pinned, LIB_TREE_MODEL_ADAPTER::NAME_COL, LIB_TREE_MODEL_ADAPTER::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 517 of file lib_tree_model_adapter.cpp.

References LIB_TREE_MODEL_ADAPTER::IsContainer().

◆ IntoArray()

unsigned int LIB_TREE_MODEL_ADAPTER::IntoArray	(	const LIB_TREE_NODE &	aNode,
		wxDataViewItemArray &	aChildren
	)

staticprotectedinherited

Convert SYM_TREE_NODE's children to wxDataViewItemArray.

Definition at line 49 of file lib_tree_model_adapter.cpp.

References LIB_TREE_NODE::m_Children, and LIB_TREE_MODEL_ADAPTER::ToItem().

Referenced by LIB_TREE_MODEL_ADAPTER::GetChildren().

◆ IsContainer()

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

overrideprotectedinherited

Check whether an item can have children.

Definition at line 523 of file lib_tree_model_adapter.cpp.

References LIB_TREE_NODE::m_Children, and LIB_TREE_MODEL_ADAPTER::ToNode().

Referenced by LIB_TREE_MODEL_ADAPTER::HasContainerColumns().

◆ IsFrozen()

bool LIB_TREE_MODEL_ADAPTER::IsFrozen ( ) const

inlineinherited

Definition at line 299 of file lib_tree_model_adapter.h.

References LIB_TREE_MODEL_ADAPTER::m_freeze.

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

◆ isSymbolModel()

bool FP_TREE_MODEL_ADAPTER::isSymbolModel ( )

inlineoverrideprotectedvirtual

Implements LIB_TREE_MODEL_ADAPTER.

Definition at line 54 of file fp_tree_model_adapter.h.

◆ OnSize()

void LIB_TREE_MODEL_ADAPTER::OnSize ( wxSizeEvent & aEvent )

inherited

Definition at line 466 of file lib_tree_model_adapter.cpp.

◆ PinLibrary()

void LIB_TREE_MODEL_ADAPTER::PinLibrary ( LIB_TREE_NODE * aTreeNode )

inherited

Definition at line 284 of file lib_tree_model_adapter.cpp.

References LIB_ID::GetLibNickname(), LIB_TREE_MODEL_ADAPTER::isSymbolModel(), LIB_TREE_NODE::m_LibId, LIB_TREE_MODEL_ADAPTER::m_parent, LIB_TREE_NODE::m_Pinned, LIB_TREE_MODEL_ADAPTER::m_widget, PROJECT::PinLibrary(), KIWAY_HOLDER::Prj(), LIB_TREE_MODEL_ADAPTER::resortTree(), and LIB_TREE_MODEL_ADAPTER::ToItem().

◆ recreateColumns()

void LIB_TREE_MODEL_ADAPTER::recreateColumns ( )

protectedinherited

Definition at line 253 of file lib_tree_model_adapter.cpp.

References LIB_TREE_MODEL_ADAPTER::doAddColumn(), LIB_TREE_MODEL_ADAPTER::m_colIdxMap, LIB_TREE_MODEL_ADAPTER::m_colNameMap, LIB_TREE_MODEL_ADAPTER::m_columns, LIB_TREE_MODEL_ADAPTER::m_shownColumns, and LIB_TREE_MODEL_ADAPTER::m_widget.

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

◆ RefreshTree()

void LIB_TREE_MODEL_ADAPTER::RefreshTree ( )

inherited

Definition at line 472 of file lib_tree_model_adapter.cpp.

References LIB_TREE_MODEL_ADAPTER::m_colNameMap, LIB_TREE_MODEL_ADAPTER::m_columns, and LIB_TREE_MODEL_ADAPTER::m_colWidths.

◆ resortTree()

void LIB_TREE_MODEL_ADAPTER::resortTree ( )

protectedinherited

Definition at line 272 of file lib_tree_model_adapter.cpp.

References LIB_TREE_MODEL_ADAPTER::BEST_MATCH, LIB_TREE_MODEL_ADAPTER::Freeze(), LIB_TREE_MODEL_ADAPTER::m_sort_mode, LIB_TREE_MODEL_ADAPTER::m_tree, LIB_TREE_NODE::SortNodes(), and LIB_TREE_MODEL_ADAPTER::Thaw().

Referenced by LIB_TREE_MODEL_ADAPTER::PinLibrary(), and LIB_TREE_MODEL_ADAPTER::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 102 of file lib_tree_model_adapter.cpp.

References APP_SETTINGS_BASE::LIB_TREE::column_widths, APP_SETTINGS_BASE::LIB_TREE::columns, LIB_TREE_MODEL_ADAPTER::GetShownColumns(), Kiface(), KIFACE_BASE::KifaceSettings(), LIB_TREE_MODEL_ADAPTER::m_colNameMap, APP_SETTINGS_BASE::m_LibTree, and LIB_TREE_MODEL_ADAPTER::m_widget.

Referenced by SYMBOL_VIEWER_FRAME::OnSelectSymbol(), SCH_BASE_FRAME::PickSymbolFromLibTree(), and PCB_BASE_FRAME::SelectFootprintFromLibTree().

◆ SetFilter()

void LIB_TREE_MODEL_ADAPTER::SetFilter ( SYM_FILTER_TYPE aFilter )

inherited

Set the symbol filter type.

Must be set before adding libraries

Parameters

aFilter if SYM_FILTER_POWER, only power parts are loaded

Definition at line 117 of file lib_tree_model_adapter.cpp.

References LIB_TREE_MODEL_ADAPTER::m_filter.

Referenced by SCH_BASE_FRAME::PickSymbolFromLibTree().

◆ 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 129 of file lib_tree_model_adapter.cpp.

References LIB_TREE_MODEL_ADAPTER::m_preselect_lib_id, and LIB_TREE_MODEL_ADAPTER::m_preselect_unit.

Referenced by SYMBOL_VIEWER_FRAME::OnSelectSymbol(), SCH_BASE_FRAME::PickSymbolFromLibTree(), and PCB_BASE_FRAME::SelectFootprintFromLibTree().

◆ 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 341 of file lib_tree_model_adapter.cpp.

References LIB_TREE_MODEL_ADAPTER::m_shownColumns, LIB_TREE_MODEL_ADAPTER::m_widget, and LIB_TREE_MODEL_ADAPTER::recreateColumns().

◆ SetSortMode()

void LIB_TREE_MODEL_ADAPTER::SetSortMode ( SORT_MODE aMode )

inlineinherited

Definition at line 160 of file lib_tree_model_adapter.h.

References LIB_TREE_MODEL_ADAPTER::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 380 of file lib_tree_model_adapter.h.

◆ ShowChangedLanguage()

void LIB_TREE_MODEL_ADAPTER::ShowChangedLanguage ( )

inlineinherited

Definition at line 309 of file lib_tree_model_adapter.h.

References LIB_TREE_MODEL_ADAPTER::recreateColumns().

◆ 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 629 of file lib_tree_model_adapter.cpp.

References LIB_ID::IsValid(), LIB_TREE_NODE::LIBID, LIB_TREE_NODE::m_Children, LIB_TREE_NODE::m_LibId, LIB_TREE_NODE::m_Parent, LIB_TREE_MODEL_ADAPTER::m_preselect_lib_id, LIB_TREE_MODEL_ADAPTER::m_preselect_unit, LIB_TREE_NODE::m_Score, LIB_TREE_MODEL_ADAPTER::m_tree, LIB_TREE_NODE::m_Type, LIB_TREE_NODE::m_Unit, recursiveDescent(), and LIB_TREE_NODE::UNIT.

Referenced by LIB_TREE_MODEL_ADAPTER::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 123 of file lib_tree_model_adapter.cpp.

References LIB_TREE_MODEL_ADAPTER::m_show_units.

◆ Thaw()

void LIB_TREE_MODEL_ADAPTER::Thaw ( )

inlineinherited

Definition at line 298 of file lib_tree_model_adapter.h.

References LIB_TREE_MODEL_ADAPTER::m_freeze.

Referenced by LIB_TREE_MODEL_ADAPTER::resortTree(), and LIB_TREE_MODEL_ADAPTER::UpdateSearchString().

◆ ToItem()

wxDataViewItem LIB_TREE_MODEL_ADAPTER::ToItem ( const LIB_TREE_NODE * aNode )

staticprotectedinherited

Convert #SYM_TREE_NODE -> wxDataViewItem.

Definition at line 37 of file lib_tree_model_adapter.cpp.

Referenced by LIB_TREE_MODEL_ADAPTER::FindItem(), LIB_TREE_MODEL_ADAPTER::GetParent(), LIB_TREE_MODEL_ADAPTER::IntoArray(), LIB_TREE_MODEL_ADAPTER::PinLibrary(), and LIB_TREE_MODEL_ADAPTER::UpdateSearchString().

◆ ToNode()

LIB_TREE_NODE * LIB_TREE_MODEL_ADAPTER::ToNode ( wxDataViewItem aItem )

staticprotectedinherited

Convert wxDataViewItem -> #SYM_TREE_NODE.

Definition at line 43 of file lib_tree_model_adapter.cpp.

◆ UnpinLibrary()

void LIB_TREE_MODEL_ADAPTER::UnpinLibrary ( LIB_TREE_NODE * aTreeNode )

inherited

Definition at line 294 of file lib_tree_model_adapter.cpp.

References LIB_ID::GetLibNickname(), LIB_TREE_MODEL_ADAPTER::isSymbolModel(), LIB_TREE_NODE::m_LibId, LIB_TREE_MODEL_ADAPTER::m_parent, LIB_TREE_NODE::m_Pinned, KIWAY_HOLDER::Prj(), LIB_TREE_MODEL_ADAPTER::resortTree(), and PROJECT::UnpinLibrary().

◆ 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 160 of file lib_tree_model_adapter.cpp.

References LIB_TREE_MODEL_ADAPTER::BEST_MATCH, CTX_LIBITEM, LIB_TREE_MODEL_ADAPTER::Freeze(), LIB_TREE_MODEL_ADAPTER::GetParent(), LIB_TREE_NODE::m_Children, LIB_TREE_MODEL_ADAPTER::m_sort_mode, LIB_TREE_MODEL_ADAPTER::m_tree, LIB_TREE_MODEL_ADAPTER::m_widget, LIB_TREE_NODE::ResetScore(), LIB_TREE_MODEL_ADAPTER::ShowResults(), LIB_TREE_NODE::SortNodes(), LIB_TREE_MODEL_ADAPTER::Thaw(), LIB_TREE_MODEL_ADAPTER::ToItem(), and LIB_TREE_NODE_ROOT::UpdateScore().

Member Data Documentation

◆ m_availableColumns

std::vector<wxString> LIB_TREE_MODEL_ADAPTER::m_availableColumns

protectedinherited

Definition at line 420 of file lib_tree_model_adapter.h.

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

◆ m_colIdxMap

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

protectedinherited

Definition at line 419 of file lib_tree_model_adapter.h.

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

◆ m_colNameMap

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

privateinherited

Definition at line 435 of file lib_tree_model_adapter.h.

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

◆ m_columns

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

privateinherited

Definition at line 434 of file lib_tree_model_adapter.h.

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

◆ m_colWidths

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

privateinherited

Definition at line 436 of file lib_tree_model_adapter.h.

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

◆ m_filter

SYM_FILTER_TYPE LIB_TREE_MODEL_ADAPTER::m_filter

privateinherited

Definition at line 425 of file lib_tree_model_adapter.h.

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

◆ m_freeze

int LIB_TREE_MODEL_ADAPTER::m_freeze

privateinherited

Definition at line 430 of file lib_tree_model_adapter.h.

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

◆ m_libs

FP_LIB_TABLE* FP_TREE_MODEL_ADAPTER::m_libs

protected

Definition at line 57 of file fp_tree_model_adapter.h.

Referenced by AddLibraries(), GenerateInfo(), and FP_TREE_SYNCHRONIZING_ADAPTER::Sync().

◆ m_parent

EDA_BASE_FRAME* LIB_TREE_MODEL_ADAPTER::m_parent

privateinherited

Definition at line 423 of file lib_tree_model_adapter.h.

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

◆ m_preselect_lib_id

LIB_ID LIB_TREE_MODEL_ADAPTER::m_preselect_lib_id

privateinherited

Definition at line 428 of file lib_tree_model_adapter.h.

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

◆ m_preselect_unit

int LIB_TREE_MODEL_ADAPTER::m_preselect_unit

privateinherited

Definition at line 429 of file lib_tree_model_adapter.h.

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

◆ m_show_units

bool LIB_TREE_MODEL_ADAPTER::m_show_units

privateinherited

Definition at line 427 of file lib_tree_model_adapter.h.

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

◆ m_shownColumns

std::vector<wxString> LIB_TREE_MODEL_ADAPTER::m_shownColumns

privateinherited

Definition at line 437 of file lib_tree_model_adapter.h.

Referenced by LIB_TREE_MODEL_ADAPTER::GetShownColumns(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), LIB_TREE_MODEL_ADAPTER::recreateColumns(), and LIB_TREE_MODEL_ADAPTER::SetShownColumns().

◆ m_sort_mode

SORT_MODE LIB_TREE_MODEL_ADAPTER::m_sort_mode

privateinherited

Definition at line 426 of file lib_tree_model_adapter.h.

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

◆ m_tree

LIB_TREE_NODE_ROOT LIB_TREE_MODEL_ADAPTER::m_tree

protectedinherited

Definition at line 418 of file lib_tree_model_adapter.h.

◆ m_widget

wxDataViewCtrl* LIB_TREE_MODEL_ADAPTER::m_widget

privateinherited

Definition at line 432 of file lib_tree_model_adapter.h.

Referenced by LIB_TREE_MODEL_ADAPTER::AttachTo(), LIB_TREE_MODEL_ADAPTER::doAddColumn(), LIB_TREE_MODEL_ADAPTER::FinishTreeInitialization(), LIB_TREE_MODEL_ADAPTER::PinLibrary(), LIB_TREE_MODEL_ADAPTER::recreateColumns(), LIB_TREE_MODEL_ADAPTER::SaveSettings(), LIB_TREE_MODEL_ADAPTER::SetShownColumns(), and LIB_TREE_MODEL_ADAPTER::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

Detailed Description

Member Enumeration Documentation

◆ SORT_MODE

◆ SYM_FILTER_TYPE

◆ TREE_COLS

Constructor & Destructor Documentation

◆ FP_TREE_MODEL_ADAPTER()

Member Function Documentation

◆ addColumnIfNecessary()

◆ AddLibraries()

◆ AssignIntrinsicRanks()

◆ AttachTo()

◆ Create()

◆ doAddColumn()

◆ DoAddLibrary()

◆ DoAddLibraryNode()

◆ Find()

◆ FindItem()

◆ FinishTreeInitialization()

◆ Freeze()

◆ GenerateInfo()

◆ GetAliasFor()

◆ GetAttr()

◆ GetAvailableColumns()

◆ GetChildren()

◆ GetColumnCount()

◆ GetColumnType()

◆ GetContextMenuTool()

◆ GetFilter()

◆ getFootprints()

◆ GetItemCount()

◆ GetLibrariesCount()

◆ GetParent()

◆ GetPinningSymbol()

◆ GetShownColumns()

◆ GetSortMode()

◆ GetTreeNodeFor()

◆ GetTypeFor()

◆ GetUnitFor()

◆ GetValue()

◆ HasContainerColumns()

◆ IntoArray()

◆ IsContainer()

◆ IsFrozen()

◆ isSymbolModel()

◆ OnSize()

◆ PinLibrary()

◆ recreateColumns()

◆ RefreshTree()

◆ resortTree()

◆ SaveSettings()

◆ SetFilter()

◆ SetPreselectNode()

◆ SetShownColumns()

◆ SetSortMode()

◆ SetValue()

◆ ShowChangedLanguage()

◆ ShowResults()

◆ ShowUnits()

◆ Thaw()

◆ ToItem()

◆ ToNode()

◆ UnpinLibrary()

◆ UpdateSearchString()

Member Data Documentation

◆ m_availableColumns

◆ m_colIdxMap

◆ m_colNameMap

◆ m_columns

◆ m_colWidths

◆ m_filter

◆ m_freeze