KiCad PCB EDA Suite
lib_tree.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) 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 #include "lib_tree.h"
26 #include <wxdataviewctrl_helpers.h>
27 #include <wx/artprov.h>
28 #include <wx/sizer.h>
29 #include <wx/html/htmlwin.h>
30 #include <tool/tool_interactive.h>
31 #include <tool/tool_manager.h>
32 
33 
34 LIB_TREE::LIB_TREE( wxWindow* aParent, LIB_TABLE* aLibTable, LIB_TREE_MODEL_ADAPTER::PTR& aAdapter,
35  WIDGETS aWidgets, wxHtmlWindow* aDetails )
36  : wxPanel( aParent, wxID_ANY, wxDefaultPosition, wxDefaultSize,
37  wxWANTS_CHARS | wxTAB_TRAVERSAL | wxNO_BORDER ),
38  m_lib_table( aLibTable ),
39  m_adapter( aAdapter ),
40  m_query_ctrl( nullptr ),
41  m_details_ctrl( nullptr )
42 {
43  auto sizer = new wxBoxSizer( wxVERTICAL );
44 
45  // Search text control
46  if( aWidgets & SEARCH )
47  {
48  auto search_sizer = new wxBoxSizer( wxHORIZONTAL );
49 
50  m_query_ctrl = new wxTextCtrl( this, wxID_ANY, wxEmptyString, wxDefaultPosition,
51  wxDefaultSize, wxTE_PROCESS_ENTER );
52 
53 // Additional visual cue for GTK, which hides the placeholder text on focus
54 #ifdef __WXGTK__
55  auto bitmap = new wxStaticBitmap( this, wxID_ANY, wxArtProvider::GetBitmap( wxART_FIND, wxART_FRAME_ICON ) );
56 
57  if( aWidgets & DETAILS )
58  search_sizer->Add( bitmap, 0, wxALIGN_CENTER | wxALL, 5 );
59  else
60  search_sizer->Add( bitmap, 0, wxALIGN_CENTER | wxRIGHT, 5 );
61 #endif
62 
63  if( aWidgets & DETAILS )
64  search_sizer->Add( m_query_ctrl, 1, wxLEFT | wxTOP | wxRIGHT | wxEXPAND, 5 );
65  else
66  search_sizer->Add( m_query_ctrl, 1, wxEXPAND, 5 );
67  sizer->Add( search_sizer, 0, wxEXPAND, 5 );
68 
69  m_query_ctrl->Bind( wxEVT_TEXT, &LIB_TREE::onQueryText, this );
70  m_query_ctrl->Bind( wxEVT_TEXT_ENTER, &LIB_TREE::onQueryEnter, this );
71  m_query_ctrl->Bind( wxEVT_CHAR_HOOK, &LIB_TREE::onQueryCharHook, this );
72  }
73 
74  // Tree control
75  m_tree_ctrl = new wxDataViewCtrl( this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
76  wxDV_SINGLE );
77  m_adapter->AttachTo( m_tree_ctrl );
78 
79  if( aWidgets & DETAILS )
80  sizer->Add( m_tree_ctrl, 5, wxLEFT | wxTOP | wxRIGHT | wxEXPAND, 5 );
81  else
82  sizer->Add( m_tree_ctrl, 5, wxRIGHT | wxBOTTOM | wxEXPAND, 1 );
83 
84  // Description panel
85  if( aWidgets & DETAILS )
86  {
87  if( !aDetails )
88  {
89  auto html_sz = ConvertDialogToPixels( wxPoint( 80, 80 ) );
90 
91  m_details_ctrl = new wxHtmlWindow(
92  this, wxID_ANY, wxDefaultPosition, wxSize( html_sz.x, html_sz.y ),
93  wxHW_SCROLLBAR_AUTO );
94 
95  sizer->Add( m_details_ctrl, 2, wxALL | wxEXPAND, 5 );
96  }
97  else
98  {
99  m_details_ctrl = aDetails;
100  }
101 
102  m_details_ctrl->Bind( wxEVT_HTML_LINK_CLICKED, &LIB_TREE::onDetailsLink, this );
103  }
104 
105  SetSizer( sizer );
106 
107  m_tree_ctrl->Bind( wxEVT_DATAVIEW_ITEM_ACTIVATED, &LIB_TREE::onTreeActivate, this );
108  m_tree_ctrl->Bind( wxEVT_DATAVIEW_SELECTION_CHANGED, &LIB_TREE::onTreeSelect, this );
109  m_tree_ctrl->Bind( wxEVT_COMMAND_DATAVIEW_ITEM_CONTEXT_MENU, &LIB_TREE::onContextMenu, this );
110 
111  Bind( COMPONENT_PRESELECTED, &LIB_TREE::onPreselect, this );
112 
113  // If wxTextCtrl::SetHint() is called before binding wxEVT_TEXT, the event
114  // handler will intermittently fire.
115  if( m_query_ctrl )
116  {
117  m_query_ctrl->SetHint( _( "Filter" ) );
118  m_query_ctrl->SetFocus();
119  m_query_ctrl->SetValue( wxEmptyString ); // SetValue() is required here to kick off
120  // initial sorting and pre-selection.
121  }
122 
123  // There may be a part preselected in the model. Make sure it is displayed.
125 
126  Layout();
127  sizer->Fit( this );
128 
129 #ifdef __WXGTK__
130  // Scrollbars must be always enabled to prevent an infinite event loop
131  // more details: http://trac.wxwidgets.org/ticket/18141
132  if( m_details_ctrl )
133  m_details_ctrl->ShowScrollbars( wxSHOW_SB_ALWAYS, wxSHOW_SB_ALWAYS );
134 #endif /* __WXGTK__ */
135 }
136 
137 
139 {
140  // Save the column widths to the config file
141  m_adapter->SaveColWidths();
142 
143  m_adapter->SavePinnedItems();
144 }
145 
146 
148 {
149  auto sel = m_tree_ctrl->GetSelection();
150 
151  if( !sel )
152  {
153  LIB_ID emptyId;
154 
155  return emptyId;
156  }
157 
158  if( aUnit )
159  *aUnit = m_adapter->GetUnitFor( sel );
160 
161  return m_adapter->GetAliasFor( sel );
162 }
163 
164 
166 {
167  auto sel = m_tree_ctrl->GetSelection();
168 
169  if( !sel )
170  return nullptr;
171 
172  return m_adapter->GetTreeNodeFor( sel );
173 }
174 
175 
176 void LIB_TREE::SelectLibId( const LIB_ID& aLibId )
177 {
178  selectIfValid( m_adapter->FindItem( aLibId ) );
179 }
180 
181 
182 void LIB_TREE::CenterLibId( const LIB_ID& aLibId )
183 {
184  centerIfValid( m_adapter->FindItem( aLibId ) );
185 }
186 
187 
189 {
190  m_tree_ctrl->UnselectAll();
191 }
192 
193 void LIB_TREE::ExpandLibId( const LIB_ID& aLibId )
194 {
195  expandIfValid( m_adapter->FindItem( aLibId ) );
196 }
197 
198 
199 void LIB_TREE::Regenerate( bool aKeepState )
200 {
201  STATE current;
202 
203  // Store the state
204  if( aKeepState )
205  current = getState();
206 
207  wxString filter = m_query_ctrl->GetValue();
208  m_adapter->UpdateSearchString( filter );
210 
211  // Restore the state
212  if( aKeepState )
213  setState( current );
214 }
215 
216 
218 {
219  m_adapter->RefreshTree();
220 }
221 
222 
224 {
225  if( m_query_ctrl )
226  m_query_ctrl->SetFocus();
227  else
228  m_tree_ctrl->SetFocus();
229 }
230 
231 
232 void LIB_TREE::toggleExpand( const wxDataViewItem& aTreeId )
233 {
234  if( !aTreeId.IsOk() )
235  return;
236 
237  if( m_tree_ctrl->IsExpanded( aTreeId ) )
238  m_tree_ctrl->Collapse( aTreeId );
239  else
240  m_tree_ctrl->Expand( aTreeId );
241 }
242 
243 
244 void LIB_TREE::selectIfValid( const wxDataViewItem& aTreeId )
245 {
246  if( aTreeId.IsOk() )
247  {
248  m_tree_ctrl->EnsureVisible( aTreeId );
249  m_tree_ctrl->Select( aTreeId );
251  }
252 }
253 
254 
255 void LIB_TREE::centerIfValid( const wxDataViewItem& aTreeId )
256 {
257  if( aTreeId.IsOk() )
258  m_tree_ctrl->EnsureVisible( aTreeId );
259 }
260 
261 
262 void LIB_TREE::expandIfValid( const wxDataViewItem& aTreeId )
263 {
264  if( aTreeId.IsOk() && !m_tree_ctrl->IsExpanded( aTreeId ) )
265  m_tree_ctrl->Expand( aTreeId );
266 }
267 
268 
270 {
271  wxCommandEvent event( COMPONENT_PRESELECTED );
272  wxPostEvent( this, event );
273 }
274 
275 
277 {
278  wxCommandEvent event( COMPONENT_SELECTED );
279  wxPostEvent( this, event );
280 }
281 
282 
284 {
285  STATE state;
286  wxDataViewItemArray items;
287  m_adapter->GetChildren( wxDataViewItem( nullptr ), items );
288 
289  for( const auto& item : items )
290  {
291  if( m_tree_ctrl->IsExpanded( item ) )
292  state.expanded.push_back( item );
293  }
294 
295  state.selection = GetSelectedLibId();
296 
297  return state;
298 }
299 
300 
301 void LIB_TREE::setState( const STATE& aState )
302 {
303  m_tree_ctrl->Freeze();
304 
305  for( const auto& item : aState.expanded )
306  m_tree_ctrl->Expand( item );
307 
308  // wxDataViewCtrl cannot be frozen when a selection
309  // command is issued, otherwise it selects a random item (Windows)
310  m_tree_ctrl->Thaw();
311 
312  if( !aState.selection.GetLibItemName().empty() || !aState.selection.GetLibNickname().empty() )
313  SelectLibId( aState.selection );
314 }
315 
316 
317 void LIB_TREE::onQueryText( wxCommandEvent& aEvent )
318 {
319  Regenerate( false );
320 
321  // Required to avoid interaction with SetHint()
322  // See documentation for wxTextEntry::SetHint
323  aEvent.Skip();
324 }
325 
326 
327 void LIB_TREE::onQueryEnter( wxCommandEvent& aEvent )
328 {
329  if( GetSelectedLibId().IsValid() )
330  postSelectEvent();
331 }
332 
333 
334 void LIB_TREE::onQueryCharHook( wxKeyEvent& aKeyStroke )
335 {
336  auto const sel = m_tree_ctrl->GetSelection();
337  auto type = sel.IsOk() ? m_adapter->GetTypeFor( sel ) : LIB_TREE_NODE::INVALID;
338 
339  switch( aKeyStroke.GetKeyCode() )
340  {
341  case WXK_UP:
343  break;
344 
345  case WXK_DOWN:
347  break;
348 
349  case WXK_ADD:
350  if( type == LIB_TREE_NODE::LIB )
351  m_tree_ctrl->Expand( sel );
352 
353  break;
354 
355  case WXK_SUBTRACT:
356  if( type == LIB_TREE_NODE::LIB )
357  m_tree_ctrl->Collapse( sel );
358 
359  break;
360 
361  case WXK_RETURN:
362  if( type == LIB_TREE_NODE::LIB )
363  {
364  toggleExpand( sel );
365  break;
366  }
367  // Intentionally fall through, so the selected component will be treated as the selected one
368 
369  default:
370  aKeyStroke.Skip(); // Any other key: pass on to search box directly.
371  break;
372  }
373 }
374 
375 
376 void LIB_TREE::onTreeSelect( wxDataViewEvent& aEvent )
377 {
379 }
380 
381 
382 void LIB_TREE::onTreeActivate( wxDataViewEvent& aEvent )
383 {
384  if( !GetSelectedLibId().IsValid() )
385  {
386  // Expand library/part units subtree
387  toggleExpand( m_tree_ctrl->GetSelection() );
388  }
389  else
390  {
391  postSelectEvent();
392  }
393 }
394 
395 
396 void LIB_TREE::onDetailsLink( wxHtmlLinkEvent& aEvent )
397 {
398  const wxHtmlLinkInfo& info = aEvent.GetLinkInfo();
399  ::wxLaunchDefaultBrowser( info.GetHref() );
400 }
401 
402 
403 void LIB_TREE::onPreselect( wxCommandEvent& aEvent )
404 {
405  if( m_details_ctrl )
406  {
407  int unit = 0;
408  LIB_ID id = GetSelectedLibId( &unit );
409 
410  if( id.IsValid() )
411  m_details_ctrl->SetPage( m_adapter->GenerateInfo( id, unit ) );
412  else
413  m_details_ctrl->SetPage( wxEmptyString );
414  }
415 
416  aEvent.Skip();
417 }
418 
419 
420 void LIB_TREE::onContextMenu( wxDataViewEvent& aEvent )
421 {
422  TOOL_INTERACTIVE* tool = m_adapter->GetContextMenuTool();
423 
424  if( tool )
425  {
426  tool->Activate();
428  tool->GetToolMenu().ShowContextMenu();
429 
431  tool->GetManager()->DispatchContextMenu( evt );
432  }
433 }
434 
435 
436 wxDEFINE_EVENT( COMPONENT_PRESELECTED, wxCommandEvent );
437 wxDEFINE_EVENT( COMPONENT_SELECTED, wxCommandEvent );
void selectIfValid(const wxDataViewItem &aTreeId)
If a wxDataViewitem is valid, select it and post a selection event.
Definition: lib_tree.cpp:244
void DispatchContextMenu(const TOOL_EVENT &aEvent)
Function DispatchContextMenu() Handles context menu related events.
const UTF8 & GetLibItemName() const
Definition: lib_id.h:114
void toggleExpand(const wxDataViewItem &aTreeId)
Expands or collapses a node, switching it to the opposite state.
Definition: lib_tree.cpp:232
STATE getState() const
Returns the component tree widget state.
Definition: lib_tree.cpp:283
wxDataViewItem GetPrevItem(wxDataViewCtrl const &aView, wxDataViewItem const &aItem)
Get the previous item in list order.
void onQueryEnter(wxCommandEvent &aEvent)
Definition: lib_tree.cpp:327
wxHtmlWindow * m_details_ctrl
Definition: lib_tree.h:174
BITMAP_DEF GetBitmap(GRAPHIC_PINSHAPE aShape)
Definition: pin_shape.cpp:68
void centerIfValid(const wxDataViewItem &aTreeId)
Definition: lib_tree.cpp:255
void postSelectEvent()
Post COMPONENT_SELECTED event to notify the selection handler that a part has been selected.
Definition: lib_tree.cpp:276
wxDataViewCtrl * m_tree_ctrl
Definition: lib_tree.h:173
TOOL_MENU & GetToolMenu()
LIB_ID selection
Current selection, might be not valid if nothing was selected
Definition: lib_tree.h:144
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:403
TOOL_MANAGER * GetManager() const
Function GetManager() Returns the instance of TOOL_MANAGER that takes care of the tool.
Definition: tool_base.h:142
void onQueryCharHook(wxKeyEvent &aEvent)
Definition: lib_tree.cpp:334
wxDEFINE_EVENT(COMPONENT_PRESELECTED, wxCommandEvent)
LIB_TREE_NODE * GetCurrentTreeNode() const
Definition: lib_tree.cpp:165
void onTreeActivate(wxDataViewEvent &aEvent)
Definition: lib_tree.cpp:382
TOOL_EVENT.
Definition: tool_event.h:171
void onQueryText(wxCommandEvent &aEvent)
Definition: lib_tree.cpp:317
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:147
void Regenerate(bool aKeepState)
Regenerates the tree.
Definition: lib_tree.cpp:199
void Unselect()
Unselect currently selected item in wxDataViewCtrl.
Definition: lib_tree.cpp:188
void onTreeSelect(wxDataViewEvent &aEvent)
Definition: lib_tree.cpp:376
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:97
Model class in the component selector Model-View-Adapter (mediated MVC) architecture.
wxDataViewItem GetNextItem(wxDataViewCtrl const &aView, wxDataViewItem const &aItem)
Get the next item in list order.
void onDetailsLink(wxHtmlLinkEvent &aEvent)
Definition: lib_tree.cpp:396
void SetFocus() override
Definition: lib_tree.cpp:223
void RefreshLibTree()
Refreshes the tree (mainly to update highlighting and asterisking)
Definition: lib_tree.cpp:217
void ExpandLibId(const LIB_ID &aLibId)
Expand and item i the tree widget.
Definition: lib_tree.cpp:193
WIDGETS
Flags to select extra widgets
Definition: lib_tree.h:46
#define _(s)
Definition: 3d_actions.cpp:33
void VetoContextMenuMouseWarp()
Disables mouse warping after the current context menu is closed.
Definition: tool_manager.h:414
void expandIfValid(const wxDataViewItem &aTreeId)
Definition: lib_tree.cpp:262
std::vector< wxDataViewItem > expanded
List of expanded nodes
Definition: lib_tree.h:140
void Activate()
Function Activate() Runs the tool.
Structure storing state of the component tree widget.
Definition: lib_tree.h:137
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:269
LIB_TREE_MODEL_ADAPTER::PTR m_adapter
Definition: lib_tree.h:170
void ShowContextMenu(SELECTION &aSelection)
Function ShowContextMenu.
Definition: tool_menu.cpp:59
wxDataViewCtrl helper functions.
void setState(const STATE &aState)
Restores the component tree widget state from an object.
Definition: lib_tree.cpp:301
void CenterLibId(const LIB_ID &aLibId)
Ensure that an item is visible (preferrably centered).
Definition: lib_tree.cpp:182
void SelectLibId(const LIB_ID &aLibId)
Select an item in the tree widget.
Definition: lib_tree.cpp:176
bool empty() const
Definition: utf8.h:108
wxTextCtrl * m_query_ctrl
Definition: lib_tree.h:172
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:420
Manage LIB_TABLE_ROW records (rows), and can be searched based on library nickname.