footprint_select_widget.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 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 FOOTPRINT_SELECT_WIDGET_H
#define FOOTPRINT_SELECT_WIDGET_H
 
#include <wx/arrstr.h>
#include <wx/panel.h>
 
#include <vector>
 
#include <lib_id.h>
 
class KIWAY;
class PROJECT;
class FOOTPRINT_CHOICE;
class wxWindow;
class EDA_DRAW_FRAME;

wxDECLARE_EVENT( EVT_FOOTPRINT_SELECTED, wxCommandEvent );
 
class FOOTPRINT_SELECT_WIDGET : public wxPanel
{
public:
    FOOTPRINT_SELECT_WIDGET( EDA_DRAW_FRAME* aFrame, wxWindow* aParent, int aMaxItems = 400 );
 
    virtual ~FOOTPRINT_SELECT_WIDGET()
    {
    }

    void Load( KIWAY& aKiway, PROJECT& aProject );

    void ClearFilters();

    void AddAlwaysIncludedFootprint( const LIB_ID& aFootprintId );

    void FilterByPinCount( int aPinCount );

    void FilterByFootprintFilters( const wxArrayString& aFilters, bool aZeroFilters );

    void SetDefaultFootprint( const wxString& aFp );

    bool UpdateList();

    void SelectDefault();

    virtual bool Enable( bool aEnable = true ) override;
 
private:
    FOOTPRINT_CHOICE* m_fp_sel_ctrl;
    wxSizer*          m_sizer;
 
    int               m_max_items;
    wxString          m_default_footprint;
 
    // Filter parameters
    int                 m_pin_count;
    wxArrayString       m_filters;
    bool                m_zero_filter;
    std::vector<LIB_ID> m_always_included;
 
    KIWAY*            m_kiway;
 
    void OnComboBox( wxCommandEvent& aEvent );
};
 
 
#endif // FOOTPRINT_SELECT_WIDGET