symbol_tree_model_adapter.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2017 Chris Pavlina <[email protected]>
 * Copyright (C) 2014 Henner Zeller <[email protected]>
 * Copyright The 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 <https://www.gnu.org/licenses/>.
 */
 
#ifndef SYMBOL_TREE_MODEL_ADAPTER_H
#define SYMBOL_TREE_MODEL_ADAPTER_H
 
#include <lib_tree_model_adapter.h>
#include <variant_symbol_utils.h>
 
class SYMBOL_LIBRARY_ADAPTER;
class SCH_BASE_FRAME;
 
class wxTimer;
 
class SYMBOL_TREE_MODEL_ADAPTER : public LIB_TREE_MODEL_ADAPTER
{
public:
    ~SYMBOL_TREE_MODEL_ADAPTER();

    static wxObjectDataPtr<LIB_TREE_MODEL_ADAPTER> Create( SCH_BASE_FRAME* aParent,
                                                           SYMBOL_LIBRARY_ADAPTER* aLibs );

    void AddLibraries( SCH_BASE_FRAME* aFrame );
 
    void AddLibrary( wxString const& aLibNickname, bool pinned );
 
    void SetCompatibilityCallback( SYMBOL_COMPAT_FUNC aFunc )
    {
        m_compatCallback = std::move( aFunc );
        m_compatCache.clear();
    }
 
    bool GetAttr( const wxDataViewItem& aItem, unsigned int aCol,
                  wxDataViewItemAttr& aAttr ) const override;
 
    wxString GenerateInfo( LIB_ID const& aLibId, int aUnit ) override;
 
protected:
    SYMBOL_TREE_MODEL_ADAPTER( SCH_BASE_FRAME* aParent, SYMBOL_LIBRARY_ADAPTER* aManager );
 
    void loadColumnConfig() override;
 
    PROJECT::LIB_TYPE_T getLibType() override { return PROJECT::LIB_TYPE_T::SYMBOL_LIB; }
 
private:
    SYMBOL_LIBRARY_ADAPTER*  m_adapter;
 
    std::set<wxString> m_pending_load_libraries;
    std::unique_ptr<wxTimer> m_check_pending_libraries_timer;
 
    SYMBOL_COMPAT_FUNC                    m_compatCallback;
    mutable std::map<LIB_ID, bool>        m_compatCache;
};
 
#endif // SYMBOL_TREE_MODEL_ADAPTER_H