CMP_TREE_MODEL_ADAPTER Class Reference

Adapter class in the component selector Model-View-Adapter (mediated MVC) architecture. More...

#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 >	PTR
	Reference-counting container for a pointer to CMP_TREE_MODEL_ADAPTER. More...

Public Member Functions
	~CMP_TREE_MODEL_ADAPTER ()
	Destructor. More...
void	SetFilter (CMP_FILTER_TYPE aFilter)
	Set the component filter type. More...
void	ShowUnits (bool aShow)
	Whether or not to show units. More...
void	SetPreselectNode (wxString const &aName, int aUnit)
	Set the component name to be selected if there are no search results. More...
void	AddLibrary (PART_LIB &aLib)
	Add all the components and their aliases in this library. More...
void	AddAliasList (wxString const &aNodeName, wxArrayString const &aAliasNameList, PART_LIB *aOptionalLib=nullptr)
	Add the given list of components, by name. More...
void	AddAliasList (wxString const &aNodeName, std::vector< LIB_ALIAS * > const &aAliasList, PART_LIB *aOptionalLib=nullptr)
	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_ALIAS *	GetAliasFor (wxDataViewItem aSelection) const
	Return the alias for the given item. More...
int	GetUnitFor (wxDataViewItem aSelection) const
	Return the unit for the given item. More...
int	GetComponentsCount () const
	Return the number of components loaded in the tree. More...

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

Protected Member Functions
	CMP_TREE_MODEL_ADAPTER (PART_LIBS *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	GetChildren (wxDataViewItem const &aItem, wxDataViewItemArray &aChildren) const override
	Populate a list of all the children 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...

Private Member Functions
	WX_DECLARE_STRING_HASH_MAP (std::vector< int >, WIDTH_CACHE)
int	ColWidth (CMP_TREE_NODE &aTree, int aCol, wxString const &aHeading)
	Compute the width required for the given column of a node and its children. More...
int	WidthFor (CMP_TREE_NODE &aNode, int aCol)
	Return the width required to display a single row's aCol text. More...
int	WidthFor (wxString const &aHeading, int aCol)
	Return the width required to display a column's heading. More...
bool	FindAndExpand (CMP_TREE_NODE &aNode, std::function< bool(CMP_TREE_NODE const *)> aFunc)
	Find any results worth highlighting and expand them, according to given criteria (f(CMP_TREE_NODE const*) -> bool) More...
bool	ShowResults ()
	Find and expand successful search results. More...
bool	ShowPreselect ()
	Find and expand preselected node. More...
bool	ShowSingleLibrary ()
	Find and expand a library if there is only one. More...

Private Attributes
CMP_FILTER_TYPE	m_filter
bool	m_show_units
PART_LIBS *	m_libs
wxString	m_preselect_name
int	m_preselect_unit
CMP_TREE_NODE_ROOT	m_tree
wxDataViewColumn *	m_col_part
wxDataViewColumn *	m_col_desc
wxDataViewCtrl *	m_widget

Static Private Attributes
static WIDTH_CACHE	m_width_cache

Detailed Description

Adapter class in the component selector Model-View-Adapter (mediated MVC) architecture.

The other pieces are in:

• Model: CMP_TREE_NODE and descendants in eeschema/cmp_tree_model.h
• View:
  • DIALOG_CHOOSE_COMPONENT in eeschema/dialogs/dialog_choose_component.h
  • wxDataViewCtrl

This adapter presents the interface specified by wxDataViewModel to the wxDataViewCtrl:

                  +---+                      +------------------+
+---+  Generates  | A |                      |       VIEW       |
| M |  from libs  | D |   wxDataViewModel    |------------------|
| O | <---------- | A | <------------------> |  wxDataViewCtrl  |
| D |             | P |                      |------------------|
| E | <---------> | T | <------------------- |    wxTextCtrl    |
| L | UpdateScore | E | UpdateSearchString() |------------------|
+---+             | R |                      |                  |
                  +---+                      +------------------+

Because this adapter is a wxDataViewModel, it is reference-counted by wxObject. To ensure this interface is used correctly, the constructor is private; CMP_TREE_MODEL_ADAPTER should be created by the static factory method CMP_TREE_MODEL_ADAPTER::Create().

Quick summary of methods used to drive this class:

• SetFilter() - set whether the view is restricted to power parts
• ShowUnits() - set whether units are displayed
• SetPreselectNode() - set a node to highlight when not searching
• AddLibrary() - populate the model with all aliases in a library
• AddAliasList() - populate the model with a specific list of aliases

Quick summary of methods used by the View:

• UpdateSearchString() - pass in the user's search text
• AttachTo() - pass in the wxDataViewCtrl
• GetAliasFor() - get the LIB_ALIAS* for a selected item
• GetUnitFor() - get the unit for a selected item
• GetComponentsCount() - count the aliases loaded

Methods implemented as part of wxDataViewModel:

• HasContainerColumns() - whether a parent item has more than one column
• IsContainer() - whether an item is a parent
• GetParent() - return the parent of an item, or invalid if root
• GetChildren() - get the children of an item
• GetColumnCount() - get the number of columns in the view
• GetColumnType() - get the data type shown in each column
• GetValue() - get the data shown in a cell
• SetValue() - edit the data in a cell (does nothing)
• GetAttr() - get any per-item formatting
• Compare() - compare two rows, for sorting
• HasDefaultCompare() - whether sorted by default

Definition at line 94 of file cmp_tree_model_adapter.h.

Member Typedef Documentation

typedef wxObjectDataPtr<CMP_TREE_MODEL_ADAPTER> CMP_TREE_MODEL_ADAPTER::PTR

Reference-counting container for a pointer to CMP_TREE_MODEL_ADAPTER.

Definition at line 101 of file cmp_tree_model_adapter.h.

Member Enumeration Documentation

enum CMP_TREE_MODEL_ADAPTER::CMP_FILTER_TYPE

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 120 of file cmp_tree_model_adapter.h.

    {
        CMP_FILTER_NONE,        
        CMP_FILTER_POWER,       
    };

Constructor & Destructor Documentation

CMP_TREE_MODEL_ADAPTER::~CMP_TREE_MODEL_ADAPTER

(

)

Destructor.

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

Definition at line 92 of file cmp_tree_model_adapter.cpp.

{}

CMP_TREE_MODEL_ADAPTER::CMP_TREE_MODEL_ADAPTER ( PART_LIBS *  aLibs )

protected

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

Definition at line 81 of file cmp_tree_model_adapter.cpp.

Referenced by Create().

    :m_filter( CMP_FILTER_NONE ),
     m_show_units( true ),
     m_libs( aLibs ),
     m_preselect_unit( 0 ),
     m_col_part( nullptr ),
     m_col_desc( nullptr ),
     m_widget( nullptr )
{}

Member Function Documentation

void CMP_TREE_MODEL_ADAPTER::AddAliasList	(	wxString const &	aNodeName,
		wxArrayString const &	aAliasNameList,
		PART_LIB *	aOptionalLib = nullptr
	)

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
aOptionalLib	library to look up names in (null = global)

Definition at line 134 of file cmp_tree_model_adapter.cpp.

References PART_LIB::FindAlias(), PART_LIBS::FindLibraryAlias(), m_libs, and name.

Referenced by AddLibrary().

{
    std::vector<LIB_ALIAS*> alias_list;

    for( const wxString& name: aAliasNameList )
    {
        LIB_ALIAS* a;

        if( aOptionalLib )
            a = aOptionalLib->FindAlias( name );
        else
            a = m_libs->FindLibraryAlias( LIB_ID( wxEmptyString, name ), wxEmptyString );

        if( a )
            alias_list.push_back( a );
    }

    AddAliasList( aNodeName, alias_list, aOptionalLib );
}

void CMP_TREE_MODEL_ADAPTER::AddAliasList	(	wxString const &	aNodeName,
		std::vector< LIB_ALIAS * > const &	aAliasList,
		PART_LIB *	aOptionalLib = nullptr
	)

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
aAliasList	list of aliases
aOptionalLib	library to look up names in (null = global)

Definition at line 158 of file cmp_tree_model_adapter.cpp.

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

{
    auto& lib_node = m_tree.AddLib( aNodeName );

    for( auto a: aAliasList )
    {
        lib_node.AddAlias( a );
    }

    lib_node.AssignIntrinsicRanks();
    m_tree.AssignIntrinsicRanks();
}

void CMP_TREE_MODEL_ADAPTER::AddLibrary

(

PART_LIB &

aLib

)

Add all the components and their aliases in this library.

To be called in the setup phase.

Parameters

aLib	reference to a library

Definition at line 115 of file cmp_tree_model_adapter.cpp.

References AddAliasList(), CMP_TREE_NODE::AssignIntrinsicRanks(), CMP_FILTER_POWER, PART_LIB::GetAliases(), PART_LIB::GetEntryTypePowerNames(), PART_LIB::GetName(), m_filter, and m_tree.

{
    if( m_filter == CMP_FILTER_POWER )
    {
        wxArrayString all_aliases;
        aLib.GetEntryTypePowerNames( all_aliases );
        AddAliasList( aLib.GetName(), all_aliases, &aLib );
    }
    else
    {
        std::vector<LIB_ALIAS*> all_aliases;
        aLib.GetAliases( all_aliases );
        AddAliasList( aLib.GetName(), all_aliases, &aLib );
    }

    m_tree.AssignIntrinsicRanks();
}

void CMP_TREE_MODEL_ADAPTER::AttachTo

(

wxDataViewCtrl *

aDataViewCtrl

)

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 197 of file cmp_tree_model_adapter.cpp.

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

Referenced by UpdateSearchString().

{
    m_widget = aDataViewCtrl;
    aDataViewCtrl->Freeze();
    aDataViewCtrl->SetIndent( kDataViewIndent );
    aDataViewCtrl->AssociateModel( this );
    aDataViewCtrl->ClearColumns();

    wxString part_head = _( "Part" );
    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 ) );
    aDataViewCtrl->Thaw();
}

int CMP_TREE_MODEL_ADAPTER::ColWidth ( CMP_TREE_NODE &  aTree, int  aCol, wxString const &  aHeading  )

private

Compute the width required for the given column of a node and its children.

Parameters

aTree	- root node of the tree
aCol	- column number
aHeading	- heading text, to set the minimum width

Definition at line 340 of file cmp_tree_model_adapter.cpp.

References CMP_TREE_NODE::Children, kDataViewIndent, max, CMP_TREE_NODE::Score, and WidthFor().

Referenced by AttachTo().

{
    const int indent = aCol ? 0 : kDataViewIndent;

    int min_width = WidthFor( aHeading, aCol );
    int width = std::max( aTree.Score > 0 ? WidthFor( aTree, aCol ) : 0, min_width );

    if( aTree.Score > 0 )
    {
        for( auto& node: aTree.Children )
        {
            width = std::max( width, ColWidth( *node, aCol, aHeading ) + indent );
        }
    }

    return width;
}

CMP_TREE_MODEL_ADAPTER::PTR CMP_TREE_MODEL_ADAPTER::Create ( PART_LIBS *  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 73 of file cmp_tree_model_adapter.cpp.

References CMP_TREE_MODEL_ADAPTER().

Referenced by LIB_EDIT_FRAME::DeleteOnePart(), 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;
}

bool CMP_TREE_MODEL_ADAPTER::FindAndExpand ( CMP_TREE_NODE &  aNode, std::function< bool(CMP_TREE_NODE const *)>  aFunc  )

private

Find any results worth highlighting and expand them, according to given criteria (f(CMP_TREE_NODE const*) -> bool)

Returns

whether a node was expanded

Definition at line 398 of file cmp_tree_model_adapter.cpp.

References CMP_TREE_NODE::Children, and m_widget.

Referenced by ShowPreselect(), ShowResults(), and ShowSingleLibrary().

{
    for( auto& node: aNode.Children )
    {
        if( aFunc( &*node ) )
        {
            auto item = wxDataViewItem(
                    const_cast<void*>( static_cast<void const*>( &*node ) ) );
            m_widget->ExpandAncestors( item );
            m_widget->EnsureVisible( item );
            m_widget->Select( item );
            return true;
        }
        else if( FindAndExpand( *node, aFunc ) )
        {
            return true;
        }
    }

    return false;
}

LIB_ALIAS * CMP_TREE_MODEL_ADAPTER::GetAliasFor

(

wxDataViewItem

aSelection

)

const

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 216 of file cmp_tree_model_adapter.cpp.

References ToNode().

{
    auto node = ToNode( aSelection );
    return node ? node->Alias : nullptr;
}

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

overrideprotectedvirtual

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

Definition at line 313 of file cmp_tree_model_adapter.cpp.

References CMP_TREE_NODE::ALIAS, and ToNode().

{
    auto node = ToNode( aItem );
    wxASSERT( node );

    if( node->Type != CMP_TREE_NODE::ALIAS )
    {
        // Currently only aliases are formatted at all
        return false;
    }

    if( node->Alias && !node->Alias->IsRoot() && aCol == 0 )
    {
        // Names of non-root aliases are italicized
        aAttr.SetItalic( true );
        return true;
    }
    else
    {
        return false;
    }
}

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

overrideprotectedvirtual

Populate a list of all the children of an item.

Returns

number of children

Definition at line 278 of file cmp_tree_model_adapter.cpp.

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

{
    auto node = ( aItem.IsOk() ? ToNode( aItem ) : &m_tree );

    if( node->Type != CMP_TREE_NODE::TYPE::ALIAS || m_show_units )
        return IntoArray( *node, aChildren );
    else
        return 0;
}

virtual unsigned int CMP_TREE_MODEL_ADAPTER::GetColumnCount ( ) const

inlineoverrideprotectedvirtual

Return the number of columns in the model.

Definition at line 262 of file cmp_tree_model_adapter.h.

{ return 2; }

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

inlineoverrideprotectedvirtual

Return the type of data stored in the column.

Returns

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

Definition at line 269 of file cmp_tree_model_adapter.h.

{ return "string"; }

int CMP_TREE_MODEL_ADAPTER::GetComponentsCount

(

)

const

Return the number of components loaded in the tree.

Definition at line 230 of file cmp_tree_model_adapter.cpp.

References CMP_TREE_NODE::Children, and m_tree.

{
    int n = 0;

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

    return n;
}

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

overrideprotectedvirtual

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 260 of file cmp_tree_model_adapter.cpp.

References ToItem(), and 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 );
    }
}

int CMP_TREE_MODEL_ADAPTER::GetUnitFor

(

wxDataViewItem

aSelection

)

const

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 223 of file cmp_tree_model_adapter.cpp.

References ToNode().

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

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

overrideprotectedvirtual

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 291 of file cmp_tree_model_adapter.cpp.

References ToNode().

{
    auto node = ToNode( aItem );
    wxASSERT( node );

    switch( aCol )
    {
    case 0:
        aVariant = node->Name;
        break;
    case 1:
        aVariant = node->Desc;
        break;
    default:
        wxFAIL_MSG( "Invalid column ID!" );
    }
}

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

overrideprotectedvirtual

Check whether a container has columns too.

Definition at line 247 of file cmp_tree_model_adapter.cpp.

References IsContainer().

{
    return IsContainer( aItem );
}

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

overrideprotectedvirtual

Check whether an item can have children.

Definition at line 253 of file cmp_tree_model_adapter.cpp.

References ToNode().

Referenced by HasContainerColumns().

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

void CMP_TREE_MODEL_ADAPTER::SetFilter

(

CMP_FILTER_TYPE

aFilter

)

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 96 of file cmp_tree_model_adapter.cpp.

References m_filter.

{
    m_filter = aFilter;
}

void CMP_TREE_MODEL_ADAPTER::SetPreselectNode	(	wxString const &	aName,
		int	aUnit
	)

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

aName	component name to be selected
aUnit	unit to be selected, if > 0 (0 selects the alias itself)

Definition at line 108 of file cmp_tree_model_adapter.cpp.

References m_preselect_name, and m_preselect_unit.

{
    m_preselect_name = aName;
    m_preselect_unit = aUnit;
}

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

inlineoverrideprotectedvirtual

Set the value of an item.

Does nothing - this model doesn't support editing.

Definition at line 287 of file cmp_tree_model_adapter.h.

                                                    { return false; }

bool CMP_TREE_MODEL_ADAPTER::ShowPreselect ( )

private

Find and expand preselected node.

Definition at line 433 of file cmp_tree_model_adapter.cpp.

References CMP_TREE_NODE::ALIAS, CMP_TREE_NODE::Children, FindAndExpand(), m_preselect_name, m_preselect_unit, m_tree, CMP_TREE_NODE::Name, CMP_TREE_NODE::Parent, CMP_TREE_NODE::Type, CMP_TREE_NODE::UNIT, and CMP_TREE_NODE::Unit.

Referenced by UpdateSearchString().

{
    if( m_preselect_name == wxEmptyString )
        return false;

    return FindAndExpand( m_tree,
            [&]( CMP_TREE_NODE const* n )
            {
                if( n->Type == CMP_TREE_NODE::ALIAS && ( n->Children.empty() || !m_preselect_unit ) )
                    return m_preselect_name == n->Name;
                else if( n->Type == CMP_TREE_NODE::UNIT && m_preselect_unit )
                    return m_preselect_name == n->Parent->Name && m_preselect_unit == n->Unit;
                else
                    return false;
            } );
}

bool CMP_TREE_MODEL_ADAPTER::ShowResults ( )

private

Find and expand successful search results.

Definition at line 423 of file cmp_tree_model_adapter.cpp.

References FindAndExpand(), m_tree, CMP_TREE_NODE::Score, and CMP_TREE_NODE::Type.

Referenced by UpdateSearchString().

{
    return FindAndExpand( m_tree,
            []( CMP_TREE_NODE const* n )
            {
                return n->Type == CMP_TREE_NODE::TYPE::ALIAS && n->Score > 1;
            } );
}

bool CMP_TREE_MODEL_ADAPTER::ShowSingleLibrary ( )

private

Find and expand a library if there is only one.

Definition at line 451 of file cmp_tree_model_adapter.cpp.

References CMP_TREE_NODE::Children, FindAndExpand(), m_tree, CMP_TREE_NODE::Parent, and CMP_TREE_NODE::Type.

Referenced by UpdateSearchString().

{
    return FindAndExpand( m_tree,
            []( CMP_TREE_NODE const* n )
            {
                return n->Type == CMP_TREE_NODE::TYPE::ALIAS &&
                       n->Parent->Parent->Children.size() == 1;
            } );
}

void CMP_TREE_MODEL_ADAPTER::ShowUnits

(

bool

aShow

)

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 102 of file cmp_tree_model_adapter.cpp.

References m_show_units.

{
    m_show_units = aShow;
}

void CMP_TREE_MODEL_ADAPTER::UpdateSearchString

(

wxString const &

aSearch

)

Set the search string provided by the user.

Parameters

aSearch

full, unprocessed search text

Definition at line 175 of file cmp_tree_model_adapter.cpp.

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

{
    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();
    Cleared();
    AttachTo( m_widget );

    ShowResults() || ShowPreselect() || ShowSingleLibrary();
}

int CMP_TREE_MODEL_ADAPTER::WidthFor ( CMP_TREE_NODE &  aNode, int  aCol  )

private

Return the width required to display a single row's aCol text.

This is cached for efficiency as it's very slow on some platforms (cough macOS)

Definition at line 359 of file cmp_tree_model_adapter.cpp.

References CMP_TREE_NODE::Desc, kDataViewIndent, m_widget, m_width_cache, and CMP_TREE_NODE::Name.

Referenced by ColWidth().

{
    auto result = m_width_cache.find( aNode.Name );

    if( result != m_width_cache.end() )
    {
        return result->second[aCol];
    }
    else
    {
        int wname = m_widget->GetTextExtent( aNode.Name ).x + kDataViewIndent;
        int wdesc = m_widget->GetTextExtent( aNode.Desc ).x;

        auto& val = m_width_cache[aNode.Name];
        val.push_back( wname );
        val.push_back( wdesc );
        return val[aCol];
    }
}

int CMP_TREE_MODEL_ADAPTER::WidthFor ( wxString const &  aHeading, int  aCol  )

private

Return the width required to display a column's heading.

This is cached by column number for the same reason as the width per cell.

Definition at line 380 of file cmp_tree_model_adapter.cpp.

References m_widget.

{
    static std::vector<int> widths;

    for( int i = (int) widths.size(); i <= aCol; ++i )
    {
        widths.push_back( 0 );
    }

    if( widths[aCol] == 0 )
    {
        widths[aCol] = m_widget->GetTextExtent( aHeading ).x;
    }

    return widths[aCol];
}

CMP_TREE_MODEL_ADAPTER::WX_DECLARE_STRING_HASH_MAP ( std::vector< int >  , WIDTH_CACHE    )

private

Member Data Documentation

wxDataViewColumn* CMP_TREE_MODEL_ADAPTER::m_col_desc

private

Definition at line 315 of file cmp_tree_model_adapter.h.

Referenced by AttachTo().

wxDataViewColumn* CMP_TREE_MODEL_ADAPTER::m_col_part

private

Definition at line 314 of file cmp_tree_model_adapter.h.

Referenced by AttachTo().

CMP_FILTER_TYPE CMP_TREE_MODEL_ADAPTER::m_filter

private

Definition at line 306 of file cmp_tree_model_adapter.h.

Referenced by AddLibrary(), and SetFilter().

PART_LIBS* CMP_TREE_MODEL_ADAPTER::m_libs

private

Definition at line 308 of file cmp_tree_model_adapter.h.

Referenced by AddAliasList().

wxString CMP_TREE_MODEL_ADAPTER::m_preselect_name

private

Definition at line 309 of file cmp_tree_model_adapter.h.

Referenced by SetPreselectNode(), and ShowPreselect().

int CMP_TREE_MODEL_ADAPTER::m_preselect_unit

private

Definition at line 310 of file cmp_tree_model_adapter.h.

Referenced by SetPreselectNode(), and ShowPreselect().

bool CMP_TREE_MODEL_ADAPTER::m_show_units

private

Definition at line 307 of file cmp_tree_model_adapter.h.

Referenced by GetChildren(), and ShowUnits().

CMP_TREE_NODE_ROOT CMP_TREE_MODEL_ADAPTER::m_tree

private

Definition at line 312 of file cmp_tree_model_adapter.h.

Referenced by AddAliasList(), AddLibrary(), AttachTo(), GetChildren(), GetComponentsCount(), ShowPreselect(), ShowResults(), ShowSingleLibrary(), and UpdateSearchString().

wxDataViewCtrl* CMP_TREE_MODEL_ADAPTER::m_widget

private

Definition at line 316 of file cmp_tree_model_adapter.h.

Referenced by AttachTo(), FindAndExpand(), UpdateSearchString(), and WidthFor().

CMP_TREE_MODEL_ADAPTER::WIDTH_CACHE CMP_TREE_MODEL_ADAPTER::m_width_cache

staticprivate

Definition at line 320 of file cmp_tree_model_adapter.h.

Referenced by WidthFor().

---

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

• cmp_tree_model_adapter.h
• cmp_tree_model_adapter.cpp