dialog_symbol_chooser.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * 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 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, see <https://www.gnu.org/licenses/>.
 */
#ifndef DIALOG_SYMBOL_CHOOSER_H
#define DIALOG_SYMBOL_CHOOSER_H
 
#include "dialog_shim.h"
#include <template_fieldnames.h>
#include <symbol_library_common.h>
#include <symbol_tree_model_adapter.h>
#include <footprint_info.h>
#include <widgets/html_window.h>
#include <wx/checkbox.h>
 
 
class SCH_BASE_FRAME;
class PANEL_SYMBOL_CHOOSER;
struct PICKED_SYMBOL;
 
 
class DIALOG_SYMBOL_CHOOSER : public DIALOG_SHIM
{
public:
    DIALOG_SYMBOL_CHOOSER( SCH_BASE_FRAME* aParent, const LIB_ID* aPreselect,
                           const SYMBOL_LIBRARY_FILTER* aFilter,
                           std::vector<PICKED_SYMBOL>& aHistoryList,
                           std::vector<PICKED_SYMBOL>& aAlreadyPlaced, bool aAllowFieldEdits,
                           bool aShowFootprints, bool& aCancelled );
 
    ~DIALOG_SYMBOL_CHOOSER();

    LIB_ID GetSelectedLibId( int* aUnit = nullptr ) const;

    std::vector<std::pair<FIELD_T, wxString>> GetFields() const;
 
    bool GetKeepSymbol() { return m_keepSymbol->GetValue(); }
    bool GetPlaceAllUnits() { return m_useUnits->GetValue(); }
 
public:
    static std::mutex         g_Mutex;
 
protected:
    PANEL_SYMBOL_CHOOSER*     m_chooserPanel;
    wxCheckBox*               m_keepSymbol;
    wxCheckBox*               m_useUnits;
 
private:
    void onLazyLoadUpdate();
 
    wxString                  m_originalTitle;
};
 
#endif /* DIALOG_SYMBOL_CHOOSER_H */