dialog_footprint_users.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 <wx/timer.h>
 
#include <lib_id.h>
#include <symbol_library_query.h>
 
#include <dialog_footprint_users_base.h>
 
class KIWAY;
 

class DIALOG_FOOTPRINT_USERS : public DIALOG_FOOTPRINT_USERS_BASE
{
public:
    DIALOG_FOOTPRINT_USERS( wxWindow* aParent, KIWAY& aKiway, const LIB_ID& aFootprint, int aFootprintPinCount );
 
private:
    void onMatchTypeChanged( wxCommandEvent& aEvent );
    void onLoadTimer( wxTimerEvent& aEvent );
    void onUserActivated( wxDataViewEvent& aEvent );
    void onUserRightClick( wxDataViewEvent& aEvent );
    void onUserKeyDown( wxKeyEvent& aEvent );

    void updateUsers();

    int matchCategories() const;

    bool symbolLibrariesReady();
 
    void showUsers( const FOOTPRINT_USERS_RESULT& aResult );
    void showLoadIndication( bool aShow, float aProgress = 0.0f );

    wxString userSymbolName( int aRow ) const;
 
    void openSymbolInEditor( const wxString& aSymbolName );
    void copySymbolName( const wxString& aSymbolName );
 
    KIWAY&  m_kiway;
    LIB_ID  m_footprint;
    int     m_footprintPinCount;
    wxTimer m_loadTimer;
    bool    m_librariesReady;
};