KiCad PCB EDA Suite
lib_tree_item.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) 2018 KiCad Developers, see change_log.txt for contributors.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, you may find one here:
18  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19  * or you may search the http://www.gnu.org website for the version 2 license,
20  * or you may write to the Free Software Foundation, Inc.,
21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22  */
23 
24 
25 #ifndef LIB_TREE_ITEM_H
26 #define LIB_TREE_ITEM_H
27 
28 #include <base_struct.h>
29 #include <lib_id.h>
30 #include <import_export.h>
31 
40 {
41 public:
42  virtual ~LIB_TREE_ITEM()
43  {
44  }
45 
46  virtual LIB_ID GetLibId() const = 0;
47 
48  virtual wxString GetName() const = 0;
49  virtual wxString GetLibNickname() const = 0;
50 
51  virtual wxString GetDescription() = 0;
52 
53  virtual wxString GetSearchText() { return wxEmptyString; }
54 
58  virtual bool IsRoot() const { return true; }
59 
63  virtual int GetUnitCount() const { return 0; }
64 
68  virtual wxString GetUnitReference( int aUnit ) { return wxEmptyString; }
69 };
70 
71 #endif //LIB_TREE_ITEM_H
#define APIEXPORT
Macros which export functions from a DLL/DSO.
Definition: import_export.h:44
virtual int GetUnitCount() const
For items with units, return the number of units.
Definition: lib_tree_item.h:63
A mix-in to provide polymorphism between items stored in libraries (symbols, aliases and footprints).
Definition: lib_tree_item.h:39
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
virtual bool IsRoot() const
For items having aliases, IsRoot() indicates the principal item.
Definition: lib_tree_item.h:58
virtual wxString GetSearchText()
Definition: lib_tree_item.h:53
virtual ~LIB_TREE_ITEM()
Definition: lib_tree_item.h:42
virtual wxString GetUnitReference(int aUnit)
For items with units, return an identifier for unit x.
Definition: lib_tree_item.h:68