31#include <wx/tokenzr.h>
32#include <wx/wupdlock.h>
33#include <wx/settings.h>
51 return wxSize( GetOwner()->GetWidth(), GetTextExtent(
m_text ).y + 2 );
54 bool GetValue( wxVariant& aValue )
const override
60 bool SetValue(
const wxVariant& aValue )
override
62 m_text = aValue.GetString();
66 void SetAttr(
const wxDataViewItemAttr& aAttr )
override
71 wxDataViewItemAttr realAttr = aAttr;
72 realAttr.SetStrikethrough(
false );
74 wxDataViewCustomRenderer::SetAttr( realAttr );
77 bool Render( wxRect aRect, wxDC *dc,
int aState )
override
79 RenderBackground( dc, aRect );
84 points[0] = aRect.GetTopLeft();
85 points[1] = aRect.GetTopRight() + wxPoint( -4, 0 );
86 points[2] = aRect.GetTopRight() + wxPoint( 0, aRect.GetHeight() / 2 );
87 points[3] = aRect.GetBottomRight() + wxPoint( -4, 1 );
88 points[4] = aRect.GetBottomLeft() + wxPoint( 0, 1 );
89 points[5] = aRect.GetTopLeft();
92 dc->DrawLines( 6, points );
101 if( aState & wxDATAVIEW_CELL_SELECTED )
102 dc->SetTextForeground( wxSystemSettings::GetColour( wxSYS_COLOUR_LISTBOXHIGHLIGHTTEXT ) );
104 RenderText(
m_text, 0, aRect, dc, 0 );
106 RenderText(
m_text, 0, aRect, dc, aState );
119 return wxDataViewItem(
const_cast<void*
>(
static_cast<void const*
>( aNode ) ) );
130 const wxString& aPinnedKey,
134 m_cfg( aSettingsStruct ),
147 for(
const std::pair<const wxString, int>& pair :
m_cfg.column_widths )
166 std::vector<wxString> openLibs;
167 wxDataViewItem rootItem(
nullptr );
168 wxDataViewItemArray children;
172 for(
const wxDataViewItem& child : children )
175 openLibs.emplace_back(
ToNode( child )->m_LibId.GetLibNickname().wx_str() );
184 wxWindowUpdateLocker updateLock(
m_widget );
186 for(
const wxString& lib : aLibs )
201 m_cfg.column_widths.clear();
203 for(
const std::pair<const wxString, wxDataViewColumn*>& pair :
m_colNameMap )
204 m_cfg.column_widths[pair.first] = pair.second->GetWidth();
225 const wxString& aDesc,
237 const wxString& aDesc,
238 const std::vector<LIB_TREE_ITEM*>& aItemList,
239 bool pinned,
bool presorted )
254 m_tree.RemoveGroup( aRecentGroup, aPlacedGroup );
261 wxWindowUpdateLocker updateLock(
m_widget );
277 if( !aState && !aSearch.IsNull() &&
m_tree.m_Children.size() )
279 for( std::unique_ptr<LIB_TREE_NODE>& child:
m_tree.m_Children )
280 m_widget->Collapse( wxDataViewItem( &*child ) );
292 constexpr int MAX_TERMS = 100;
294 wxStringTokenizer tokenizer( aSearch,
" \t\r\n", wxTOKEN_STRTOK );
295 std::vector<std::unique_ptr<EDA_COMBINED_MATCHER>> termMatchers;
297 while( tokenizer.HasMoreTokens() && termMatchers.size() < MAX_TERMS )
299 wxString term = tokenizer.GetNextToken().Lower();
300 termMatchers.emplace_back( std::make_unique<EDA_COMBINED_MATCHER>( term,
CTX_LIBITEM ) );
323 wxDataViewItem item =
ToItem( firstMatch );
334 wxDataViewItem parent =
GetParent( item );
349 aDataViewCtrl->AssociateModel(
this );
368 doAddColumn( colName, colName == wxT(
"Description" ) );
409 for(
const std::unique_ptr<LIB_TREE_NODE>& lib:
m_tree.m_Children )
411 if( lib->m_IsRecentlyUsedGroup )
412 lib->m_Name = wxT(
"-- " ) +
_(
"Recently Used" ) + wxT(
" --" );
413 else if( lib->m_IsAlreadyPlacedGroup )
414 lib->m_Name = wxT(
"-- " ) +
_(
"Already Placed" ) + wxT(
" --" );
421 wxString translatedHeader = aTranslate ? wxGetTranslation( aHeader ) : aHeader;
432 wxDataViewColumn* col =
new wxDataViewColumn(
434 wxDATAVIEW_CELL_INERT |
static_cast<int>( wxDATAVIEW_COL_RESIZABLE ) );
437 col->SetMinWidth( headerMinWidth.x );
467 for( std::unique_ptr<LIB_TREE_NODE>& lib:
m_tree.m_Children )
482 return node ? node->
m_Unit : 0;
489 return node ? node->
m_Type : LIB_TREE_NODE::TYPE::INVALID;
495 return ToNode( aSelection );
503 for(
const std::unique_ptr<LIB_TREE_NODE>& lib:
m_tree.m_Children )
504 n += lib->m_Children.size();
512 for( std::unique_ptr<LIB_TREE_NODE>& lib:
m_tree.m_Children )
519 return ToItem( lib.get() );
521 for( std::unique_ptr<LIB_TREE_NODE>& alias: lib->m_Children )
524 return ToItem( alias.get() );
530 return wxDataViewItem();
541 wxDataViewItemArray& aChildren )
const
544 unsigned int count = 0;
546 if( node->
m_Type == LIB_TREE_NODE::TYPE::ROOT
547 || node->
m_Type == LIB_TREE_NODE::TYPE::LIBRARY
550 for( std::unique_ptr<LIB_TREE_NODE>
const& child: node->
m_Children )
552 if( child->m_Score > 0 )
554 aChildren.Add(
ToItem( &*child ) );
566 wxDataViewColumn* col =
nullptr;
571 for( ; idx <
m_columns.size() - 1; idx++ )
581 totalWidth += col->GetWidth();
584 int remainingWidth =
m_widget->GetSize().x - totalWidth;
598 std::vector<int> widths;
600 for(
const wxDataViewColumn* col :
m_columns )
601 widths.emplace_back( col->GetWidth() );
603 wxASSERT( widths.size() );
617 colIt->second += walk;
621 colIt->second -= walk;
659 if( !node || !parent || parent->
m_Type == LIB_TREE_NODE::TYPE::ROOT )
667 const wxDataViewItem& aItem,
668 unsigned int aCol )
const
672 aVariant = wxEmptyString;
695 if( key == wxT(
"Description" ) )
697 else if( node->
m_Fields.count( key ) )
700 valueStr = wxEmptyString;
706 valueStr.Replace( wxS(
"\n" ), wxS(
" " ) );
714 wxDataViewItemAttr& aAttr )
const
720 wxCHECK( node,
false );
722 if( node->
m_Type == LIB_TREE_NODE::TYPE::ITEM )
727 aAttr.SetItalic(
true );
738 for( std::unique_ptr<LIB_TREE_NODE>& node: aNode.
m_Children )
740 int r = f( node.get() );
760 if( n->
m_Type == LIB_TREE_NODE::TYPE::ITEM && n->
m_Score > 1 )
780 if( n->
m_Name.StartsWith(
"-- " ) )
783 if( n->
m_Type == LIB_TREE_NODE::TYPE::ITEM
791 else if( n->
m_Type == LIB_TREE_NODE::TYPE::UNIT
809 for(
const std::unique_ptr<LIB_TREE_NODE>& child :
m_tree.m_Children )
811 if( !child->m_Name.StartsWith(
"-- " ) )
821 if( n->
m_Type == LIB_TREE_NODE::TYPE::ITEM )
The base frame for deriving all KiCad main window classes.
A logical library item identifier and consists of various portions much like a URI.
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).
LIB_TREE_MODEL_ADAPTER(EDA_BASE_FRAME *aParent, const wxString &aPinnedKey, APP_SETTINGS_BASE::LIB_TREE &aSettingsStruct)
Create the adapter.
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.
APP_SETTINGS_BASE::LIB_TREE & m_cfg
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 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)
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.
void ShowChangedLanguage()
const LIB_TREE_NODE * ShowResults()
Find and expand successful search results.
std::vector< wxString > m_shownColumns
void RemoveGroup(bool aRecentlyUsedGroup, bool aAlreadyPlacedGroup)
Remove one of the system groups from the library.
void GetValue(wxVariant &aVariant, const wxDataViewItem &aItem, unsigned int aCol) const override
Get the value of an item.
void UnpinLibrary(LIB_TREE_NODE *aTreeNode)
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
LIB_TREE_NODE_LIBRARY & 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.
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.
Model class in the component selector Model-View-Adapter (mediated MVC) architecture.
std::map< wxString, wxString > m_Fields
List of weighted search terms.
void AssignIntrinsicRanks(const std::vector< wxString > &aShownColumns, 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
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)
Functions to provide common constants and other functions to assist in making a consistent UI.