89 lines
3.0 KiB
C++
89 lines
3.0 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2017 Chris Pavlina <pavlina.chris@gmail.com>
|
|
* Copyright (C) 2014 Henner Zeller <h.zeller@acm.org>
|
|
* Copyright (C) 2014-2022 KiCad Developers, see AUTHORS.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 3 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, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#ifndef SYMBOL_TREE_MODEL_ADAPTER_H
|
|
#define SYMBOL_TREE_MODEL_ADAPTER_H
|
|
|
|
#include <lib_tree_model_adapter.h>
|
|
|
|
class LIB_TABLE;
|
|
class SYMBOL_LIB_TABLE;
|
|
class SCH_BASE_FRAME;
|
|
|
|
class SYMBOL_TREE_MODEL_ADAPTER : public LIB_TREE_MODEL_ADAPTER
|
|
{
|
|
public:
|
|
/**
|
|
* Destructor. Do NOT delete this class manually; it is reference-counted by wxObject.
|
|
*/
|
|
~SYMBOL_TREE_MODEL_ADAPTER();
|
|
|
|
/**
|
|
* Factory function: create a model adapter in a reference-counting container.
|
|
*
|
|
* @param aLibs library set from which parts will be loaded
|
|
*/
|
|
static wxObjectDataPtr<LIB_TREE_MODEL_ADAPTER> Create( EDA_BASE_FRAME* aParent,
|
|
LIB_TABLE* aLibs );
|
|
|
|
/**
|
|
* Add all the libraries in a SYMBOL_LIB_TABLE to the model.
|
|
* Displays a progress dialog attached to the parent frame the first time it is run.
|
|
*
|
|
* @param aNicknames is the list of library nicknames
|
|
* @param aParent is the parent window to display the progress dialog
|
|
* @return false if loading was cancelled by the user
|
|
*/
|
|
bool AddLibraries( const std::vector<wxString>& aNicknames, SCH_BASE_FRAME* aFrame );
|
|
|
|
void AddLibrary( wxString const& aLibNickname, bool pinned );
|
|
|
|
wxString GenerateInfo( LIB_ID const& aLibId, int aUnit ) override;
|
|
|
|
protected:
|
|
/**
|
|
* Constructor; takes a set of libraries to be included in the search.
|
|
*/
|
|
SYMBOL_TREE_MODEL_ADAPTER( EDA_BASE_FRAME* aParent, LIB_TABLE* aLibs );
|
|
|
|
/**
|
|
* Get the value of an item.
|
|
*
|
|
* @param aVariant wxVariant to receive the data
|
|
* @param aItem item whose data will be placed into aVariant
|
|
* @param aCol column number of the data
|
|
*/
|
|
void GetValue( wxVariant& aVariant,
|
|
const wxDataViewItem& aItem,
|
|
unsigned int aCol ) const override;
|
|
|
|
private:
|
|
friend class SYMBOL_ASYNC_LOADER;
|
|
/**
|
|
* Flag to only show the symbol library table load progress dialog the first time.
|
|
*/
|
|
static bool m_show_progress;
|
|
|
|
SYMBOL_LIB_TABLE* m_libs;
|
|
};
|
|
|
|
#endif // SYMBOL_TREE_MODEL_ADAPTER_H
|