KiCad PCB EDA Suite
RC_TREE_MODEL Class Reference

#include <rc_item.h>

Inheritance diagram for RC_TREE_MODEL:

Public Member Functions

 RC_TREE_MODEL (EDA_DRAW_FRAME *aParentFrame, wxDataViewCtrl *aView)
 
 ~RC_TREE_MODEL ()
 
void SetProvider (RC_ITEMS_PROVIDER *aProvider)
 
void SetSeverities (int aSeverities)
 
int GetDRCItemCount () const
 
void ExpandAll ()
 
void PrevMarker ()
 
void NextMarker ()
 
void SelectMarker (const MARKER_BASE *aMarker)
 
void CenterMarker (const MARKER_BASE *aMarker)
 
bool IsContainer (wxDataViewItem const &aItem) const override
 
wxDataViewItem GetParent (wxDataViewItem const &aItem) const override
 
unsigned int GetChildren (wxDataViewItem const &aItem, wxDataViewItemArray &aChildren) const override
 
unsigned int GetColumnCount () const override
 
wxString GetColumnType (unsigned int aCol) const override
 
bool HasContainerColumns (wxDataViewItem const &aItem) const override
 
void GetValue (wxVariant &aVariant, wxDataViewItem const &aItem, unsigned int aCol) const override
 Called by the wxDataView to fetch an item's value. More...
 
bool SetValue (wxVariant const &aVariant, wxDataViewItem const &aItem, unsigned int aCol) override
 Called by the wxDataView to edit an item's content. More...
 
bool GetAttr (wxDataViewItem const &aItem, unsigned int aCol, wxDataViewItemAttr &aAttr) const override
 Called by the wxDataView to fetch an item's formatting. More...
 
void ValueChanged (const RC_TREE_NODE *aNode)
 
void DeleteCurrentItem (bool aDeep)
 
void DeleteItems (bool aCurrentOnly, bool aIncludeExclusions, bool aDeep)
 Deletes the current item or all items. More...
 

Static Public Member Functions

static wxDataViewItem ToItem (RC_TREE_NODE const *aNode)
 
static RC_TREE_NODEToNode (wxDataViewItem aItem)
 
static KIID ToUUID (wxDataViewItem aItem)
 

Private Member Functions

void rebuildModel (RC_ITEMS_PROVIDER *aProvider, int aSeverities)
 
void onSizeView (wxSizeEvent &aEvent)
 

Private Attributes

EDA_DRAW_FRAMEm_editFrame
 
wxDataViewCtrl * m_view
 
int m_severities
 
RC_ITEMS_PROVIDERm_rcItemsProvider
 
std::vector< RC_TREE_NODE * > m_tree
 

Detailed Description

Definition at line 204 of file rc_item.h.

Constructor & Destructor Documentation

◆ RC_TREE_MODEL()

RC_TREE_MODEL::RC_TREE_MODEL ( EDA_DRAW_FRAME aParentFrame,
wxDataViewCtrl *  aView 
)

Definition at line 176 of file rc_item.cpp.

176  :
177  m_editFrame( aParentFrame ),
178  m_view( aView ),
179  m_severities( 0 ),
180  m_rcItemsProvider( nullptr )
181 {
182  m_view->GetMainWindow()->Connect( wxEVT_SIZE,
183  wxSizeEventHandler( RC_TREE_MODEL::onSizeView ),
184  nullptr, this );
185 }
wxDataViewCtrl * m_view
Definition: rc_item.h:288
RC_ITEMS_PROVIDER * m_rcItemsProvider
Definition: rc_item.h:290
EDA_DRAW_FRAME * m_editFrame
Definition: rc_item.h:287
void onSizeView(wxSizeEvent &aEvent)
Definition: rc_item.cpp:631
int m_severities
Definition: rc_item.h:289

References m_view, and onSizeView().

◆ ~RC_TREE_MODEL()

RC_TREE_MODEL::~RC_TREE_MODEL ( )

Definition at line 188 of file rc_item.cpp.

189 {
190  delete m_rcItemsProvider;
191 
192  for( RC_TREE_NODE* topLevelNode : m_tree )
193  delete topLevelNode;
194 }
RC_ITEMS_PROVIDER * m_rcItemsProvider
Definition: rc_item.h:290
std::vector< RC_TREE_NODE * > m_tree
Definition: rc_item.h:292

References m_rcItemsProvider, and m_tree.

Member Function Documentation

◆ CenterMarker()

void RC_TREE_MODEL::CenterMarker ( const MARKER_BASE aMarker)

Definition at line 618 of file rc_item.cpp.

619 {
620  for( RC_TREE_NODE* candidate : m_tree )
621  {
622  if( candidate->m_RcItem->GetParent() == aMarker )
623  {
624  m_view->EnsureVisible( ToItem( candidate ) );
625  return;
626  }
627  }
628 }
static wxDataViewItem ToItem(RC_TREE_NODE const *aNode)
Definition: rc_item.h:207
wxDataViewCtrl * m_view
Definition: rc_item.h:288
std::vector< RC_TREE_NODE * > m_tree
Definition: rc_item.h:292

References m_tree, m_view, and ToItem().

Referenced by DIALOG_DRC::centerMarkerIdleHandler().

◆ DeleteCurrentItem()

void RC_TREE_MODEL::DeleteCurrentItem ( bool  aDeep)

Definition at line 461 of file rc_item.cpp.

462 {
463  DeleteItems( true, true, aDeep );
464 }
void DeleteItems(bool aCurrentOnly, bool aIncludeExclusions, bool aDeep)
Deletes the current item or all items.
Definition: rc_item.cpp:467

References DeleteItems().

Referenced by DIALOG_DRC::ExcludeMarker(), DIALOG_ERC::ExcludeMarker(), DIALOG_FOOTPRINT_CHECKER::OnDeleteOneClick(), and DIALOG_DRC::OnDeleteOneClick().

◆ DeleteItems()

void RC_TREE_MODEL::DeleteItems ( bool  aCurrentOnly,
bool  aIncludeExclusions,
bool  aDeep 
)

Deletes the current item or all items.

If all, aIncludeExclusions determines whether or not exclusions are also deleted.

Keep a vector of elements to free after wxWidgets is definitely done accessing them

Definition at line 467 of file rc_item.cpp.

468 {
469  RC_TREE_NODE* current_node = ToNode( m_view->GetCurrentItem() );
470  const std::shared_ptr<RC_ITEM> current_item = current_node ? current_node->m_RcItem : nullptr;
471 
473  std::vector<RC_TREE_NODE*> to_delete;
474 
475  if( aCurrentOnly && !current_item )
476  {
477  wxBell();
478  return;
479  }
480 
481  if( !m_rcItemsProvider )
482  return;
483 
484  int lastGood = -1;
485  bool itemDeleted = false;
486 
487  if( m_view )
488  {
489  m_view->UnselectAll();
490  wxSafeYield();
491  m_view->Freeze();
492  }
493 
494  for( int i = m_rcItemsProvider->GetCount() - 1; i >= 0; --i )
495  {
496  std::shared_ptr<RC_ITEM> rcItem = m_rcItemsProvider->GetItem( i );
497  MARKER_BASE* marker = rcItem->GetParent();
498  bool excluded = marker ? marker->IsExcluded() : false;
499 
500  if( aCurrentOnly && itemDeleted && lastGood >= 0 )
501  break;
502 
503  if( aCurrentOnly && rcItem != current_item )
504  {
505  lastGood = i;
506  continue;
507  }
508 
509  if( excluded && !aIncludeExclusions )
510  continue;
511 
512  if( i < (int) m_tree.size() ) // Careful; tree is truncated for large datasets
513  {
514  wxDataViewItem markerItem = ToItem( m_tree[i] );
515  wxDataViewItemArray childItems;
516  wxDataViewItem parentItem = ToItem( m_tree[i]->m_Parent );
517 
518  for( RC_TREE_NODE* child : m_tree[i]->m_Children )
519  {
520  childItems.push_back( ToItem( child ) );
521  to_delete.push_back( child );
522  }
523 
524  m_tree[i]->m_Children.clear();
525  ItemsDeleted( markerItem, childItems );
526 
527  to_delete.push_back( m_tree[i] );
528  m_tree.erase( m_tree.begin() + i );
529  ItemDeleted( parentItem, markerItem );
530  }
531 
532  // Only deep delete the current item here; others will be done through the
533  // DeleteAllItems() call below, which is more efficient.
534  m_rcItemsProvider->DeleteItem( i, aDeep && aCurrentOnly );
535 
536  if( lastGood > i )
537  lastGood--;
538 
539  itemDeleted = true;
540  }
541 
542  if( m_view && aCurrentOnly && lastGood >= 0 )
543  m_view->Select( ToItem( m_tree[ lastGood ] ) );
544 
545  for( RC_TREE_NODE* item : to_delete )
546  delete( item );
547 
548  if( !aCurrentOnly )
549  m_rcItemsProvider->DeleteAllItems( aIncludeExclusions, aDeep );
550 
551  if( m_view )
552  m_view->Thaw();
553 }
virtual void DeleteAllItems(bool aIncludeExclusions, bool aDeep)=0
static wxDataViewItem ToItem(RC_TREE_NODE const *aNode)
Definition: rc_item.h:207
wxDataViewCtrl * m_view
Definition: rc_item.h:288
virtual int GetCount(int aSeverity=-1) const =0
RC_ITEMS_PROVIDER * m_rcItemsProvider
Definition: rc_item.h:290
std::shared_ptr< RC_ITEM > m_RcItem
Definition: rc_item.h:197
static RC_TREE_NODE * ToNode(wxDataViewItem aItem)
Definition: rc_item.h:212
bool IsExcluded() const
Definition: marker_base.h:95
std::vector< RC_TREE_NODE * > m_tree
Definition: rc_item.h:292
virtual std::shared_ptr< RC_ITEM > GetItem(int aIndex) const =0
Retrieve a RC_ITEM by index.
virtual void DeleteItem(int aIndex, bool aDeep)=0
Remove (and optionally deletes) the indexed item from the list.

References RC_ITEMS_PROVIDER::DeleteAllItems(), RC_ITEMS_PROVIDER::DeleteItem(), RC_ITEMS_PROVIDER::GetCount(), RC_ITEMS_PROVIDER::GetItem(), MARKER_BASE::IsExcluded(), RC_TREE_NODE::m_RcItem, m_rcItemsProvider, m_tree, m_view, ToItem(), and ToNode().

Referenced by DIALOG_FOOTPRINT_CHECKER::deleteAllMarkers(), DIALOG_ERC::deleteAllMarkers(), DIALOG_DRC::deleteAllMarkers(), DeleteCurrentItem(), and DIALOG_DRC::OnRunDRCClick().

◆ ExpandAll()

void RC_TREE_MODEL::ExpandAll ( )

Definition at line 306 of file rc_item.cpp.

307 {
308  for( RC_TREE_NODE* topLevelNode : m_tree )
309  m_view->Expand( ToItem( topLevelNode ) );
310 }
static wxDataViewItem ToItem(RC_TREE_NODE const *aNode)
Definition: rc_item.h:207
wxDataViewCtrl * m_view
Definition: rc_item.h:288
std::vector< RC_TREE_NODE * > m_tree
Definition: rc_item.h:292

References m_tree, m_view, and ToItem().

Referenced by rebuildModel().

◆ GetAttr()

bool RC_TREE_MODEL::GetAttr ( wxDataViewItem const &  aItem,
unsigned int  aCol,
wxDataViewItemAttr &  aAttr 
) const
override

Called by the wxDataView to fetch an item's formatting.

Return true if the item has non-default attributes.

Definition at line 405 of file rc_item.cpp.

408 {
409  const RC_TREE_NODE* node = ToNode( aItem );
410  wxASSERT( node );
411 
412  bool ret = false;
413  bool heading = node->m_Type == RC_TREE_NODE::MARKER;
414 
415  if( heading )
416  {
417  aAttr.SetBold( true );
418  ret = true;
419  }
420 
421  if( node->m_RcItem->GetParent() && node->m_RcItem->GetParent()->IsExcluded() )
422  {
423  wxColour textColour = wxSystemSettings::GetColour( wxSYS_COLOUR_LISTBOXTEXT );
424  double brightness = KIGFX::COLOR4D( textColour ).GetBrightness();
425 
426  if( brightness > 0.5 )
427  {
428  int lightness = static_cast<int>( brightness * ( heading ? 50 : 60 ) );
429  aAttr.SetColour( textColour.ChangeLightness( lightness ) );
430  }
431  else
432  {
433  aAttr.SetColour( textColour.ChangeLightness( heading ? 170 : 165 ) );
434  }
435 
436  aAttr.SetItalic( true ); // Strikethrough would be better, if wxWidgets supported it
437  ret = true;
438  }
439 
440  return ret;
441 }
double GetBrightness() const
Returns the brightness value of the color ranged from 0.0 to 1.0.
Definition: color4d.h:343
std::shared_ptr< RC_ITEM > m_RcItem
Definition: rc_item.h:197
static RC_TREE_NODE * ToNode(wxDataViewItem aItem)
Definition: rc_item.h:212
NODE_TYPE m_Type
Definition: rc_item.h:196
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:103

References KIGFX::COLOR4D::GetBrightness(), RC_TREE_NODE::m_RcItem, RC_TREE_NODE::m_Type, RC_TREE_NODE::MARKER, and ToNode().

◆ GetChildren()

unsigned int RC_TREE_MODEL::GetChildren ( wxDataViewItem const &  aItem,
wxDataViewItemArray &  aChildren 
) const
override

Definition at line 328 of file rc_item.cpp.

330 {
331  const RC_TREE_NODE* node = ToNode( aItem );
332  const std::vector<RC_TREE_NODE*>& children = node ? node->m_Children : m_tree;
333 
334  for( const RC_TREE_NODE* child: children )
335  aChildren.push_back( ToItem( child ) );
336 
337  return children.size();
338 }
static wxDataViewItem ToItem(RC_TREE_NODE const *aNode)
Definition: rc_item.h:207
std::vector< RC_TREE_NODE * > m_Children
Definition: rc_item.h:200
static RC_TREE_NODE * ToNode(wxDataViewItem aItem)
Definition: rc_item.h:212
std::vector< RC_TREE_NODE * > m_tree
Definition: rc_item.h:292

References RC_TREE_NODE::m_Children, m_tree, ToItem(), and ToNode().

◆ GetColumnCount()

unsigned int RC_TREE_MODEL::GetColumnCount ( ) const
inlineoverride

Definition at line 243 of file rc_item.h.

243 { return 1; }

◆ GetColumnType()

wxString RC_TREE_MODEL::GetColumnType ( unsigned int  aCol) const
inlineoverride

Definition at line 244 of file rc_item.h.

244 { return "string"; }

◆ GetDRCItemCount()

int RC_TREE_MODEL::GetDRCItemCount ( ) const
inline

Definition at line 226 of file rc_item.h.

226 { return m_tree.size(); }
std::vector< RC_TREE_NODE * > m_tree
Definition: rc_item.h:292

References m_tree.

◆ GetParent()

wxDataViewItem RC_TREE_MODEL::GetParent ( wxDataViewItem const &  aItem) const
override

Definition at line 322 of file rc_item.cpp.

323 {
324  return ToItem( ToNode( aItem)->m_Parent );
325 }
static wxDataViewItem ToItem(RC_TREE_NODE const *aNode)
Definition: rc_item.h:207
static RC_TREE_NODE * ToNode(wxDataViewItem aItem)
Definition: rc_item.h:212

References ToItem(), and ToNode().

◆ GetValue()

void RC_TREE_MODEL::GetValue ( wxVariant &  aVariant,
wxDataViewItem const &  aItem,
unsigned int  aCol 
) const
override

Called by the wxDataView to fetch an item's value.

Definition at line 341 of file rc_item.cpp.

344 {
345  const RC_TREE_NODE* node = ToNode( aItem );
346  const std::shared_ptr<RC_ITEM> rcItem = node->m_RcItem;
347 
348  switch( node->m_Type )
349  {
351  {
352  wxString prefix;
353 
354  if( rcItem->GetParent() && rcItem->GetParent()->IsExcluded() )
355  prefix = _( "Excluded " );
356 
357  switch( m_editFrame->GetSeverity( rcItem->GetErrorCode() ) )
358  {
359  case RPT_SEVERITY_ERROR: prefix += _( "Error: " ); break;
360  case RPT_SEVERITY_WARNING: prefix += _( "Warning: " ); break;
361 
364  case RPT_SEVERITY_INFO:
365  case RPT_SEVERITY_ACTION:
366  case RPT_SEVERITY_IGNORE:
367  break;
368  }
369 
370  aVariant = prefix + rcItem->GetErrorMessage();
371  }
372  break;
373 
375  {
376  EDA_ITEM* item = m_editFrame->GetItem( rcItem->GetMainItemID() );
377  aVariant = item->GetSelectMenuText( m_editFrame->GetUserUnits() );
378  }
379  break;
380 
382  {
383  EDA_ITEM* item = m_editFrame->GetItem( rcItem->GetAuxItemID() );
384  aVariant = item->GetSelectMenuText( m_editFrame->GetUserUnits() );
385  }
386  break;
387 
389  {
390  EDA_ITEM* item = m_editFrame->GetItem( rcItem->GetAuxItem2ID() );
391  aVariant = item->GetSelectMenuText( m_editFrame->GetUserUnits() );
392  }
393  break;
394 
396  {
397  EDA_ITEM* item = m_editFrame->GetItem( rcItem->GetAuxItem3ID() );
398  aVariant = item->GetSelectMenuText( m_editFrame->GetUserUnits() );
399  }
400  break;
401  }
402 }
virtual SEVERITY GetSeverity(int aErrorCode) const
std::shared_ptr< RC_ITEM > m_RcItem
Definition: rc_item.h:197
static RC_TREE_NODE * ToNode(wxDataViewItem aItem)
Definition: rc_item.h:212
#define _(s)
EDA_DRAW_FRAME * m_editFrame
Definition: rc_item.h:287
virtual EDA_ITEM * GetItem(const KIID &aId) const
Fetch an item by KIID.
NODE_TYPE m_Type
Definition: rc_item.h:196
virtual wxString GetSelectMenuText(EDA_UNITS aUnits) const
Return the text to display to be used in the selection clarification context menu when multiple items...
Definition: eda_item.cpp:109
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:99
EDA_UNITS GetUserUnits() const
Return the user units currently in use.

References _, RC_TREE_NODE::AUX_ITEM, RC_TREE_NODE::AUX_ITEM2, RC_TREE_NODE::AUX_ITEM3, EDA_DRAW_FRAME::GetItem(), EDA_ITEM::GetSelectMenuText(), EDA_BASE_FRAME::GetSeverity(), EDA_BASE_FRAME::GetUserUnits(), m_editFrame, RC_TREE_NODE::m_RcItem, RC_TREE_NODE::m_Type, RC_TREE_NODE::MAIN_ITEM, RC_TREE_NODE::MARKER, RPT_SEVERITY_ACTION, RPT_SEVERITY_ERROR, RPT_SEVERITY_EXCLUSION, RPT_SEVERITY_IGNORE, RPT_SEVERITY_INFO, RPT_SEVERITY_UNDEFINED, RPT_SEVERITY_WARNING, and ToNode().

◆ HasContainerColumns()

bool RC_TREE_MODEL::HasContainerColumns ( wxDataViewItem const &  aItem) const
inlineoverride

Definition at line 245 of file rc_item.h.

245 { return true; }

◆ IsContainer()

bool RC_TREE_MODEL::IsContainer ( wxDataViewItem const &  aItem) const
override

Definition at line 313 of file rc_item.cpp.

314 {
315  if( ToNode( aItem ) == nullptr ) // must be tree root...
316  return true;
317  else
318  return ToNode( aItem )->m_Type == RC_TREE_NODE::MARKER;
319 }
static RC_TREE_NODE * ToNode(wxDataViewItem aItem)
Definition: rc_item.h:212
NODE_TYPE m_Type
Definition: rc_item.h:196

References RC_TREE_NODE::m_Type, RC_TREE_NODE::MARKER, and ToNode().

◆ NextMarker()

void RC_TREE_MODEL::NextMarker ( )

Definition at line 577 of file rc_item.cpp.

578 {
579  RC_TREE_NODE* currentNode = ToNode( m_view->GetCurrentItem() );
580 
581  while( currentNode && currentNode->m_Type != RC_TREE_NODE::MARKER )
582  currentNode = currentNode->m_Parent;
583 
584  RC_TREE_NODE* nextMarker = nullptr;
585  bool trigger = currentNode == nullptr;
586 
587  for( RC_TREE_NODE* candidate : m_tree )
588  {
589  if( candidate == currentNode )
590  {
591  trigger = true;
592  }
593  else if( trigger )
594  {
595  nextMarker = candidate;
596  break;
597  }
598  }
599 
600  if( nextMarker )
601  m_view->Select( ToItem( nextMarker ) );
602 }
static wxDataViewItem ToItem(RC_TREE_NODE const *aNode)
Definition: rc_item.h:207
RC_TREE_NODE * m_Parent
Definition: rc_item.h:199
wxDataViewCtrl * m_view
Definition: rc_item.h:288
static RC_TREE_NODE * ToNode(wxDataViewItem aItem)
Definition: rc_item.h:212
NODE_TYPE m_Type
Definition: rc_item.h:196
std::vector< RC_TREE_NODE * > m_tree
Definition: rc_item.h:292

References RC_TREE_NODE::m_Parent, m_tree, RC_TREE_NODE::m_Type, m_view, RC_TREE_NODE::MARKER, ToItem(), and ToNode().

Referenced by DIALOG_ERC::NextMarker(), and DIALOG_DRC::NextMarker().

◆ onSizeView()

void RC_TREE_MODEL::onSizeView ( wxSizeEvent &  aEvent)
private

Definition at line 631 of file rc_item.cpp.

632 {
633  int width = m_view->GetMainWindow()->GetRect().GetWidth() - WX_DATAVIEW_WINDOW_PADDING;
634 
635  if( m_view->GetColumnCount() > 0 )
636  m_view->GetColumn( 0 )->SetWidth( width );
637 
638  // Pass size event to other widgets
639  aEvent.Skip();
640 }
wxDataViewCtrl * m_view
Definition: rc_item.h:288
#define WX_DATAVIEW_WINDOW_PADDING
Definition: rc_item.cpp:35

References m_view, and WX_DATAVIEW_WINDOW_PADDING.

Referenced by RC_TREE_MODEL().

◆ PrevMarker()

void RC_TREE_MODEL::PrevMarker ( )

Definition at line 556 of file rc_item.cpp.

557 {
558  RC_TREE_NODE* currentNode = ToNode( m_view->GetCurrentItem() );
559  RC_TREE_NODE* prevMarker = nullptr;
560 
561  while( currentNode && currentNode->m_Type != RC_TREE_NODE::MARKER )
562  currentNode = currentNode->m_Parent;
563 
564  for( RC_TREE_NODE* candidate : m_tree )
565  {
566  if( candidate == currentNode )
567  break;
568  else
569  prevMarker = candidate;
570  }
571 
572  if( prevMarker )
573  m_view->Select( ToItem( prevMarker ) );
574 }
static wxDataViewItem ToItem(RC_TREE_NODE const *aNode)
Definition: rc_item.h:207
RC_TREE_NODE * m_Parent
Definition: rc_item.h:199
wxDataViewCtrl * m_view
Definition: rc_item.h:288
static RC_TREE_NODE * ToNode(wxDataViewItem aItem)
Definition: rc_item.h:212
NODE_TYPE m_Type
Definition: rc_item.h:196
std::vector< RC_TREE_NODE * > m_tree
Definition: rc_item.h:292

References RC_TREE_NODE::m_Parent, m_tree, RC_TREE_NODE::m_Type, m_view, RC_TREE_NODE::MARKER, ToItem(), and ToNode().

Referenced by DIALOG_ERC::PrevMarker(), and DIALOG_DRC::PrevMarker().

◆ rebuildModel()

void RC_TREE_MODEL::rebuildModel ( RC_ITEMS_PROVIDER aProvider,
int  aSeverities 
)
private

Definition at line 197 of file rc_item.cpp.

198 {
199  wxWindowUpdateLocker updateLock( m_view );
200 
201  std::shared_ptr<RC_ITEM> selectedRcItem = nullptr;
202 
203  if( m_view )
204  {
205  RC_TREE_NODE* selectedNode = ToNode( m_view->GetSelection() );
206  selectedRcItem = selectedNode ? selectedNode->m_RcItem : nullptr;
207 
208  // Even with the updateLock, wxWidgets sometimes ties its knickers in a knot trying
209  // to run a wxdataview_selection_changed_callback() on a row that has been deleted.
210  m_view->UnselectAll();
211  }
212 
213  BeforeReset();
214 
215  if( aProvider != m_rcItemsProvider )
216  {
217  delete m_rcItemsProvider;
218  m_rcItemsProvider = aProvider;
219  }
220 
221  if( aSeverities != m_severities )
222  m_severities = aSeverities;
223 
224  if( m_rcItemsProvider )
226 
227  for( RC_TREE_NODE* topLevelNode : m_tree )
228  delete topLevelNode;
229 
230  m_tree.clear();
231 
232  // wxDataView::ExpandAll() pukes with large lists
233  int count = 0;
234 
235  if( m_rcItemsProvider )
236  count = std::min( 1000, m_rcItemsProvider->GetCount() );
237 
238  for( int i = 0; i < count; ++i )
239  {
240  std::shared_ptr<RC_ITEM> rcItem = m_rcItemsProvider->GetItem( i );
241 
242  m_tree.push_back( new RC_TREE_NODE( nullptr, rcItem, RC_TREE_NODE::MARKER ) );
243  RC_TREE_NODE* n = m_tree.back();
244 
245  if( rcItem->GetMainItemID() != niluuid )
246  n->m_Children.push_back( new RC_TREE_NODE( n, rcItem, RC_TREE_NODE::MAIN_ITEM ) );
247 
248  if( rcItem->GetAuxItemID() != niluuid )
249  n->m_Children.push_back( new RC_TREE_NODE( n, rcItem, RC_TREE_NODE::AUX_ITEM ) );
250 
251  if( rcItem->GetAuxItem2ID() != niluuid )
252  n->m_Children.push_back( new RC_TREE_NODE( n, rcItem, RC_TREE_NODE::AUX_ITEM2 ) );
253 
254  if( rcItem->GetAuxItem3ID() != niluuid )
255  n->m_Children.push_back( new RC_TREE_NODE( n, rcItem, RC_TREE_NODE::AUX_ITEM3 ) );
256  }
257 
258  // Must be called after a significant change of items to force the
259  // wxDataViewModel to reread all of them, repopulating itself entirely.
260  AfterReset();
261 
262 #ifdef __WXGTK__
263  // The fastest method to update wxDataViewCtrl is to rebuild from
264  // scratch by calling Cleared(). Linux requires to reassociate model to
265  // display data, but Windows will create multiple associations.
266  // On MacOS, this crashes KiCad. See https://gitlab.com/kicad/code/kicad/issues/3666
267  // and https://gitlab.com/kicad/code/kicad/issues/3653
268  m_view->AssociateModel( this );
269 #endif
270 
271  m_view->ClearColumns();
272  int width = m_view->GetMainWindow()->GetRect().GetWidth() - WX_DATAVIEW_WINDOW_PADDING;
273  m_view->AppendTextColumn( wxEmptyString, 0, wxDATAVIEW_CELL_INERT, width );
274 
275  ExpandAll();
276 
277  // Most annoyingly wxWidgets won't tell us the scroll position (and no, all the usual
278  // routines don't work), so we can only restore the scroll position based on a selection.
279  if( selectedRcItem )
280  {
281  for( RC_TREE_NODE* candidate : m_tree )
282  {
283  if( candidate->m_RcItem == selectedRcItem )
284  {
285  m_view->Select( ToItem( candidate ) );
286  m_view->EnsureVisible( ToItem( candidate ) );
287  break;
288  }
289  }
290  }
291 }
KIID niluuid(0)
static wxDataViewItem ToItem(RC_TREE_NODE const *aNode)
Definition: rc_item.h:207
wxDataViewCtrl * m_view
Definition: rc_item.h:288
#define WX_DATAVIEW_WINDOW_PADDING
Definition: rc_item.cpp:35
virtual int GetCount(int aSeverity=-1) const =0
std::vector< RC_TREE_NODE * > m_Children
Definition: rc_item.h:200
RC_ITEMS_PROVIDER * m_rcItemsProvider
Definition: rc_item.h:290
std::shared_ptr< RC_ITEM > m_RcItem
Definition: rc_item.h:197
void ExpandAll()
Definition: rc_item.cpp:306
static RC_TREE_NODE * ToNode(wxDataViewItem aItem)
Definition: rc_item.h:212
virtual void SetSeverities(int aSeverities)=0
std::vector< RC_TREE_NODE * > m_tree
Definition: rc_item.h:292
virtual std::shared_ptr< RC_ITEM > GetItem(int aIndex) const =0
Retrieve a RC_ITEM by index.
int m_severities
Definition: rc_item.h:289

References RC_TREE_NODE::AUX_ITEM, RC_TREE_NODE::AUX_ITEM2, RC_TREE_NODE::AUX_ITEM3, ExpandAll(), RC_ITEMS_PROVIDER::GetCount(), RC_ITEMS_PROVIDER::GetItem(), RC_TREE_NODE::m_Children, RC_TREE_NODE::m_RcItem, m_rcItemsProvider, m_severities, m_tree, m_view, RC_TREE_NODE::MAIN_ITEM, RC_TREE_NODE::MARKER, niluuid, RC_ITEMS_PROVIDER::SetSeverities(), ToItem(), ToNode(), and WX_DATAVIEW_WINDOW_PADDING.

Referenced by SetProvider(), and SetSeverities().

◆ SelectMarker()

void RC_TREE_MODEL::SelectMarker ( const MARKER_BASE aMarker)

Definition at line 605 of file rc_item.cpp.

606 {
607  for( RC_TREE_NODE* candidate : m_tree )
608  {
609  if( candidate->m_RcItem->GetParent() == aMarker )
610  {
611  m_view->Select( ToItem( candidate ) );
612  return;
613  }
614  }
615 }
static wxDataViewItem ToItem(RC_TREE_NODE const *aNode)
Definition: rc_item.h:207
wxDataViewCtrl * m_view
Definition: rc_item.h:288
std::vector< RC_TREE_NODE * > m_tree
Definition: rc_item.h:292

References m_tree, m_view, and ToItem().

Referenced by DIALOG_ERC::ExcludeMarker(), and DIALOG_DRC::SelectMarker().

◆ SetProvider()

◆ SetSeverities()

◆ SetValue()

bool RC_TREE_MODEL::SetValue ( wxVariant const &  aVariant,
wxDataViewItem const &  aItem,
unsigned int  aCol 
)
inlineoverride

Called by the wxDataView to edit an item's content.

Definition at line 257 of file rc_item.h.

260  {
261  // Editing not supported
262  return false;
263  }

◆ ToItem()

static wxDataViewItem RC_TREE_MODEL::ToItem ( RC_TREE_NODE const *  aNode)
inlinestatic

Definition at line 207 of file rc_item.h.

208  {
209  return wxDataViewItem( const_cast<void*>( static_cast<void const*>( aNode ) ) );
210  }

Referenced by CenterMarker(), DeleteItems(), ExpandAll(), GetChildren(), GetParent(), NextMarker(), PrevMarker(), rebuildModel(), SelectMarker(), and ValueChanged().

◆ ToNode()

static RC_TREE_NODE* RC_TREE_MODEL::ToNode ( wxDataViewItem  aItem)
inlinestatic

◆ ToUUID()

KIID RC_TREE_MODEL::ToUUID ( wxDataViewItem  aItem)
static

Definition at line 147 of file rc_item.cpp.

148 {
149  const RC_TREE_NODE* node = RC_TREE_MODEL::ToNode( aItem );
150 
151  if( node && node->m_RcItem )
152  {
153  const std::shared_ptr<RC_ITEM> rc_item = node->m_RcItem;
154 
155  switch( node->m_Type )
156  {
158  // rc_item->GetParent() can be null, if the parent is not existing
159  // when a RC item has no corresponding ERC/DRC marker
160  if( rc_item->GetParent() )
161  return rc_item->GetParent()->GetUUID();
162 
163  break;
164 
165  case RC_TREE_NODE::MAIN_ITEM: return rc_item->GetMainItemID();
166  case RC_TREE_NODE::AUX_ITEM: return rc_item->GetAuxItemID();
167  case RC_TREE_NODE::AUX_ITEM2: return rc_item->GetAuxItem2ID();
168  case RC_TREE_NODE::AUX_ITEM3: return rc_item->GetAuxItem3ID();
169  }
170  }
171 
172  return niluuid;
173 }
KIID niluuid(0)
std::shared_ptr< RC_ITEM > m_RcItem
Definition: rc_item.h:197
static RC_TREE_NODE * ToNode(wxDataViewItem aItem)
Definition: rc_item.h:212
NODE_TYPE m_Type
Definition: rc_item.h:196

References RC_TREE_NODE::AUX_ITEM, RC_TREE_NODE::AUX_ITEM2, RC_TREE_NODE::AUX_ITEM3, RC_TREE_NODE::m_RcItem, RC_TREE_NODE::m_Type, RC_TREE_NODE::MAIN_ITEM, RC_TREE_NODE::MARKER, niluuid, and ToNode().

Referenced by DIALOG_DRC::OnDRCItemSelected(), DIALOG_ERC::OnERCItemSelected(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnSelectItem(), DIALOG_CLEANUP_GRAPHICS::OnSelectItem(), and DIALOG_FOOTPRINT_CHECKER::OnSelectItem().

◆ ValueChanged()

void RC_TREE_MODEL::ValueChanged ( const RC_TREE_NODE aNode)

Definition at line 444 of file rc_item.cpp.

445 {
446  if( aNode->m_Type == RC_TREE_NODE::MAIN_ITEM || aNode->m_Type == RC_TREE_NODE::AUX_ITEM )
447  {
448  ValueChanged( aNode->m_Parent );
449  }
450 
451  if( aNode->m_Type == RC_TREE_NODE::MARKER )
452  {
453  wxDataViewModel::ValueChanged( ToItem( aNode ), 0 );
454 
455  for( const RC_TREE_NODE* child : aNode->m_Children )
456  wxDataViewModel::ValueChanged( ToItem( child ), 0 );
457  }
458 }
static wxDataViewItem ToItem(RC_TREE_NODE const *aNode)
Definition: rc_item.h:207
RC_TREE_NODE * m_Parent
Definition: rc_item.h:199
std::vector< RC_TREE_NODE * > m_Children
Definition: rc_item.h:200
NODE_TYPE m_Type
Definition: rc_item.h:196
void ValueChanged(const RC_TREE_NODE *aNode)
Definition: rc_item.cpp:444

References RC_TREE_NODE::AUX_ITEM, RC_TREE_NODE::m_Children, RC_TREE_NODE::m_Parent, RC_TREE_NODE::m_Type, RC_TREE_NODE::MAIN_ITEM, RC_TREE_NODE::MARKER, and ToItem().

Referenced by DIALOG_DRC::ExcludeMarker(), and DIALOG_ERC::ExcludeMarker().

Member Data Documentation

◆ m_editFrame

EDA_DRAW_FRAME* RC_TREE_MODEL::m_editFrame
private

Definition at line 287 of file rc_item.h.

Referenced by GetValue().

◆ m_rcItemsProvider

RC_ITEMS_PROVIDER* RC_TREE_MODEL::m_rcItemsProvider
private

Definition at line 290 of file rc_item.h.

Referenced by DeleteItems(), rebuildModel(), SetSeverities(), and ~RC_TREE_MODEL().

◆ m_severities

int RC_TREE_MODEL::m_severities
private

Definition at line 289 of file rc_item.h.

Referenced by rebuildModel(), and SetProvider().

◆ m_tree

std::vector<RC_TREE_NODE*> RC_TREE_MODEL::m_tree
private

◆ m_view

wxDataViewCtrl* RC_TREE_MODEL::m_view
private

The documentation for this class was generated from the following files: