panel_footprint_filters.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/>.
 */
 
#pragma once
 
#include <functional>
#include <memory>
#include <vector>
 
#include <wx/arrstr.h>
#include <wx/timer.h>
 
#include <dialog_lib_symbol_properties_base.h>
#include <widgets/wx_debounced_action.h>
 
class KIWAY;
class FP_FILTER_MATCHER;
class LISTBOX_TRICKS;
 

class PANEL_FOOTPRINT_FILTERS : public PANEL_FOOTPRINT_FILTERS_BASE
{
public:
    PANEL_FOOTPRINT_FILTERS( wxWindow* aParent, KIWAY& aKiway );
 
    ~PANEL_FOOTPRINT_FILTERS() override;

    void SetFilters( const wxArrayString& aFilters );

    wxArrayString GetFilters() const;
 
 
    using FOOTPRINT_ASSIGN_QUERY = std::function<bool()>;
    using FOOTPRINT_ASSIGNER = std::function<void( const wxString& )>;

    void SetFootprintFieldAccessors( FOOTPRINT_ASSIGN_QUERY aCanAssign, FOOTPRINT_ASSIGNER aAssign );
 
protected:
    void OnFpFilterDClick( wxMouseEvent& aEvent ) override;
    void OnEditFootprintFilter( wxCommandEvent& aEvent ) override;
    void OnAddFootprintFilter( wxCommandEvent& aEvent ) override;
 
private:
    void onModify();

    void updateMatchingFootprints();
 
    void showFootprintMatches( const std::vector<wxString>& aPatterns );

    wxString matchingFootprintName( long aItem ) const;
 
    void openFootprintInEditor( const wxString& aFootprintName );
    void copyFootprintName( const wxString& aFootprintName );

    bool matchLibrariesReady();

    void showFpFilterMatchLoadIndication( bool aShow, float aProgress = 0.0f );
    void onFpFilterMatchLoadTimer( wxTimerEvent& aEvent );

    void onFilterPreviewText( wxCommandEvent& aEvent );
 
    void onMatchingFootprintDoubleClick( wxListEvent& aEvent );
    void onMatchingFootprintContextMenu( wxListEvent& aEvent );
    void onMatchingFootprintKeyDown( wxKeyEvent& aEvent );

    void onNotebookPageChanged( wxBookCtrlEvent& aEvent );
 
    KIWAY& m_kiway;
 
    std::unique_ptr<LISTBOX_TRICKS> m_fpFilterTricks;

    std::unique_ptr<FP_FILTER_MATCHER> m_fpMatcher;

    wxString m_fpFilterPreview;

    FOOTPRINT_ASSIGN_QUERY m_canAssignFootprint;
    FOOTPRINT_ASSIGNER     m_assignFootprint;
 
    bool    m_matchLibrariesReady = false;
    wxTimer m_matchLoadTimer;

    WX_DEBOUNCED_ACTION m_filterPreviewDebounce;
};