31#include <wx/tokenzr.h>
32#include <wx/wupdlock.h>
33#include <wx/settings.h>
50 return wxSize( GetOwner()->GetWidth(), GetTextExtent(
m_text ).y + 2 );
53 bool GetValue( wxVariant& aValue )
const override
59 bool SetValue(
const wxVariant& aValue )
override
61 m_text = aValue.GetString();
65 void SetAttr(
const wxDataViewItemAttr& aAttr )
override
70 wxDataViewItemAttr realAttr = aAttr;
71 realAttr.SetStrikethrough(
false );
73 wxDataViewCustomRenderer::SetAttr( realAttr );
76 bool Render( wxRect aRect, wxDC *dc,
int aState )
override
78 RenderBackground( dc, aRect );
83 points[0] = aRect.GetTopLeft();
84 points[1] = aRect.GetTopRight() + wxPoint( -4, 0 );
85 points[2] = aRect.GetTopRight() + wxPoint( 0, aRect.GetHeight() / 2 );
86 points[3] = aRect.GetBottomRight() + wxPoint( -4, 1 );
87 points[4] = aRect.GetBottomLeft() + wxPoint( 0, 1 );
88 points[5] = aRect.GetTopLeft();
91 dc->DrawLines( 6, points );
100 if( aState & wxDATAVIEW_CELL_SELECTED )
101 dc->SetTextForeground( wxSystemSettings::GetColour( wxSYS_COLOUR_LISTBOXHIGHLIGHTTEXT ) );
103 RenderText(
m_text, 0, aRect, dc, 0 );
105 RenderText(
m_text, 0, aRect, dc, aState );
118 return wxDataViewItem(
const_cast<void*
>(
static_cast<void const*
>( aNode ) ) );
129 const wxString& aPinnedKey ) :
132 m_sort_mode( BEST_MATCH ),
133 m_show_units( true ),
134 m_preselect_unit( 0 ),
165 std::vector<wxString> openLibs;
166 wxDataViewItem rootItem(
nullptr );
167 wxDataViewItemArray children;
171 for(
const wxDataViewItem& child : children )
174 openLibs.emplace_back(
ToNode( child )->m_LibId.GetLibNickname().wx_str() );
183 wxWindowUpdateLocker updateLock(
m_widget );
185 for(
const wxString& lib : aLibs )
204 for(
const std::pair<const wxString, wxDataViewColumn*>& pair :
m_colNameMap )
226 const wxString& aDesc,
238 const std::vector<LIB_TREE_ITEM*>& aItemList,
239 bool pinned,
bool presorted )
259 wxWindowUpdateLocker updateLock(
m_widget );
278 m_widget->Collapse( wxDataViewItem( &*child ) );
290 wxStringTokenizer tokenizer( aSearch );
291 bool firstTerm =
true;
293 while( tokenizer.HasMoreTokens() )
296 wxString term = tokenizer.GetNextToken().Lower();
302 if( term.Contains(
":" ) )
305 wxString lib = term.BeforeFirst(
':' );
306 wxString itemName = term.AfterFirst(
':' );
328 wxDataViewItem item =
ToItem( firstMatch );
339 wxDataViewItem parent =
GetParent( item );
354 aDataViewCtrl->AssociateModel(
this );
373 doAddColumn( colName, colName == wxT(
"Description" ) );
412 wxString translatedHeader = aTranslate ? wxGetTranslation( aHeader ) : aHeader;
423 wxDataViewColumn* col =
new wxDataViewColumn(
425 wxDATAVIEW_CELL_INERT |
static_cast<int>( wxDATAVIEW_COL_RESIZABLE ) );
428 col->SetMinWidth( headerMinWidth.x );
470 return node ? node->
m_Unit : 0;
477 return node ? node->
m_Type : LIB_TREE_NODE::TYPE::INVALID;
483 return ToNode( aSelection );
492 n += lib->m_Children.size();
507 return ToItem( lib.get() );
509 for( std::unique_ptr<LIB_TREE_NODE>& alias: lib->m_Children )
512 return ToItem( alias.get() );
518 return wxDataViewItem();
529 wxDataViewItemArray& aChildren )
const
532 unsigned int count = 0;
534 if( node->
m_Type == LIB_TREE_NODE::TYPE::ROOT
535 || node->
m_Type == LIB_TREE_NODE::TYPE::LIBRARY
538 for( std::unique_ptr<LIB_TREE_NODE>
const& child: node->
m_Children )
540 if( child->m_Score > 0 )
542 aChildren.Add(
ToItem( &*child ) );
554 wxDataViewColumn* col =
nullptr;
559 for( ; idx <
m_columns.size() - 1; idx++ )
569 totalWidth += col->GetWidth();
572 int remainingWidth =
m_widget->GetSize().x - totalWidth;
586 std::vector<int> widths;
588 for(
const wxDataViewColumn* col :
m_columns )
589 widths.emplace_back( col->GetWidth() );
591 wxASSERT( widths.size() );
605 colIt->second += walk;
609 colIt->second -= walk;
647 if( !node || !parent || parent->
m_Type == LIB_TREE_NODE::TYPE::ROOT )
655 const wxDataViewItem& aItem,
656 unsigned int aCol )
const
660 aVariant = wxEmptyString;
683 if( key == wxT(
"Description" ) )
685 else if( node->
m_Fields.count( key ) )
688 valueStr = wxEmptyString;
694 valueStr.Replace( wxS(
"\n" ), wxS(
" " ) );
702 wxDataViewItemAttr& aAttr )
const
708 wxCHECK( node,
false );
710 if( node->
m_Type == LIB_TREE_NODE::TYPE::ITEM )
715 aAttr.SetItalic(
true );
726 for( std::unique_ptr<LIB_TREE_NODE>& node: aNode.
m_Children )
728 int r = f( node.get() );
748 if( n->
m_Type == LIB_TREE_NODE::TYPE::ITEM && n->
m_Score > 1 )
752 else if( n->m_Score > firstMatch->m_Score )
755 m_widget->ExpandAncestors( ToItem( n ) );
768 if( n->
m_Name.StartsWith(
"-- " ) )
771 if( n->
m_Type == LIB_TREE_NODE::TYPE::ITEM
776 m_widget->ExpandAncestors( ToItem( n ) );
779 else if( n->
m_Type == LIB_TREE_NODE::TYPE::UNIT
784 m_widget->ExpandAncestors( ToItem( n ) );
799 if( !child->m_Name.StartsWith(
"-- " ) )
809 if( n->
m_Type == LIB_TREE_NODE::TYPE::ITEM )
812 m_widget->ExpandAncestors( ToItem( n ) );
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
The base frame for deriving all KiCad main window classes.
APP_SETTINGS_BASE * KifaceSettings() const
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
A logical library item identifier and consists of various portions much like a URI.
bool IsValid() const
Check if this LID_ID is valid.
const UTF8 & GetLibItemName() const
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
A mix-in to provide polymorphism between items stored in libraries (symbols, aliases and footprints).
std::vector< wxString > GetOpenLibs() const
int GetUnitFor(const wxDataViewItem &aSelection) const
Return the unit for the given item.
LIB_ID m_preselect_lib_id
LIB_TREE_NODE::TYPE GetTypeFor(const wxDataViewItem &aSelection) const
Return node type for the given item.
bool GetAttr(const wxDataViewItem &aItem, unsigned int aCol, wxDataViewItemAttr &aAttr) const override
Get any formatting for an item.
LIB_TREE_NODE_ROOT m_tree
std::map< wxString, int > m_colWidths
void FinishTreeInitialization()
A final-stage initialization to be called after the window hierarchy has been realized and the window...
void addColumnIfNecessary(const wxString &aHeader)
void PinLibrary(LIB_TREE_NODE *aTreeNode)
virtual PROJECT::LIB_TYPE_T getLibType()=0
virtual wxDataViewItem GetCurrentDataViewItem()
void SetPreselectNode(const LIB_ID &aLibId, int aUnit)
Set the symbol name to be selected if there are no search results.
static LIB_TREE_NODE * ToNode(wxDataViewItem aItem)
Convert wxDataViewItem -> #SYM_TREE_NODE.
LIB_ID GetAliasFor(const wxDataViewItem &aSelection) const
Return the alias for the given item.
~LIB_TREE_MODEL_ADAPTER()
Destructor.
void AttachTo(wxDataViewCtrl *aDataViewCtrl)
Attach to a wxDataViewCtrl and initialize it.
void DoAddLibrary(const wxString &aNodeName, const wxString &aDesc, const std::vector< LIB_TREE_ITEM * > &aItemList, bool pinned, bool presorted)
Add the given list of symbols by alias.
void SetShownColumns(const std::vector< wxString > &aColumnNames)
Sets which columns are shown in the widget.
static wxDataViewItem ToItem(const LIB_TREE_NODE *aNode)
Convert #SYM_TREE_NODE -> wxDataViewItem.
bool IsContainer(const wxDataViewItem &aItem) const override
Check whether an item can have children.
static const wxString GetPinningSymbol()
void ShowUnits(bool aShow)
Whether or not to show units.
LIB_TREE_NODE * GetTreeNodeFor(const wxDataViewItem &aSelection) const
unsigned int GetChildren(const wxDataViewItem &aItem, wxDataViewItemArray &aChildren) const override
Populate a list of all the children of an item.
void SaveSettings()
Save the column widths to the config file.
@ NAME_COL
Library or library item name column.
std::map< unsigned, wxString > m_colIdxMap
wxDataViewColumn * doAddColumn(const wxString &aHeader, bool aTranslate=true)
LIB_TREE_MODEL_ADAPTER(EDA_BASE_FRAME *aParent, const wxString &aPinnedKey)
Create the adapter.
std::vector< wxDataViewColumn * > m_columns
std::vector< wxString > GetShownColumns() const
wxDataViewCtrl * m_widget
int GetItemCount() const
Return the number of symbols loaded in the tree.
const LIB_TREE_NODE * ShowResults()
Find and expand successful search results.
std::vector< wxString > m_shownColumns
void GetValue(wxVariant &aVariant, const wxDataViewItem &aItem, unsigned int aCol) const override
Get the value of an item.
void UnpinLibrary(LIB_TREE_NODE *aTreeNode)
void DoRemoveLibrary(const wxString &aNodeName)
Remove the library by name.
std::map< wxString, wxDataViewColumn * > m_colNameMap
bool HasContainerColumns(const wxDataViewItem &aItem) const override
Check whether a container has columns too.
wxDataViewItem GetParent(const wxDataViewItem &aItem) const override
Get the parent of an item.
LIB_TREE_NODE_LIBRARY & DoAddLibraryNode(const wxString &aNodeName, const wxString &aDesc, bool pinned)
std::vector< wxString > m_availableColumns
EDA_BASE_FRAME * m_parent
wxDataViewItem FindItem(const LIB_ID &aLibId)
Returns tree item corresponding to part.
void UpdateSearchString(const wxString &aSearch, bool aState)
Set the search string provided by the user.
std::function< bool(LIB_TREE_NODE &aNode)> * m_filter
void OpenLibs(const std::vector< wxString > &aLibs)
LIB_TREE_NODE_ITEM & AddItem(LIB_TREE_ITEM *aItem)
Construct a new alias node, add it to this library, and return it.
LIB_TREE_NODE_LIBRARY & AddLib(wxString const &aName, wxString const &aDesc)
Construct an empty library node, add it to the root, and return it.
void RemoveLib(wxString const &aName)
Remove a library node from the root.
void UpdateScore(EDA_COMBINED_MATCHER *aMatcher, const wxString &aLib, std::function< bool(LIB_TREE_NODE &aNode)> *aFilter) override
Update the score for this part.
Model class in the component selector Model-View-Adapter (mediated MVC) architecture.
void SortNodes(bool aUseScores)
Sort child nodes quickly and recursively (IntrinsicRanks must have been set).
std::map< wxString, wxString > m_Fields
List of weighted search terms.
virtual void ResetScore()
Initialize scores recursively.
void AssignIntrinsicRanks(bool presorted=false)
Store intrinsic ranks on all children of this node.
void SetAttr(const wxDataViewItemAttr &aAttr) override
bool SetValue(const wxVariant &aValue) override
wxSize GetSize() const override
bool GetValue(wxVariant &aValue) const override
bool Render(wxRect aRect, wxDC *dc, int aState) override
void PinLibrary(const wxString &aLibrary, enum LIB_TYPE_T aLibType)
void UnpinLibrary(const wxString &aLibrary, enum LIB_TYPE_T aLibType)
static void recursiveDescent(wxSizer *aSizer, std::map< int, wxString > &aLabels)
Base window classes and related definitions.
Abstract pattern-matching tool and implementations.
void recursiveDescent(LIB_TREE_NODE &aNode, const std::function< int(const LIB_TREE_NODE *)> &f)
static const int kDataViewIndent
KICOMMON_API wxSize GetTextSize(const wxString &aSingleLine, wxWindow *aWindow)
Return the size of aSingleLine of text when it is rendered in aWindow using whatever font is currentl...
wxString UnescapeString(const wxString &aSource)
std::vector< wxString > columns
Ordered list of visible columns in the tree.
std::map< wxString, int > column_widths
Column widths, keyed by header name.
std::vector< wxString > open_libs
list of libraries the user has open in the tree
Functions to provide common constants and other functions to assist in making a consistent UI.