#include <symbol_tree_synchronizing_adapter.h>

Inheritance diagram for SYMBOL_TREE_SYNCHRONIZING_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...

Public Member Functions
bool	IsContainer (const wxDataViewItem &aItem) const override

void	Sync (const wxString &aForceRefresh, std::function< void(int, int, const wxString &)> aProgressCallback)

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

TOOL_INTERACTIVE *	GetContextMenuTool () 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	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...

void	AddColumn (const wxString &aHeader)

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

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

int	GetItemCount () const
	Return the number of symbols 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 ()

void	PinLibrary (LIB_TREE_NODE *aTreeNode)

void	UnpinLibrary (LIB_TREE_NODE *aTreeNode)

Static Public Member Functions
static wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER >	Create (SYMBOL_EDIT_FRAME aParent, SYMBOL_LIBRARY_MANAGER aLibs)

static const wxString	GetPinningSymbol ()

Protected Member Functions
void	updateLibrary (LIB_TREE_NODE_LIB &aLibNode)

LIB_TREE_NODE::PTR_VECTOR::iterator	deleteLibrary (LIB_TREE_NODE::PTR_VECTOR::iterator &aLibNodeIt)

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

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

	SYMBOL_TREE_SYNCHRONIZING_ADAPTER (SYMBOL_EDIT_FRAME aParent, SYMBOL_LIBRARY_MANAGER aLibMgr)

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

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

bool	SetValue (const wxVariant &aVariant, const wxDataViewItem &aItem, unsigned int aCol) override
	Set the value of 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
SYMBOL_EDIT_FRAME *	m_frame

SYMBOL_LIBRARY_MANAGER *	m_libMgr
	Hashes to decide whether a library needs an update. More...

std::map< wxString, int >	m_libHashes
	SYMBOL_LIBRARY_MANAGER hash value returned in the last synchronization. More...

int	m_lastSyncHash

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, LIB_TREE_NODE *aHighScore)
	Find any results worth highlighting and expand them, according to given criteria The highest-scoring node is written to aHighScore. More...

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

LIB_TREE_NODE *	ShowPreselect ()
	Find and expand preselected node. More...

LIB_TREE_NODE *	ShowSingleLibrary ()
	Find and expand a library if there is only one. More...

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

Private Attributes
EDA_BASE_FRAME *	m_parent

SYM_FILTER_TYPE	m_filter

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 36 of file symbol_tree_synchronizing_adapter.h.

Member Enumeration Documentation

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

 {
 SYM_FILTER_NONE, 
 SYM_FILTER_POWER, 
 };

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

 {
 NAME_COL = 0, 
 DESC_COL, 
 NUM_COLS 
 };

Constructor & Destructor Documentation

◆ SYMBOL_TREE_SYNCHRONIZING_ADAPTER()

SYMBOL_TREE_SYNCHRONIZING_ADAPTER::SYMBOL_TREE_SYNCHRONIZING_ADAPTER	(	SYMBOL_EDIT_FRAME *	aParent,
		SYMBOL_LIBRARY_MANAGER *	aLibMgr
	)

protected

Definition at line 44 of file symbol_tree_synchronizing_adapter.cpp.

 :
 LIB_TREE_MODEL_ADAPTER( aParent, "pinned_symbol_libs" ),
 m_frame( aParent ),
 m_libMgr( aLibMgr ),
 m_lastSyncHash( -1 )
{
}

Referenced by Create().

Member Function Documentation

◆ AddColumn()

void LIB_TREE_MODEL_ADAPTER::AddColumn ( const wxString & aHeader )

inlineinherited

Definition at line 184 of file lib_tree_model_adapter.h.

 {
 doAddColumn( aHeader, false );
 }

References LIB_TREE_MODEL_ADAPTER::doAddColumn().

◆ addColumnIfNecessary()

void LIB_TREE_MODEL_ADAPTER::addColumnIfNecessary ( const wxString & aHeader )

protectedinherited

Definition at line 335 of file lib_tree_model_adapter.cpp.

{
 if( m_colNameMap.count( aHeader ) )
 return;
 
 // Columns will be created later
 m_colNameMap[aHeader] = nullptr;
 m_availableColumns.emplace_back( aHeader );
}

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

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibraries().

◆ AssignIntrinsicRanks()

void LIB_TREE_MODEL_ADAPTER::AssignIntrinsicRanks ( )

inlineinherited

Sort the tree and assign ranks after adding libraries.

Definition at line 202 of file lib_tree_model_adapter.h.

202{ m_tree.AssignIntrinsicRanks(); }

LIB_TREE_MODEL_ADAPTER::m_tree

LIB_TREE_NODE_ROOT m_tree

Definition: lib_tree_model_adapter.h:422

LIB_TREE_NODE::AssignIntrinsicRanks

void AssignIntrinsicRanks(bool presorted=false)

Store intrinsic ranks on all children of this node.

Definition: lib_tree_model.cpp:62

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

{
 m_widget = aDataViewCtrl;
 aDataViewCtrl->SetIndent( kDataViewIndent );
 aDataViewCtrl->AssociateModel( this );
 recreateColumns();
}

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

◆ Create()

wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Create	(	SYMBOL_EDIT_FRAME *	aParent,
		SYMBOL_LIBRARY_MANAGER *	aLibs
	)

static

Definition at line 36 of file symbol_tree_synchronizing_adapter.cpp.

{
 auto* adapter = new SYMBOL_TREE_SYNCHRONIZING_ADAPTER( aParent, aLibMgr );
 return wxObjectDataPtr<LIB_TREE_MODEL_ADAPTER>( adapter );
}

References SYMBOL_TREE_SYNCHRONIZING_ADAPTER().

Referenced by LIB_SYMBOL_LIBRARY_MANAGER::LIB_SYMBOL_LIBRARY_MANAGER().

◆ deleteLibrary()

LIB_TREE_NODE::PTR_VECTOR::iterator SYMBOL_TREE_SYNCHRONIZING_ADAPTER::deleteLibrary ( LIB_TREE_NODE::PTR_VECTOR::iterator & aLibNodeIt )

protected

Definition at line 202 of file symbol_tree_synchronizing_adapter.cpp.

{
 LIB_TREE_NODE* node = aLibNodeIt->get();
 m_libHashes.erase( node->m_Name );
 auto it = m_tree.m_Children.erase( aLibNodeIt );
 return it;
}

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

Referenced by Sync().

◆ doAddColumn()

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

privateinherited

Definition at line 309 of file lib_tree_model_adapter.cpp.

{
 wxString translatedHeader = aTranslate ? wxGetTranslation( aHeader ) : aHeader;
 
 // The extent of the text doesn't take into account the space on either side
 // in the header, so artificially pad it
 wxSize headerMinWidth = KIUI::GetTextSize( translatedHeader + wxT( "MMM" ), m_widget );
 
 if( !m_colWidths.count( aHeader ) || m_colWidths[aHeader] < headerMinWidth.x )
 m_colWidths[aHeader] = headerMinWidth.x;
 
 int index = m_columns.size();
 
 wxDataViewColumn* ret = m_widget->AppendTextColumn( translatedHeader, index,
 wxDATAVIEW_CELL_INERT,
 m_colWidths[aHeader] );
 ret->SetMinWidth( headerMinWidth.x );
 
 m_columns.emplace_back( ret );
 m_colNameMap[aHeader] = ret;
 m_colIdxMap[m_columns.size() - 1] = aHeader;
 
 return ret;
}

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::AddColumn(), and 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 146 of file lib_tree_model_adapter.cpp.

{
 LIB_TREE_NODE_LIB& lib_node = DoAddLibraryNode( aNodeName, aDesc, pinned );
 
 for( LIB_TREE_ITEM* item: aItemList )
 lib_node.AddItem( item );
 
 lib_node.AssignIntrinsicRanks( presorted );
}

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

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), FP_TREE_MODEL_ADAPTER::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 135 of file lib_tree_model_adapter.cpp.

{
 LIB_TREE_NODE_LIB& lib_node = m_tree.AddLib( aNodeName, aDesc );
 
 lib_node.m_Pinned = pinned;
 
 return lib_node;
}

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

◆ Find()

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

privateinherited

Find any results worth highlighting and expand them, according to given criteria The highest-scoring node is written to aHighScore.

Definition at line 622 of file lib_tree_model_adapter.cpp.

{
 for( std::unique_ptr<LIB_TREE_NODE>& node: aNode.m_Children )
 {
 if( aFunc( &*node ) )
 {
 if( !(*aHighScore) || node->m_Score > (*aHighScore)->m_Score )
 (*aHighScore) = &*node;
 }
 
 Find( *node, aFunc, aHighScore );
 }
}

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

Referenced by LIB_TREE_MODEL_ADAPTER::Find(), LIB_TREE_MODEL_ADAPTER::ShowPreselect(), LIB_TREE_MODEL_ADAPTER::ShowResults(), and LIB_TREE_MODEL_ADAPTER::ShowSingleLibrary().

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

{
 for( std::unique_ptr<LIB_TREE_NODE>& lib: m_tree.m_Children )
 {
 if( lib->m_Name != aLibId.GetLibNickname() )
 continue;
 
 // if part name is not specified, return the library node
 if( aLibId.GetLibItemName() == "" )
 return ToItem( lib.get() );
 
 for( std::unique_ptr<LIB_TREE_NODE>& alias: lib->m_Children )
 {
 if( alias->m_Name == aLibId.GetLibItemName() )
 return ToItem( alias.get() );
 }
 
 break; // could not find the part in the requested library
 }
 
 return wxDataViewItem();
}

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

{
 wxDataViewColumn* col = nullptr;
 size_t idx = 0;
 int totalWidth = 0;
 wxString header;
 
 for( ; idx < m_columns.size() - 1; idx++ )
 {
 wxASSERT( m_colIdxMap.count( idx ) );
 
 col = m_columns[idx];
 header = m_colIdxMap[idx];
 
 wxASSERT( m_colWidths.count( header ) );
 
 col->SetWidth( m_colWidths[header] );
 totalWidth += col->GetWidth();
 }
 
 int remainingWidth = m_widget->GetSize().x - totalWidth;
 header = m_columns[idx]->GetTitle();
 
 m_columns[idx]->SetWidth( std::max( m_colWidths[header], remainingWidth ) );
}

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 294 of file lib_tree_model_adapter.h.

294{ m_freeze++; }

LIB_TREE_MODEL_ADAPTER::m_freeze

int m_freeze

Definition: lib_tree_model_adapter.h:433

References LIB_TREE_MODEL_ADAPTER::m_freeze.

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

◆ GenerateInfo()

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

inlinevirtualinherited

Reimplemented in SYMBOL_TREE_MODEL_ADAPTER, and FP_TREE_MODEL_ADAPTER.

Definition at line 260 of file lib_tree_model_adapter.h.

260{ return wxEmptyString; };

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

{
 const LIB_TREE_NODE* node = ToNode( aSelection );
 
 LIB_ID emptyId;
 
 if( !node )
 return emptyId;
 
 return node->m_LibId;
}

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

◆ GetAttr()

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

overrideprotected

Definition at line 282 of file symbol_tree_synchronizing_adapter.cpp.

{
 if( IsFrozen() )
 return false;
 
 LIB_TREE_NODE* node = ToNode( aItem );
 wxCHECK( node, false );
 
 // Mark both columns of unloaded libraries using grey text color (to look disabled)
 if( node->m_Type == LIB_TREE_NODE::LIB && !m_libMgr->IsLibraryLoaded( node->m_Name ) )
 {
 aAttr.SetColour( wxSystemSettings::GetColour( wxSYS_COLOUR_GRAYTEXT ) );
 return true;
 }
 
 // The remaining attributes are only for the name column
 if( aCol != NAME_COL )
 return false;
 
 LIB_SYMBOL* curSymbol = m_frame->GetCurSymbol();
 
 switch( node->m_Type )
 {
 case LIB_TREE_NODE::LIB:
 // mark modified libs with bold font
 aAttr.SetBold( m_libMgr->IsLibraryModified( node->m_Name ) );
 
 // mark the current library with background color
 if( curSymbol && curSymbol->GetLibId().GetLibNickname() == node->m_LibId.GetLibNickname() )
 {
#ifdef __WXGTK__
 // The native wxGTK+ impl ignores background colour, so set the text colour instead.
 // This works reasonably well in dark themes, and quite poorly in light ones....
 aAttr.SetColour( wxSystemSettings::GetColour( wxSYS_COLOUR_HIGHLIGHT ) );
#else
 aAttr.SetBackgroundColour( wxSystemSettings::GetColour( wxSYS_COLOUR_HIGHLIGHT ) );
 aAttr.SetColour( wxSystemSettings::GetColour( wxSYS_COLOUR_LISTBOXHIGHLIGHTTEXT ) );
#endif
 }
 break;
 
 case LIB_TREE_NODE::LIBID:
 // mark modified part with bold font
 aAttr.SetBold( m_libMgr->IsSymbolModified( node->m_Name, node->m_Parent->m_Name ) );
 
 // mark aliases with italic font
 aAttr.SetItalic( !node->m_IsRoot );
 
 // mark the current part with background color
 if( curSymbol && curSymbol->GetLibId() == node->m_LibId )
 {
#ifdef __WXGTK__
 // The native wxGTK+ impl ignores background colour, so set the text colour instead.
 // This works reasonably well in dark themes, and quite poorly in light ones....
 aAttr.SetColour( wxSystemSettings::GetColour( wxSYS_COLOUR_HIGHLIGHT ) );
#else
 aAttr.SetBackgroundColour( wxSystemSettings::GetColour( wxSYS_COLOUR_HIGHLIGHT ) );
 aAttr.SetColour( wxSystemSettings::GetColour( wxSYS_COLOUR_LISTBOXHIGHLIGHTTEXT ) );
#endif
 }
 break;
 
 default:
 return false;
 }
 
 return true;
}

References SYMBOL_EDIT_FRAME::GetCurSymbol(), LIB_SYMBOL::GetLibId(), LIB_ID::GetLibNickname(), LIB_TREE_MODEL_ADAPTER::IsFrozen(), SYMBOL_LIBRARY_MANAGER::IsLibraryLoaded(), SYMBOL_LIBRARY_MANAGER::IsLibraryModified(), SYMBOL_LIBRARY_MANAGER::IsSymbolModified(), LIB_TREE_NODE::LIB, LIB_TREE_NODE::LIBID, m_frame, LIB_TREE_NODE::m_IsRoot, LIB_TREE_NODE::m_LibId, m_libMgr, LIB_TREE_NODE::m_Name, LIB_TREE_NODE::m_Parent, LIB_TREE_NODE::m_Type, LIB_TREE_MODEL_ADAPTER::NAME_COL, and LIB_TREE_MODEL_ADAPTER::ToNode().

◆ GetAvailableColumns()

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

inlineinherited

Definition at line 189 of file lib_tree_model_adapter.h.

189{ return m_availableColumns; }

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

{
 const LIB_TREE_NODE* node = ( aItem.IsOk() ? ToNode( aItem ) : &m_tree );
 
 if( node->m_Type == LIB_TREE_NODE::TYPE::ROOT
 || node->m_Type == LIB_TREE_NODE::LIB
 || ( m_show_units && node->m_Type == LIB_TREE_NODE::TYPE::LIBID ) )
 {
 return IntoArray( *node, aChildren );
 }
 else
 {
 return 0;
 }
 
}

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 350 of file lib_tree_model_adapter.h.

350{ return m_columns.size(); }

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 355 of file lib_tree_model_adapter.h.

355{ return "string"; }

◆ GetContextMenuTool()

TOOL_INTERACTIVE * SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool ( )

overridevirtual

Reimplemented from LIB_TREE_MODEL_ADAPTER.

Definition at line 54 of file symbol_tree_synchronizing_adapter.cpp.

{
 return m_frame->GetToolManager()->GetTool<SYMBOL_EDITOR_CONTROL>();
}

References TOOL_MANAGER::GetTool(), TOOLS_HOLDER::GetToolManager(), and m_frame.

◆ GetFilter()

SYM_FILTER_TYPE LIB_TREE_MODEL_ADAPTER::GetFilter ( ) const

inlineinherited

Return the active filter.

Definition at line 153 of file lib_tree_model_adapter.h.

153{ return m_filter; }

LIB_TREE_MODEL_ADAPTER::m_filter

SYM_FILTER_TYPE m_filter

Definition: lib_tree_model_adapter.h:429

References LIB_TREE_MODEL_ADAPTER::m_filter.

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

◆ GetItemCount()

int LIB_TREE_MODEL_ADAPTER::GetItemCount ( ) const

inherited

Return the number of symbols loaded in the tree.

Definition at line 390 of file lib_tree_model_adapter.cpp.

{
 int n = 0;
 
 for( const std::unique_ptr<LIB_TREE_NODE>& lib: m_tree.m_Children )
 n += lib->m_Children.size();
 
 return n;
}

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

int SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetLibrariesCount ( ) const

overridevirtual

Return the number of libraries loaded in the tree.

Reimplemented from LIB_TREE_MODEL_ADAPTER.

Definition at line 138 of file symbol_tree_synchronizing_adapter.cpp.

{
 int count = LIB_TREE_MODEL_ADAPTER::GetLibrariesCount();
 
 for( const wxString& libName : m_libMgr->GetLibraryNames() )
 {
 if( m_libHashes.count( libName ) == 0 )
 ++count;
 }
 
 return count;
}

References LIB_TREE_MODEL_ADAPTER::GetLibrariesCount(), SYMBOL_LIBRARY_MANAGER::GetLibraryNames(), m_libHashes, and m_libMgr.

Referenced by Sync().

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

{
 if( m_freeze )
 return ToItem( nullptr );
 
 LIB_TREE_NODE* node = ToNode( aItem );
 LIB_TREE_NODE* parent = node ? node->m_Parent : nullptr;
 
 // wxDataViewModel has no root node, but rather top-level elements have
 // an invalid (null) parent.
 if( !node || !parent || parent->m_Type == LIB_TREE_NODE::TYPE::ROOT )
 return ToItem( nullptr );
 else
 return ToItem( parent );
}

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.

 {
 return wxString::FromUTF8( "☆ " );
 }

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(), 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 191 of file lib_tree_model_adapter.h.

191{ return m_shownColumns; }

LIB_TREE_MODEL_ADAPTER::m_shownColumns

std::vector< wxString > m_shownColumns

Definition: lib_tree_model_adapter.h:440

References LIB_TREE_MODEL_ADAPTER::m_shownColumns.

Referenced by LIB_TREE_MODEL_ADAPTER::SaveSettings().

◆ GetTreeNodeFor()

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

inherited

Definition at line 384 of file lib_tree_model_adapter.cpp.

{
 return ToNode( aSelection );
}

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

{
 const LIB_TREE_NODE* node = ToNode( aSelection );
 return node ? node->m_Type : LIB_TREE_NODE::INVALID;
}

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

{
 const LIB_TREE_NODE* node = ToNode( aSelection );
 return node ? node->m_Unit : 0;
}

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

◆ GetValue()

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

overrideprotected

Definition at line 211 of file symbol_tree_synchronizing_adapter.cpp.

{
 if( IsFrozen() )
 {
 aVariant = wxEmptyString;
 return;
 }
 
 LIB_TREE_NODE* node = ToNode( aItem );
 wxASSERT( node );
 
 switch( aCol )
 {
 case NAME_COL:
 if( m_frame->GetCurSymbol() && m_frame->GetCurSymbol()->GetLibId() == node->m_LibId )
 node->m_Name = m_frame->GetCurSymbol()->GetLibId().GetLibItemName();
 
 if( node->m_Pinned )
 aVariant = GetPinningSymbol() + UnescapeString( node->m_Name );
 else
 aVariant = UnescapeString( node->m_Name );
 
 // mark modified items with an asterisk
 if( node->m_Type == LIB_TREE_NODE::LIB )
 {
 if( m_libMgr->IsLibraryModified( node->m_Name ) )
 aVariant = aVariant.GetString() + " *";
 }
 else if( node->m_Type == LIB_TREE_NODE::LIBID )
 {
 if( m_libMgr->IsSymbolModified( node->m_Name, node->m_Parent->m_Name ) )
 aVariant = aVariant.GetString() + " *";
 }
 
 break;
 
 default:
 if( m_colIdxMap.count( aCol ) )
 {
 if( node->m_Type == LIB_TREE_NODE::LIB )
 {
 LIB_SYMBOL_LIBRARY_MANAGER& libMgr = m_frame->GetLibManager();
 SYMBOL_LIB_TABLE_ROW* lib = libMgr.GetLibrary( node->m_LibId.GetLibNickname() );
 
 if( lib )
 node->m_Desc = lib->GetDescr();
 
 if( !m_libMgr->IsLibraryLoaded( node->m_Name ) )
 aVariant = _( "(failed to load)" ) + wxS( " " ) + aVariant.GetString();
 }
 
 const wxString& key = m_colIdxMap.at( aCol );
 
 if( m_frame->GetCurSymbol() && m_frame->GetCurSymbol()->GetLibId() == node->m_LibId )
 {
 node->m_Desc = m_frame->GetCurSymbol()->GetDescription();
 }
 
 if( node->m_Fields.count( key ) )
 aVariant = node->m_Fields.at( key );
 else if( key == wxT( "Description" ) )
 aVariant = node->m_Desc;
 else
 aVariant = wxEmptyString;
 }
 break;
 }
}

References _, SYMBOL_EDIT_FRAME::GetCurSymbol(), LIB_TABLE_ROW::GetDescr(), LIB_SYMBOL::GetDescription(), LIB_SYMBOL::GetLibId(), LIB_ID::GetLibItemName(), SYMBOL_EDIT_FRAME::GetLibManager(), LIB_ID::GetLibNickname(), SYMBOL_LIBRARY_MANAGER::GetLibrary(), LIB_TREE_MODEL_ADAPTER::GetPinningSymbol(), LIB_TREE_MODEL_ADAPTER::IsFrozen(), SYMBOL_LIBRARY_MANAGER::IsLibraryLoaded(), SYMBOL_LIBRARY_MANAGER::IsLibraryModified(), SYMBOL_LIBRARY_MANAGER::IsSymbolModified(), LIB_TREE_NODE::LIB, LIB_TREE_NODE::LIBID, LIB_TREE_MODEL_ADAPTER::m_colIdxMap, LIB_TREE_NODE::m_Desc, LIB_TREE_NODE::m_Fields, m_frame, LIB_TREE_NODE::m_LibId, m_libMgr, LIB_TREE_NODE::m_Name, LIB_TREE_NODE::m_Parent, LIB_TREE_NODE::m_Pinned, LIB_TREE_NODE::m_Type, 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 522 of file lib_tree_model_adapter.cpp.

{
 return IsContainer( aItem );
}

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.

{
 unsigned int n = 0;
 
 for( std::unique_ptr<LIB_TREE_NODE> const& child: aNode.m_Children )
 {
 if( child->m_Score > 0 )
 {
 aChildren.Add( ToItem( &*child ) );
 ++n;
 }
 }
 
 return n;
}

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

Referenced by LIB_TREE_MODEL_ADAPTER::GetChildren().

◆ IsContainer()

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

override

Definition at line 60 of file symbol_tree_synchronizing_adapter.cpp.

{
 const LIB_TREE_NODE* node = ToNode( aItem );
 return node ? node->m_Type == LIB_TREE_NODE::LIB : true;
}

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

◆ IsFrozen()

bool LIB_TREE_MODEL_ADAPTER::IsFrozen ( ) const

inlineinherited

Definition at line 296 of file lib_tree_model_adapter.h.

296{ return m_freeze; }

References LIB_TREE_MODEL_ADAPTER::m_freeze.

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

◆ isSymbolModel()

bool SYMBOL_TREE_SYNCHRONIZING_ADAPTER::isSymbolModel ( )

inlineoverrideprotectedvirtual

Implements LIB_TREE_MODEL_ADAPTER.

Definition at line 64 of file symbol_tree_synchronizing_adapter.h.

64{ return true; }

◆ OnSize()

void LIB_TREE_MODEL_ADAPTER::OnSize ( wxSizeEvent & aEvent )

inherited

Definition at line 471 of file lib_tree_model_adapter.cpp.

{
 aEvent.Skip();
}

◆ PinLibrary()

void LIB_TREE_MODEL_ADAPTER::PinLibrary ( LIB_TREE_NODE * aTreeNode )

inherited

Definition at line 289 of file lib_tree_model_adapter.cpp.

{
 m_parent->Prj().PinLibrary( aTreeNode->m_LibId.GetLibNickname(), isSymbolModel() );
 aTreeNode->m_Pinned = true;
 
 resortTree();
 m_widget->EnsureVisible( ToItem( aTreeNode ) );
}

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

{
 m_widget->ClearColumns();
 
 m_columns.clear();
 m_colIdxMap.clear();
 m_colNameMap.clear();
 
 // The Item column is always shown
 doAddColumn( wxT( "Item" ) );
 
 for( const wxString& colName : m_shownColumns )
 {
 if( !m_colNameMap.count( colName ) )
 doAddColumn( colName, false );
 }
}

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(), and LIB_TREE_MODEL_ADAPTER::SetShownColumns().

◆ RefreshTree()

void LIB_TREE_MODEL_ADAPTER::RefreshTree ( )

inherited

Definition at line 477 of file lib_tree_model_adapter.cpp.

{
 // Yes, this is an enormous hack. But it works on all platforms, it doesn't suffer
 // the On^2 sorting issues that ItemChanged() does on OSX, and it doesn't lose the
 // user's scroll position (which re-attaching or deleting/re-inserting columns does).
 static int walk = 1;
 
 std::vector<int> widths;
 
 for( const wxDataViewColumn* col : m_columns )
 widths.emplace_back( col->GetWidth() );
 
 wxASSERT( widths.size() );
 
 // Only use the widths read back if they are non-zero.
 // GTK returns the displayed width of the column, which is not calculated immediately
 if( widths[0] > 0 )
 {
 size_t i = 0;
 
 for( const auto& [ colName, colPtr ] : m_colNameMap )
 m_colWidths[ colName ] = widths[i++];
 }
 
 auto colIt = m_colWidths.begin();
 
 colIt->second += walk;
 colIt++;
 
 if( colIt != m_colWidths.end() )
 colIt->second -= walk;
 
 for( const auto& [ colName, colPtr ] : m_colNameMap )
 {
 if( colPtr == m_columns[0] )
 continue;
 
 wxASSERT( m_colWidths.count( colName ) );
 colPtr->SetWidth( m_colWidths[ colName ] );
 }
 
 walk = -walk;
}

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

{
 Freeze();
 BeforeReset();
 
 m_tree.SortNodes();
 
 AfterReset();
 Thaw();
}

References LIB_TREE_MODEL_ADAPTER::Freeze(), 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 101 of file lib_tree_model_adapter.cpp.

{
 if( m_widget )
 {
 APP_SETTINGS_BASE* cfg = Kiface().KifaceSettings();
 
 cfg->m_LibTree.columns = GetShownColumns();
 cfg->m_LibTree.column_widths.clear();
 
 for( const std::pair<const wxString, wxDataViewColumn*>& pair : m_colNameMap )
 cfg->m_LibTree.column_widths[pair.first] = pair.second->GetWidth();
 }
}

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

{
 m_filter = aFilter;
}

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

{
 m_preselect_lib_id = aLibId;
 m_preselect_unit = aUnit;
}

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

{
 bool recreate = m_shownColumns != aColumnNames;
 
 m_shownColumns = aColumnNames;
 
 if( recreate && m_widget )
 recreateColumns();
}

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

◆ 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 372 of file lib_tree_model_adapter.h.

374 { return false; }

◆ ShowPreselect()

LIB_TREE_NODE * LIB_TREE_MODEL_ADAPTER::ShowPreselect ( )

privateinherited

Find and expand preselected node.

Return the best match (if any).

Definition at line 661 of file lib_tree_model_adapter.cpp.

{
 LIB_TREE_NODE* highScore = nullptr;
 
 if( !m_preselect_lib_id.IsValid() )
 return highScore;
 
 Find( m_tree,
 [&]( LIB_TREE_NODE const* n )
 {
 if( n->m_Type == LIB_TREE_NODE::LIBID && ( n->m_Children.empty() ||
 !m_preselect_unit ) )
 return m_preselect_lib_id == n->m_LibId;
 else if( n->m_Type == LIB_TREE_NODE::UNIT && m_preselect_unit )
 return m_preselect_lib_id == n->m_Parent->m_LibId &&
 m_preselect_unit == n->m_Unit;
 else
 return false;
 },
 &highScore );
 
 if( highScore)
 {
 wxDataViewItem item = wxDataViewItem( highScore );
 m_widget->ExpandAncestors( item );
 }
 
 return highScore;
}

References LIB_TREE_MODEL_ADAPTER::Find(), 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_MODEL_ADAPTER::m_tree, LIB_TREE_NODE::m_Type, LIB_TREE_NODE::m_Unit, LIB_TREE_MODEL_ADAPTER::m_widget, and LIB_TREE_NODE::UNIT.

Referenced by LIB_TREE_MODEL_ADAPTER::UpdateSearchString().

◆ ShowResults()

LIB_TREE_NODE * LIB_TREE_MODEL_ADAPTER::ShowResults ( )

privateinherited

Find and expand successful search results.

Return the best match (if any).

Definition at line 639 of file lib_tree_model_adapter.cpp.

{
 LIB_TREE_NODE* highScore = nullptr;
 
 Find( m_tree,
 []( LIB_TREE_NODE const* n )
 {
 // return leaf nodes with some level of matching
 return n->m_Type == LIB_TREE_NODE::TYPE::LIBID && n->m_Score > 1;
 },
 &highScore );
 
 if( highScore)
 {
 wxDataViewItem item = wxDataViewItem( highScore );
 m_widget->ExpandAncestors( item );
 }
 
 return highScore;
}

References LIB_TREE_MODEL_ADAPTER::Find(), LIB_TREE_NODE::m_Score, LIB_TREE_MODEL_ADAPTER::m_tree, LIB_TREE_NODE::m_Type, and LIB_TREE_MODEL_ADAPTER::m_widget.

Referenced by LIB_TREE_MODEL_ADAPTER::UpdateSearchString().

◆ ShowSingleLibrary()

LIB_TREE_NODE * LIB_TREE_MODEL_ADAPTER::ShowSingleLibrary ( )

privateinherited

Find and expand a library if there is only one.

Return the best match (if any).

Definition at line 692 of file lib_tree_model_adapter.cpp.

{
 LIB_TREE_NODE* highScore = nullptr;
 
 Find( m_tree,
 []( LIB_TREE_NODE const* n )
 {
 return n->m_Type == LIB_TREE_NODE::TYPE::LIBID &&
 n->m_Parent->m_Parent->m_Children.size() == 1;
 },
 &highScore );
 
 if( highScore)
 {
 wxDataViewItem item = wxDataViewItem( highScore );
 m_widget->ExpandAncestors( item );
 }
 
 return highScore;
}

References LIB_TREE_MODEL_ADAPTER::Find(), LIB_TREE_NODE::m_Children, LIB_TREE_NODE::m_Parent, LIB_TREE_MODEL_ADAPTER::m_tree, LIB_TREE_NODE::m_Type, and LIB_TREE_MODEL_ADAPTER::m_widget.

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

{
 m_show_units = aShow;
}

References LIB_TREE_MODEL_ADAPTER::m_show_units.

◆ Sync()

void SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync	(	const wxString &	aForceRefresh,
		std::function< void(int, int, const wxString &)>	aProgressCallback
	)

Definition at line 69 of file symbol_tree_synchronizing_adapter.cpp.

{
 wxLongLong nextUpdate = wxGetUTCTimeMillis() + (PROGRESS_INTERVAL_MILLIS / 2);
 
 m_lastSyncHash = m_libMgr->GetHash();
 int i = 0, max = GetLibrariesCount();
 
 // Process already stored libraries
 for( auto it = m_tree.m_Children.begin(); it != m_tree.m_Children.end(); /* iteration inside */ )
 {
 const wxString& name = it->get()->m_Name;
 
 if( wxGetUTCTimeMillis() > nextUpdate )
 {
 aProgressCallback( i, max, name );
 nextUpdate = wxGetUTCTimeMillis() + PROGRESS_INTERVAL_MILLIS;
 }
 
 // There is a bug in SYMBOL_LIBRARY_MANAGER::LibraryExists() that uses the buffered
 // modified libraries before the symbol library table which prevents the library from
 // being removed from the tree control.
 if( !m_libMgr->LibraryExists( name, true )
 || !m_frame->Prj().SchSymbolLibTable()->HasLibrary( name, true )
 || m_frame->Prj().SchSymbolLibTable()->FindRow( name, true ) !=
 m_frame->Prj().SchSymbolLibTable()->FindRow( name, false )
 || name == aForceRefresh )
 {
 it = deleteLibrary( it );
 continue;
 }
 else
 {
 updateLibrary( *(LIB_TREE_NODE_LIB*) it->get() );
 }
 
 ++it;
 ++i;
 }
 
 // Look for new libraries
 //
 COMMON_SETTINGS* cfg = Pgm().GetCommonSettings();
 PROJECT_FILE& project = m_frame->Prj().GetProjectFile();
 
 for( const wxString& libName : m_libMgr->GetLibraryNames() )
 {
 if( m_libHashes.count( libName ) == 0 )
 {
 if( wxGetUTCTimeMillis() > nextUpdate )
 {
 aProgressCallback( i++, max, libName );
 nextUpdate = wxGetUTCTimeMillis() + PROGRESS_INTERVAL_MILLIS;
 }
 
 SYMBOL_LIB_TABLE_ROW* library = m_libMgr->GetLibrary( libName );
 bool pinned = alg::contains( cfg->m_Session.pinned_symbol_libs, libName )
 || alg::contains( project.m_PinnedSymbolLibs, libName );
 
 LIB_TREE_NODE_LIB& lib_node = DoAddLibraryNode( libName, library->GetDescr(), pinned );
 
 updateLibrary( lib_node );
 }
 }
 
 m_tree.AssignIntrinsicRanks();
}

References LIB_TREE_NODE::AssignIntrinsicRanks(), alg::contains(), deleteLibrary(), LIB_TREE_MODEL_ADAPTER::DoAddLibraryNode(), SYMBOL_LIBRARY_MANAGER::GetHash(), GetLibrariesCount(), SYMBOL_LIBRARY_MANAGER::GetLibrary(), SYMBOL_LIBRARY_MANAGER::GetLibraryNames(), PROJECT::GetProjectFile(), library, SYMBOL_LIBRARY_MANAGER::LibraryExists(), LIB_TREE_NODE::m_Children, m_frame, m_lastSyncHash, m_libHashes, m_libMgr, COMMON_SETTINGS::m_Session, LIB_TREE_MODEL_ADAPTER::m_tree, name, Pgm(), COMMON_SETTINGS::SESSION::pinned_symbol_libs, KIWAY_HOLDER::Prj(), PROGRESS_INTERVAL_MILLIS, project, and updateLibrary().

Referenced by LIB_SYMBOL_LIBRARY_MANAGER::Sync().

◆ Thaw()

void LIB_TREE_MODEL_ADAPTER::Thaw ( )

inlineinherited

Definition at line 295 of file lib_tree_model_adapter.h.

295{ m_freeze--; }

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.

{
 return wxDataViewItem( const_cast<void*>( static_cast<void const*>( aNode ) ) );
}

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

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

{
 return static_cast<LIB_TREE_NODE*>( aItem.GetID() );
}

◆ UnpinLibrary()

void LIB_TREE_MODEL_ADAPTER::UnpinLibrary ( LIB_TREE_NODE * aTreeNode )

inherited

Definition at line 299 of file lib_tree_model_adapter.cpp.

{
 m_parent->Prj().UnpinLibrary( aTreeNode->m_LibId.GetLibNickname(), isSymbolModel() );
 aTreeNode->m_Pinned = false;
 
 resortTree();
 // Keep focus at top when unpinning
}

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

◆ updateLibrary()

void SYMBOL_TREE_SYNCHRONIZING_ADAPTER::updateLibrary ( LIB_TREE_NODE_LIB & aLibNode )

protected

Definition at line 152 of file symbol_tree_synchronizing_adapter.cpp.

{
 auto hashIt = m_libHashes.find( aLibNode.m_Name );
 
 if( hashIt == m_libHashes.end() )
 {
 // add a new library
 for( LIB_SYMBOL* alias : m_libMgr->GetAliases( aLibNode.m_Name ) )
 aLibNode.AddItem( alias );
 }
 else if( hashIt->second != m_libMgr->GetLibraryHash( aLibNode.m_Name ) )
 {
 // update an existing library
 std::list<LIB_SYMBOL*> aliases = m_libMgr->GetAliases( aLibNode.m_Name );
 
 // remove the common part from the aliases list
 for( auto nodeIt = aLibNode.m_Children.begin(); nodeIt != aLibNode.m_Children.end(); )
 {
 auto aliasIt = std::find_if( aliases.begin(), aliases.end(),
 [&] ( const LIB_SYMBOL* a )
 {
 return a->GetName() == (*nodeIt)->m_LibId.GetLibItemName();
 } );
 
 if( aliasIt != aliases.end() )
 {
 // alias exists both in the symbol tree and the library manager,
 // update only the node data.
 static_cast<LIB_TREE_NODE_LIB_ID*>( nodeIt->get() )->Update( *aliasIt );
 aliases.erase( aliasIt );
 ++nodeIt;
 }
 else
 {
 // node does not exist in the library manager, remove the corresponding node
 nodeIt = aLibNode.m_Children.erase( nodeIt );
 }
 }
 
 // now the aliases list contains only new aliases that need to be added to the tree
 for( LIB_SYMBOL* alias : aliases )
 aLibNode.AddItem( alias );
 }
 
 aLibNode.AssignIntrinsicRanks();
 m_libHashes[aLibNode.m_Name] = m_libMgr->GetLibraryHash( aLibNode.m_Name );
}

References LIB_TREE_NODE_LIB::AddItem(), LIB_TREE_NODE::AssignIntrinsicRanks(), SYMBOL_LIBRARY_MANAGER::GetAliases(), SYMBOL_LIBRARY_MANAGER::GetLibraryHash(), LIB_TREE_NODE::m_Children, m_libHashes, m_libMgr, and LIB_TREE_NODE::m_Name.

Referenced by Sync().

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

{
 {
 wxWindowUpdateLocker updateLock( m_widget );
 
 // Even with the updateLock, wxWidgets sometimes ties its knickers in a knot trying to
 // run a wxdataview_selection_changed_callback() on a row that has been deleted.
 // https://bugs.launchpad.net/kicad/+bug/1756255
 m_widget->UnselectAll();
 
 // This collapse is required before the call to "Freeze()" below. Once Freeze()
 // is called, GetParent() will return nullptr. While this works for some calls, it
 // segfaults when we have any expanded elements b/c the sub units in the tree don't
 // have explicit references that are maintained over a search
 // The tree will be expanded again below when we get our matches
 //
 // Also note that this cannot happen when we have deleted a symbol as GTK will also
 // iterate over the tree in this case and find a symbol that has an invalid link
 // and crash https://gitlab.com/kicad/code/kicad/-/issues/6910
 if( !aState && !aSearch.IsNull() && m_tree.m_Children.size() )
 {
 for( std::unique_ptr<LIB_TREE_NODE>& child: m_tree.m_Children )
 m_widget->Collapse( wxDataViewItem( &*child ) );
 }
 
 // DO NOT REMOVE THE FREEZE/THAW. This freeze/thaw is a flag for this model adapter
 // that tells it when it shouldn't trust any of the data in the model. When set, it will
 // not return invalid data to the UI, since this invalid data can cause crashes.
 // This is different than the update locker, which locks the UI aspects only.
 Freeze();
 BeforeReset();
 
 m_tree.ResetScore();
 
 wxStringTokenizer tokenizer( aSearch );
 
 while( tokenizer.HasMoreTokens() )
 {
 wxString lib;
 wxString term = tokenizer.GetNextToken().Lower();
 
 if( term.Contains( ":" ) )
 {
 lib = term.BeforeFirst( ':' );
 term = term.AfterFirst( ':' );
 }
 
 EDA_COMBINED_MATCHER matcher( term, CTX_LIBITEM );
 
 m_tree.UpdateScore( matcher, lib );
 }
 
 m_tree.SortNodes();
 AfterReset();
 Thaw();
 }
 
 LIB_TREE_NODE* bestMatch = ShowResults();
 
 if( !bestMatch )
 bestMatch = ShowPreselect();
 
 if( !bestMatch )
 bestMatch = ShowSingleLibrary();
 
 if( bestMatch )
 {
 wxDataViewItem item = wxDataViewItem( bestMatch );
 m_widget->Select( item );
 
 // Make sure the *parent* item is visible. The selected item is the
 // first (shown) child of the parent. So it's always right below the parent,
 // and this way the user can also see what library the selected part belongs to,
  // without having a case where the selection is off the screen (unless the
 // window is a single row high, which is unlikely)
 //
 // This also happens to circumvent https://bugs.launchpad.net/kicad/+bug/1804400
 // which appears to be a GTK+3 bug.
 {
 wxDataViewItem parent = GetParent( item );
 
 if( parent.IsOk() )
 m_widget->EnsureVisible( parent );
 }
 
 m_widget->EnsureVisible( item );
 }
}

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

Member Data Documentation

◆ m_availableColumns

std::vector<wxString> LIB_TREE_MODEL_ADAPTER::m_availableColumns

protectedinherited

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

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

◆ m_colNameMap

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

privateinherited

Definition at line 438 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 437 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 439 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 429 of file lib_tree_model_adapter.h.

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

◆ m_frame

SYMBOL_EDIT_FRAME* SYMBOL_TREE_SYNCHRONIZING_ADAPTER::m_frame

protected

Definition at line 67 of file symbol_tree_synchronizing_adapter.h.

Referenced by GetAttr(), GetContextMenuTool(), GetValue(), and Sync().

◆ m_freeze

int LIB_TREE_MODEL_ADAPTER::m_freeze

privateinherited

Definition at line 433 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_lastSyncHash

int SYMBOL_TREE_SYNCHRONIZING_ADAPTER::m_lastSyncHash

protected

Definition at line 74 of file symbol_tree_synchronizing_adapter.h.

Referenced by Sync().

◆ m_libHashes

std::map<wxString, int> SYMBOL_TREE_SYNCHRONIZING_ADAPTER::m_libHashes

protected

SYMBOL_LIBRARY_MANAGER hash value returned in the last synchronization.

Definition at line 71 of file symbol_tree_synchronizing_adapter.h.

Referenced by deleteLibrary(), GetLibrariesCount(), Sync(), and updateLibrary().

◆ m_libMgr

SYMBOL_LIBRARY_MANAGER* SYMBOL_TREE_SYNCHRONIZING_ADAPTER::m_libMgr

protected

Hashes to decide whether a library needs an update.

Definition at line 68 of file symbol_tree_synchronizing_adapter.h.

Referenced by GetAttr(), GetLibrariesCount(), GetValue(), Sync(), and updateLibrary().

◆ m_parent

EDA_BASE_FRAME* LIB_TREE_MODEL_ADAPTER::m_parent

privateinherited

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

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

◆ m_preselect_unit

int LIB_TREE_MODEL_ADAPTER::m_preselect_unit

privateinherited

Definition at line 432 of file lib_tree_model_adapter.h.

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

◆ m_show_units

bool LIB_TREE_MODEL_ADAPTER::m_show_units

privateinherited

Definition at line 430 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 440 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_tree

LIB_TREE_NODE_ROOT LIB_TREE_MODEL_ADAPTER::m_tree

protectedinherited

Definition at line 422 of file lib_tree_model_adapter.h.

◆ m_widget

wxDataViewCtrl* LIB_TREE_MODEL_ADAPTER::m_widget

privateinherited

Definition at line 435 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(), LIB_TREE_MODEL_ADAPTER::ShowPreselect(), LIB_TREE_MODEL_ADAPTER::ShowResults(), LIB_TREE_MODEL_ADAPTER::ShowSingleLibrary(), 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

◆ SYM_FILTER_TYPE

◆ TREE_COLS

Constructor & Destructor Documentation

◆ SYMBOL_TREE_SYNCHRONIZING_ADAPTER()

Member Function Documentation

◆ AddColumn()

◆ addColumnIfNecessary()

◆ AssignIntrinsicRanks()

◆ AttachTo()

◆ Create()

◆ deleteLibrary()

◆ doAddColumn()

◆ DoAddLibrary()

◆ DoAddLibraryNode()

◆ Find()

◆ FindItem()

◆ FinishTreeInitialization()

◆ Freeze()

◆ GenerateInfo()

◆ GetAliasFor()

◆ GetAttr()

◆ GetAvailableColumns()

◆ GetChildren()

◆ GetColumnCount()

◆ GetColumnType()

◆ GetContextMenuTool()

◆ GetFilter()

◆ GetItemCount()

◆ GetLibrariesCount()

◆ GetParent()

◆ GetPinningSymbol()

◆ GetShownColumns()

◆ GetTreeNodeFor()

◆ GetTypeFor()

◆ GetUnitFor()

◆ GetValue()

◆ HasContainerColumns()

◆ IntoArray()

◆ IsContainer()

◆ IsFrozen()

◆ isSymbolModel()

◆ OnSize()

◆ PinLibrary()

◆ recreateColumns()

◆ RefreshTree()

◆ resortTree()

◆ SaveSettings()

◆ SetFilter()

◆ SetPreselectNode()

◆ SetShownColumns()

◆ SetValue()

◆ ShowPreselect()

◆ ShowResults()

◆ ShowSingleLibrary()

◆ ShowUnits()

◆ Sync()

◆ Thaw()

◆ ToItem()

◆ ToNode()

◆ UnpinLibrary()

◆ updateLibrary()

◆ UpdateSearchString()

Member Data Documentation

◆ m_availableColumns

◆ m_colIdxMap

◆ m_colNameMap

◆ m_columns

◆ m_colWidths

◆ m_filter

◆ m_frame