#include <panel_fp_editor_defaults.h>

Inheritance diagram for PANEL_FP_EDITOR_DEFAULTS:

Public Member Functions
	PANEL_FP_EDITOR_DEFAULTS (wxWindow aParent, EDA_BASE_FRAME aUnitsProvider)

	~PANEL_FP_EDITOR_DEFAULTS () override

bool	TransferDataToWindow () override

bool	TransferDataFromWindow () override

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

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 Member Functions
virtual void	OnGridSize (wxSizeEvent &event)

Protected Attributes
wxStaticText *	defaultTextItemsLabel

WX_GRID *	m_textItemsGrid

wxBitmapButton *	m_bpAdd

wxBitmapButton *	m_bpDelete

wxStaticText *	m_staticTextInfo

WX_GRID *	m_graphicsGrid

Private Member Functions
virtual void	OnAddTextItem (wxCommandEvent &event) override

virtual void	OnDeleteTextItem (wxCommandEvent &event) override

bool	Show (bool aShow) override

int	getGridValue (int aRow, int aCol)

bool	validateData ()

void	loadFPSettings (FOOTPRINT_EDITOR_SETTINGS *aCfg)

Private Attributes
EDA_UNITS	m_units = EDA_UNITS::MILLIMETRES

PAGED_DIALOG *	m_parent

bool	m_firstShow = true

Detailed Description

Definition at line 29 of file panel_fp_editor_defaults.h.

Constructor & Destructor Documentation

◆ PANEL_FP_EDITOR_DEFAULTS()

PANEL_FP_EDITOR_DEFAULTS::PANEL_FP_EDITOR_DEFAULTS	(	wxWindow *	aParent,
		EDA_BASE_FRAME *	aUnitsProvider
	)

Definition at line 172 of file panel_fp_editor_defaults.cpp.

 :
 PANEL_FP_EDITOR_DEFAULTS_BASE( aParent )
{
 if( aUnitsProvider )
 m_units = aUnitsProvider->GetUserUnits();
 
 m_parent = static_cast<PAGED_DIALOG*>( aParent->GetParent() );
 
 m_textItemsGrid->SetDefaultRowSize( m_textItemsGrid->GetDefaultRowSize() + 4 );
 m_graphicsGrid->SetDefaultRowSize( m_graphicsGrid->GetDefaultRowSize() + 4 );
 
 m_textItemsGrid->SetTable( new TEXT_ITEMS_GRID_TABLE(), true );
 m_textItemsGrid->PushEventHandler( new GRID_TRICKS( m_textItemsGrid ) );
 m_textItemsGrid->SetSelectionMode( wxGrid::wxGridSelectRows );
 
 wxGridCellAttr* attr = new wxGridCellAttr;
 attr->SetRenderer( new wxGridCellBoolRenderer() );
 attr->SetReadOnly(); // not really; we delegate interactivity to GRID_TRICKS
 attr->SetAlignment( wxALIGN_CENTER, wxALIGN_CENTER );
 m_textItemsGrid->SetColAttr( 1, attr );
 
 attr = new wxGridCellAttr;
 attr->SetRenderer( new GRID_CELL_LAYER_RENDERER( nullptr ) );
 attr->SetEditor( new GRID_CELL_LAYER_SELECTOR( nullptr, {} ) );
 m_textItemsGrid->SetColAttr( 2, attr );
 
 // Work around a bug in wxWidgets where it fails to recalculate the grid height
 // after changing the default row size
 m_graphicsGrid->AppendRows( 1 );
 m_graphicsGrid->DeleteRows( m_graphicsGrid->GetNumberRows() - 1, 1 );
 
 m_graphicsGrid->PushEventHandler( new GRID_TRICKS( m_graphicsGrid ) );
 
 m_staticTextInfo->SetFont( KIUI::GetInfoFont( this ).Italic() );
}

References KIUI::GetInfoFont(), UNITS_PROVIDER::GetUserUnits(), PANEL_FP_EDITOR_DEFAULTS_BASE::m_graphicsGrid, m_parent, PANEL_FP_EDITOR_DEFAULTS_BASE::m_staticTextInfo, PANEL_FP_EDITOR_DEFAULTS_BASE::m_textItemsGrid, m_units, and WX_GRID::SetTable().

◆ ~PANEL_FP_EDITOR_DEFAULTS()

PANEL_FP_EDITOR_DEFAULTS::~PANEL_FP_EDITOR_DEFAULTS ( )

override

Definition at line 210 of file panel_fp_editor_defaults.cpp.

{
 // destroy GRID_TRICKS before grids.
 m_textItemsGrid->PopEventHandler( true );
 m_graphicsGrid->PopEventHandler( true );
}

References PANEL_FP_EDITOR_DEFAULTS_BASE::m_graphicsGrid, and PANEL_FP_EDITOR_DEFAULTS_BASE::m_textItemsGrid.

Member Function Documentation

◆ getGridValue()

int PANEL_FP_EDITOR_DEFAULTS::getGridValue	(	int	aRow,
		int	aCol
	)

private

Definition at line 318 of file panel_fp_editor_defaults.cpp.

{
 return EDA_UNIT_UTILS::UI::ValueFromString( pcbIUScale, m_units, m_graphicsGrid->GetCellValue( aRow, aCol ) );
}

References PANEL_FP_EDITOR_DEFAULTS_BASE::m_graphicsGrid, m_units, pcbIUScale, and EDA_UNIT_UTILS::UI::ValueFromString().

Referenced by TransferDataFromWindow(), and validateData().

◆ 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().

◆ loadFPSettings()

void PANEL_FP_EDITOR_DEFAULTS::loadFPSettings ( FOOTPRINT_EDITOR_SETTINGS * aCfg )

private

Definition at line 218 of file panel_fp_editor_defaults.cpp.

{
 wxColour disabledColour = wxSystemSettings::GetColour( wxSYS_COLOUR_BACKGROUND );
 
#define SET_MILS_CELL( row, col, val ) \
 m_graphicsGrid->SetCellValue( row, col, EDA_UNIT_UTILS::UI::StringFromValue( pcbIUScale, m_units, val, true ) )
 
#define DISABLE_CELL( row, col ) \
 m_graphicsGrid->SetReadOnly( row, col ); \
 m_graphicsGrid->SetCellBackgroundColour( row, col, disabledColour );
 
 for( int i = 0; i < ROW_COUNT; ++i )
 {
 SET_MILS_CELL( i, COL_LINE_THICKNESS, aCfg->m_DesignSettings.m_LineThickness[ i ] );
 
 if( i == ROW_EDGES || i == ROW_COURTYARD )
 {
 DISABLE_CELL( i, COL_TEXT_WIDTH );
 DISABLE_CELL( i, COL_TEXT_HEIGHT );
 DISABLE_CELL( i, COL_TEXT_THICKNESS );
 DISABLE_CELL( i, COL_TEXT_ITALIC );
 }
 else
 {
 SET_MILS_CELL( i, COL_TEXT_WIDTH, aCfg->m_DesignSettings.m_TextSize[ i ].x );
 SET_MILS_CELL( i, COL_TEXT_HEIGHT, aCfg->m_DesignSettings.m_TextSize[ i ].y );
 SET_MILS_CELL( i, COL_TEXT_THICKNESS, aCfg->m_DesignSettings.m_TextThickness[ i ] );
 m_graphicsGrid->SetCellValue( i, COL_TEXT_ITALIC, aCfg->m_DesignSettings.m_TextItalic[ i ] ? wxT( "1" ) : wxT( "" ) );
 
 auto attr = new wxGridCellAttr;
 attr->SetRenderer( new wxGridCellBoolRenderer() );
 attr->SetReadOnly(); // not really; we delegate interactivity to GRID_TRICKS
 attr->SetAlignment( wxALIGN_CENTER, wxALIGN_CENTER );
 m_graphicsGrid->SetAttr( i, COL_TEXT_ITALIC, attr );
 }
 }
 
 // Footprint defaults
 m_textItemsGrid->GetTable()->DeleteRows( 0, m_textItemsGrid->GetNumberRows() );
 m_textItemsGrid->GetTable()->AppendRows( aCfg->m_DesignSettings.m_DefaultFPTextItems.size() );
 
 for( size_t i = 0; i < aCfg->m_DesignSettings.m_DefaultFPTextItems.size(); ++i )
 {
 TEXT_ITEM_INFO item = aCfg->m_DesignSettings.m_DefaultFPTextItems[i];
 
 m_textItemsGrid->GetTable()->SetValue( i, 0, item.m_Text );
 m_textItemsGrid->GetTable()->SetValueAsBool( i, 1, item.m_Visible );
 m_textItemsGrid->GetTable()->SetValueAsLong( i, 2, item.m_Layer );
 }
 
 for( int col = 0; col < m_graphicsGrid->GetNumberCols(); col++ )
 {
 // Set the minimal width to the column label size.
 m_graphicsGrid->SetColMinimalWidth( col, m_graphicsGrid->GetVisibleWidth( col, true, false ) );
 
 // Set the width to see the full contents
 if( m_graphicsGrid->IsColShown( col ) )
 m_graphicsGrid->SetColSize( col, m_graphicsGrid->GetVisibleWidth( col, true, true, true ) );
 }
 
 m_graphicsGrid->SetRowLabelSize( m_graphicsGrid->GetVisibleWidth( -1, true, true, true ) );
 
 Layout();
}

References COL_LINE_THICKNESS, COL_TEXT_HEIGHT, COL_TEXT_ITALIC, COL_TEXT_THICKNESS, COL_TEXT_WIDTH, DISABLE_CELL, WX_GRID::GetVisibleWidth(), BOARD_DESIGN_SETTINGS::m_DefaultFPTextItems, FOOTPRINT_EDITOR_SETTINGS::m_DesignSettings, PANEL_FP_EDITOR_DEFAULTS_BASE::m_graphicsGrid, TEXT_ITEM_INFO::m_Layer, BOARD_DESIGN_SETTINGS::m_LineThickness, TEXT_ITEM_INFO::m_Text, BOARD_DESIGN_SETTINGS::m_TextItalic, PANEL_FP_EDITOR_DEFAULTS_BASE::m_textItemsGrid, BOARD_DESIGN_SETTINGS::m_TextSize, BOARD_DESIGN_SETTINGS::m_TextThickness, TEXT_ITEM_INFO::m_Visible, ROW_COUNT, ROW_COURTYARD, ROW_EDGES, and SET_MILS_CELL.

Referenced by ResetPanel(), and TransferDataToWindow().

◆ OnAddTextItem()

void PANEL_FP_EDITOR_DEFAULTS::OnAddTextItem ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PANEL_FP_EDITOR_DEFAULTS_BASE.

Definition at line 388 of file panel_fp_editor_defaults.cpp.

{
 if( !m_textItemsGrid->CommitPendingChanges() || !m_graphicsGrid->CommitPendingChanges() )
 return;
 
 wxGridTableBase* table = m_textItemsGrid->GetTable();
 
 int newRow = m_textItemsGrid->GetNumberRows();
 table->AppendRows( 1 );
 table->SetValueAsBool( newRow, 1, table->GetValueAsBool( newRow - 1, 1 ) );
 table->SetValueAsLong( newRow, 2, table->GetValueAsLong( newRow - 1, 2 ) );
 
 m_textItemsGrid->MakeCellVisible( newRow, 0 );
 m_textItemsGrid->SetGridCursor( newRow, 0 );
 
 m_textItemsGrid->EnableCellEditControl( true );
 m_textItemsGrid->ShowCellEditControl();
}

References WX_GRID::CommitPendingChanges(), PANEL_FP_EDITOR_DEFAULTS_BASE::m_graphicsGrid, and PANEL_FP_EDITOR_DEFAULTS_BASE::m_textItemsGrid.

◆ OnDeleteTextItem()

void PANEL_FP_EDITOR_DEFAULTS::OnDeleteTextItem ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PANEL_FP_EDITOR_DEFAULTS_BASE.

Definition at line 408 of file panel_fp_editor_defaults.cpp.

{
 wxArrayInt selectedRows = m_textItemsGrid->GetSelectedRows();
 
 if( selectedRows.empty() && m_textItemsGrid->GetGridCursorRow() >= 0 )
 selectedRows.push_back( m_textItemsGrid->GetGridCursorRow() );
 
 if( selectedRows.empty() )
 return;
 
 for( int row : selectedRows )
 {
 if( row < 2 )
 {
 DisplayError( nullptr, _( "Reference and value are mandatory." ) );
 return;
 }
 }
 
 if( !m_textItemsGrid->CommitPendingChanges() || !m_graphicsGrid->CommitPendingChanges() )
 return;
 
 // Reverse sort so deleting a row doesn't change the indexes of the other rows.
 selectedRows.Sort( []( int* first, int* second ) { return *second - *first; } );
 
 for( int row : selectedRows )
 {
 m_textItemsGrid->GetTable()->DeleteRows( row, 1 );
 
 if( m_textItemsGrid->GetNumberRows() > 0 )
 {
 m_textItemsGrid->MakeCellVisible( std::max( 0, row-1 ),
 m_textItemsGrid->GetGridCursorCol() );
 m_textItemsGrid->SetGridCursor( std::max( 0, row-1 ),
 m_textItemsGrid->GetGridCursorCol() );
 }
 }
}

References _, WX_GRID::CommitPendingChanges(), DisplayError(), PANEL_FP_EDITOR_DEFAULTS_BASE::m_graphicsGrid, and PANEL_FP_EDITOR_DEFAULTS_BASE::m_textItemsGrid.

◆ OnGridSize()

virtual void PANEL_FP_EDITOR_DEFAULTS_BASE::OnGridSize ( wxSizeEvent & event )

inlineprotectedvirtualinherited

Definition at line 50 of file panel_fp_editor_defaults_base.h.

50{ event.Skip(); }

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

◆ ResetPanel()

void PANEL_FP_EDITOR_DEFAULTS::ResetPanel ( )

overridevirtual

Reset the contents of this panel.

Implements RESETTABLE_PANEL.

Definition at line 448 of file panel_fp_editor_defaults.cpp.

{
 FOOTPRINT_EDITOR_SETTINGS cfg;
 cfg.Load(); // Loading without a file will init to defaults
 
 loadFPSettings( &cfg );
}

References JSON_SETTINGS::Load(), and loadFPSettings().

◆ Show()

bool PANEL_FP_EDITOR_DEFAULTS::Show ( bool aShow )

overrideprivate

Definition at line 295 of file panel_fp_editor_defaults.cpp.

{
 bool retVal = wxPanel::Show( aShow );
 
 if( aShow )
 {
 // These *should* work in the constructor, and indeed they do if this panel is the
 // first displayed. However, on OSX 3.0.5 (at least), if another panel is displayed
 // first then the icons will be blank unless they're set here.
 m_bpAdd->SetBitmap( KiBitmap( BITMAPS::small_plus ) );
 m_bpDelete->SetBitmap( KiBitmap( BITMAPS::small_trash ) );
 }
 
 if( aShow && m_firstShow )
 {
 m_graphicsGrid->SetColSize( 0, m_graphicsGrid->GetColSize( 0 ) + 1 );
 m_firstShow = false;
 }
 
 return retVal;
}

References KiBitmap(), PANEL_FP_EDITOR_DEFAULTS_BASE::m_bpAdd, PANEL_FP_EDITOR_DEFAULTS_BASE::m_bpDelete, m_firstShow, PANEL_FP_EDITOR_DEFAULTS_BASE::m_graphicsGrid, small_plus, and small_trash.

◆ TransferDataFromWindow()

bool PANEL_FP_EDITOR_DEFAULTS::TransferDataFromWindow ( )

override

Definition at line 348 of file panel_fp_editor_defaults.cpp.

{
 if( !validateData() )
 return false;
 
 SETTINGS_MANAGER& mgr = Pgm().GetSettingsManager();
 FOOTPRINT_EDITOR_SETTINGS* cfg = mgr.GetAppSettings<FOOTPRINT_EDITOR_SETTINGS>();
 
 for( int i = 0; i < ROW_COUNT; ++i )
 {
 cfg->m_DesignSettings.m_LineThickness[ i ] = getGridValue( i, COL_LINE_THICKNESS );
 
 if( i == ROW_EDGES || i == ROW_COURTYARD )
 continue;
 
 cfg->m_DesignSettings.m_TextSize[ i ] = wxSize( getGridValue( i, COL_TEXT_WIDTH ),
 getGridValue( i, COL_TEXT_HEIGHT ) );
 cfg->m_DesignSettings.m_TextThickness[ i ] = getGridValue( i, COL_TEXT_THICKNESS );
 
 wxString msg = m_graphicsGrid->GetCellValue( i, COL_TEXT_ITALIC );
 cfg->m_DesignSettings.m_TextItalic[ i ] = wxGridCellBoolEditor::IsTrueValue( msg );
 }
 
 // Footprint defaults
 wxGridTableBase* table = m_textItemsGrid->GetTable();
 cfg->m_DesignSettings.m_DefaultFPTextItems.clear();
 
 for( int i = 0; i < m_textItemsGrid->GetNumberRows(); ++i )
 {
 wxString text = table->GetValue( i, 0 );
 bool visible = table->GetValueAsBool( i, 1 );
 int layer = (int) table->GetValueAsLong( i, 2 );
 
 cfg->m_DesignSettings.m_DefaultFPTextItems.emplace_back( text, visible, layer );
 }
 
 return true;
}

References COL_LINE_THICKNESS, COL_TEXT_HEIGHT, COL_TEXT_ITALIC, COL_TEXT_THICKNESS, COL_TEXT_WIDTH, SETTINGS_MANAGER::GetAppSettings(), getGridValue(), BOARD_DESIGN_SETTINGS::m_DefaultFPTextItems, FOOTPRINT_EDITOR_SETTINGS::m_DesignSettings, PANEL_FP_EDITOR_DEFAULTS_BASE::m_graphicsGrid, BOARD_DESIGN_SETTINGS::m_LineThickness, BOARD_DESIGN_SETTINGS::m_TextItalic, PANEL_FP_EDITOR_DEFAULTS_BASE::m_textItemsGrid, BOARD_DESIGN_SETTINGS::m_TextSize, BOARD_DESIGN_SETTINGS::m_TextThickness, Pgm(), ROW_COUNT, ROW_COURTYARD, ROW_EDGES, text, and validateData().

◆ TransferDataToWindow()

bool PANEL_FP_EDITOR_DEFAULTS::TransferDataToWindow ( )

override

Definition at line 284 of file panel_fp_editor_defaults.cpp.

{
 SETTINGS_MANAGER& mgr = Pgm().GetSettingsManager();
 FOOTPRINT_EDITOR_SETTINGS* cfg = mgr.GetAppSettings<FOOTPRINT_EDITOR_SETTINGS>();
 
 loadFPSettings( cfg );
 
 return true;
}

References SETTINGS_MANAGER::GetAppSettings(), loadFPSettings(), and Pgm().

◆ validateData()

bool PANEL_FP_EDITOR_DEFAULTS::validateData ( )

private

Definition at line 324 of file panel_fp_editor_defaults.cpp.

{
 if( !m_textItemsGrid->CommitPendingChanges() || !m_graphicsGrid->CommitPendingChanges() )
 return false;
 
 // Test text parameters.
 for( int row : { ROW_SILK, ROW_COPPER, ROW_FAB, ROW_OTHERS } )
 {
 int textSize = std::min( getGridValue( row, COL_TEXT_WIDTH ),
 getGridValue( row, COL_TEXT_HEIGHT ) );
 
 if( getGridValue( row, COL_TEXT_THICKNESS ) > textSize / 4 )
 {
 wxString msg = _( "Text will not be readable with a thickness greater than\n"
 "1/4 its width or height." );
 m_parent->SetError( msg, this, m_graphicsGrid, row, COL_TEXT_THICKNESS );
 return false;
 }
 }
 
 return true;
}