KiCad PCB EDA Suite
lib_tree.h
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) 2014 Henner Zeller <h.zeller@acm.org>
5  * Copyright (C) 2014-2019 KiCad Developers, see AUTHORS.txt for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
25 #ifndef LIB_TREE_H
26 #define LIB_TREE_H
27 
28 #include <wx/panel.h>
29 #include <lib_tree_model_adapter.h>
30 
31 class wxDataViewCtrl;
32 class wxTextCtrl;
33 class wxHtmlWindow;
34 class wxHtmlLinkEvent;
35 class ACTION_MENU;
36 class LIB_ID;
37 class LIB_TABLE;
38 
42 class LIB_TREE : public wxPanel
43 {
44 public:
46  enum WIDGETS { NONE = 0x00, SEARCH = 0x01, DETAILS = 0x02, ALL = 0xFF };
47 
58  LIB_TREE( wxWindow* aParent, LIB_TABLE* aLibTable, LIB_TREE_MODEL_ADAPTER::PTR& aAdapter,
59  WIDGETS aWidgets = ALL, wxHtmlWindow *aDetails = nullptr );
60 
61  ~LIB_TREE() override;
62 
72  LIB_ID GetSelectedLibId( int* aUnit = nullptr ) const;
73 
77  void SelectLibId( const LIB_ID& aLibId );
78 
82  void CenterLibId( const LIB_ID& aLibId );
83 
87  void Unselect();
88 
92  void ExpandLibId( const LIB_ID& aLibId );
93 
97  void Regenerate( bool aKeepState );
98 
102  void RefreshLibTree();
103 
104  void SetFocus() override;
105 
106 protected:
110  void toggleExpand( const wxDataViewItem& aTreeId );
111 
115  void selectIfValid( const wxDataViewItem& aTreeId );
116 
117  void centerIfValid( const wxDataViewItem& aTreeId );
118 
119  void expandIfValid( const wxDataViewItem& aTreeId );
120 
125  void postPreselectEvent();
126 
130  void postSelectEvent();
131 
135  struct STATE
136  {
138  std::vector<wxDataViewItem> expanded;
139 
142  };
143 
147  STATE getState() const;
148 
152  void setState( const STATE& aState );
153 
154  void onQueryText( wxCommandEvent& aEvent );
155  void onQueryEnter( wxCommandEvent& aEvent );
156  void onQueryCharHook( wxKeyEvent& aEvent );
157 
158  void onTreeSelect( wxDataViewEvent& aEvent );
159  void onTreeActivate( wxDataViewEvent& aEvent );
160 
161  void onDetailsLink( wxHtmlLinkEvent& aEvent );
162  void onPreselect( wxCommandEvent& aEvent );
163  void onContextMenu( wxDataViewEvent& aEvent );
164 
165 protected:
168 
169  wxTextCtrl* m_query_ctrl;
170  wxDataViewCtrl* m_tree_ctrl;
171  wxHtmlWindow* m_details_ctrl;
172 };
173 
175 wxDECLARE_EVENT( COMPONENT_PRESELECTED, wxCommandEvent );
176 
178 wxDECLARE_EVENT( COMPONENT_SELECTED, wxCommandEvent );
179 
180 #endif /* LIB_TREE_H */
void selectIfValid(const wxDataViewItem &aTreeId)
If a wxDataViewitem is valid, select it and post a selection event.
Definition: lib_tree.cpp:238
void toggleExpand(const wxDataViewItem &aTreeId)
Expands or collapses a node, switching it to the opposite state.
Definition: lib_tree.cpp:226
ACTION_MENU.
Definition: action_menu.h:43
STATE getState() const
Returns the component tree widget state.
Definition: lib_tree.cpp:277
void onQueryEnter(wxCommandEvent &aEvent)
Definition: lib_tree.cpp:321
wxHtmlWindow * m_details_ctrl
Definition: lib_tree.h:171
void centerIfValid(const wxDataViewItem &aTreeId)
Definition: lib_tree.cpp:249
void postSelectEvent()
Post COMPONENT_SELECTED event to notify the selection handler that a part has been selected.
Definition: lib_tree.cpp:270
wxDataViewCtrl * m_tree_ctrl
Definition: lib_tree.h:170
LIB_ID selection
Current selection, might be not valid if nothing was selected
Definition: lib_tree.h:141
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
~LIB_TREE() override
Definition: lib_tree.cpp:138
void onPreselect(wxCommandEvent &aEvent)
Definition: lib_tree.cpp:397
LIB_TABLE * m_lib_table
Definition: lib_tree.h:166
void onQueryCharHook(wxKeyEvent &aEvent)
Definition: lib_tree.cpp:328
void onTreeActivate(wxDataViewEvent &aEvent)
Definition: lib_tree.cpp:376
void onQueryText(wxCommandEvent &aEvent)
Definition: lib_tree.cpp:311
LIB_ID GetSelectedLibId(int *aUnit=nullptr) const
For multi-unit components, if the user selects the component itself rather than picking an individual...
Definition: lib_tree.cpp:145
void Regenerate(bool aKeepState)
Regenerates the tree.
Definition: lib_tree.cpp:186
void Unselect()
Unselect currently selected item in wxDataViewCtrl.
Definition: lib_tree.cpp:175
void onTreeSelect(wxDataViewEvent &aEvent)
Definition: lib_tree.cpp:370
wxDECLARE_EVENT(COMPONENT_PRESELECTED, wxCommandEvent)
Custom event sent when a new component is preselected
void onDetailsLink(wxHtmlLinkEvent &aEvent)
Definition: lib_tree.cpp:390
void SetFocus() override
Definition: lib_tree.cpp:217
void RefreshLibTree()
Refreshes the tree (mainly to update highlighting and asterisking)
Definition: lib_tree.cpp:204
void ExpandLibId(const LIB_ID &aLibId)
Expand and item i the tree widget.
Definition: lib_tree.cpp:180
WIDGETS
Flags to select extra widgets
Definition: lib_tree.h:46
void expandIfValid(const wxDataViewItem &aTreeId)
Definition: lib_tree.cpp:256
std::vector< wxDataViewItem > expanded
List of expanded nodes
Definition: lib_tree.h:138
Structure storing state of the component tree widget.
Definition: lib_tree.h:135
wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > PTR
Reference-counting container for a pointer to CMP_TREE_MODEL_ADAPTER_BASE.
void postPreselectEvent()
Post a wxEVT_DATAVIEW_SELECTION_CHANGED to notify the selection handler that a new part has been pres...
Definition: lib_tree.cpp:263
LIB_TREE_MODEL_ADAPTER::PTR m_adapter
Definition: lib_tree.h:167
void setState(const STATE &aState)
Restores the component tree widget state from an object.
Definition: lib_tree.cpp:295
void CenterLibId(const LIB_ID &aLibId)
Ensure that an item is visible (preferrably centered).
Definition: lib_tree.cpp:169
Widget displaying a tree of components with optional search text control and description panel.
Definition: lib_tree.h:42
void SelectLibId(const LIB_ID &aLibId)
Select an item in the tree widget.
Definition: lib_tree.cpp:163
wxTextCtrl * m_query_ctrl
Definition: lib_tree.h:169
LIB_TREE(wxWindow *aParent, LIB_TABLE *aLibTable, LIB_TREE_MODEL_ADAPTER::PTR &aAdapter, WIDGETS aWidgets=ALL, wxHtmlWindow *aDetails=nullptr)
Construct a component tree.
Definition: lib_tree.cpp:34
void onContextMenu(wxDataViewEvent &aEvent)
Definition: lib_tree.cpp:414
Manage LIB_TABLE_ROW records (rows), and can be searched based on library nickname.