KiCad PCB EDA Suite
lib_tree_model_adapter.h
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2017 Chris Pavlina <pavlina.chris@gmail.com>
5  * Copyright (C) 2014 Henner Zeller <h.zeller@acm.org>
6  * Copyright (C) 2014-2019 KiCad Developers, see AUTHORS.txt for contributors.
7  *
8  * This program is free software: you can redistribute it and/or modify it
9  * under the terms of the GNU General Public License as published by the
10  * Free Software Foundation, either version 3 of the License, or (at your
11  * option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful, but
14  * WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License along
19  * with this program. If not, see <http://www.gnu.org/licenses/>.
20  */
21 
22 #ifndef LIB_TREE_MODEL_ADAPTER_H
23 #define LIB_TREE_MODEL_ADAPTER_H
24 
25 #include <lib_id.h>
26 #include <lib_tree_model.h>
27 #include <wx/hashmap.h>
28 #include <wx/dataview.h>
29 #include <wx/headerctrl.h>
30 #include <vector>
31 #include <functional>
32 #include <set>
33 
92 class APP_SETTINGS_BASE;
93 class TOOL_INTERACTIVE;
94 class EDA_BASE_FRAME;
95 
96 
97 class LIB_TREE_MODEL_ADAPTER: public wxDataViewModel
98 {
99 public:
105 
110  {
113  };
114 
119  {
120  PART_COL = 0,
123  };
124 
129  void SaveColWidths();
130  void SavePinnedItems();
131 
137  void SetFilter( CMP_FILTER_TYPE aFilter );
138 
142  CMP_FILTER_TYPE GetFilter() const { return m_filter; }
143 
150  void ShowUnits( bool aShow );
151 
159  void SetPreselectNode( LIB_ID const& aLibId, int aUnit );
160 
169  void DoAddLibrary( wxString const& aNodeName, wxString const& aDesc,
170  std::vector<LIB_TREE_ITEM*> const& aItemList, bool presorted );
171 
172 
177 
184  void UpdateSearchString( wxString const& aSearch, bool aState );
185 
192  void AttachTo( wxDataViewCtrl* aDataViewCtrl );
193 
199 
208  LIB_ID GetAliasFor( const wxDataViewItem& aSelection ) const;
209 
219  int GetUnitFor( const wxDataViewItem& aSelection ) const;
220 
229  LIB_TREE_NODE::TYPE GetTypeFor( const wxDataViewItem& aSelection ) const;
230 
231  LIB_TREE_NODE* GetTreeNodeFor( const wxDataViewItem& aSelection ) const;
232 
233  virtual wxString GenerateInfo( LIB_ID const& aLibId, int aUnit ) { return wxEmptyString; };
234 
238  int GetItemCount() const;
239 
243  virtual int GetLibrariesCount() const
244  {
245  return m_tree.m_Children.size();
246  }
247 
254  wxDataViewItem FindItem( const LIB_ID& aLibId );
255 
261  unsigned int GetChildren( wxDataViewItem const& aItem,
262  wxDataViewItemArray& aChildren ) const override;
263 
264  // Freezing/Thawing. Used when updating the table model so that we don't try and fetch
265  // values during updating. Primarily a problem on OSX which doesn't pay attention to the
266  // wxDataViewCtrl's freeze count when updating the keyWindow.
267  void Freeze() { m_freeze++; }
268  void Thaw() { m_freeze--; }
269  bool IsFrozen() const { return m_freeze; }
270 
271  void RefreshTree();
272 
273  // Allows subclasses to nominate a context menu handler.
274  virtual TOOL_INTERACTIVE* GetContextMenuTool() { return nullptr; }
275 
276 protected:
277  static wxDataViewItem ToItem( LIB_TREE_NODE const* aNode );
278  static LIB_TREE_NODE* ToNode( wxDataViewItem aItem );
279  static unsigned int IntoArray( LIB_TREE_NODE const& aNode, wxDataViewItemArray& aChildren );
280 
286  LIB_TREE_MODEL_ADAPTER( EDA_BASE_FRAME* aParent, wxString aPinnedKey );
287 
288  LIB_TREE_NODE_LIB& DoAddLibraryNode( wxString const& aNodeName, wxString const& aDesc );
289 
293  bool HasContainerColumns( wxDataViewItem const& aItem ) const override;
294 
298  bool IsContainer( wxDataViewItem const& aItem ) const override;
299 
305  wxDataViewItem GetParent( wxDataViewItem const& aItem ) const override;
306 
307  unsigned int GetColumnCount() const override { return NUM_COLS; }
308 
312  wxString GetColumnType( unsigned int aCol ) const override { return "string"; }
313 
321  void GetValue( wxVariant& aVariant,
322  wxDataViewItem const& aItem,
323  unsigned int aCol ) const override;
324 
329  bool SetValue( wxVariant const& aVariant,
330  wxDataViewItem const& aItem,
331  unsigned int aCol ) override { return false; }
332 
341  bool GetAttr( wxDataViewItem const& aItem,
342  unsigned int aCol,
343  wxDataViewItemAttr& aAttr ) const override;
344 
350  const wxString GetPinningSymbol() const
351  {
352  return wxString::FromUTF8( "☆ " );
353  }
354 
355 private:
360  void FindAndExpand( LIB_TREE_NODE& aNode, std::function<bool( LIB_TREE_NODE const* )> aFunc,
361  LIB_TREE_NODE** aHighScore );
362 
367 
372 
377 
378 protected:
380 
381 private:
383 
388  int m_freeze;
389 
390  wxDataViewColumn* m_col_part;
391  wxDataViewColumn* m_col_desc;
392  wxDataViewCtrl* m_widget;
393 
395  wxArrayString m_pinnedLibs;
396  wxString m_pinnedKey;
397 };
398 
399 #endif // LIB_TREE_MODEL_ADAPTER_H
400 
void DoAddLibrary(wxString const &aNodeName, wxString const &aDesc, std::vector< LIB_TREE_ITEM * > const &aItemList, bool presorted)
Add the given list of components by alias.
void AssignIntrinsicRanks()
Sort the tree and assign ranks after adding libraries.
bool IsContainer(wxDataViewItem const &aItem) const override
Check whether an item can have children.
CMP_FILTER_TYPE
This enum allows a selective filtering of components to list.
virtual int GetLibrariesCount() const
Return the number of libraries loaded in the tree.
int GetUnitFor(const wxDataViewItem &aSelection) const
Return the unit for the given item.
void SetPreselectNode(LIB_ID const &aLibId, int aUnit)
Set the component name to be selected if there are no search results.
LIB_TREE_NODE * ShowResults()
Find and expand successful search results.
LIB_TREE_NODE::TYPE GetTypeFor(const wxDataViewItem &aSelection) const
Return node type for the given item.
LIB_TREE_NODE * ShowPreselect()
Find and expand preselected node.
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()
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
virtual wxString GenerateInfo(LIB_ID const &aLibId, int aUnit)
static wxDataViewItem ToItem(LIB_TREE_NODE const *aNode)
Convert CMP_TREE_NODE -> wxDataViewItem.
LIB_TREE_NODE * GetTreeNodeFor(const wxDataViewItem &aSelection) const
static unsigned int IntoArray(LIB_TREE_NODE const &aNode, wxDataViewItemArray &aChildren)
Convert CMP_TREE_NODE's children to wxDataViewItemArray.
bool GetAttr(wxDataViewItem const &aItem, unsigned int aCol, wxDataViewItemAttr &aAttr) const override
Get any formatting for an item.
int GetItemCount() const
Return the number of components loaded in the tree.
bool HasContainerColumns(wxDataViewItem const &aItem) const override
Check whether a container has columns too.
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Definition: app_settings.h:99
void FindAndExpand(LIB_TREE_NODE &aNode, std::function< bool(LIB_TREE_NODE const *)> aFunc, LIB_TREE_NODE **aHighScore)
Find any results worth highlighting and expand them, according to given criteria The highest-scoring ...
Node type: root.
void FinishTreeInitialization()
A final-stage initialization to be called after the window hierarchy has been realized and the window...
Node type: library.
void SetFilter(CMP_FILTER_TYPE aFilter)
Set the component filter type.
static LIB_TREE_NODE * ToNode(wxDataViewItem aItem)
Convert wxDataViewItem -> CMP_TREE_NODE.
wxDataViewItem GetParent(wxDataViewItem const &aItem) const override
Get the parent of an item.
Model class in the component selector Model-View-Adapter (mediated MVC) architecture.
LIB_TREE_NODE_LIB & DoAddLibraryNode(wxString const &aNodeName, wxString const &aDesc)
void UpdateSearchString(wxString const &aSearch, bool aState)
Set the search string provided by the user.
virtual TOOL_INTERACTIVE * GetContextMenuTool()
TREE_COLS
This enum defines the order of the columns in the tree view.
LIB_ID GetAliasFor(const wxDataViewItem &aSelection) const
Return the alias for the given item.
const wxString GetPinningSymbol() const
void AssignIntrinsicRanks(bool presorted=false)
Store intrinsic ranks on all children of this node.
void GetValue(wxVariant &aVariant, wxDataViewItem const &aItem, unsigned int aCol) const override
Get the value of an item.
bool SetValue(wxVariant const &aVariant, wxDataViewItem const &aItem, unsigned int aCol) override
Set the value of an item.
The base frame for deriving all KiCad main window classes.
wxDataViewItem FindItem(const LIB_ID &aLibId)
Returns tree item corresponding to part.
LIB_TREE_NODE * ShowSingleLibrary()
Find and expand a library if there is only one.
PTR_VECTOR m_Children
void SaveColWidths()
Save the column widths to the config file.
unsigned int GetChildren(wxDataViewItem const &aItem, wxDataViewItemArray &aChildren) const override
Populate a list of all the children of an item.
void AttachTo(wxDataViewCtrl *aDataViewCtrl)
Attach to a wxDataViewCtrl and initialize it.
CMP_FILTER_TYPE GetFilter() const
Return the active filter.
void ShowUnits(bool aShow)
Whether or not to show units.
LIB_TREE_MODEL_ADAPTER(EDA_BASE_FRAME *aParent, wxString aPinnedKey)
Creates the adapter.