#include <panel_setup_pinmap.h>

Inheritance diagram for PANEL_SETUP_PINMAP:

Public Member Functions
	PANEL_SETUP_PINMAP (wxWindow aWindow, SCH_EDIT_FRAME aParent)

	~PANEL_SETUP_PINMAP ()

void	ImportSettingsFrom (PIN_ERROR aPinMap[][ELECTRICAL_PINTYPES_TOTAL])

void	ResetPanel () override
	Reset the contents of this panel. More...

void	OnMouseEnter (wxMouseEvent &aEvent)

void	OnMouseLeave (wxMouseEvent &aEvent)

virtual wxString	GetResetTooltip () const
	Get the tooltip the reset button should display when showing this panel. More...

wxString	GetHelpTextAtPoint (const wxPoint &aPt, wxHelpEvent::Origin aOrigin) const override
	Overridden to supply the reset button tooltip when queried with { -INT_MAX, INT_MAX }. More...

Protected Attributes
wxPanel *	m_matrixPanel

Private Member Functions
void	changeErrorLevel (wxCommandEvent &event)

void	reBuildMatrixPanel ()

void	setDRCMatrixButtonState (wxWindow *aButton, PIN_ERROR aState)

Private Attributes
SCH_EDIT_FRAME *	m_parent

SCHEMATIC *	m_schematic

wxColour	m_btnBackground

wxWindow *	m_buttonList [ELECTRICAL_PINTYPES_TOTAL][ELECTRICAL_PINTYPES_TOTAL]

bool	m_initialized

Detailed Description

Definition at line 40 of file panel_setup_pinmap.h.

Constructor & Destructor Documentation

◆ PANEL_SETUP_PINMAP()

PANEL_SETUP_PINMAP::PANEL_SETUP_PINMAP	(	wxWindow *	aWindow,
		SCH_EDIT_FRAME *	aParent
	)

◆ ~PANEL_SETUP_PINMAP()

PANEL_SETUP_PINMAP::~PANEL_SETUP_PINMAP ( )

Definition at line 64 of file panel_setup_pinmap.cpp.

{
#ifndef __WXMAC__
 if( m_initialized )
 {
 for( int ii = 0; ii < ELECTRICAL_PINTYPES_TOTAL; ii++ )
 {
 for( int jj = 0; jj <= ii; jj++ )
 {
 m_buttonList[ii][jj]->Unbind( wxEVT_ENTER_WINDOW,
 &PANEL_SETUP_PINMAP::OnMouseLeave, this );
 m_buttonList[ii][jj]->Unbind( wxEVT_LEAVE_WINDOW,
 &PANEL_SETUP_PINMAP::OnMouseLeave, this );
 }
 }
 }
#endif
}

References ELECTRICAL_PINTYPES_TOTAL, m_buttonList, m_initialized, and OnMouseLeave().

Member Function Documentation

◆ changeErrorLevel()

void PANEL_SETUP_PINMAP::changeErrorLevel ( wxCommandEvent & event )

private

Definition at line 249 of file panel_setup_pinmap.cpp.

{
 int id = event.GetId();
 int ii = id - ID_MATRIX_0;
 int x = ii / ELECTRICAL_PINTYPES_TOTAL;
 int y = ii % ELECTRICAL_PINTYPES_TOTAL;
 wxWindow* butt = static_cast<wxWindow*>( event.GetEventObject() );
 
 int level = static_cast<int>( m_schematic->ErcSettings().GetPinMapValue( y, x ) );
 level = ( level + 1 ) % 3;
 
 setDRCMatrixButtonState( butt, static_cast<PIN_ERROR>( level ) );
 
 m_schematic->ErcSettings().SetPinMapValue( y, x, static_cast<PIN_ERROR>( level ) );
 m_schematic->ErcSettings().SetPinMapValue( x, y, static_cast<PIN_ERROR>( level ) );
}

References ELECTRICAL_PINTYPES_TOTAL, SCHEMATIC::ErcSettings(), ERC_SETTINGS::GetPinMapValue(), ID_MATRIX_0, m_schematic, setDRCMatrixButtonState(), and ERC_SETTINGS::SetPinMapValue().

◆ GetHelpTextAtPoint()

wxString RESETTABLE_PANEL::GetHelpTextAtPoint	(	const wxPoint &	aPt,
		wxHelpEvent::Origin	aOrigin
	)		const

inlineoverrideinherited

Overridden to supply the reset button tooltip when queried with { -INT_MAX, INT_MAX }.

Definition at line 72 of file resettable_panel.h.

 {
 if( aPt == wxPoint( -INT_MAX, INT_MAX ) )
 return GetResetTooltip();
 else
 return wxPanel::GetHelpTextAtPoint( aPt, aOrigin );
 }

References RESETTABLE_PANEL::GetResetTooltip().

◆ GetResetTooltip()

virtual wxString RESETTABLE_PANEL::GetResetTooltip ( ) const

inlinevirtualinherited

Get the tooltip the reset button should display when showing this panel.

Returns: the tooltip

Reimplemented in PANEL_COLOR_SETTINGS, and PANEL_HOTKEYS_EDITOR.

Definition at line 64 of file resettable_panel.h.

 {
 return _( "Reset all settings on this page to their default" );
 }

References _.

Referenced by RESETTABLE_PANEL::GetHelpTextAtPoint().

◆ ImportSettingsFrom()

void PANEL_SETUP_PINMAP::ImportSettingsFrom ( PIN_ERROR aPinMap[][ELECTRICAL_PINTYPES_TOTAL] )

Definition at line 267 of file panel_setup_pinmap.cpp.

{
 for( int ii = 0; ii < ELECTRICAL_PINTYPES_TOTAL; ii++ )
 {
 for( int jj = 0; jj <= ii; jj++ )
 setDRCMatrixButtonState( m_buttonList[ii][jj], aPinMap[ii][jj] );
 }
}

References ELECTRICAL_PINTYPES_TOTAL, m_buttonList, and setDRCMatrixButtonState().

Referenced by DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction().

◆ OnMouseEnter()

void PANEL_SETUP_PINMAP::OnMouseEnter ( wxMouseEvent & aEvent )

Definition at line 91 of file panel_setup_pinmap.cpp.

{
 wxBitmapButton* btn = static_cast<wxBitmapButton*>( aEvent.GetEventObject() );
 m_btnBackground = btn->GetBackgroundColour();
 
 btn->SetBackgroundColour( wxSystemSettings::GetColour( wxSystemColour::wxSYS_COLOUR_HIGHLIGHT ) );
}

References m_btnBackground.

Referenced by reBuildMatrixPanel().

◆ OnMouseLeave()

void PANEL_SETUP_PINMAP::OnMouseLeave ( wxMouseEvent & aEvent )

Definition at line 100 of file panel_setup_pinmap.cpp.

{
 wxBitmapButton* btn = static_cast<wxBitmapButton*>( aEvent.GetEventObject() );
 btn->SetBackgroundColour( m_btnBackground );
}

References m_btnBackground.

Referenced by reBuildMatrixPanel(), and ~PANEL_SETUP_PINMAP().

◆ reBuildMatrixPanel()

void PANEL_SETUP_PINMAP::reBuildMatrixPanel ( )

private

Definition at line 107 of file panel_setup_pinmap.cpp.

{
 // Try to know the size of bitmap button used in drc matrix
 wxBitmapButton* dummy = new wxBitmapButton( m_matrixPanel, wxID_ANY, KiBitmap( BITMAPS::ercerr ),
 wxDefaultPosition, wxDefaultSize, wxBORDER_NONE );
 wxSize bitmapSize = dummy->GetSize();
 delete dummy;
 
#ifdef __WXMAC__
 const wxSize text_padding( 2, 1 );
 const int twiddle = -1;
#else
 const wxSize text_padding( 8, 6 );
 const int twiddle = 1;
#endif
 
 wxSize charSize = KIUI::GetTextSize( wxS( "X" ), m_matrixPanel );
 wxPoint pos( 0, charSize.y * 2 );
 wxStaticText* text;
 
 if( !m_initialized )
 {
 std::vector<wxStaticText*> labels;
 
 // Print row labels
 for( int ii = 0; ii < ELECTRICAL_PINTYPES_TOTAL; ii++ )
 {
 int y = pos.y + ( ii * ( bitmapSize.y + text_padding.y ) );
 text = new wxStaticText( m_matrixPanel, - 1, CommentERC_H[ii],
 wxPoint( 5, y + ( bitmapSize.y / 2 ) - ( 12 / 2 ) ) );
 labels.push_back( text );
 
 int x = text->GetRect().GetRight();
 pos.x = std::max( pos.x, x );
 }
 
 // Right-align
 for( int ii = 0; ii < ELECTRICAL_PINTYPES_TOTAL; ii++ )
 {
 wxPoint labelPos = labels[ ii ]->GetPosition();
 labelPos.x = pos.x - labels[ ii ]->GetRect().GetWidth();
 labelPos.y += twiddle;
 labels[ ii ]->SetPosition( labelPos );
 }
 
 pos.x += 5;
 }
 else
 {
 pos = m_buttonList[0][0]->GetPosition();
 }
 
 for( int ii = 0; ii < ELECTRICAL_PINTYPES_TOTAL; ii++ )
 {
 int y = pos.y + (ii * ( bitmapSize.y + text_padding.y ) );
 
 for( int jj = 0; jj <= ii; jj++ )
 {
 // Add column labels (only once)
 PIN_ERROR diag = m_schematic->ErcSettings().GetPinMapValue( ii, jj );
 
 int x = pos.x + ( jj * ( bitmapSize.x + text_padding.x ) );
 
 if( ( ii == jj ) && !m_initialized )
 {
 wxPoint textPos( x + KiROUND( bitmapSize.x / 2 ),
 y - charSize.y * 2 );
 new wxStaticText( m_matrixPanel, wxID_ANY, CommentERC_V[ii], textPos );
 
 wxPoint calloutPos( x + KiROUND( bitmapSize.x / 2 ),
 y - charSize.y );
 new wxStaticText( m_matrixPanel, wxID_ANY, "|", calloutPos );
 }
 
 int id = ID_MATRIX_0 + ii + ( jj * ELECTRICAL_PINTYPES_TOTAL );
 BITMAPS bitmap_butt = BITMAPS::erc_green;
 
#ifdef __WXMAC__
 BITMAP_BUTTON* btn = new BITMAP_BUTTON( m_matrixPanel, id, KiBitmap( bitmap_butt ),
 wxPoint( x, y ), bitmapSize );
#else
 if( m_initialized )
 {
 m_buttonList[ii][jj]->Unbind(wxEVT_ENTER_WINDOW, &PANEL_SETUP_PINMAP::OnMouseLeave, this );
 m_buttonList[ii][jj]->Unbind(wxEVT_LEAVE_WINDOW, &PANEL_SETUP_PINMAP::OnMouseLeave, this );
 }
 
 wxBitmapButton* btn = new wxBitmapButton( m_matrixPanel, id, KiBitmap( bitmap_butt ),
 wxPoint( x, y ), wxDefaultSize, wxBORDER_NONE );
 btn->Bind( wxEVT_LEAVE_WINDOW, &PANEL_SETUP_PINMAP::OnMouseLeave, this );
 btn->Bind( wxEVT_ENTER_WINDOW, &PANEL_SETUP_PINMAP::OnMouseEnter, this );
#endif
 btn->SetSize( btn->GetSize() + text_padding );
 
 delete m_buttonList[ii][jj];
 m_buttonList[ii][jj] = btn;
 setDRCMatrixButtonState( m_buttonList[ii][jj], diag );
 }
 }
 
 m_initialized = true;
}

References CommentERC_H, CommentERC_V, dummy, ELECTRICAL_PINTYPES_TOTAL, erc_green, ercerr, SCHEMATIC::ErcSettings(), ERC_SETTINGS::GetPinMapValue(), KIUI::GetTextSize(), ID_MATRIX_0, KiBitmap(), KiROUND(), m_buttonList, m_initialized, PANEL_SETUP_PINMAP_BASE::m_matrixPanel, m_schematic, OnMouseEnter(), OnMouseLeave(), setDRCMatrixButtonState(), and text.

Referenced by ResetPanel().

◆ ResetPanel()

void PANEL_SETUP_PINMAP::ResetPanel ( )

overridevirtual

Reset the contents of this panel.

Implements RESETTABLE_PANEL.

Definition at line 84 of file panel_setup_pinmap.cpp.

{
 m_schematic->ErcSettings().ResetPinMap();
 reBuildMatrixPanel();
}

References SCHEMATIC::ErcSettings(), m_schematic, reBuildMatrixPanel(), and ERC_SETTINGS::ResetPinMap().

◆ setDRCMatrixButtonState()

void PANEL_SETUP_PINMAP::setDRCMatrixButtonState	(	wxWindow *	aButton,
		PIN_ERROR	aState
	)

private

Definition at line 211 of file panel_setup_pinmap.cpp.

{
 BITMAPS bitmap_butt = BITMAPS::INVALID_BITMAP;
 wxString tooltip;
 
 switch( aState )
 {
 case PIN_ERROR::OK:
 bitmap_butt = BITMAPS::erc_green;
 tooltip = _( "No error or warning" );
 break;
 
 case PIN_ERROR::WARNING:
 bitmap_butt = BITMAPS::ercwarn;
 tooltip = _( "Generate warning" );
 break;
 
 case PIN_ERROR::PP_ERROR:
 bitmap_butt = BITMAPS::ercerr;
 tooltip = _( "Generate error" );
 break;
 
 default:
 break;
 }
 
 if( !!bitmap_butt )
 {
 if( wxBitmapButton* wx_btn = dynamic_cast<wxBitmapButton*>( aButton ) )
 wx_btn->SetBitmap( KiBitmap( bitmap_butt ) );
 else if( BITMAP_BUTTON* ki_btn = dynamic_cast<BITMAP_BUTTON*>( aButton ) )
 ki_btn->SetBitmap( KiBitmap( bitmap_butt ) );
 
 aButton->SetToolTip( tooltip );
 }
}

References _, erc_green, ercerr, ercwarn, INVALID_BITMAP, KiBitmap(), OK, PP_ERROR, and WARNING.

Referenced by changeErrorLevel(), ImportSettingsFrom(), and reBuildMatrixPanel().

Member Data Documentation

◆ m_btnBackground

wxColour PANEL_SETUP_PINMAP::m_btnBackground

private

Definition at line 61 of file panel_setup_pinmap.h.

Referenced by OnMouseEnter(), and OnMouseLeave().

◆ m_buttonList

wxWindow* PANEL_SETUP_PINMAP::m_buttonList[ELECTRICAL_PINTYPES_TOTAL][ELECTRICAL_PINTYPES_TOTAL]

private

Definition at line 62 of file panel_setup_pinmap.h.

Referenced by ImportSettingsFrom(), reBuildMatrixPanel(), and ~PANEL_SETUP_PINMAP().

◆ m_initialized

bool PANEL_SETUP_PINMAP::m_initialized

private

Definition at line 63 of file panel_setup_pinmap.h.

Referenced by reBuildMatrixPanel(), and ~PANEL_SETUP_PINMAP().

◆ m_matrixPanel

wxPanel* PANEL_SETUP_PINMAP_BASE::m_matrixPanel

protectedinherited

Definition at line 32 of file panel_setup_pinmap_base.h.

Referenced by PANEL_SETUP_PINMAP_BASE::PANEL_SETUP_PINMAP_BASE(), and reBuildMatrixPanel().

◆ m_parent

SCH_EDIT_FRAME* PANEL_SETUP_PINMAP::m_parent

private

Definition at line 59 of file panel_setup_pinmap.h.

◆ m_schematic

SCHEMATIC* PANEL_SETUP_PINMAP::m_schematic

private

Definition at line 60 of file panel_setup_pinmap.h.

Referenced by changeErrorLevel(), reBuildMatrixPanel(), and ResetPanel().

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

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PANEL_SETUP_PINMAP()

◆ ~PANEL_SETUP_PINMAP()

Member Function Documentation

◆ changeErrorLevel()

◆ GetHelpTextAtPoint()

◆ GetResetTooltip()

◆ ImportSettingsFrom()

◆ OnMouseEnter()

◆ OnMouseLeave()

◆ reBuildMatrixPanel()

◆ ResetPanel()

◆ setDRCMatrixButtonState()

Member Data Documentation

◆ m_btnBackground

◆ m_buttonList

◆ m_initialized

◆ m_matrixPanel

◆ m_parent

◆ m_schematic