KiCad PCB EDA Suite
|
A mix-in to provide polymorphism between items stored in libraries (symbols, aliases and footprints). More...
#include <lib_tree_item.h>
Public Member Functions | |
virtual | ~LIB_TREE_ITEM () |
virtual LIB_ID | GetLibId () const =0 |
virtual wxString | GetName () const =0 |
virtual wxString | GetLibNickname () const =0 |
virtual wxString | GetDescription ()=0 |
virtual void | GetChooserFields (std::map< wxString, wxString > &aColumnMap) |
Retrieves a key/value map of the fields on this item that should be exposed to the library browser/chooser for displaying in columns, searching, etc. More... | |
virtual wxString | GetSearchText () |
virtual bool | IsRoot () const |
For items having aliases, IsRoot() indicates the principal item. More... | |
virtual wxString | GetFootprint () |
For items with footprint fields. More... | |
virtual int | GetUnitCount () const |
For items with units, return the number of units. More... | |
virtual wxString | GetUnitReference (int aUnit) |
For items with units, return an identifier for unit x. More... | |
virtual wxString | GetUnitDisplayName (int aUnit) |
For items with units, return a display name for unit x. More... | |
virtual bool | HasUnitDisplayName (int aUnit) |
For items with units, return true if a display name is set for x. More... | |
A mix-in to provide polymorphism between items stored in libraries (symbols, aliases and footprints).
It is used primarily to drive the component tree for library browsing and editing.
Definition at line 39 of file lib_tree_item.h.
|
inlinevirtual |
Definition at line 42 of file lib_tree_item.h.
|
inlinevirtual |
Retrieves a key/value map of the fields on this item that should be exposed to the library browser/chooser for displaying in columns, searching, etc.
Reimplemented in LIB_SYMBOL.
Definition at line 56 of file lib_tree_item.h.
Referenced by LIB_TREE_NODE_LIB_ID::LIB_TREE_NODE_LIB_ID(), and LIB_TREE_NODE_LIB_ID::Update().
|
pure virtual |
Implemented in LIB_SYMBOL, and FOOTPRINT_INFO.
Referenced by FOOTPRINT_INFO::GetSearchText(), LIB_TREE_NODE_LIB_ID::LIB_TREE_NODE_LIB_ID(), and LIB_TREE_NODE_LIB_ID::Update().
|
inlinevirtual |
For items with footprint fields.
Reimplemented in LIB_SYMBOL.
Definition at line 68 of file lib_tree_item.h.
Referenced by LIB_TREE_NODE_LIB_ID::LIB_TREE_NODE_LIB_ID().
|
pure virtual |
Implemented in LIB_SYMBOL, and FOOTPRINT_INFO.
Referenced by LIB_TREE_NODE_LIB_ID::Update().
|
pure virtual |
Implemented in LIB_SYMBOL, and FOOTPRINT_INFO.
Referenced by LIB_TREE_NODE_LIB_ID::LIB_TREE_NODE_LIB_ID().
|
pure virtual |
Implemented in LIB_SYMBOL, and FOOTPRINT_INFO.
Referenced by LIB_TREE_NODE_LIB_ID::LIB_TREE_NODE_LIB_ID(), and LIB_TREE_NODE_LIB_ID::Update().
|
inlinevirtual |
Reimplemented in LIB_SYMBOL, and FOOTPRINT_INFO.
Definition at line 58 of file lib_tree_item.h.
Referenced by LIB_TREE_NODE_LIB_ID::LIB_TREE_NODE_LIB_ID(), and LIB_TREE_NODE_LIB_ID::Update().
|
inlinevirtual |
For items with units, return the number of units.
Reimplemented in LIB_SYMBOL.
Definition at line 73 of file lib_tree_item.h.
Referenced by LIB_TREE_NODE_LIB_ID::LIB_TREE_NODE_LIB_ID(), and LIB_TREE_NODE_LIB_ID::Update().
|
inlinevirtual |
For items with units, return a display name for unit x.
Reimplemented in LIB_SYMBOL.
Definition at line 83 of file lib_tree_item.h.
Referenced by LIB_TREE_NODE_UNIT::LIB_TREE_NODE_UNIT().
|
inlinevirtual |
For items with units, return an identifier for unit x.
Reimplemented in LIB_SYMBOL.
Definition at line 78 of file lib_tree_item.h.
Referenced by LIB_TREE_NODE_UNIT::LIB_TREE_NODE_UNIT().
|
inlinevirtual |
For items with units, return true if a display name is set for x.
Reimplemented in LIB_SYMBOL.
Definition at line 88 of file lib_tree_item.h.
Referenced by LIB_TREE_NODE_UNIT::LIB_TREE_NODE_UNIT().
|
inlinevirtual |
For items having aliases, IsRoot() indicates the principal item.
Reimplemented in LIB_SYMBOL.
Definition at line 63 of file lib_tree_item.h.
Referenced by LIB_TREE_NODE_LIB_ID::LIB_TREE_NODE_LIB_ID(), and LIB_TREE_NODE_LIB_ID::Update().