KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | List of all members
LIB_TREE_ITEM Class Referenceabstract

A mix-in to provide polymorphism between items stored in libraries (symbols, aliases and footprints). More...

#include <lib_tree_item.h>

Inheritance diagram for LIB_TREE_ITEM:
DESIGN_BLOCK FOOTPRINT FOOTPRINT_INFO LIB_SYMBOL BASIC_FOOTPRINT_INFO FOOTPRINT_INFO_IMPL INSTRUMENTED_LIB_SYMBOL

Public Member Functions

virtual ~LIB_TREE_ITEM ()
 
virtual LIB_ID GetLIB_ID () const =0
 
virtual wxString GetName () const =0
 
virtual wxString GetLibNickname () const =0
 
virtual wxString GetDesc ()=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.
 
virtual std::vector< SEARCH_TERM > & GetSearchTerms ()=0
 
virtual bool IsRoot () const
 For items having aliases, IsRoot() indicates the principal item.
 
virtual bool IsPowerSymbol () const
 For symbols that could be a power symbol.
 
virtual wxString GetFootprint ()
 For items with footprint fields.
 
virtual int GetPinCount ()
 The pin count for symbols or the unique pad count for footprints.
 
virtual int GetSubUnitCount () const
 For items with units, return the number of units.
 
virtual wxString GetUnitName (int aUnit) const
 For items with units, return an identifier for unit x.
 

Detailed Description

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 36 of file lib_tree_item.h.

Constructor & Destructor Documentation

◆ ~LIB_TREE_ITEM()

virtual LIB_TREE_ITEM::~LIB_TREE_ITEM ( )
inlinevirtual

Definition at line 39 of file lib_tree_item.h.

Member Function Documentation

◆ GetChooserFields()

virtual void LIB_TREE_ITEM::GetChooserFields ( std::map< wxString, wxString > & aColumnMap)
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 53 of file lib_tree_item.h.

Referenced by LIB_TREE_NODE_ITEM::LIB_TREE_NODE_ITEM(), and LIB_TREE_NODE_ITEM::Update().

◆ GetDesc()

virtual wxString LIB_TREE_ITEM::GetDesc ( )
pure virtual

Implemented in DESIGN_BLOCK, FOOTPRINT, FOOTPRINT_INFO, and LIB_SYMBOL.

Referenced by LIB_TREE_NODE_ITEM::LIB_TREE_NODE_ITEM(), and LIB_TREE_NODE_ITEM::Update().

◆ GetFootprint()

virtual wxString LIB_TREE_ITEM::GetFootprint ( )
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_ITEM::LIB_TREE_NODE_ITEM().

◆ GetLIB_ID()

virtual LIB_ID LIB_TREE_ITEM::GetLIB_ID ( ) const
pure virtual

Implemented in DESIGN_BLOCK, FOOTPRINT, FOOTPRINT_INFO, and LIB_SYMBOL.

Referenced by LIB_TREE_NODE_ITEM::Update().

◆ GetLibNickname()

virtual wxString LIB_TREE_ITEM::GetLibNickname ( ) const
pure virtual

Implemented in DESIGN_BLOCK, FOOTPRINT, FOOTPRINT_INFO, and LIB_SYMBOL.

Referenced by LIB_TREE_NODE_ITEM::LIB_TREE_NODE_ITEM().

◆ GetName()

virtual wxString LIB_TREE_ITEM::GetName ( ) const
pure virtual

Implemented in DESIGN_BLOCK, FOOTPRINT, FOOTPRINT_INFO, and LIB_SYMBOL.

Referenced by LIB_TREE_NODE_ITEM::LIB_TREE_NODE_ITEM(), and LIB_TREE_NODE_ITEM::Update().

◆ GetPinCount()

virtual int LIB_TREE_ITEM::GetPinCount ( )
inlinevirtual

The pin count for symbols or the unique pad count for footprints.

Reimplemented in FOOTPRINT, FOOTPRINT_INFO, and LIB_SYMBOL.

Definition at line 73 of file lib_tree_item.h.

Referenced by LIB_TREE_NODE_ITEM::LIB_TREE_NODE_ITEM().

◆ GetSearchTerms()

virtual std::vector< SEARCH_TERM > & LIB_TREE_ITEM::GetSearchTerms ( )
pure virtual

Implemented in DESIGN_BLOCK, FOOTPRINT, FOOTPRINT_INFO, and LIB_SYMBOL.

Referenced by LIB_TREE_NODE_ITEM::LIB_TREE_NODE_ITEM(), and LIB_TREE_NODE_ITEM::Update().

◆ GetSubUnitCount()

virtual int LIB_TREE_ITEM::GetSubUnitCount ( ) const
inlinevirtual

For items with units, return the number of units.

Reimplemented in LIB_SYMBOL.

Definition at line 78 of file lib_tree_item.h.

Referenced by LIB_TREE_NODE_ITEM::LIB_TREE_NODE_ITEM(), and LIB_TREE_NODE_ITEM::Update().

◆ GetUnitName()

virtual wxString LIB_TREE_ITEM::GetUnitName ( int aUnit) const
inlinevirtual

For items with units, return an identifier 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().

◆ IsPowerSymbol()

virtual bool LIB_TREE_ITEM::IsPowerSymbol ( ) const
inlinevirtual

For symbols that could be a power symbol.

Reimplemented in LIB_SYMBOL.

Definition at line 63 of file lib_tree_item.h.

Referenced by LIB_TREE_NODE_ITEM::LIB_TREE_NODE_ITEM(), and LIB_TREE_NODE_ITEM::Update().

◆ IsRoot()

virtual bool LIB_TREE_ITEM::IsRoot ( ) const
inlinevirtual

For items having aliases, IsRoot() indicates the principal item.

Reimplemented in LIB_SYMBOL.

Definition at line 60 of file lib_tree_item.h.

Referenced by LIB_TREE_NODE_ITEM::LIB_TREE_NODE_ITEM(), and LIB_TREE_NODE_ITEM::Update().

The documentation for this class was generated from the following file: