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 
144 
146 {
147  auto sel = m_tree_ctrl->GetSelection();
148 
149  if( !sel )
150  {
151  LIB_ID emptyId;
152 
153  return emptyId;
154  }
155 
156  if( aUnit )
157  *aUnit = m_adapter->GetUnitFor( sel );
158 
159  return m_adapter->GetAliasFor( sel );
160 }
161 
162 
163 void LIB_TREE::SelectLibId( const LIB_ID& aLibId )
164 {
165  selectIfValid( m_adapter->FindItem( aLibId ) );
166 }
167 
168 
169 void LIB_TREE::CenterLibId( const LIB_ID& aLibId )
170 {
171  centerIfValid( m_adapter->FindItem( aLibId ) );
172 }
173 
174 
176 {
177  m_tree_ctrl->UnselectAll();
178 }
179 
180 void LIB_TREE::ExpandLibId( const LIB_ID& aLibId )
181 {
182  expandIfValid( m_adapter->FindItem( aLibId ) );
183 }
184 
185 
186 void LIB_TREE::Regenerate( bool aKeepState )
187 {
188  STATE current;
189 
190  // Store the state
191  if( aKeepState )
192  current = getState();
193 
194  wxString filter = m_query_ctrl->GetValue();
195  m_adapter->UpdateSearchString( filter );
197 
198  // Restore the state
199  if( aKeepState )
200  setState( current );
201 }
202 
203 
205 {
206 #ifdef __WXOSX__
207  // Yes, this is an enormous hack. It should be replaced if anyone can figure out a better
208  // way to get the OSX version to re-fetch the text and attributes from the dataModel for
209  // each visible item.
210  int width = m_tree_ctrl->GetColumn( 0 )->GetWidth();
211  m_tree_ctrl->GetColumn( 0 )->SetWidth( width + 1 );
212  m_tree_ctrl->GetColumn( 0 )->SetWidth( width );
213 #endif
214 }
215 
216 
218 {
219  if( m_query_ctrl )
220  m_query_ctrl->SetFocus();
221  else
222  m_tree_ctrl->SetFocus();
223 }
224 
225 
226 void LIB_TREE::toggleExpand( const wxDataViewItem& aTreeId )
227 {
228  if( !aTreeId.IsOk() )
229  return;
230 
231  if( m_tree_ctrl->IsExpanded( aTreeId ) )
232  m_tree_ctrl->Collapse( aTreeId );
233  else
234  m_tree_ctrl->Expand( aTreeId );
235 }
236 
237 
238 void LIB_TREE::selectIfValid( const wxDataViewItem& aTreeId )
239 {
240  if( aTreeId.IsOk() )
241  {
242  m_tree_ctrl->EnsureVisible( aTreeId );
243  m_tree_ctrl->Select( aTreeId );
245  }
246 }
247 
248 
249 void LIB_TREE::centerIfValid( const wxDataViewItem& aTreeId )
250 {
251  if( aTreeId.IsOk() )
252  m_tree_ctrl->EnsureVisible( aTreeId );
253 }
254 
255 
256 void LIB_TREE::expandIfValid( const wxDataViewItem& aTreeId )
257 {
258  if( aTreeId.IsOk() && !m_tree_ctrl->IsExpanded( aTreeId ) )
259  m_tree_ctrl->Expand( aTreeId );
260 }
261 
262 
264 {
265  wxCommandEvent event( COMPONENT_PRESELECTED );
266  wxPostEvent( this, event );
267 }
268 
269 
271 {
272  wxCommandEvent event( COMPONENT_SELECTED );
273  wxPostEvent( this, event );
274 }
275 
276 
278 {
279  STATE state;
280  wxDataViewItemArray items;
281  m_adapter->GetChildren( wxDataViewItem( nullptr ), items );
282 
283  for( const auto& item : items )
284  {
285  if( m_tree_ctrl->IsExpanded( item ) )
286  state.expanded.push_back( item );
287  }
288 
289  state.selection = GetSelectedLibId();
290 
291  return state;
292 }
293 
294 
295 void LIB_TREE::setState( const STATE& aState )
296 {
297  m_tree_ctrl->Freeze();
298 
299  for( const auto& item : aState.expanded )
300  m_tree_ctrl->Expand( item );
301 
302  // wxDataViewCtrl cannot be frozen when a selection
303  // command is issued, otherwise it selects a random item (Windows)
304  m_tree_ctrl->Thaw();
305 
306  if( !aState.selection.GetLibItemName().empty() || !aState.selection.GetLibNickname().empty() )
307  SelectLibId( aState.selection );
308 }
309 
310 
311 void LIB_TREE::onQueryText( wxCommandEvent& aEvent )
312 {
313  Regenerate( false );
314 
315  // Required to avoid interaction with SetHint()
316  // See documentation for wxTextEntry::SetHint
317  aEvent.Skip();
318 }
319 
320 
321 void LIB_TREE::onQueryEnter( wxCommandEvent& aEvent )
322 {
323  if( GetSelectedLibId().IsValid() )
324  postSelectEvent();
325 }
326 
327 
328 void LIB_TREE::onQueryCharHook( wxKeyEvent& aKeyStroke )
329 {
330  auto const sel = m_tree_ctrl->GetSelection();
331  auto type = sel.IsOk() ? m_adapter->GetTypeFor( sel ) : LIB_TREE_NODE::INVALID;
332 
333  switch( aKeyStroke.GetKeyCode() )
334  {
335  case WXK_UP:
337  break;
338 
339  case WXK_DOWN:
341  break;
342 
343  case WXK_ADD:
344  if( type == LIB_TREE_NODE::LIB )
345  m_tree_ctrl->Expand( sel );
346 
347  break;
348 
349  case WXK_SUBTRACT:
350  if( type == LIB_TREE_NODE::LIB )
351  m_tree_ctrl->Collapse( sel );
352 
353  break;
354 
355  case WXK_RETURN:
356  if( type == LIB_TREE_NODE::LIB )
357  {
358  toggleExpand( sel );
359  break;
360  }
361  // Intentionally fall through, so the selected component will be treated as the selected one
362 
363  default:
364  aKeyStroke.Skip(); // Any other key: pass on to search box directly.
365  break;
366  }
367 }
368 
369 
370 void LIB_TREE::onTreeSelect( wxDataViewEvent& aEvent )
371 {
373 }
374 
375 
376 void LIB_TREE::onTreeActivate( wxDataViewEvent& aEvent )
377 {
378  if( !GetSelectedLibId().IsValid() )
379  {
380  // Expand library/part units subtree
381  toggleExpand( m_tree_ctrl->GetSelection() );
382  }
383  else
384  {
385  postSelectEvent();
386  }
387 }
388 
389 
390 void LIB_TREE::onDetailsLink( wxHtmlLinkEvent& aEvent )
391 {
392  const wxHtmlLinkInfo& info = aEvent.GetLinkInfo();
393  ::wxLaunchDefaultBrowser( info.GetHref() );
394 }
395 
396 
397 void LIB_TREE::onPreselect( wxCommandEvent& aEvent )
398 {
399  if( m_details_ctrl )
400  {
401  int unit = 0;
402  LIB_ID id = GetSelectedLibId( &unit );
403 
404  if( id.IsValid() )
405  m_details_ctrl->SetPage( m_adapter->GenerateInfo( id, unit ) );
406  else
407  m_details_ctrl->SetPage( wxEmptyString );
408  }
409 
410  aEvent.Skip();
411 }
412 
413 
414 void LIB_TREE::onContextMenu( wxDataViewEvent& aEvent )
415 {
416  TOOL_INTERACTIVE* tool = m_adapter->GetContextMenuTool();
417 
418  if( tool )
419  {
420  tool->Activate();
422  tool->GetToolMenu().ShowContextMenu();
423 
425  tool->GetManager()->DispatchContextMenu( evt );
426  }
427 }
428 
429 
430 wxDEFINE_EVENT( COMPONENT_PRESELECTED, wxCommandEvent );
431 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:238
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:226
STATE getState() const
Returns the component tree widget state.
Definition: lib_tree.cpp:277
wxDataViewItem GetPrevItem(wxDataViewCtrl const &aView, wxDataViewItem const &aItem)
Get the previous item in list order.
void onQueryEnter(wxCommandEvent &aEvent)
Definition: lib_tree.cpp:321
wxHtmlWindow * m_details_ctrl
Definition: lib_tree.h:171
BITMAP_DEF GetBitmap(GRAPHIC_PINSHAPE aShape)
Definition: pin_shape.cpp:68
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
TOOL_MENU & GetToolMenu()
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
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:328
wxDEFINE_EVENT(COMPONENT_PRESELECTED, wxCommandEvent)
void onTreeActivate(wxDataViewEvent &aEvent)
Definition: lib_tree.cpp:376
TOOL_EVENT.
Definition: tool_event.h:171
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
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:97
wxDataViewItem GetNextItem(wxDataViewCtrl const &aView, wxDataViewItem const &aItem)
Get the next item in list order.
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
#define _(s)
Definition: 3d_actions.cpp:31
void VetoContextMenuMouseWarp()
Disables mouse warping after the current context menu is closed.
Definition: tool_manager.h:384
void expandIfValid(const wxDataViewItem &aTreeId)
Definition: lib_tree.cpp:256
std::vector< wxDataViewItem > expanded
List of expanded nodes
Definition: lib_tree.h:138
void Activate()
Function Activate() Runs the tool.
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 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:295
void CenterLibId(const LIB_ID &aLibId)
Ensure that an item is visible (preferrably centered).
Definition: lib_tree.cpp:169
void SelectLibId(const LIB_ID &aLibId)
Select an item in the tree widget.
Definition: lib_tree.cpp:163
bool empty() const
Definition: utf8.h:108
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.