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