mirror of
https://gitlab.com/kicad/code/kicad.git
synced 2025-09-14 02:03:12 +02:00
df7d62fdd3
Also simplifies the scoring algorithm so that it only differentiates between exact-match, match-at-start and any-match. The rest of the position-based matching stuff is gone, as is the knowledge of the name vs the keywords vs the description. All that is left to the provider of the weighted search terms array.
93 lines
2.8 KiB
C++
93 lines
2.8 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2018-2023 KiCad Developers, see change_log.txt for contributors.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, you may find one here:
|
|
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
|
|
* or you may search the http://www.gnu.org website for the version 2 license,
|
|
* or you may write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
|
*/
|
|
|
|
|
|
#ifndef LIB_TREE_ITEM_H
|
|
#define LIB_TREE_ITEM_H
|
|
|
|
#include <map>
|
|
#include <lib_id.h>
|
|
#include <import_export.h>
|
|
#include <eda_pattern_match.h>
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
|
|
class APIEXPORT LIB_TREE_ITEM
|
|
{
|
|
public:
|
|
virtual ~LIB_TREE_ITEM()
|
|
{
|
|
}
|
|
|
|
virtual LIB_ID GetLibId() const = 0;
|
|
|
|
virtual wxString GetName() const = 0;
|
|
virtual wxString GetLibNickname() const = 0;
|
|
virtual wxString GetDescription() = 0;
|
|
|
|
/**
|
|
* 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 void GetChooserFields( std::map<wxString , wxString>& aColumnMap ) {}
|
|
|
|
virtual std::vector<SEARCH_TERM> GetSearchTerms() { return std::vector<SEARCH_TERM>(); }
|
|
|
|
/**
|
|
* For items having aliases, IsRoot() indicates the principal item.
|
|
*/
|
|
virtual bool IsRoot() const { return true; }
|
|
|
|
/**
|
|
* For items with footprint fields.
|
|
*/
|
|
virtual wxString GetFootprint() { return wxEmptyString; }
|
|
|
|
/**
|
|
* For items with units, return the number of units.
|
|
*/
|
|
virtual int GetUnitCount() const { return 0; }
|
|
|
|
/**
|
|
* For items with units, return an identifier for unit x.
|
|
*/
|
|
virtual wxString GetUnitReference( int aUnit ) { return wxEmptyString; }
|
|
|
|
/**
|
|
* For items with units, return a display name for unit x.
|
|
*/
|
|
virtual wxString GetUnitDisplayName( int aUnit ) { return wxEmptyString; }
|
|
|
|
/**
|
|
* For items with units, return true if a display name is set for x.
|
|
*/
|
|
virtual bool HasUnitDisplayName( int aUnit ) { return false; }
|
|
};
|
|
|
|
#endif //LIB_TREE_ITEM_H
|