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_INFO FOOTPRINT_INFO LIB_SYMBOL DESIGN_BLOCK_INFO_IMPL BASIC_FOOTPRINT_INFO FOOTPRINT_INFO_IMPL

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 ()
 
virtual bool IsRoot () const
 For items having aliases, IsRoot() indicates the principal item.
 
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 GetUnitReference (int aUnit)
 For items with units, return an identifier for unit x.
 
virtual wxString GetUnitDisplayName (int aUnit)
 For items with units, return a display name for unit x.
 
virtual bool HasUnitDisplayName (int aUnit)
 For items with units, return true if a display name is set for 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 40 of file lib_tree_item.h.

Constructor & Destructor Documentation

◆ ~LIB_TREE_ITEM()

virtual LIB_TREE_ITEM::~LIB_TREE_ITEM ( )
inlinevirtual

Definition at line 43 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 57 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_INFO, LIB_SYMBOL, and FOOTPRINT_INFO.

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 69 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_INFO, LIB_SYMBOL, and FOOTPRINT_INFO.

Referenced by LIB_TREE_NODE_ITEM::Update().

◆ GetLibNickname()

virtual wxString LIB_TREE_ITEM::GetLibNickname ( ) const
pure virtual

Implemented in DESIGN_BLOCK_INFO, LIB_SYMBOL, and FOOTPRINT_INFO.

Referenced by LIB_TREE_NODE_ITEM::LIB_TREE_NODE_ITEM().

◆ GetName()

virtual wxString LIB_TREE_ITEM::GetName ( ) const
pure virtual

Implemented in DESIGN_BLOCK_INFO, LIB_SYMBOL, and FOOTPRINT_INFO.

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 LIB_SYMBOL, and FOOTPRINT_INFO.

Definition at line 74 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 ( )
inlinevirtual

Reimplemented in DESIGN_BLOCK_INFO, LIB_SYMBOL, and FOOTPRINT_INFO.

Definition at line 59 of file lib_tree_item.h.

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

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

◆ GetUnitDisplayName()

virtual wxString LIB_TREE_ITEM::GetUnitDisplayName ( int  aUnit)
inlinevirtual

For items with units, return a display name for unit x.

Reimplemented in LIB_SYMBOL.

Definition at line 89 of file lib_tree_item.h.

Referenced by LIB_TREE_NODE_UNIT::LIB_TREE_NODE_UNIT().

◆ GetUnitReference()

virtual wxString LIB_TREE_ITEM::GetUnitReference ( int  aUnit)
inlinevirtual

For items with units, return an identifier for unit x.

Reimplemented in LIB_SYMBOL.

Definition at line 84 of file lib_tree_item.h.

Referenced by LIB_TREE_NODE_UNIT::LIB_TREE_NODE_UNIT().

◆ HasUnitDisplayName()

virtual bool LIB_TREE_ITEM::HasUnitDisplayName ( int  aUnit)
inlinevirtual

For items with units, return true if a display name is set for x.

Reimplemented in LIB_SYMBOL.

Definition at line 94 of file lib_tree_item.h.

Referenced by LIB_TREE_NODE_UNIT::LIB_TREE_NODE_UNIT().

◆ 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 64 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: