FP_TREE_MODEL_ADAPTER Class Reference

#include <fp_tree_model_adapter.h>

Inheritance diagram for FP_TREE_MODEL_ADAPTER:

Public Types
enum	SYM_FILTER_TYPE { SYM_FILTER_NONE, SYM_FILTER_POWER }
	This enum allows a selective filtering of symbols to list. More...
enum	TREE_COLS { PART_COL = 0, DESC_COL, NUM_COLS }
	This enum defines the order of the columns in the tree view. More...

Public Member Functions
void	AddLibraries ()
wxString	GenerateInfo (LIB_ID const &aLibId, int aUnit) override
void	SaveColWidths ()
	Save the column widths to the config file. More...
void	SavePinnedItems ()
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 presorted)
	Add the given list of symbols by alias. 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...
LIB_ID	GetAliasFor (const wxDataViewItem &aSelection) const
	Return the alias for the given item. More...
int	GetUnitFor (const wxDataViewItem &aSelection) const
	Return the unit for the given item. More...
LIB_TREE_NODE::TYPE	GetTypeFor (const wxDataViewItem &aSelection) const
	Return node type for the given item. More...
LIB_TREE_NODE *	GetTreeNodeFor (const wxDataViewItem &aSelection) const
int	GetItemCount () const
	Return the number of symbols loaded in the tree. More...
virtual int	GetLibrariesCount () const
	Return the number of libraries loaded in the tree. More...
wxDataViewItem	FindItem (const LIB_ID &aLibId)
	Returns tree item corresponding to part. More...
unsigned int	GetChildren (const wxDataViewItem &aItem, wxDataViewItemArray &aChildren) const override
	Populate a list of all the children of an item. More...
void	Freeze ()
void	Thaw ()
bool	IsFrozen () const
void	RefreshTree ()
virtual TOOL_INTERACTIVE *	GetContextMenuTool ()

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

Protected Member Functions
	FP_TREE_MODEL_ADAPTER (EDA_BASE_FRAME *aParent, LIB_TABLE *aLibs)
	Constructor; takes a set of libraries to be included in the search. More...
std::vector< LIB_TREE_ITEM * >	getFootprints (const wxString &aLibName)
LIB_TREE_NODE_LIB &	DoAddLibraryNode (const wxString &aNodeName, const wxString &aDesc)
bool	HasContainerColumns (const wxDataViewItem &aItem) const override
	Check whether a container has columns too. More...
bool	IsContainer (const wxDataViewItem &aItem) const override
	Check whether an item can have children. More...
wxDataViewItem	GetParent (const wxDataViewItem &aItem) const override
	Get the parent of an item. More...
unsigned int	GetColumnCount () const override
wxString	GetColumnType (unsigned int aCol) const override
	Return the type of data stored in the column as indicated by wxVariant::GetType() More...
void	GetValue (wxVariant &aVariant, const wxDataViewItem &aItem, unsigned int aCol) const override
	Get the value of an item. More...
bool	SetValue (const wxVariant &aVariant, const wxDataViewItem &aItem, unsigned int aCol) override
	Set the value of an item. More...
bool	GetAttr (const wxDataViewItem &aItem, unsigned int aCol, wxDataViewItemAttr &aAttr) const override
	Get any formatting for an item. More...
const wxString	GetPinningSymbol () const

Static Protected Member Functions
static wxDataViewItem	ToItem (const LIB_TREE_NODE *aNode)
	Convert #SYM_TREE_NODE -> wxDataViewItem. More...
static LIB_TREE_NODE *	ToNode (wxDataViewItem aItem)
	Convert wxDataViewItem -> #SYM_TREE_NODE. More...
static unsigned int	IntoArray (const LIB_TREE_NODE &aNode, wxDataViewItemArray &aChildren)
	Convert SYM_TREE_NODE's children to wxDataViewItemArray. More...

Protected Attributes
FP_LIB_TABLE *	m_libs
LIB_TREE_NODE_ROOT	m_tree

Detailed Description

Definition at line 31 of file fp_tree_model_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 109 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 columns in the tree view.

Enumerator
PART_COL	Part name column.
DESC_COL	Part description column.
NUM_COLS	The number of tree columns.

Definition at line 118 of file lib_tree_model_adapter.h.

    {
        PART_COL = 0,   
        DESC_COL,       
        NUM_COLS        
    };

Constructor & Destructor Documentation

FP_TREE_MODEL_ADAPTER()

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

protected

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

Definition at line 39 of file fp_tree_model_adapter.cpp.

                                                                                        :
        LIB_TREE_MODEL_ADAPTER( aParent, "pinned_footprint_libs" ),
        m_libs( (FP_LIB_TABLE*) aLibs )
{}

Referenced by Create().

Member Function Documentation

AddLibraries()

void FP_TREE_MODEL_ADAPTER::AddLibraries

(

)

Definition at line 45 of file fp_tree_model_adapter.cpp.

{
    for( const wxString& libName : m_libs->GetLogicalLibs() )
    {
        const FP_LIB_TABLE_ROW* library = m_libs->FindRow( libName, true );

        DoAddLibrary( libName, library->GetDescr(), getFootprints( libName ), true );
    }

    m_tree.AssignIntrinsicRanks();
}

References LIB_TREE_NODE::AssignIntrinsicRanks(), LIB_TREE_MODEL_ADAPTER::DoAddLibrary(), FP_LIB_TABLE::FindRow(), getFootprints(), LIB_TABLE::GetLogicalLibs(), library, m_libs, and LIB_TREE_MODEL_ADAPTER::m_tree.

Referenced by PCB_BASE_FRAME::SelectFootprintFromLibTree().

AssignIntrinsicRanks()

void LIB_TREE_MODEL_ADAPTER::AssignIntrinsicRanks ( )

inlineinherited

Sort the tree and assign ranks after adding libraries.

Definition at line 176 of file lib_tree_model_adapter.h.

{ m_tree.AssignIntrinsicRanks(); }

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

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

{
    wxString partHead = _( "Item" );
    wxString descHead = _( "Description" );

    // The extent of the text doesn't take into account the space on either side
    // in the header, so artificially pad it
    wxSize partHeadMinWidth = KIUI::GetTextSize( partHead + "MMM", aDataViewCtrl );

    // Ensure the part column is wider than the smallest allowable width
    if( m_colWidths[PART_COL] < partHeadMinWidth.x )
        m_colWidths[PART_COL] = partHeadMinWidth.x;

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

    m_col_part = aDataViewCtrl->AppendTextColumn( partHead, PART_COL, wxDATAVIEW_CELL_INERT,
                                                  m_colWidths[PART_COL] );
    m_col_desc = aDataViewCtrl->AppendTextColumn( descHead, DESC_COL, wxDATAVIEW_CELL_INERT,
                                                  m_colWidths[DESC_COL] );

    m_col_part->SetMinWidth( partHeadMinWidth.x );
}

References _, LIB_TREE_MODEL_ADAPTER::DESC_COL, KIUI::GetTextSize(), kDataViewIndent, LIB_TREE_MODEL_ADAPTER::m_col_desc, LIB_TREE_MODEL_ADAPTER::m_col_part, LIB_TREE_MODEL_ADAPTER::m_colWidths, LIB_TREE_MODEL_ADAPTER::m_widget, and LIB_TREE_MODEL_ADAPTER::PART_COL.

Create()

wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > FP_TREE_MODEL_ADAPTER::Create ( EDA_BASE_FRAME *  aParent, LIB_TABLE *  aLibs  )

static

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

Parameters

aLibs

library set from which parts will be loaded

Definition at line 32 of file fp_tree_model_adapter.cpp.

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

References FP_TREE_MODEL_ADAPTER().

Referenced by PCB_BASE_FRAME::SelectFootprintFromLibTree().

DoAddLibrary()

void LIB_TREE_MODEL_ADAPTER::DoAddLibrary ( const wxString &  aNodeName, const wxString &  aDesc, const std::vector< LIB_TREE_ITEM * > &  aItemList, 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 170 of file lib_tree_model_adapter.cpp.

{
    LIB_TREE_NODE_LIB& lib_node = DoAddLibraryNode( aNodeName, aDesc );

    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 AddLibraries(), SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), SYMBOL_TREE_MODEL_ADAPTER::AddLibrary(), 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  )

protectedinherited

Definition at line 159 of file lib_tree_model_adapter.cpp.

{
    LIB_TREE_NODE_LIB& lib_node = m_tree.AddLib( aNodeName, aDesc );

    lib_node.m_Pinned = m_pinnedLibs.Index( lib_node.m_LibId.GetLibNickname() ) != wxNOT_FOUND;

    return lib_node;
}

References LIB_TREE_NODE_ROOT::AddLib(), LIB_ID::GetLibNickname(), LIB_TREE_NODE::m_LibId, LIB_TREE_NODE::m_Pinned, LIB_TREE_MODEL_ADAPTER::m_pinnedLibs, and LIB_TREE_MODEL_ADAPTER::m_tree.

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

FindItem()

wxDataViewItem LIB_TREE_MODEL_ADAPTER::FindItem ( const LIB_ID &  aLibId )

inherited

Returns tree item corresponding to part.

Parameters

aLibId

specifies the part and library name to be searched for.

Returns

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

Definition at line 342 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 385 of file lib_tree_model_adapter.cpp.

{
    m_col_part->SetWidth( m_colWidths[PART_COL] );
    m_col_desc->SetWidth( m_colWidths[DESC_COL] );
}

References LIB_TREE_MODEL_ADAPTER::DESC_COL, LIB_TREE_MODEL_ADAPTER::m_col_desc, LIB_TREE_MODEL_ADAPTER::m_col_part, LIB_TREE_MODEL_ADAPTER::m_colWidths, and LIB_TREE_MODEL_ADAPTER::PART_COL.

Freeze()

void LIB_TREE_MODEL_ADAPTER::Freeze ( )

inlineinherited

Definition at line 267 of file lib_tree_model_adapter.h.

{ m_freeze++; }

References LIB_TREE_MODEL_ADAPTER::m_freeze.

Referenced by LIB_TREE_MODEL_ADAPTER::UpdateSearchString().

GenerateInfo()

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

overridevirtual

Reimplemented from LIB_TREE_MODEL_ADAPTER.

Definition at line 81 of file fp_tree_model_adapter.cpp.

{
    return GenerateFootprintInfo( m_libs, aLibId );
}

References GenerateFootprintInfo(), and m_libs.

GetAliasFor()

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

inherited

Return the alias for the given item.

Parameters

aSelection

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

Returns

alias, or nullptr if none is selected

Definition at line 298 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 LIB_TREE_MODEL_ADAPTER::GetAttr ( const wxDataViewItem &  aItem, unsigned int  aCol, wxDataViewItemAttr &  aAttr  ) const

overrideprotectedinherited

Get any formatting for an item.

Parameters

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

Returns

true if the item has non-default attributes

Definition at line 475 of file lib_tree_model_adapter.cpp.

{
    if( IsFrozen() )
        return false;

    LIB_TREE_NODE* node = ToNode( aItem );
    wxASSERT( node );

    if( node->m_Type != LIB_TREE_NODE::LIBID )
    {
        // Currently only aliases are formatted at all
        return false;
    }

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

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

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

{ return NUM_COLS; }

References LIB_TREE_MODEL_ADAPTER::NUM_COLS.

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

{ return "string"; }

GetContextMenuTool()

virtual TOOL_INTERACTIVE* LIB_TREE_MODEL_ADAPTER::GetContextMenuTool ( )

inlinevirtualinherited

Reimplemented in SYMBOL_TREE_SYNCHRONIZING_ADAPTER, and FP_TREE_SYNCHRONIZING_ADAPTER.

Definition at line 274 of file lib_tree_model_adapter.h.

{ return nullptr; }

GetFilter()

SYM_FILTER_TYPE LIB_TREE_MODEL_ADAPTER::GetFilter ( ) const

inlineinherited

Return the active filter.

Definition at line 142 of file lib_tree_model_adapter.h.

{ return m_filter; }

References LIB_TREE_MODEL_ADAPTER::m_filter.

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

getFootprints()

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

protected

Definition at line 58 of file fp_tree_model_adapter.cpp.

{
    std::vector<LIB_TREE_ITEM*> libList;

    auto fullListStart = GFootprintList.GetList().begin();
    auto fullListEnd = GFootprintList.GetList().end();
    std::unique_ptr<FOOTPRINT_INFO> dummy = std::make_unique<FOOTPRINT_INFO_IMPL>( aLibName, wxEmptyString );

    // List is sorted, so use a binary search to find the range of footnotes for our library
    auto libBounds = std::equal_range( fullListStart, fullListEnd, dummy,
            []( const std::unique_ptr<FOOTPRINT_INFO>& a,
                const std::unique_ptr<FOOTPRINT_INFO>& b )
            {
                return StrNumCmp( a->GetLibNickname(), b->GetLibNickname(), false ) < 0;
            } );

    for( auto i = libBounds.first; i != libBounds.second; ++i )
        libList.push_back( i->get() );

    return libList;
}

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

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

GetItemCount()

int LIB_TREE_MODEL_ADAPTER::GetItemCount ( ) const

inherited

Return the number of symbols loaded in the tree.

Definition at line 331 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 PCB_BASE_FRAME::SelectFootprintFromLibTree().

GetLibrariesCount()

virtual int LIB_TREE_MODEL_ADAPTER::GetLibrariesCount ( ) const

inlinevirtualinherited

Return the number of libraries loaded in the tree.

Reimplemented in SYMBOL_TREE_SYNCHRONIZING_ADAPTER, and FP_TREE_SYNCHRONIZING_ADAPTER.

Definition at line 243 of file lib_tree_model_adapter.h.

    {
        return m_tree.m_Children.size();
    }

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

Referenced by SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetLibrariesCount().

GetParent()

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

overrideprotectedinherited

Get the parent of an item.

Returns

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

Definition at line 432 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()

const wxString LIB_TREE_MODEL_ADAPTER::GetPinningSymbol ( ) const

inlineprotectedinherited

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

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

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

GetTreeNodeFor()

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

inherited

Definition at line 325 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 318 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 311 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 LIB_TREE_MODEL_ADAPTER::GetValue ( wxVariant &  aVariant, const wxDataViewItem &  aItem, unsigned int  aCol  ) const

overrideprotectedinherited

Get the value of an item.

Parameters

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

Definition at line 449 of file lib_tree_model_adapter.cpp.

{
    if( IsFrozen() )
    {
        aVariant = wxEmptyString;
        return;
    }

    LIB_TREE_NODE* node = ToNode( aItem );
    wxASSERT( node );

    switch( aCol )
    {
    default:    // column == -1 is used for default Compare function
    case 0:
        aVariant = UnescapeString( node->m_Name );
        break;
    case 1:
        aVariant = node->m_Desc;
        break;
    }
}

References LIB_TREE_MODEL_ADAPTER::IsFrozen(), LIB_TREE_NODE::m_Desc, LIB_TREE_NODE::m_Name, 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 419 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 52 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 LIB_TREE_MODEL_ADAPTER::IsContainer ( const wxDataViewItem &  aItem ) const

overrideprotectedinherited

Check whether an item can have children.

Definition at line 425 of file lib_tree_model_adapter.cpp.

{
    LIB_TREE_NODE* node = ToNode( aItem );
    return node ? node->m_Children.size() : true;
}

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

Referenced by LIB_TREE_MODEL_ADAPTER::HasContainerColumns().

IsFrozen()

bool LIB_TREE_MODEL_ADAPTER::IsFrozen ( ) const

inlineinherited

Definition at line 269 of file lib_tree_model_adapter.h.

{ return m_freeze; }

References LIB_TREE_MODEL_ADAPTER::m_freeze.

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

RefreshTree()

void LIB_TREE_MODEL_ADAPTER::RefreshTree ( )

inherited

Definition at line 392 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;

    int partWidth = m_col_part->GetWidth();
    int descWidth = m_col_desc->GetWidth();

    // 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( descWidth > 0 )
    {
        m_colWidths[PART_COL] = partWidth;
        m_colWidths[DESC_COL] = descWidth;
    }

    m_colWidths[PART_COL] += walk;
    m_colWidths[DESC_COL] -= walk;

    m_col_part->SetWidth( m_colWidths[PART_COL] );
    m_col_desc->SetWidth( m_colWidths[DESC_COL] );
    walk = -walk;
}

References LIB_TREE_MODEL_ADAPTER::DESC_COL, LIB_TREE_MODEL_ADAPTER::m_col_desc, LIB_TREE_MODEL_ADAPTER::m_col_part, LIB_TREE_MODEL_ADAPTER::m_colWidths, and LIB_TREE_MODEL_ADAPTER::PART_COL.

SaveColWidths()

void LIB_TREE_MODEL_ADAPTER::SaveColWidths ( )

inherited

Save the column widths to the config file.

This requires the tree view to still be valid.

Definition at line 106 of file lib_tree_model_adapter.cpp.

{
    if( m_widget )
    {
        APP_SETTINGS_BASE* cfg = Kiface().KifaceSettings();
        cfg->m_LibTree.column_width = m_widget->GetColumn( PART_COL )->GetWidth();
    }
}

References APP_SETTINGS_BASE::LIB_TREE::column_width, Kiface(), KIFACE_BASE::KifaceSettings(), APP_SETTINGS_BASE::m_LibTree, LIB_TREE_MODEL_ADAPTER::m_widget, and LIB_TREE_MODEL_ADAPTER::PART_COL.

SavePinnedItems()

void LIB_TREE_MODEL_ADAPTER::SavePinnedItems ( )

inherited

Definition at line 116 of file lib_tree_model_adapter.cpp.

{
    PROJECT_FILE& project = m_parent->Kiway().Prj().GetProjectFile();

    std::vector<wxString>& entries = ( m_pinnedKey == "pinned_symbol_libs" ) ?
                                     project.m_PinnedSymbolLibs :
                                     project.m_PinnedFootprintLibs;

    entries.clear();
    m_pinnedLibs.clear();

    for( std::unique_ptr<LIB_TREE_NODE>& child: m_tree.m_Children )
    {
        if( child->m_Pinned )
        {
            m_pinnedLibs.push_back( child->m_LibId.GetLibNickname() );
            entries.push_back( child->m_LibId.GetLibNickname() );
        }
    }


}

References PROJECT::GetProjectFile(), KIWAY_HOLDER::Kiway(), LIB_TREE_NODE::m_Children, LIB_TREE_MODEL_ADAPTER::m_parent, LIB_TREE_MODEL_ADAPTER::m_pinnedKey, LIB_TREE_MODEL_ADAPTER::m_pinnedLibs, LIB_TREE_MODEL_ADAPTER::m_tree, KIWAY::Prj(), and project.

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

{
    m_filter = aFilter;
}

References LIB_TREE_MODEL_ADAPTER::m_filter.

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 152 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 PCB_BASE_FRAME::SelectFootprintFromLibTree().

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

                                                           { return false; }

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

{
    m_show_units = aShow;
}

References LIB_TREE_MODEL_ADAPTER::m_show_units.

Thaw()

void LIB_TREE_MODEL_ADAPTER::Thaw ( )

inlineinherited

Definition at line 268 of file lib_tree_model_adapter.h.

{ m_freeze--; }

References LIB_TREE_MODEL_ADAPTER::m_freeze.

Referenced by 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 40 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(), and LIB_TREE_MODEL_ADAPTER::IntoArray().

ToNode()

LIB_TREE_NODE * LIB_TREE_MODEL_ADAPTER::ToNode ( wxDataViewItem  aItem )

staticprotectedinherited

Convert wxDataViewItem -> #SYM_TREE_NODE.

Definition at line 46 of file lib_tree_model_adapter.cpp.

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

Referenced by LIB_TREE_MODEL_ADAPTER::GetAliasFor(), FP_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), LIB_TREE_MODEL_ADAPTER::GetAttr(), LIB_TREE_MODEL_ADAPTER::GetChildren(), LIB_TREE_MODEL_ADAPTER::GetParent(), LIB_TREE_MODEL_ADAPTER::GetTreeNodeFor(), LIB_TREE_MODEL_ADAPTER::GetTypeFor(), LIB_TREE_MODEL_ADAPTER::GetUnitFor(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue(), LIB_TREE_MODEL_ADAPTER::GetValue(), FP_TREE_SYNCHRONIZING_ADAPTER::IsContainer(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::IsContainer(), and LIB_TREE_MODEL_ADAPTER::IsContainer().

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

        for( std::unique_ptr<LIB_TREE_NODE>& child: m_tree.m_Children )
        {
            if( child->m_Pinned )
                child->m_Score *= 2;
        }

        wxStringTokenizer tokenizer( aSearch );

        while( tokenizer.HasMoreTokens() )
        {
            const wxString term = tokenizer.GetNextToken().Lower();
            EDA_COMBINED_MATCHER matcher( term );

            m_tree.UpdateScore( matcher );
        }

        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() )
                item = parent;
        }

        m_widget->EnsureVisible( item );
    }
}

References 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_libs

FP_LIB_TABLE* FP_TREE_MODEL_ADAPTER::m_libs

protected

Definition at line 54 of file fp_tree_model_adapter.h.

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

m_tree

LIB_TREE_NODE_ROOT LIB_TREE_MODEL_ADAPTER::m_tree

protectedinherited

Definition at line 391 of file lib_tree_model_adapter.h.

Referenced by AddLibraries(), SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), LIB_TREE_MODEL_ADAPTER::AssignIntrinsicRanks(), FP_TREE_SYNCHRONIZING_ADAPTER::deleteLibrary(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::deleteLibrary(), LIB_TREE_MODEL_ADAPTER::DoAddLibraryNode(), LIB_TREE_MODEL_ADAPTER::FindItem(), LIB_TREE_MODEL_ADAPTER::GetChildren(), LIB_TREE_MODEL_ADAPTER::GetItemCount(), LIB_TREE_MODEL_ADAPTER::GetLibrariesCount(), LIB_TREE_MODEL_ADAPTER::SavePinnedItems(), LIB_TREE_MODEL_ADAPTER::ShowPreselect(), LIB_TREE_MODEL_ADAPTER::ShowResults(), LIB_TREE_MODEL_ADAPTER::ShowSingleLibrary(), FP_TREE_SYNCHRONIZING_ADAPTER::Sync(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), and LIB_TREE_MODEL_ADAPTER::UpdateSearchString().

---

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

• fp_tree_model_adapter.h
• fp_tree_model_adapter.cpp