KiCad PCB EDA Suite
footprint_tree_pane.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2018-2021 KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 3
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, you may find one here:
18 * https://www.gnu.org/licenses/gpl-3.0.html
19 * or you may search the http://www.gnu.org website for the version 3 license,
20 * or you may write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22 */
23
24#include "footprint_tree_pane.h"
26#include <widgets/lib_tree.h>
28#include <fp_lib_table.h>
29
31 : wxPanel( aParent ),
32 m_frame( aParent ),
33 m_tree( nullptr )
34{
35 // Create widgets
36 wxBoxSizer* boxSizer = new wxBoxSizer( wxVERTICAL );
37 m_tree = new LIB_TREE( this, wxT( "footprints" ), &GFootprintTable,
39 boxSizer->Add( m_tree, 1, wxEXPAND, 5 );
40
41 SetSizer( boxSizer ); // should remove the previous sizer according to wxWidgets docs
42 Layout();
43 boxSizer->Fit( this );
44
45 m_frame->GetLibTreeAdapter()->FinishTreeInitialization();
46
47 // Event handlers
48 Bind( SYMBOL_SELECTED, &FOOTPRINT_TREE_PANE::onComponentSelected, this );
49 m_tree->Bind( wxEVT_UPDATE_UI, &FOOTPRINT_TREE_PANE::onUpdateUI, this );
50}
51
52
54{
55 if( m_tree )
56 {
58 }
59}
60
61
63{
64 m_tree->Destroy();
65}
66
67
68void FOOTPRINT_TREE_PANE::onComponentSelected( wxCommandEvent& aEvent )
69{
70 m_frame->LoadFootprintFromLibrary( GetLibTree()->GetSelectedLibId() );
71 // Make sure current-part highlighting doesn't get lost in seleciton highlighting
73}
74
75
76void FOOTPRINT_TREE_PANE::onUpdateUI( wxUpdateUIEvent& aEvent )
77{
78 if( m_frame->GetCanvas()->HasFocus() )
79 {
80 // Don't allow a selected item in the tree when the canvas has focus: it's too easy
81 // to confuse the selected-highlighting with the being-edited-on-canvas-highlighting.
83 }
84}
void LoadFootprintFromLibrary(LIB_ID aFPID)
wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > & GetLibTreeAdapter()
Return the adapter object that provides the stored data.
LIB_TREE * m_tree
component search tree widget
void onUpdateUI(wxUpdateUIEvent &aEvent)
FOOTPRINT_EDIT_FRAME * m_frame
void FocusSearchFieldIfExists()
Focus the search widget if it exists.
void onComponentSelected(wxCommandEvent &aEvent)
FOOTPRINT_TREE_PANE(FOOTPRINT_EDIT_FRAME *aParent)
LIB_TREE * GetLibTree() const
Widget displaying a tree of symbols with optional search text control and description panel....
Definition: lib_tree.h:46
void FocusSearchFieldIfExists()
Focus the search widget if it exists.
Definition: lib_tree.cpp:328
void Unselect()
Unselect currently selected item in wxDataViewCtrl.
Definition: lib_tree.cpp:242
@ SEARCH
Definition: lib_tree.h:52
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
FP_LIB_TABLE GFootprintTable
The global footprint library table.
Definition: cvpcb.cpp:134