KiCad PCB EDA Suite
symbol_tree_synchronizing_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 CERN
5  * @author Maciej Suminski <maciej.suminski@cern.ch>
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 3
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * https://www.gnu.org/licenses/gpl-3.0.html
20  * or you may search the http://www.gnu.org website for the version 3 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
25 #ifndef SYMBOL_TREE_SYNCHRONIZING_ADAPTER_H
26 #define SYMBOL_TREE_SYNCHRONIZING_ADAPTER_H
27 
28 #include <lib_tree_model_adapter.h>
29 #include <map>
30 
31 class LIB_EDIT_FRAME;
32 class LIB_MANAGER;
33 
35 {
36 public:
37  static PTR Create( LIB_EDIT_FRAME* aParent, LIB_MANAGER* aLibs );
38 
39  bool IsContainer( const wxDataViewItem& aItem ) const override;
40 
41  void Sync( bool aForce = false,
42  std::function<void(int, int, const wxString&)> aProgressCallback = [](int, int, const wxString&){} );
43 
44  int GetLibrariesCount() const override;
45 
47 
48 protected:
49  void updateLibrary( LIB_TREE_NODE_LIB& aLibNode );
50 
51  LIB_TREE_NODE::PTR_VECTOR::iterator deleteLibrary( LIB_TREE_NODE::PTR_VECTOR::iterator& aLibNodeIt );
52 
53  void GetValue( wxVariant& aVariant, wxDataViewItem const& aItem,
54  unsigned int aCol ) const override;
55  bool GetAttr( wxDataViewItem const& aItem, unsigned int aCol,
56  wxDataViewItemAttr& aAttr ) const override;
57 
59 
60 protected:
63 
65  std::map<wxString, int> m_libHashes;
66 
69 };
70 
71 #endif /* SYMBOL_TREE_SYNCHRONIZING_ADAPTER_H */
int m_lastSyncHash
LIB_MANAGER hash value returned in the last synchronization
static PTR Create(LIB_EDIT_FRAME *aParent, LIB_MANAGER *aLibs)
bool IsContainer(const wxDataViewItem &aItem) const override
std::map< wxString, int > m_libHashes
Hashes to decide whether a library needs an update
int GetLibrariesCount() const override
Return the number of libraries loaded in the tree.
Node type: library.
bool GetAttr(wxDataViewItem const &aItem, unsigned int aCol, wxDataViewItemAttr &aAttr) const override
Class to handle modifications to the symbol libraries.
Definition: lib_manager.h:99
LIB_TREE_NODE::PTR_VECTOR::iterator deleteLibrary(LIB_TREE_NODE::PTR_VECTOR::iterator &aLibNodeIt)
The symbol library editor main window.
void GetValue(wxVariant &aVariant, wxDataViewItem const &aItem, unsigned int aCol) const override
wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > PTR
Reference-counting container for a pointer to CMP_TREE_MODEL_ADAPTER_BASE.
void Sync(bool aForce=false, std::function< void(int, int, const wxString &)> aProgressCallback=[](int, int, const wxString &){})
SYMBOL_TREE_SYNCHRONIZING_ADAPTER(LIB_EDIT_FRAME *aParent, LIB_MANAGER *aLibMgr)