lib_tree_model_adapter.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2017 Chris Pavlina <[email protected]>
 * Copyright (C) 2014 Henner Zeller <[email protected]>
 * Copyright (C) 2023 CERN
 * Copyright (C) 2014-2024 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program. If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef LIB_TREE_MODEL_ADAPTER_H
#define LIB_TREE_MODEL_ADAPTER_H
 
#include <eda_base_frame.h>
#include <lib_id.h>
#include <lib_tree_model.h>
#include <wx/hashmap.h>
#include <wx/dataview.h>
#include <wx/headerctrl.h>
#include <vector>
#include <functional>
#include <set>
#include <map>
 
#include <project.h>
 
class APP_SETTINGS_BASE;
class TOOL_INTERACTIVE;
class EDA_BASE_FRAME;
 
 
class LIB_TREE_MODEL_ADAPTER: public wxDataViewModel
{
public:
 static const wxString GetPinningSymbol()
 {
 return wxString::FromUTF8( "☆ " );
 }
 
public:
 ~LIB_TREE_MODEL_ADAPTER();
 
 enum TREE_COLS
 {
 NAME_COL = 0, 
 DESC_COL, 
 NUM_COLS 
 };
 
 enum SORT_MODE
 {
 BEST_MATCH = 0,
 ALPHABETIC
 };
 
 void SaveSettings();
 
 void SetFilter( std::function<bool( LIB_TREE_NODE& aNode )>* aFilter ) { m_filter = aFilter; }
 
 std::function<bool( LIB_TREE_NODE& aNode )>* GetFilter() const { return m_filter; }
 
 void SetSortMode( SORT_MODE aMode ) { m_sort_mode = aMode; }
 SORT_MODE GetSortMode() const { return m_sort_mode; }
 
 void ShowUnits( bool aShow );
 
 void SetPreselectNode( const LIB_ID& aLibId, int aUnit );
 
 void DoAddLibrary( const wxString& aNodeName, const wxString& aDesc,
 const std::vector<LIB_TREE_ITEM*>& aItemList,
 bool pinned, bool presorted );
 
 void DoRemoveLibrary( const wxString& aNodeName );
 
 std::vector<wxString> GetAvailableColumns() const { return m_availableColumns; }
 
 std::vector<wxString> GetShownColumns() const { return m_shownColumns; }
 
 std::vector<wxString> GetOpenLibs() const;
 void OpenLibs( const std::vector<wxString>& aLibs );
 
 void SetShownColumns( const std::vector<wxString>& aColumnNames );
 
 void AssignIntrinsicRanks() { m_tree.AssignIntrinsicRanks(); }
 
 void UpdateSearchString( const wxString& aSearch, bool aState );
 
 void AttachTo( wxDataViewCtrl* aDataViewCtrl );
 
 void FinishTreeInitialization();
 
 LIB_ID GetAliasFor( const wxDataViewItem& aSelection ) const;
 
 int GetUnitFor( const wxDataViewItem& aSelection ) const;
 
 LIB_TREE_NODE::TYPE GetTypeFor( const wxDataViewItem& aSelection ) const;
 
 LIB_TREE_NODE* GetTreeNodeFor( const wxDataViewItem& aSelection ) const;
 
 virtual wxString GenerateInfo( const LIB_ID& aLibId, int aUnit ) { return wxEmptyString; }
 
 virtual bool HasPreview( const wxDataViewItem& aItem ) { return false; }
 virtual void ShowPreview( wxWindow* aParent, const wxDataViewItem& aItem ) {}
 
 TOOL_DISPATCHER* GetToolDispatcher() const { return m_parent->GetToolDispatcher(); }
 
 int GetItemCount() const;
 
 virtual int GetLibrariesCount() const
 {
 return m_tree.m_Children.size();
 }
 
 wxDataViewItem FindItem( const LIB_ID& aLibId );
 
 virtual wxDataViewItem GetCurrentDataViewItem();
 
 unsigned int GetChildren( const wxDataViewItem& aItem,
 wxDataViewItemArray& aChildren ) const override;
 
 // Freezing/Thawing. Used when updating the table model so that we don't try and fetch
 // values during updating. Primarily a problem on OSX which doesn't pay attention to the
 // wxDataViewCtrl's freeze count when updating the keyWindow.
 void Freeze() { m_freeze++; }
 void Thaw() { m_freeze--; }
 bool IsFrozen() const { return m_freeze; }
 
 void RefreshTree();
 
 // Allows subclasses to nominate a context menu handler.
 virtual TOOL_INTERACTIVE* GetContextMenuTool() { return nullptr; }
 
 void PinLibrary( LIB_TREE_NODE* aTreeNode );
 void UnpinLibrary( LIB_TREE_NODE* aTreeNode );
 
 void ShowChangedLanguage()
 {
 recreateColumns();
 }
 
protected:
 static wxDataViewItem ToItem( const LIB_TREE_NODE* aNode );
 
 static LIB_TREE_NODE* ToNode( wxDataViewItem aItem );
 
 LIB_TREE_MODEL_ADAPTER( EDA_BASE_FRAME* aParent, const wxString& aPinnedKey,
 APP_SETTINGS_BASE* aCfg );
 
 LIB_TREE_NODE_LIBRARY& DoAddLibraryNode( const wxString& aNodeName, const wxString& aDesc,
 bool pinned );
 
 bool HasContainerColumns( const wxDataViewItem& aItem ) const override;
 
 bool IsContainer( const wxDataViewItem& aItem ) const override;
 
 wxDataViewItem GetParent( const wxDataViewItem& aItem ) const override;
 
 unsigned int GetColumnCount() const override { return m_columns.size(); }
 
 wxString GetColumnType( unsigned int aCol ) const override { return "string"; }
 
 void GetValue( wxVariant& aVariant,
 const wxDataViewItem& aItem,
 unsigned int aCol ) const override;
 
 bool SetValue( const wxVariant& aVariant,
 const wxDataViewItem& aItem,
 unsigned int aCol ) override { return false; }
 
 bool GetAttr( const wxDataViewItem& aItem,
 unsigned int aCol,
 wxDataViewItemAttr& aAttr ) const override;
 
 virtual PROJECT::LIB_TYPE_T getLibType() = 0;
 
 void resortTree();
 
private:
 const LIB_TREE_NODE* ShowResults();
 
 wxDataViewColumn* doAddColumn( const wxString& aHeader, bool aTranslate = true );
 
protected:
 void addColumnIfNecessary( const wxString& aHeader );
 
 void recreateColumns();
 
 LIB_TREE_NODE_ROOT m_tree;
 std::map<unsigned, wxString> m_colIdxMap;
 std::vector<wxString> m_availableColumns;
 
 wxDataViewCtrl* m_widget;
 
private:
 EDA_BASE_FRAME* m_parent;
 APP_SETTINGS_BASE* m_cfg;
 
 SORT_MODE m_sort_mode;
 bool m_show_units;
 LIB_ID m_preselect_lib_id;
 int m_preselect_unit;
 int m_freeze;
 
 std::function<bool( LIB_TREE_NODE& aNode )>* m_filter;
 
 std::vector<wxDataViewColumn*> m_columns;
 std::map<wxString, wxDataViewColumn*> m_colNameMap;
 std::map<wxString, int> m_colWidths;
 std::vector<wxString> m_shownColumns; // Stored in display order
};
 
#endif // LIB_TREE_MODEL_ADAPTER_H