#include <cmp_tree_model_adapter.h>

Inheritance diagram for CMP_TREE_MODEL_ADAPTER:

Public Types
enum	CMP_FILTER_TYPE { CMP_FILTER_NONE, CMP_FILTER_POWER }
	This enum allows a selective filtering of components to list. More...

typedef wxObjectDataPtr< CMP_TREE_MODEL_ADAPTER_BASE >	PTR
	Reference-counting container for a pointer to CMP_TREE_MODEL_ADAPTER_BASE. More...

Public Member Functions
	~CMP_TREE_MODEL_ADAPTER ()
	Reference-counting container for a pointer to CMP_TREE_MODEL_ADAPTER. More...

void	AddLibrary (wxString const &aLibNickname) override
	Add all the components and their aliases in this library. More...

void	AddAliasList (wxString const &aNodeName, wxArrayString const &aAliasNameList) override
	Add the given list of components, by name. More...

void	SetFilter (CMP_FILTER_TYPE aFilter)
	Set the component filter type. More...

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

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

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

void	AddLibrariesWithProgress (const std::vector< wxString > &aNicknames, wxWindow *aParent)
	Add all the libraries in a SYMBOL_LIB_TABLE to the model, displaying a progress dialog attached to the parent frame. More...

void	AddAliasList (wxString const &aNodeName, wxString const &aDesc, std::vector< LIB_ALIAS * > const &aAliasList)
	Add the given list of components by alias. More...

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

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

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

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

int	GetComponentsCount () const
	Return the number of components 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...

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

void	Freeze ()

void	Thaw ()

bool	IsFrozen () const

Static Public Member Functions
static PTR	Create (SYMBOL_LIB_TABLE *aLibs)
	Factory function: create a model adapter in a reference-counting container. More...

Protected Member Functions
	CMP_TREE_MODEL_ADAPTER (SYMBOL_LIB_TABLE *aLibs)
	Constructor; takes a set of libraries to be included in the search. More...

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

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

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

virtual unsigned int	GetColumnCount () const override
	Return the number of columns in the model. More...

virtual wxString	GetColumnType (unsigned int aCol) const override
	Return the type of data stored in the column. More...

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

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

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

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

static CMP_TREE_NODE const *	ToNode (wxDataViewItem aItem)
	Convert wxDataViewItem -> CMP_TREE_NODE. More...

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

Protected Attributes
CMP_TREE_NODE_ROOT	m_tree

Private Attributes
SYMBOL_LIB_TABLE *	m_libs

Detailed Description

Definition at line 29 of file cmp_tree_model_adapter.h.

Member Typedef Documentation

typedef wxObjectDataPtr<CMP_TREE_MODEL_ADAPTER_BASE> CMP_TREE_MODEL_ADAPTER_BASE::PTR

inherited

Reference-counting container for a pointer to CMP_TREE_MODEL_ADAPTER_BASE.

Definition at line 99 of file cmp_tree_model_adapter_base.h.

Member Enumeration Documentation

enum CMP_TREE_MODEL_ADAPTER_BASE::CMP_FILTER_TYPE

inherited

This enum allows a selective filtering of components to list.

Enumerator
CMP_FILTER_NONE	no filtering
CMP_FILTER_POWER	list components flagged PWR

Definition at line 110 of file cmp_tree_model_adapter_base.h.

     {
         CMP_FILTER_NONE,        
         CMP_FILTER_POWER,       
     };

Constructor & Destructor Documentation

CMP_TREE_MODEL_ADAPTER::~CMP_TREE_MODEL_ADAPTER ( )

Reference-counting container for a pointer to CMP_TREE_MODEL_ADAPTER.

Destructor. Do NOT delete this class manually; it is reference-counted by wxObject.

Definition at line 42 of file cmp_tree_model_adapter.cpp.

43 {}

CMP_TREE_MODEL_ADAPTER::CMP_TREE_MODEL_ADAPTER ( SYMBOL_LIB_TABLE * aLibs )

protected

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

Definition at line 37 of file cmp_tree_model_adapter.cpp.

Referenced by Create().

38 : m_libs( aLibs )

39 {}

CMP_TREE_MODEL_ADAPTER::m_libs

SYMBOL_LIB_TABLE * m_libs

Definition: cmp_tree_model_adapter.h:80

Member Function Documentation

void CMP_TREE_MODEL_ADAPTER::AddAliasList	(	wxString const &	aNodeName,
		wxArrayString const &	aAliasNameList
	)

overridevirtual

Add the given list of components, by name.

To be called in the setup phase.

Parameters

aNodeName	the parent node the components will appear under
aAliasNameList	list of alias names

Implements CMP_TREE_MODEL_ADAPTER_BASE.

Definition at line 71 of file cmp_tree_model_adapter.cpp.

References Format(), LIB_TABLE::GetDescription(), SYMBOL_LIB_TABLE::LoadSymbol(), m_libs, name, and IO_ERROR::What().

Referenced by AddLibrary().

 {
     std::vector<LIB_ALIAS*> alias_list;
 
     for( const wxString& name: aAliasNameList )
     {
         LIB_ALIAS* a = nullptr;
 
         try
         {
             a = m_libs->LoadSymbol( aNodeName, name );
         }
         catch( const IO_ERROR& ioe )
         {
             wxLogError( wxString::Format( _( "Error occurred loading symbol %s from library %s."
                                              "\n\n%s" ), name, aNodeName, ioe.What() ) );
             continue;
         }
 
         if( a )
             alias_list.push_back( a );
     }
 
     if( alias_list.size() > 0 )
         AddAliasList( aNodeName, m_libs->GetDescription( aNodeName ), alias_list );
 }

void CMP_TREE_MODEL_ADAPTER_BASE::AddAliasList	(	wxString const &	aNodeName,
		wxString const &	aDesc,
		std::vector< LIB_ALIAS * > const &	aAliasList
	)

inherited

Add the given list of components by alias.

To be called in the setup phase.

Parameters

aNodeName	the parent node the components will appear under
aDesc	the description field of the parent node
aAliasList	list of aliases

Definition at line 147 of file cmp_tree_model_adapter_base.cpp.

References CMP_TREE_NODE_LIB::AddAlias(), CMP_TREE_NODE_ROOT::AddLib(), CMP_TREE_NODE::AssignIntrinsicRanks(), and CMP_TREE_MODEL_ADAPTER_BASE::m_tree.

 {
     auto& lib_node = m_tree.AddLib( aNodeName, aDesc );
 
     for( auto a: aAliasList )
     {
         lib_node.AddAlias( a );
     }
 
     lib_node.AssignIntrinsicRanks();
     m_tree.AssignIntrinsicRanks();
 }

void CMP_TREE_MODEL_ADAPTER_BASE::AddLibrariesWithProgress	(	const std::vector< wxString > &	aNicknames,
		wxWindow *	aParent
	)

inherited

Add all the libraries in a SYMBOL_LIB_TABLE to the model, displaying a progress dialog attached to the parent frame.

Parameters

aNicknames	is the list of library nicknames
aParent	is the parent window to display the progress dialog

Definition at line 113 of file cmp_tree_model_adapter_base.cpp.

References CMP_TREE_MODEL_ADAPTER_BASE::AddLibrary(), Format(), CMP_TREE_MODEL_ADAPTER_BASE::m_show_progress, and PROGRESS_INTERVAL_MILLIS.

Referenced by CMP_TREE_MODEL_ADAPTER_BASE::GetFilter().

 {
     wxProgressDialog* prg = nullptr;
     wxLongLong        nextUpdate = wxGetUTCTimeMillis() + (PROGRESS_INTERVAL_MILLIS / 2);
 
     if( m_show_progress )
         prg = new wxProgressDialog( _( "Loading Symbol Libraries" ),
                                     wxEmptyString,
                                     aNicknames.size(),
                                     aParent );
 
     unsigned int ii = 0;
 
     for( const auto& nickname : aNicknames )
     {
         if( prg && wxGetUTCTimeMillis() > nextUpdate )
         {
             prg->Update( ii, wxString::Format( _( "Loading library \"%s\"" ), nickname ) );
             nextUpdate = wxGetUTCTimeMillis() + PROGRESS_INTERVAL_MILLIS;
         }
 
         AddLibrary( nickname );
         ii++;
     }
 
     if( prg )
     {
         prg->Destroy();
         m_show_progress = false;
     }
 }

void CMP_TREE_MODEL_ADAPTER::AddLibrary ( wxString const & aLibNickname )

overridevirtual

Add all the components and their aliases in this library.

To be called in the setup phase.

Parameters

aLibNickname reference to a symbol library nickname

Implements CMP_TREE_MODEL_ADAPTER_BASE.

Definition at line 46 of file cmp_tree_model_adapter.cpp.

References AddAliasList(), CMP_TREE_NODE::AssignIntrinsicRanks(), CMP_TREE_MODEL_ADAPTER_BASE::CMP_FILTER_POWER, Format(), LIB_TABLE::GetDescription(), CMP_TREE_MODEL_ADAPTER_BASE::GetFilter(), SYMBOL_LIB_TABLE::LoadSymbolLib(), m_libs, CMP_TREE_MODEL_ADAPTER_BASE::m_tree, and IO_ERROR::What().

 {
     bool onlyPowerSymbols = ( GetFilter() == CMP_FILTER_POWER );
 
     std::vector<LIB_ALIAS*> alias_list;
 
     try
     {
         m_libs->LoadSymbolLib( alias_list, aLibNickname, onlyPowerSymbols );
     }
     catch( const IO_ERROR& ioe )
     {
         wxLogError( wxString::Format( _( "Error occurred loading symbol library %s."
                                          "\n\n%s" ), aLibNickname, ioe.What() ) );
         return;
     }
 
     if( alias_list.size() > 0 )
     {
         AddAliasList( aLibNickname, m_libs->GetDescription( aLibNickname ), alias_list );
         m_tree.AssignIntrinsicRanks();
     }
 }

void CMP_TREE_MODEL_ADAPTER_BASE::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 component in the dialog

Definition at line 213 of file cmp_tree_model_adapter_base.cpp.

References CMP_TREE_MODEL_ADAPTER_BASE::ColWidth(), kDataViewIndent, CMP_TREE_MODEL_ADAPTER_BASE::m_col_desc, CMP_TREE_MODEL_ADAPTER_BASE::m_col_part, CMP_TREE_MODEL_ADAPTER_BASE::m_tree, and CMP_TREE_MODEL_ADAPTER_BASE::m_widget.

Referenced by CMP_TREE_MODEL_ADAPTER_BASE::GetFilter(), and CMP_TREE_MODEL_ADAPTER_BASE::UpdateSearchString().

 {
     m_widget = aDataViewCtrl;
     aDataViewCtrl->SetIndent( kDataViewIndent );
     aDataViewCtrl->AssociateModel( this );
     aDataViewCtrl->ClearColumns();
 
     wxString part_head = _( "Symbol" );
     wxString desc_head = _( "Desc" );
 
     m_col_part = aDataViewCtrl->AppendTextColumn( part_head, 0, wxDATAVIEW_CELL_INERT,
                 ColWidth( m_tree, 0, part_head ) );
     m_col_desc = aDataViewCtrl->AppendTextColumn( desc_head, 1, wxDATAVIEW_CELL_INERT,
                 ColWidth( m_tree, 1, desc_head ) );
 }

CMP_TREE_MODEL_ADAPTER_BASE::PTR CMP_TREE_MODEL_ADAPTER::Create ( SYMBOL_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 29 of file cmp_tree_model_adapter.cpp.

References CMP_TREE_MODEL_ADAPTER().

Referenced by LIB_VIEW_FRAME::OnSelectSymbol(), and SCH_BASE_FRAME::SelectComponentFromLibrary().

 {
     auto adapter = new CMP_TREE_MODEL_ADAPTER( aLibs );
     auto container = CMP_TREE_MODEL_ADAPTER::PTR( adapter );
     return container;
 }

wxDataViewItem CMP_TREE_MODEL_ADAPTER_BASE::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 274 of file cmp_tree_model_adapter_base.cpp.

References CMP_TREE_NODE::Children, LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), CMP_TREE_MODEL_ADAPTER_BASE::m_tree, and CMP_TREE_MODEL_ADAPTER_BASE::ToItem().

Referenced by CMP_TREE_MODEL_ADAPTER_BASE::GetLibrariesCount().

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

void CMP_TREE_MODEL_ADAPTER_BASE::Freeze ( )

inlineinherited

Definition at line 266 of file cmp_tree_model_adapter_base.h.

References CMP_TREE_MODEL_ADAPTER_BASE::m_freeze.

266 { m_freeze++; }

CMP_TREE_MODEL_ADAPTER_BASE::m_freeze

int m_freeze

Definition: cmp_tree_model_adapter_base.h:351

LIB_ID CMP_TREE_MODEL_ADAPTER_BASE::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 230 of file cmp_tree_model_adapter_base.cpp.

References CMP_TREE_MODEL_ADAPTER_BASE::ToNode().

Referenced by CMP_TREE_MODEL_ADAPTER_BASE::GetFilter().

 {
     auto node = ToNode( aSelection );
 
     LIB_ID emptyId;
 
     if( !node )
         return emptyId;
 
     return node->LibId;
 }

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

overrideprotectedvirtualinherited

Get any formatting for an item.

Parameters

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

Returns: true iff the item has non-default attributes

Reimplemented in LIB_MANAGER_ADAPTER.

Definition at line 370 of file cmp_tree_model_adapter_base.cpp.

References CMP_TREE_MODEL_ADAPTER_BASE::IsFrozen(), CMP_TREE_NODE::LIBID, and CMP_TREE_MODEL_ADAPTER_BASE::ToNode().

Referenced by CMP_TREE_MODEL_ADAPTER_BASE::SetValue().

 {
     if( IsFrozen() )
         return false;
 
     auto node = ToNode( aItem );
     wxASSERT( node );
 
     if( node->Type != CMP_TREE_NODE::LIBID )
     {
         // Currently only aliases are formatted at all
         return false;
     }
 
     if( !node->IsRoot && aCol == 0 )
     {
         // Names of non-root aliases are italicized
         aAttr.SetItalic( true );
         return true;
     }
     else
     {
         return false;
     }
 }

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

overridevirtualinherited

Populate a list of all the children of an item.

Returns: number of children

Definition at line 298 of file cmp_tree_model_adapter_base.cpp.

References CMP_TREE_MODEL_ADAPTER_BASE::IntoArray(), CMP_TREE_MODEL_ADAPTER_BASE::m_show_units, CMP_TREE_MODEL_ADAPTER_BASE::m_tree, and CMP_TREE_MODEL_ADAPTER_BASE::ToNode().

Referenced by CMP_TREE_MODEL_ADAPTER_BASE::GetLibrariesCount().

 {
     auto node = ( aItem.IsOk() ? ToNode( aItem ) : &m_tree );
 
     if( node->Type != CMP_TREE_NODE::TYPE::LIBID
             || ( m_show_units && node->Type == CMP_TREE_NODE::TYPE::LIBID ) )
         return IntoArray( *node, aChildren );
     else
         return 0;
 }

virtual unsigned int CMP_TREE_MODEL_ADAPTER_BASE::GetColumnCount ( ) const

inlineoverrideprotectedvirtualinherited

Return the number of columns in the model.

Definition at line 303 of file cmp_tree_model_adapter_base.h.

303 { return 2; }

virtual wxString CMP_TREE_MODEL_ADAPTER_BASE::GetColumnType ( unsigned int aCol ) const

inlineoverrideprotectedvirtualinherited

Return the type of data stored in the column.

Returns: type of data as indicated by wxVariant::GetType()

Definition at line 310 of file cmp_tree_model_adapter_base.h.

References CMP_TREE_MODEL_ADAPTER_BASE::GetValue().

310 { return "string"; }

int CMP_TREE_MODEL_ADAPTER_BASE::GetComponentsCount ( ) const

inherited

Return the number of components loaded in the tree.

Definition at line 257 of file cmp_tree_model_adapter_base.cpp.

References CMP_TREE_NODE::Children, and CMP_TREE_MODEL_ADAPTER_BASE::m_tree.

Referenced by CMP_TREE_MODEL_ADAPTER_BASE::GetFilter().

 {
     int n = 0;
 
     for( auto& lib: m_tree.Children )
     {
         for( auto& alias: lib->Children )
         {
             (void) alias;
             ++n;
         }
     }
 
     return n;
 }

CMP_FILTER_TYPE CMP_TREE_MODEL_ADAPTER_BASE::GetFilter ( ) const

inlineinherited

Return the active filter.

Definition at line 126 of file cmp_tree_model_adapter_base.h.

Referenced by AddLibrary().

126 { return m_filter; }

CMP_TREE_MODEL_ADAPTER_BASE::m_filter

CMP_FILTER_TYPE m_filter

Definition: cmp_tree_model_adapter_base.h:347

virtual int CMP_TREE_MODEL_ADAPTER_BASE::GetLibrariesCount ( ) const

inlinevirtualinherited

Return the number of libraries loaded in the tree.

Reimplemented in LIB_MANAGER_ADAPTER.

Definition at line 241 of file cmp_tree_model_adapter_base.h.

References CMP_TREE_NODE::Children, CMP_TREE_MODEL_ADAPTER_BASE::FindItem(), CMP_TREE_MODEL_ADAPTER_BASE::GetChildren(), and CMP_TREE_MODEL_ADAPTER_BASE::m_tree.

Referenced by LIB_MANAGER_ADAPTER::GetLibrariesCount().

     {
         return m_tree.Children.size();
     }

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

overrideprotectedvirtualinherited

Get the parent of an item.

Parameters

aItem item to get the parent of

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

Definition at line 325 of file cmp_tree_model_adapter_base.cpp.

References CMP_TREE_MODEL_ADAPTER_BASE::ToItem(), and CMP_TREE_MODEL_ADAPTER_BASE::ToNode().

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

CMP_TREE_NODE::TYPE CMP_TREE_MODEL_ADAPTER_BASE::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 250 of file cmp_tree_model_adapter_base.cpp.

References CMP_TREE_NODE::INVALID, and CMP_TREE_MODEL_ADAPTER_BASE::ToNode().

Referenced by CMP_TREE_MODEL_ADAPTER_BASE::GetFilter().

 {
     auto node = ToNode( aSelection );
     return node ? node->Type : CMP_TREE_NODE::INVALID;
 }

int CMP_TREE_MODEL_ADAPTER_BASE::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 243 of file cmp_tree_model_adapter_base.cpp.

References CMP_TREE_MODEL_ADAPTER_BASE::ToNode().

Referenced by CMP_TREE_MODEL_ADAPTER_BASE::GetFilter().

 {
     auto node = ToNode( aSelection );
     return node ? node->Unit : 0;
 }

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

overrideprotectedvirtualinherited

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

Reimplemented in LIB_MANAGER_ADAPTER.

Definition at line 343 of file cmp_tree_model_adapter_base.cpp.

References CMP_TREE_MODEL_ADAPTER_BASE::IsFrozen(), and CMP_TREE_MODEL_ADAPTER_BASE::ToNode().

Referenced by CMP_TREE_MODEL_ADAPTER_BASE::GetColumnType().

 {
     if( IsFrozen() )
     {
         aVariant = wxEmptyString;
         return;
     }
 
     auto node = ToNode( aItem );
     wxASSERT( node );
 
     switch( aCol )
     {
     default:    // column == -1 is used for default Compare function
     case 0:
         aVariant = node->Name;
         break;
     case 1:
         aVariant = node->Desc;
         break;
     }
 }

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

overrideprotectedvirtualinherited

Check whether a container has columns too.

Definition at line 312 of file cmp_tree_model_adapter_base.cpp.

References CMP_TREE_MODEL_ADAPTER_BASE::IsContainer().

 {
     return IsContainer( aItem );
 }

unsigned int CMP_TREE_MODEL_ADAPTER_BASE::IntoArray	(	CMP_TREE_NODE const &	aNode,
		wxDataViewItemArray &	aChildren
	)

staticprotectedinherited

Convert CMP_TREE_NODE's children to wxDataViewItemArray.

Definition at line 61 of file cmp_tree_model_adapter_base.cpp.

References CMP_TREE_NODE::Children, and CMP_TREE_MODEL_ADAPTER_BASE::ToItem().

Referenced by CMP_TREE_MODEL_ADAPTER_BASE::GetChildren(), and CMP_TREE_MODEL_ADAPTER_BASE::IsFrozen().

 {
     unsigned int n = 0;
 
     for( auto const& child: aNode.Children )
     {
         if( child->Score > 0 )
         {
             aChildren.Add( ToItem( &*child ) );
             ++n;
         }
     }
 
     return n;
 }

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

overrideprotectedvirtualinherited

Check whether an item can have children.

Reimplemented in LIB_MANAGER_ADAPTER.

Definition at line 318 of file cmp_tree_model_adapter_base.cpp.

References CMP_TREE_MODEL_ADAPTER_BASE::ToNode().

Referenced by CMP_TREE_MODEL_ADAPTER_BASE::HasContainerColumns().

 {
     auto node = ToNode( aItem );
     return node ? node->Children.size() : true;
 }

bool CMP_TREE_MODEL_ADAPTER_BASE::IsFrozen ( ) const

inlineinherited

Definition at line 268 of file cmp_tree_model_adapter_base.h.

References CMP_TREE_MODEL_ADAPTER_BASE::IntoArray(), CMP_TREE_MODEL_ADAPTER_BASE::m_freeze, CMP_TREE_MODEL_ADAPTER_BASE::ToItem(), and CMP_TREE_MODEL_ADAPTER_BASE::ToNode().

Referenced by LIB_MANAGER_ADAPTER::GetAttr(), CMP_TREE_MODEL_ADAPTER_BASE::GetAttr(), LIB_MANAGER_ADAPTER::GetValue(), and CMP_TREE_MODEL_ADAPTER_BASE::GetValue().

268 { return m_freeze; }

CMP_TREE_MODEL_ADAPTER_BASE::m_freeze

int m_freeze

Definition: cmp_tree_model_adapter_base.h:351

void CMP_TREE_MODEL_ADAPTER_BASE::SetFilter ( CMP_FILTER_TYPE aFilter )

inherited

Set the component filter type.

Must be set before adding libraries

Parameters

aFilter if CMP_FILTER_POWER, only power parts are loaded

Definition at line 94 of file cmp_tree_model_adapter_base.cpp.

References CMP_TREE_MODEL_ADAPTER_BASE::m_filter.

 {
     m_filter = aFilter;
 }

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

inherited

Set the component 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 106 of file cmp_tree_model_adapter_base.cpp.

References CMP_TREE_MODEL_ADAPTER_BASE::m_preselect_lib_id, and CMP_TREE_MODEL_ADAPTER_BASE::m_preselect_unit.

Referenced by CMP_TREE_MODEL_ADAPTER_BASE::GetFilter().

 {
     m_preselect_lib_id = aLibId;
     m_preselect_unit = aUnit;
 }

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

inlineoverrideprotectedvirtualinherited

Set the value of an item.

Does nothing - this model doesn't support editing.

Definition at line 328 of file cmp_tree_model_adapter_base.h.

References CMP_TREE_MODEL_ADAPTER_BASE::GetAttr().

331 { return false; }

void CMP_TREE_MODEL_ADAPTER_BASE::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 100 of file cmp_tree_model_adapter_base.cpp.

References CMP_TREE_MODEL_ADAPTER_BASE::m_show_units.

Referenced by CMP_TREE_MODEL_ADAPTER_BASE::GetFilter().

 {
     m_show_units = aShow;
 }

void CMP_TREE_MODEL_ADAPTER_BASE::Thaw ( )

inlineinherited

Definition at line 267 of file cmp_tree_model_adapter_base.h.

References CMP_TREE_MODEL_ADAPTER_BASE::m_freeze.

267 { m_freeze--; }

CMP_TREE_MODEL_ADAPTER_BASE::m_freeze

int m_freeze

Definition: cmp_tree_model_adapter_base.h:351

wxDataViewItem CMP_TREE_MODEL_ADAPTER_BASE::ToItem ( CMP_TREE_NODE const * aNode )

staticprotectedinherited

Convert CMP_TREE_NODE -> wxDataViewItem.

Definition at line 43 of file cmp_tree_model_adapter_base.cpp.

Referenced by CMP_TREE_MODEL_ADAPTER_BASE::FindItem(), CMP_TREE_MODEL_ADAPTER_BASE::GetParent(), CMP_TREE_MODEL_ADAPTER_BASE::IntoArray(), and CMP_TREE_MODEL_ADAPTER_BASE::IsFrozen().

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

CMP_TREE_NODE const * CMP_TREE_MODEL_ADAPTER_BASE::ToNode ( wxDataViewItem aItem )

staticprotectedinherited

Convert wxDataViewItem -> CMP_TREE_NODE.

Definition at line 52 of file cmp_tree_model_adapter_base.cpp.

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

void CMP_TREE_MODEL_ADAPTER_BASE::UpdateSearchString ( wxString const & aSearch )

inherited

Set the search string provided by the user.

Parameters

aSearch full, unprocessed search text

Definition at line 162 of file cmp_tree_model_adapter_base.cpp.

References CMP_TREE_MODEL_ADAPTER_BASE::AttachTo(), CMP_TREE_MODEL_ADAPTER_BASE::m_tree, CMP_TREE_MODEL_ADAPTER_BASE::m_widget, CMP_TREE_NODE::ResetScore(), CMP_TREE_MODEL_ADAPTER_BASE::ShowPreselect(), CMP_TREE_MODEL_ADAPTER_BASE::ShowResults(), CMP_TREE_MODEL_ADAPTER_BASE::ShowSingleLibrary(), CMP_TREE_NODE::SortNodes(), and CMP_TREE_NODE_ROOT::UpdateScore().

Referenced by CMP_TREE_MODEL_ADAPTER_BASE::GetFilter().

 {
     m_tree.ResetScore();
 
     wxStringTokenizer tokenizer( aSearch );
 
     while( tokenizer.HasMoreTokens() )
     {
         const wxString term = tokenizer.GetNextToken().Lower();
         EDA_COMBINED_MATCHER matcher( term );
 
         m_tree.UpdateScore( matcher );
     }
 
     m_tree.SortNodes();
 
     {
         wxWindowUpdateLocker updateLock( m_widget );
 
         // Even with the updateLock, wxWidgets sometimes ties its knickers in
         // a knot when 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();
 
         Cleared();
 #ifndef __WINDOWS__
         // The fastest method to update wxDataViewCtrl is to rebuild from
         // scratch by calling Cleared(). Linux requires to reassociate model to
         // display data, but Windows will create multiple associations.
         AttachTo( m_widget );
 #endif
     }
 
     CMP_TREE_NODE* bestMatch = ShowResults();
 
     if( !bestMatch )
         bestMatch = ShowPreselect();
 
     if( !bestMatch )
         bestMatch = ShowSingleLibrary();
 
     if( bestMatch )
     {
         auto item = wxDataViewItem( bestMatch );
         m_widget->Select( item );
         m_widget->EnsureVisible( item );
     }
 }

Member Data Documentation

SYMBOL_LIB_TABLE* CMP_TREE_MODEL_ADAPTER::m_libs

private

Definition at line 80 of file cmp_tree_model_adapter.h.

Referenced by AddAliasList(), and AddLibrary().

CMP_TREE_NODE_ROOT CMP_TREE_MODEL_ADAPTER_BASE::m_tree

protectedinherited

Definition at line 275 of file cmp_tree_model_adapter_base.h.

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 Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation