PANEL_SETUP_NETCLASSES Class Reference

#include <panel_setup_netclasses.h>

Inheritance diagram for PANEL_SETUP_NETCLASSES:

Public Member Functions
	PANEL_SETUP_NETCLASSES (PAGED_DIALOG *aParent, EDA_DRAW_FRAME *aFrame, NETCLASSES *aNetclasses, const std::vector< wxString > &aNetNames, bool isEEschema)
	~PANEL_SETUP_NETCLASSES () override
bool	TransferDataToWindow () override
bool	TransferDataFromWindow () override
bool	Validate () override
void	ImportSettingsFrom (NETCLASSES *aBoard)

Protected Attributes
wxSplitterWindow *	m_splitter
wxPanel *	m_netclassesPane
WX_GRID *	m_netclassGrid
wxBitmapButton *	m_addButton
wxBitmapButton *	m_removeButton
wxStaticText *	m_colorDefaultHelpText
wxPanel *	m_membershipPane
wxStaticText *	m_ncfilterLabel
wxChoice *	m_netClassFilter
wxStaticText *	m_filterLabel
wxTextCtrl *	m_netNameFilter
wxButton *	m_showAllButton
wxButton *	m_filterNetsButton
wxStaticText *	m_assignLabel
wxChoice *	m_assignNetClass
wxButton *	m_assignAllButton
wxButton *	m_assignSelectedButton
WX_GRID *	m_membershipGrid

Private Member Functions
void	OnAddNetclassClick (wxCommandEvent &event) override
void	OnRemoveNetclassClick (wxCommandEvent &event) override
void	OnSizeNetclassGrid (wxSizeEvent &event) override
void	OnSizeMembershipGrid (wxSizeEvent &event) override
void	onmembershipPanelSize (wxSizeEvent &event) override
void	OnUpdateUI (wxUpdateUIEvent &event) override
void	OnNetclassGridCellChanging (wxGridEvent &event)
void	OnNetclassGridMouseEvent (wxMouseEvent &event)
void	OnShowAll (wxCommandEvent &event) override
void	OnApplyFilters (wxCommandEvent &event) override
void	OnAssignAll (wxCommandEvent &event) override
void	OnAssignSelected (wxCommandEvent &event) override
void	onUnitsChanged (wxCommandEvent &aEvent)
bool	validateNetclassName (int aRow, const wxString &aName, bool focusFirst=true)
void	rebuildNetclassDropdowns ()
void	addNet (const wxString &netName, const wxString &netclass, bool aStale)
void	doApplyFilters (bool aShowAll)
void	doAssignments (bool aAssignAll)
void	AdjustNetclassGridColumns (int aWidth)
void	AdjustMembershipGridColumns (int aWidth)

Private Attributes
EDA_DRAW_FRAME *	m_frame
PAGED_DIALOG *	m_parent
NETCLASSES *	m_netclasses
std::vector< wxString >	m_netNames
int *	m_originalColWidths
bool	m_netclassesDirty
int	m_hoveredCol

Detailed Description

Definition at line 35 of file panel_setup_netclasses.h.

Constructor & Destructor Documentation

PANEL_SETUP_NETCLASSES()

PANEL_SETUP_NETCLASSES::PANEL_SETUP_NETCLASSES	(	PAGED_DIALOG *	aParent,
		EDA_DRAW_FRAME *	aFrame,
		NETCLASSES *	aNetclasses,
		const std::vector< wxString > &	aNetNames,
		bool	isEEschema
	)

Definition at line 73 of file panel_setup_netclasses.cpp.

 :
 PANEL_SETUP_NETCLASSES_BASE( aParent->GetTreebook() ),
 m_frame( aFrame ),
 m_parent( aParent ),
 m_netclasses( aNetclasses ),
 m_netNames( aNetNames ),
 m_hoveredCol( -1 )
{
 // Clear and re-load each time. Language (or darkmode) might have changed.
 g_lineStyleIcons.clear();
 g_lineStyleNames.clear();

 g_lineStyleIcons.push_back( BITMAPS::stroke_solid );
 g_lineStyleNames.push_back( _( "Solid" ) );
 g_lineStyleIcons.push_back( BITMAPS::stroke_dash );
 g_lineStyleNames.push_back( _( "Dashed" ) );
 g_lineStyleIcons.push_back( BITMAPS::stroke_dot );
 g_lineStyleNames.push_back( _( "Dotted" ) );
 g_lineStyleIcons.push_back( BITMAPS::stroke_dashdot );
 g_lineStyleNames.push_back( _( "Dash-Dot" ) );

 m_netclassesDirty = true;

 // Prevent Size events from firing before we are ready
 Freeze();
 m_netclassGrid->BeginBatch();
 m_membershipGrid->BeginBatch();

 m_originalColWidths = new int[ m_netclassGrid->GetNumberCols() ];
 // Calculate a min best size to handle longest usual numeric values:
 int min_best_width = m_netclassGrid->GetTextExtent( "555,555555 mils" ).x;

 for( int i = 0; i < m_netclassGrid->GetNumberCols(); ++i )
 {
  // We calculate the column min size only from texts sizes, not using the initial col width
 // as this initial width is sometimes strange depending on the language (wxGrid bug?)
 int min_width = m_netclassGrid->GetVisibleWidth( i, true, true, false );

 if( i == GRID_LINESTYLE )
 min_best_width *= 1.5;

 m_netclassGrid->SetColMinimalWidth( i, min_width );

 // We use a "best size" >= min_best_width
 m_originalColWidths[ i ] = std::max( min_width, min_best_width );
 m_netclassGrid->SetColSize( i, m_originalColWidths[ i ] );
 }

 if( aIsEEschema )
 {
 for( int i = GRID_FIRST_PCBNEW; i < GRID_FIRST_EESCHEMA; ++i )
 {
 m_netclassGrid->HideCol( i );
 m_originalColWidths[ i ] = 0;
 }

 wxGridCellAttr* attr = new wxGridCellAttr;
 attr->SetRenderer( new GRID_CELL_COLOR_RENDERER( aParent ) );
 attr->SetEditor( new GRID_CELL_COLOR_SELECTOR( aParent, m_netclassGrid ) );
 m_netclassGrid->SetColAttr( GRID_SCHEMATIC_COLOR, attr );

 attr = new wxGridCellAttr;
 attr->SetRenderer( new GRID_CELL_ICON_TEXT_RENDERER( g_lineStyleIcons, g_lineStyleNames ) );
 attr->SetEditor( new GRID_CELL_ICON_TEXT_POPUP( g_lineStyleIcons, g_lineStyleNames ) );
 m_netclassGrid->SetColAttr( GRID_LINESTYLE, attr );

 m_colorDefaultHelpText->SetFont( KIUI::GetInfoFont( this ).Italic() );
 }
 else
 {
 for( int i = GRID_FIRST_EESCHEMA; i < GRID_END; ++i )
 {
 m_netclassGrid->HideCol( i );
 m_originalColWidths[ i ] = 0;
 }

 m_colorDefaultHelpText->Hide();
 }

 // Be sure the column labels are readable
 m_netclassGrid->EnsureColLabelsVisible();

 // Membership combobox editors require a bit more room, so increase the row size of
 // all our grids for consistency
 m_netclassGrid->SetDefaultRowSize( m_netclassGrid->GetDefaultRowSize() + 4 );
 m_membershipGrid->SetDefaultRowSize( m_membershipGrid->GetDefaultRowSize() + 4 );

 m_netclassGrid->PushEventHandler( new GRID_TRICKS( m_netclassGrid ) );
 m_membershipGrid->PushEventHandler( new GRID_TRICKS( m_membershipGrid ) );

 m_netclassGrid->SetSelectionMode( wxGrid::wxGridSelectRows );
 m_membershipGrid->SetSelectionMode( wxGrid::wxGridSelectRows );

 // Set up the net name column of the netclass membership grid to read-only
 wxGridCellAttr* attr = new wxGridCellAttr;
 attr->SetReadOnly( true );
 attr->SetRenderer( new GRID_CELL_ESCAPED_TEXT_RENDERER );
 m_membershipGrid->SetColAttr( 0, attr );

 COMMON_SETTINGS* cfg = Pgm().GetCommonSettings();
 m_splitter->SetSashPosition( cfg->m_NetclassPanel.sash_pos );

 m_addButton->SetBitmap( KiBitmap( BITMAPS::small_plus ) );
 m_removeButton->SetBitmap( KiBitmap( BITMAPS::small_trash ) );

 // wxFormBuilder doesn't include this event...
 m_netclassGrid->Connect( wxEVT_GRID_CELL_CHANGING,
 wxGridEventHandler( PANEL_SETUP_NETCLASSES::OnNetclassGridCellChanging ),
 nullptr, this );

 // Handle tooltips for grid
 m_netclassGrid->GetGridColLabelWindow()->Bind( wxEVT_MOTION,
 &PANEL_SETUP_NETCLASSES::OnNetclassGridMouseEvent,
 this );

 m_frame->Bind( UNITS_CHANGED, &PANEL_SETUP_NETCLASSES::onUnitsChanged, this );

 m_netclassGrid->EndBatch();
 m_membershipGrid->EndBatch();
 Thaw();
}

References _, WX_GRID::EnsureColLabelsVisible(), g_lineStyleIcons, g_lineStyleNames, KIUI::GetInfoFont(), WX_GRID::GetVisibleWidth(), GRID_END, GRID_FIRST_EESCHEMA, GRID_FIRST_PCBNEW, GRID_LINESTYLE, GRID_SCHEMATIC_COLOR, KiBitmap(), PANEL_SETUP_NETCLASSES_BASE::m_addButton, PANEL_SETUP_NETCLASSES_BASE::m_colorDefaultHelpText, m_frame, PANEL_SETUP_NETCLASSES_BASE::m_membershipGrid, m_netclassesDirty, PANEL_SETUP_NETCLASSES_BASE::m_netclassGrid, COMMON_SETTINGS::m_NetclassPanel, m_originalColWidths, PANEL_SETUP_NETCLASSES_BASE::m_removeButton, PANEL_SETUP_NETCLASSES_BASE::m_splitter, OnNetclassGridCellChanging(), OnNetclassGridMouseEvent(), onUnitsChanged(), Pgm(), COMMON_SETTINGS::NETCLASS_PANEL::sash_pos, small_plus, small_trash, stroke_dash, stroke_dashdot, stroke_dot, and stroke_solid.

~PANEL_SETUP_NETCLASSES()

PANEL_SETUP_NETCLASSES::~PANEL_SETUP_NETCLASSES ( )

override

Definition at line 199 of file panel_setup_netclasses.cpp.

{
 COMMON_SETTINGS* cfg = Pgm().GetCommonSettings();
 cfg->m_NetclassPanel.sash_pos = m_splitter->GetSashPosition();

 delete [] m_originalColWidths;

 // Delete the GRID_TRICKS.
 m_netclassGrid->PopEventHandler( true );
 m_membershipGrid->PopEventHandler( true );

 m_netclassGrid->Disconnect( wxEVT_GRID_CELL_CHANGING,
 wxGridEventHandler( PANEL_SETUP_NETCLASSES::OnNetclassGridCellChanging ),
 nullptr, this );

 m_frame->Unbind( UNITS_CHANGED, &PANEL_SETUP_NETCLASSES::onUnitsChanged, this );
}

References m_frame, PANEL_SETUP_NETCLASSES_BASE::m_membershipGrid, PANEL_SETUP_NETCLASSES_BASE::m_netclassGrid, COMMON_SETTINGS::m_NetclassPanel, m_originalColWidths, PANEL_SETUP_NETCLASSES_BASE::m_splitter, OnNetclassGridCellChanging(), onUnitsChanged(), Pgm(), and COMMON_SETTINGS::NETCLASS_PANEL::sash_pos.

Member Function Documentation

addNet()

void PANEL_SETUP_NETCLASSES::addNet ( const wxString &  netName, const wxString &  netclass, bool  aStale  )

private

Definition at line 315 of file panel_setup_netclasses.cpp.

{
 int i = m_membershipGrid->GetNumberRows();

 m_membershipGrid->AppendRows( 1 );

 m_membershipGrid->SetCellValue( i, 0, netName );

 if( aStale )
 {
 wxColour color = wxSystemSettings::GetColour( wxSYS_COLOUR_GRAYTEXT );
 m_membershipGrid->SetCellTextColour( i, 0, color );
 }

 if( netclass.IsEmpty() )
 m_membershipGrid->SetCellValue( i, 1, NETCLASS::Default );
 else
 m_membershipGrid->SetCellValue( i, 1, netclass );
}

References color, NETCLASS::Default, and PANEL_SETUP_NETCLASSES_BASE::m_membershipGrid.

Referenced by TransferDataToWindow().

AdjustMembershipGridColumns()

void PANEL_SETUP_NETCLASSES::AdjustMembershipGridColumns ( int  aWidth )

private

Definition at line 617 of file panel_setup_netclasses.cpp.

{
 // Account for scroll bars
 aWidth -= ( m_membershipGrid->GetSize().x - m_membershipGrid->GetClientSize().x );

 // Set className column width to original className width from netclasses grid
 int classNameWidth = m_originalColWidths[ 0 ];
 m_membershipGrid->SetColSize( 1, m_originalColWidths[ 0 ] );
 m_membershipGrid->SetColSize( 0, std::max( aWidth - classNameWidth, classNameWidth ) );
}

References PANEL_SETUP_NETCLASSES_BASE::m_membershipGrid, and m_originalColWidths.

Referenced by OnSizeMembershipGrid().

AdjustNetclassGridColumns()

void PANEL_SETUP_NETCLASSES::AdjustNetclassGridColumns ( int  aWidth )

private

Definition at line 594 of file panel_setup_netclasses.cpp.

{
 // Account for scroll bars
 aWidth -= ( m_netclassGrid->GetSize().x - m_netclassGrid->GetClientSize().x );

 for( int i = 1; i < m_netclassGrid->GetNumberCols(); i++ )
 {
 m_netclassGrid->SetColSize( i, m_originalColWidths[ i ] );
 aWidth -= m_originalColWidths[ i ];
 }

 m_netclassGrid->SetColSize( 0, std::max( aWidth - 2, m_originalColWidths[ 0 ] ) );
}

References PANEL_SETUP_NETCLASSES_BASE::m_netclassGrid, and m_originalColWidths.

Referenced by OnSizeNetclassGrid().

doApplyFilters()

void PANEL_SETUP_NETCLASSES::doApplyFilters ( bool  aShowAll )

private

Definition at line 655 of file panel_setup_netclasses.cpp.

{
 if( !m_membershipGrid->CommitPendingChanges() )
 return;

 wxString netClassFilter = m_netClassFilter->GetStringSelection();
 wxString netFilter = m_netNameFilter->GetValue().MakeLower();

 if( !netFilter.IsEmpty() )
 netFilter = wxT( "*" ) + netFilter + wxT( "*" );

 for( int row = 0; row < m_membershipGrid->GetNumberRows(); ++row )
 {
 wxString net = m_membershipGrid->GetCellValue( row, 0 );
 wxString netClass = m_membershipGrid->GetCellValue( row, 1 );
 bool show = true;

 if( !aShowAll )
 {
 if( !netFilter.IsEmpty() && !net.MakeLower().Matches( netFilter ) )
 show = false;

 if( !netClassFilter.IsEmpty() && netClass != netClassFilter )
 show = false;
 }

 if( show )
 m_membershipGrid->ShowRow( row );
 else
 m_membershipGrid->HideRow( row );
 }
}

References WX_GRID::CommitPendingChanges(), PANEL_SETUP_NETCLASSES_BASE::m_membershipGrid, PANEL_SETUP_NETCLASSES_BASE::m_netClassFilter, and PANEL_SETUP_NETCLASSES_BASE::m_netNameFilter.

Referenced by OnApplyFilters(), and OnShowAll().

doAssignments()

void PANEL_SETUP_NETCLASSES::doAssignments ( bool  aAssignAll )

private

Definition at line 689 of file panel_setup_netclasses.cpp.

{
 if( !m_membershipGrid->CommitPendingChanges() )
 return;

 wxArrayInt selectedRows = m_membershipGrid->GetSelectedRows();

 for( int row = 0; row < m_membershipGrid->GetNumberRows(); ++row )
 {
 if( !m_membershipGrid->IsRowShown( row ) )
 continue;

 if( !aAssignAll && selectedRows.Index( row ) == wxNOT_FOUND )
 continue;

 m_membershipGrid->SetCellValue( row, 1, m_assignNetClass->GetStringSelection() );
 }
}

References WX_GRID::CommitPendingChanges(), PANEL_SETUP_NETCLASSES_BASE::m_assignNetClass, and PANEL_SETUP_NETCLASSES_BASE::m_membershipGrid.

Referenced by OnAssignAll(), and OnAssignSelected().

ImportSettingsFrom()

void PANEL_SETUP_NETCLASSES::ImportSettingsFrom

(

NETCLASSES *

aBoard

)

Definition at line 741 of file panel_setup_netclasses.cpp.

{
 NETCLASSES* savedSettings = m_netclasses;

 m_netclasses = aNetclasses;
 TransferDataToWindow();

 rebuildNetclassDropdowns();

 m_netclassGrid->ForceRefresh();
 m_membershipGrid->ForceRefresh();

 m_netclasses = savedSettings;
}

References PANEL_SETUP_NETCLASSES_BASE::m_membershipGrid, m_netclasses, PANEL_SETUP_NETCLASSES_BASE::m_netclassGrid, rebuildNetclassDropdowns(), and TransferDataToWindow().

Referenced by DIALOG_SCHEMATIC_SETUP::OnAuxiliaryAction(), and DIALOG_BOARD_SETUP::OnAuxiliaryAction().

OnAddNetclassClick()

void PANEL_SETUP_NETCLASSES::OnAddNetclassClick ( wxCommandEvent &  event )

overrideprivatevirtual

Reimplemented from PANEL_SETUP_NETCLASSES_BASE.

Definition at line 537 of file panel_setup_netclasses.cpp.

{
 if( !m_netclassGrid->CommitPendingChanges() )
 return;

 int row = m_netclassGrid->GetNumberRows();
 m_netclassGrid->AppendRows();

 // Copy values of the default class:
 for( int col = 1; col < m_netclassGrid->GetNumberCols(); col++ )
 m_netclassGrid->SetCellValue( row, col, m_netclassGrid->GetCellValue( 0, col ) );

 m_netclassGrid->MakeCellVisible( row, 0 );
 m_netclassGrid->SetGridCursor( row, 0 );

 m_netclassGrid->EnableCellEditControl( true );
 m_netclassGrid->ShowCellEditControl();

 m_netclassesDirty = true;
}

References WX_GRID::CommitPendingChanges(), m_netclassesDirty, and PANEL_SETUP_NETCLASSES_BASE::m_netclassGrid.

OnApplyFilters()

void PANEL_SETUP_NETCLASSES::OnApplyFilters ( wxCommandEvent &  event )

inlineoverrideprivatevirtual

Reimplemented from PANEL_SETUP_NETCLASSES_BASE.

Definition at line 59 of file panel_setup_netclasses.h.

{ doApplyFilters( false ); }

References doApplyFilters().

OnAssignAll()

void PANEL_SETUP_NETCLASSES::OnAssignAll ( wxCommandEvent &  event )

inlineoverrideprivatevirtual

Reimplemented from PANEL_SETUP_NETCLASSES_BASE.

Definition at line 60 of file panel_setup_netclasses.h.

{ doAssignments( true ); }

References doAssignments().

OnAssignSelected()

void PANEL_SETUP_NETCLASSES::OnAssignSelected ( wxCommandEvent &  event )

inlineoverrideprivatevirtual

Reimplemented from PANEL_SETUP_NETCLASSES_BASE.

Definition at line 61 of file panel_setup_netclasses.h.

{ doAssignments( false ); }

References doAssignments().

onmembershipPanelSize()

void PANEL_SETUP_NETCLASSES::onmembershipPanelSize ( wxSizeEvent &  event )

overrideprivatevirtual

Reimplemented from PANEL_SETUP_NETCLASSES_BASE.

Definition at line 629 of file panel_setup_netclasses.cpp.

{
 // When a class name choice widget is selected (activated), in
 // wxGrid m_membershipGrid, resizing its wxGrid parent is not taken in account
 // by the widget until it is deselected and stay in the old position.
 // So we deselect it if this is the case
 // Note also this is made here, not in OnSizeMembershipGrid because on Linux
 // there are a lot of wxSizeEvent send to m_membershipGrid when opening a choice widget
 int c_row = m_membershipGrid->GetGridCursorRow();
 int c_col = m_membershipGrid->GetGridCursorCol();

 if( c_row >= 0 && c_col == 1 ) // this means the class name choice widget is selected (opened)
 m_membershipGrid->SetGridCursor( c_row, 0 ); // Close it

 event.Skip();
}

References PANEL_SETUP_NETCLASSES_BASE::m_membershipGrid.

OnNetclassGridCellChanging()

void PANEL_SETUP_NETCLASSES::OnNetclassGridCellChanging ( wxGridEvent &  event )

private

Definition at line 459 of file panel_setup_netclasses.cpp.

{
 if( event.GetCol() == GRID_NAME )
 {
 if( validateNetclassName( event.GetRow(), event.GetString() ) )
 {
 wxString oldName = m_netclassGrid->GetCellValue( event.GetRow(), GRID_NAME );
 wxString newName = event.GetString();

 if( !oldName.IsEmpty() )
 {
 for( int row = 0; row < m_membershipGrid->GetNumberRows(); ++row )
 {
 if( m_membershipGrid->GetCellValue( row, 1 ) == oldName )
 m_membershipGrid->SetCellValue( row, 1, newName );
 }
 }

 m_netclassesDirty = true;
 }
 else
 {
 event.Veto();
 }
 }
}

References GRID_NAME, PANEL_SETUP_NETCLASSES_BASE::m_membershipGrid, m_netclassesDirty, PANEL_SETUP_NETCLASSES_BASE::m_netclassGrid, and validateNetclassName().

Referenced by PANEL_SETUP_NETCLASSES(), and ~PANEL_SETUP_NETCLASSES().

OnNetclassGridMouseEvent()

void PANEL_SETUP_NETCLASSES::OnNetclassGridMouseEvent ( wxMouseEvent &  event )

private

Definition at line 487 of file panel_setup_netclasses.cpp.

{
 int col = m_netclassGrid->XToCol( aEvent.GetPosition().x );

 if( aEvent.Moving() || aEvent.Entering() )
 {
 aEvent.Skip();

 if( col == wxNOT_FOUND )
 {
 m_netclassGrid->GetGridColLabelWindow()->UnsetToolTip();
 return;
 }

 if( col == m_hoveredCol )
 return;

 m_hoveredCol = col;

 wxString tip;

 switch( col )
 {
 case GRID_CLEARANCE: tip = _( "Minimum copper clearance" ); break;
 case GRID_TRACKSIZE: tip = _( "Minimum track width" ); break;
 case GRID_VIASIZE: tip = _( "Via pad diameter" ); break;
 case GRID_VIADRILL: tip = _( "Via plated hole diameter" ); break;
 case GRID_uVIASIZE: tip = _( "Microvia pad diameter" ); break;
 case GRID_uVIADRILL: tip = _( "Microvia plated hole diameter" ); break;
 case GRID_DIFF_PAIR_WIDTH: tip = _( "Differential pair track width" ); break;
 case GRID_DIFF_PAIR_GAP: tip = _( "Differential pair gap" ); break;
 case GRID_WIREWIDTH: tip = _( "Schematic wire thickness" ); break;
 case GRID_BUSWIDTH: tip = _( "Bus wire thickness" ); break;
 case GRID_SCHEMATIC_COLOR: tip = _( "Schematic wire color" ); break;
 case GRID_LINESTYLE: tip = _( "Schematic wire line style" ); break;
 }

 m_netclassGrid->GetGridColLabelWindow()->UnsetToolTip();
 m_netclassGrid->GetGridColLabelWindow()->SetToolTip( tip );
 }
 else if( aEvent.Leaving() )
 {
 m_netclassGrid->GetGridColLabelWindow()->UnsetToolTip();
 aEvent.Skip();
 }

 aEvent.Skip();
}

References _, GRID_BUSWIDTH, GRID_CLEARANCE, GRID_DIFF_PAIR_GAP, GRID_DIFF_PAIR_WIDTH, GRID_LINESTYLE, GRID_SCHEMATIC_COLOR, GRID_TRACKSIZE, GRID_uVIADRILL, GRID_uVIASIZE, GRID_VIADRILL, GRID_VIASIZE, GRID_WIREWIDTH, m_hoveredCol, and PANEL_SETUP_NETCLASSES_BASE::m_netclassGrid.

Referenced by PANEL_SETUP_NETCLASSES().

OnRemoveNetclassClick()

void PANEL_SETUP_NETCLASSES::OnRemoveNetclassClick ( wxCommandEvent &  event )

overrideprivatevirtual

Reimplemented from PANEL_SETUP_NETCLASSES_BASE.

Definition at line 559 of file panel_setup_netclasses.cpp.

{
 if( !m_netclassGrid->CommitPendingChanges() )
 return;

 int curRow = m_netclassGrid->GetGridCursorRow();

 if( curRow < 0 )
 {
 return;
 }
 else if( curRow == 0 )
 {
 DisplayErrorMessage( this, _( "The default net class is required." ) );
 return;
 }

 // reset the net class to default for members of the removed class
 wxString classname = m_netclassGrid->GetCellValue( curRow, GRID_NAME );

 for( int row = 0; row < m_membershipGrid->GetNumberRows(); ++row )
 {
 if( m_membershipGrid->GetCellValue( row, 1 ) == classname )
 m_membershipGrid->SetCellValue( row, 1, NETCLASS::Default );
 }

 m_netclassGrid->DeleteRows( curRow, 1 );

 m_netclassGrid->MakeCellVisible( std::max( 0, curRow-1 ), m_netclassGrid->GetGridCursorCol() );
 m_netclassGrid->SetGridCursor( std::max( 0, curRow-1 ), m_netclassGrid->GetGridCursorCol() );

 m_netclassesDirty = true;
}

References _, WX_GRID::CommitPendingChanges(), NETCLASS::Default, DisplayErrorMessage(), GRID_NAME, PANEL_SETUP_NETCLASSES_BASE::m_membershipGrid, m_netclassesDirty, and PANEL_SETUP_NETCLASSES_BASE::m_netclassGrid.

OnShowAll()

void PANEL_SETUP_NETCLASSES::OnShowAll ( wxCommandEvent &  event )

inlineoverrideprivatevirtual

Reimplemented from PANEL_SETUP_NETCLASSES_BASE.

Definition at line 58 of file panel_setup_netclasses.h.

{ doApplyFilters( true ); }

References doApplyFilters().

OnSizeMembershipGrid()

void PANEL_SETUP_NETCLASSES::OnSizeMembershipGrid ( wxSizeEvent &  event )

overrideprivatevirtual

Reimplemented from PANEL_SETUP_NETCLASSES_BASE.

Definition at line 647 of file panel_setup_netclasses.cpp.

{
 AdjustMembershipGridColumns( event.GetSize().GetX() );

 event.Skip();
}

References AdjustMembershipGridColumns().

OnSizeNetclassGrid()

void PANEL_SETUP_NETCLASSES::OnSizeNetclassGrid ( wxSizeEvent &  event )

overrideprivatevirtual

Reimplemented from PANEL_SETUP_NETCLASSES_BASE.

Definition at line 609 of file panel_setup_netclasses.cpp.

{
 AdjustNetclassGridColumns( event.GetSize().GetX() );

 event.Skip();
}

References AdjustNetclassGridColumns().

onUnitsChanged()

void PANEL_SETUP_NETCLASSES::onUnitsChanged ( wxCommandEvent &  aEvent )

private

Definition at line 218 of file panel_setup_netclasses.cpp.

{
 NETCLASSES tempNetClasses;
 NETCLASSES* saveNetClasses = m_netclasses;

 m_netclasses = &tempNetClasses; // No, address of stack var does not escape function

 TransferDataFromWindow();
 TransferDataToWindow();

 m_netclasses = saveNetClasses;

 aEvent.Skip();
}

References m_netclasses, TransferDataFromWindow(), and TransferDataToWindow().

Referenced by PANEL_SETUP_NETCLASSES(), and ~PANEL_SETUP_NETCLASSES().

OnUpdateUI()

void PANEL_SETUP_NETCLASSES::OnUpdateUI ( wxUpdateUIEvent &  event )

overrideprivatevirtual

Reimplemented from PANEL_SETUP_NETCLASSES_BASE.

Definition at line 709 of file panel_setup_netclasses.cpp.

{
 if( m_netclassesDirty )
 {
 rebuildNetclassDropdowns();
 m_netclassesDirty = false;
 }
}

References m_netclassesDirty, and rebuildNetclassDropdowns().

rebuildNetclassDropdowns()

void PANEL_SETUP_NETCLASSES::rebuildNetclassDropdowns ( )

private

Definition at line 340 of file panel_setup_netclasses.cpp.

{
 m_membershipGrid->CommitPendingChanges( true );

 wxArrayString netclassNames;

 for( int ii = 0; ii < m_netclassGrid->GetNumberRows(); ii++ )
 {
 wxString netclassName = m_netclassGrid->GetCellValue( ii, GRID_NAME );

 if( !netclassName.IsEmpty() )
 netclassNames.push_back( netclassName );
 }

 wxGridCellAttr* attr = new wxGridCellAttr;
 attr->SetEditor( new wxGridCellChoiceEditor( netclassNames ) );
 m_membershipGrid->SetColAttr( 1, attr );

 m_assignNetClass->Set( netclassNames );

 netclassNames.Insert( wxEmptyString, 0 );
 m_netClassFilter->Set( netclassNames );
}

References WX_GRID::CommitPendingChanges(), GRID_NAME, PANEL_SETUP_NETCLASSES_BASE::m_assignNetClass, PANEL_SETUP_NETCLASSES_BASE::m_membershipGrid, PANEL_SETUP_NETCLASSES_BASE::m_netClassFilter, and PANEL_SETUP_NETCLASSES_BASE::m_netclassGrid.

Referenced by ImportSettingsFrom(), and OnUpdateUI().

TransferDataFromWindow()

bool PANEL_SETUP_NETCLASSES::TransferDataFromWindow ( )

override

Definition at line 391 of file panel_setup_netclasses.cpp.

{
 if( !Validate() )
 return false;

 m_netclasses->Clear();

 // Copy the default NetClass:
 gridRowToNetclass( m_frame->GetUserUnits(), m_netclassGrid, 0, m_netclasses->GetDefault() );

 // Copy other NetClasses:
 for( int row = 1; row < m_netclassGrid->GetNumberRows(); ++row )
 {
 NETCLASSPTR nc = std::make_shared<NETCLASS>( m_netclassGrid->GetCellValue( row,
 GRID_NAME ) );

 if( m_netclasses->Add( nc ) )
 gridRowToNetclass( m_frame->GetUserUnits(), m_netclassGrid, row, nc );
 }

 // Now read all nets and push them in the corresponding netclass net buffer
 for( int row = 0; row < m_membershipGrid->GetNumberRows(); ++row )
 {
 const wxString& netname = m_membershipGrid->GetCellValue( row, 0 );
 const wxString& classname = m_membershipGrid->GetCellValue( row, 1 );

 if( classname != NETCLASS::Default )
 {
 const NETCLASSPTR& nc = m_netclasses->Find( classname );

 if( nc )
 nc->Add( netname );
 }
 }

 return true;
}

References NETCLASSES::Add(), NETCLASSES::Clear(), NETCLASS::Default, NETCLASSES::Find(), NETCLASSES::GetDefault(), EDA_BASE_FRAME::GetUserUnits(), GRID_NAME, gridRowToNetclass(), m_frame, PANEL_SETUP_NETCLASSES_BASE::m_membershipGrid, m_netclasses, PANEL_SETUP_NETCLASSES_BASE::m_netclassGrid, and Validate().

Referenced by onUnitsChanged().

TransferDataToWindow()

bool PANEL_SETUP_NETCLASSES::TransferDataToWindow ( )

override

Definition at line 265 of file panel_setup_netclasses.cpp.

{
 std::map<wxString, wxString> netToNetclassMap;
 std::map<wxString, wxString> staleNetMap;

 for( const wxString& candidate : m_netNames )
 netToNetclassMap[ candidate ] = wxEmptyString;

 m_netclassGrid->ClearRows();
 m_netclassGrid->AppendRows((int) m_netclasses->GetCount() + 1 ); // + 1 for default netclass

 // enter the Default NETCLASS.
 netclassToGridRow( m_frame->GetUserUnits(), m_netclassGrid, 0, m_netclasses->GetDefault() );

 // make the Default NETCLASS name read-only
 wxGridCellAttr* cellAttr = m_netclassGrid->GetOrCreateCellAttr( 0, GRID_NAME );
 cellAttr->SetReadOnly();
 cellAttr->DecRef();

 // enter other netclasses
 int row = 1;

 for( NETCLASSES::iterator i = m_netclasses->begin(); i != m_netclasses->end(); ++i, ++row )
 {
 NETCLASSPTR netclass = i->second;

 netclassToGridRow( m_frame->GetUserUnits(), m_netclassGrid, row, netclass );

 for( const wxString& net : *netclass )
 {
 if( netToNetclassMap.count( net ) )
 netToNetclassMap[ net ] = i->second->GetName();
 else
 staleNetMap[ net ] = i->second->GetName();
 }
 }

 m_membershipGrid->ClearRows();

 // add currently-assigned and candidate netnames to membership lists
 for( const std::pair<const wxString, wxString>& ii : netToNetclassMap )
 addNet( ii.first, ii.second, false );

 for( const std::pair<const wxString, wxString>& ii : staleNetMap )
 addNet( ii.first, ii.second, true );

 return true;
}

References addNet(), NETCLASSES::begin(), WX_GRID::ClearRows(), NETCLASSES::end(), NETCLASSES::GetCount(), NETCLASSES::GetDefault(), EDA_BASE_FRAME::GetUserUnits(), GRID_NAME, m_frame, PANEL_SETUP_NETCLASSES_BASE::m_membershipGrid, m_netclasses, PANEL_SETUP_NETCLASSES_BASE::m_netclassGrid, m_netNames, and netclassToGridRow().

Referenced by ImportSettingsFrom(), and onUnitsChanged().

Validate()

bool PANEL_SETUP_NETCLASSES::Validate ( )

override

Definition at line 719 of file panel_setup_netclasses.cpp.

{
 if( !m_netclassGrid->CommitPendingChanges() || !m_membershipGrid->CommitPendingChanges() )
 return false;

 wxString msg;

 // Test net class parameters.
 for( int row = 0; row < m_netclassGrid->GetNumberRows(); row++ )
 {
 wxString netclassName = m_netclassGrid->GetCellValue( row, GRID_NAME );
 netclassName.Trim( true );
 netclassName.Trim( false );

 if( !validateNetclassName( row, netclassName, false ) )
 return false;
 }

 return true;
}

References WX_GRID::CommitPendingChanges(), GRID_NAME, PANEL_SETUP_NETCLASSES_BASE::m_membershipGrid, PANEL_SETUP_NETCLASSES_BASE::m_netclassGrid, and validateNetclassName().

Referenced by TransferDataFromWindow().

validateNetclassName()

bool PANEL_SETUP_NETCLASSES::validateNetclassName ( int  aRow, const wxString &  aName, bool  focusFirst = true  )

private

Definition at line 430 of file panel_setup_netclasses.cpp.

{
 wxString tmp = aName;

 tmp.Trim( true );
 tmp.Trim( false );

 if( tmp.IsEmpty() )
 {
 wxString msg = _( "Netclass must have a name." );
 m_parent->SetError( msg, this, m_netclassGrid, aRow, GRID_NAME );
 return false;
 }

 for( int ii = 0; ii < m_netclassGrid->GetNumberRows(); ii++ )
 {
 if( ii != aRow && m_netclassGrid->GetCellValue( ii, GRID_NAME ).CmpNoCase( tmp ) == 0 )
 {
 wxString msg = _( "Netclass name already in use." );
 m_parent->SetError( msg, this, m_netclassGrid, focusFirst ? aRow : ii, GRID_NAME );
 return false;
 }
 }

 return true;
}

References _, GRID_NAME, PANEL_SETUP_NETCLASSES_BASE::m_netclassGrid, m_parent, and PAGED_DIALOG::SetError().

Referenced by OnNetclassGridCellChanging(), and Validate().

Member Data Documentation

m_addButton

wxBitmapButton* PANEL_SETUP_NETCLASSES_BASE::m_addButton

protectedinherited

Definition at line 47 of file panel_setup_netclasses_base.h.

Referenced by PANEL_SETUP_NETCLASSES(), PANEL_SETUP_NETCLASSES_BASE::PANEL_SETUP_NETCLASSES_BASE(), and PANEL_SETUP_NETCLASSES_BASE::~PANEL_SETUP_NETCLASSES_BASE().

m_assignAllButton

wxButton* PANEL_SETUP_NETCLASSES_BASE::m_assignAllButton

protectedinherited

Definition at line 59 of file panel_setup_netclasses_base.h.

Referenced by PANEL_SETUP_NETCLASSES_BASE::PANEL_SETUP_NETCLASSES_BASE(), and PANEL_SETUP_NETCLASSES_BASE::~PANEL_SETUP_NETCLASSES_BASE().

m_assignLabel

wxStaticText* PANEL_SETUP_NETCLASSES_BASE::m_assignLabel

protectedinherited

Definition at line 57 of file panel_setup_netclasses_base.h.

Referenced by PANEL_SETUP_NETCLASSES_BASE::PANEL_SETUP_NETCLASSES_BASE().

m_assignNetClass

wxChoice* PANEL_SETUP_NETCLASSES_BASE::m_assignNetClass

protectedinherited

Definition at line 58 of file panel_setup_netclasses_base.h.

Referenced by doAssignments(), PANEL_SETUP_NETCLASSES_BASE::PANEL_SETUP_NETCLASSES_BASE(), and rebuildNetclassDropdowns().

m_assignSelectedButton

wxButton* PANEL_SETUP_NETCLASSES_BASE::m_assignSelectedButton

protectedinherited

Definition at line 60 of file panel_setup_netclasses_base.h.

Referenced by PANEL_SETUP_NETCLASSES_BASE::PANEL_SETUP_NETCLASSES_BASE(), and PANEL_SETUP_NETCLASSES_BASE::~PANEL_SETUP_NETCLASSES_BASE().

m_colorDefaultHelpText

wxStaticText* PANEL_SETUP_NETCLASSES_BASE::m_colorDefaultHelpText

protectedinherited

Definition at line 49 of file panel_setup_netclasses_base.h.

Referenced by PANEL_SETUP_NETCLASSES(), and PANEL_SETUP_NETCLASSES_BASE::PANEL_SETUP_NETCLASSES_BASE().

m_filterLabel

wxStaticText* PANEL_SETUP_NETCLASSES_BASE::m_filterLabel

protectedinherited

Definition at line 53 of file panel_setup_netclasses_base.h.

Referenced by PANEL_SETUP_NETCLASSES_BASE::PANEL_SETUP_NETCLASSES_BASE().

m_filterNetsButton

wxButton* PANEL_SETUP_NETCLASSES_BASE::m_filterNetsButton

protectedinherited

Definition at line 56 of file panel_setup_netclasses_base.h.

Referenced by PANEL_SETUP_NETCLASSES_BASE::PANEL_SETUP_NETCLASSES_BASE(), and PANEL_SETUP_NETCLASSES_BASE::~PANEL_SETUP_NETCLASSES_BASE().

m_frame

EDA_DRAW_FRAME* PANEL_SETUP_NETCLASSES::m_frame

private

Definition at line 76 of file panel_setup_netclasses.h.

Referenced by PANEL_SETUP_NETCLASSES(), TransferDataFromWindow(), TransferDataToWindow(), and ~PANEL_SETUP_NETCLASSES().

m_hoveredCol

int PANEL_SETUP_NETCLASSES::m_hoveredCol

private

Definition at line 83 of file panel_setup_netclasses.h.

Referenced by OnNetclassGridMouseEvent().

m_membershipGrid

WX_GRID* PANEL_SETUP_NETCLASSES_BASE::m_membershipGrid

protectedinherited

Definition at line 61 of file panel_setup_netclasses_base.h.

Referenced by addNet(), AdjustMembershipGridColumns(), doApplyFilters(), doAssignments(), ImportSettingsFrom(), onmembershipPanelSize(), OnNetclassGridCellChanging(), OnRemoveNetclassClick(), PANEL_SETUP_NETCLASSES(), PANEL_SETUP_NETCLASSES_BASE::PANEL_SETUP_NETCLASSES_BASE(), rebuildNetclassDropdowns(), TransferDataFromWindow(), TransferDataToWindow(), Validate(), ~PANEL_SETUP_NETCLASSES(), and PANEL_SETUP_NETCLASSES_BASE::~PANEL_SETUP_NETCLASSES_BASE().

m_membershipPane

wxPanel* PANEL_SETUP_NETCLASSES_BASE::m_membershipPane

protectedinherited

Definition at line 50 of file panel_setup_netclasses_base.h.

Referenced by PANEL_SETUP_NETCLASSES_BASE::PANEL_SETUP_NETCLASSES_BASE(), and PANEL_SETUP_NETCLASSES_BASE::~PANEL_SETUP_NETCLASSES_BASE().

m_ncfilterLabel

wxStaticText* PANEL_SETUP_NETCLASSES_BASE::m_ncfilterLabel

protectedinherited

Definition at line 51 of file panel_setup_netclasses_base.h.

Referenced by PANEL_SETUP_NETCLASSES_BASE::PANEL_SETUP_NETCLASSES_BASE().

m_netclasses

NETCLASSES* PANEL_SETUP_NETCLASSES::m_netclasses

private

Definition at line 78 of file panel_setup_netclasses.h.

Referenced by ImportSettingsFrom(), onUnitsChanged(), TransferDataFromWindow(), and TransferDataToWindow().

m_netclassesDirty

bool PANEL_SETUP_NETCLASSES::m_netclassesDirty

private

Definition at line 82 of file panel_setup_netclasses.h.

Referenced by OnAddNetclassClick(), OnNetclassGridCellChanging(), OnRemoveNetclassClick(), OnUpdateUI(), and PANEL_SETUP_NETCLASSES().

m_netclassesPane

wxPanel* PANEL_SETUP_NETCLASSES_BASE::m_netclassesPane

protectedinherited

Definition at line 45 of file panel_setup_netclasses_base.h.

Referenced by PANEL_SETUP_NETCLASSES_BASE::PANEL_SETUP_NETCLASSES_BASE().

m_netClassFilter

wxChoice* PANEL_SETUP_NETCLASSES_BASE::m_netClassFilter

protectedinherited

Definition at line 52 of file panel_setup_netclasses_base.h.

Referenced by doApplyFilters(), PANEL_SETUP_NETCLASSES_BASE::PANEL_SETUP_NETCLASSES_BASE(), and rebuildNetclassDropdowns().

m_netclassGrid

WX_GRID* PANEL_SETUP_NETCLASSES_BASE::m_netclassGrid

protectedinherited

Definition at line 46 of file panel_setup_netclasses_base.h.

Referenced by AdjustNetclassGridColumns(), ImportSettingsFrom(), OnAddNetclassClick(), OnNetclassGridCellChanging(), OnNetclassGridMouseEvent(), OnRemoveNetclassClick(), PANEL_SETUP_NETCLASSES(), PANEL_SETUP_NETCLASSES_BASE::PANEL_SETUP_NETCLASSES_BASE(), rebuildNetclassDropdowns(), TransferDataFromWindow(), TransferDataToWindow(), Validate(), validateNetclassName(), ~PANEL_SETUP_NETCLASSES(), and PANEL_SETUP_NETCLASSES_BASE::~PANEL_SETUP_NETCLASSES_BASE().

m_netNameFilter

wxTextCtrl* PANEL_SETUP_NETCLASSES_BASE::m_netNameFilter

protectedinherited

Definition at line 54 of file panel_setup_netclasses_base.h.

Referenced by doApplyFilters(), PANEL_SETUP_NETCLASSES_BASE::PANEL_SETUP_NETCLASSES_BASE(), and PANEL_SETUP_NETCLASSES_BASE::~PANEL_SETUP_NETCLASSES_BASE().

m_netNames

std::vector<wxString> PANEL_SETUP_NETCLASSES::m_netNames

private

Definition at line 79 of file panel_setup_netclasses.h.

Referenced by TransferDataToWindow().

m_originalColWidths

int* PANEL_SETUP_NETCLASSES::m_originalColWidths

private

Definition at line 81 of file panel_setup_netclasses.h.

Referenced by AdjustMembershipGridColumns(), AdjustNetclassGridColumns(), PANEL_SETUP_NETCLASSES(), and ~PANEL_SETUP_NETCLASSES().

m_parent

PAGED_DIALOG* PANEL_SETUP_NETCLASSES::m_parent

private

Definition at line 77 of file panel_setup_netclasses.h.

Referenced by validateNetclassName().

m_removeButton

wxBitmapButton* PANEL_SETUP_NETCLASSES_BASE::m_removeButton

protectedinherited

Definition at line 48 of file panel_setup_netclasses_base.h.

Referenced by PANEL_SETUP_NETCLASSES(), PANEL_SETUP_NETCLASSES_BASE::PANEL_SETUP_NETCLASSES_BASE(), and PANEL_SETUP_NETCLASSES_BASE::~PANEL_SETUP_NETCLASSES_BASE().

m_showAllButton

wxButton* PANEL_SETUP_NETCLASSES_BASE::m_showAllButton

protectedinherited

Definition at line 55 of file panel_setup_netclasses_base.h.

Referenced by PANEL_SETUP_NETCLASSES_BASE::PANEL_SETUP_NETCLASSES_BASE(), and PANEL_SETUP_NETCLASSES_BASE::~PANEL_SETUP_NETCLASSES_BASE().

m_splitter

wxSplitterWindow* PANEL_SETUP_NETCLASSES_BASE::m_splitter

protectedinherited

Definition at line 44 of file panel_setup_netclasses_base.h.

Referenced by PANEL_SETUP_NETCLASSES(), PANEL_SETUP_NETCLASSES_BASE::PANEL_SETUP_NETCLASSES_BASE(), and ~PANEL_SETUP_NETCLASSES().

---

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

• panel_setup_netclasses.h
• panel_setup_netclasses.cpp