panel_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 (C) 2014 Henner Zeller <[email protected]>
 * Copyright (C) 2014-2023 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, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */
#ifndef PANEL_SYMBOL_CHOOSER_H
#define PANEL_SYMBOL_CHOOSER_H
 
#include <widgets/lib_tree.h>
#include <symbol_tree_model_adapter.h>
#include <footprint_info.h>
#include <widgets/html_window.h>
 
class wxPanel;
class wxTimer;
class wxSplitterWindow;
 
class SYMBOL_PREVIEW_WIDGET;
class FOOTPRINT_PREVIEW_WIDGET;
class FOOTPRINT_SELECT_WIDGET;
class SCH_BASE_FRAME;
struct PICKED_SYMBOL;
 
 
class PANEL_SYMBOL_CHOOSER : public wxPanel
{
public:
 PANEL_SYMBOL_CHOOSER( SCH_BASE_FRAME* aFrame, wxWindow* aParent,
 const SYMBOL_LIBRARY_FILTER* aFilter,
 std::vector<PICKED_SYMBOL>& aHistoryList,
 std::vector<PICKED_SYMBOL>& aAlreadyPlaced,
 bool aAllowFieldEdits, bool aShowFootprints,
 std::function<void()> aAcceptHandler,
 std::function<void()> aEscapeHandler );
 
 ~PANEL_SYMBOL_CHOOSER();
 
 void OnChar( wxKeyEvent& aEvent );
 
 void FinishSetup();
 
 void SetPreselect( const LIB_ID& aPreselect );
 
 LIB_ID GetSelectedLibId( int* aUnit = nullptr ) const;
 
 int GetItemCount() const { return m_adapter->GetItemCount(); }
 
 wxWindow* GetFocusTarget() const { return m_tree->GetFocusTarget(); }
 
 std::vector<std::pair<int, wxString>> GetFields() const
 {
 return m_field_edits;
 }
 
protected:
 static constexpr int DBLCLICK_DELAY = 100; // milliseconds
 
 wxPanel* constructRightPanel( wxWindow* aParent );
 
 void OnDetailsCharHook( wxKeyEvent& aEvt );
 void onCloseTimer( wxTimerEvent& aEvent );
 void onOpenLibsTimer( wxTimerEvent& aEvent );
 
 void onFootprintSelected( wxCommandEvent& aEvent );
 void onSymbolSelected( wxCommandEvent& aEvent );
 
 void onSymbolChosen( wxCommandEvent& aEvent );
 
 void showFootprintFor( const LIB_ID& aLibId );
 
 void showFootprint( const wxString& aFootprint );
 
 void populateFootprintSelector( const LIB_ID& aLibId );
 
public:
 static std::mutex g_Mutex;
 
protected:
 static wxString g_symbolSearchString;
 static wxString g_powerSearchString;
 
 wxTimer* m_dbl_click_timer;
 wxTimer* m_open_libs_timer;
 SYMBOL_PREVIEW_WIDGET* m_symbol_preview;
 wxSplitterWindow* m_hsplitter;
 wxSplitterWindow* m_vsplitter;
 
 wxObjectDataPtr<LIB_TREE_MODEL_ADAPTER> m_adapter;
 
 FOOTPRINT_SELECT_WIDGET* m_fp_sel_ctrl;
 FOOTPRINT_PREVIEW_WIDGET* m_fp_preview;
 LIB_TREE* m_tree;
 HTML_WINDOW* m_details;
 
 SCH_BASE_FRAME* m_frame;
 std::function<void()> m_acceptHandler;
 std::function<void()> m_escapeHandler;
 
 bool m_showPower;
 bool m_allow_field_edits;
 bool m_show_footprints;
 wxString m_fp_override;
 
 std::vector<std::pair<int, wxString>> m_field_edits;
};
 
#endif /* PANEL_SYMBOL_CHOOSER_H */