#include <panel_fp_editor_defaults.h>

Inheritance diagram for PANEL_FP_EDITOR_DEFAULTS:

Public Member Functions
	PANEL_FP_EDITOR_DEFAULTS (FOOTPRINT_EDIT_FRAME aFrame, PAGED_DIALOG aParent)

	~PANEL_FP_EDITOR_DEFAULTS () override

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_layerClassesGrid

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

bool	TransferDataToWindow () override

bool	TransferDataFromWindow () override

Private Attributes
BOARD_DESIGN_SETTINGS	m_brdSettings

FOOTPRINT_EDIT_FRAME *	m_frame

PAGED_DIALOG *	m_parent

bool	m_firstShow = true

Detailed Description

Definition at line 30 of file panel_fp_editor_defaults.h.

Constructor & Destructor Documentation

◆ PANEL_FP_EDITOR_DEFAULTS()

PANEL_FP_EDITOR_DEFAULTS::PANEL_FP_EDITOR_DEFAULTS	(	FOOTPRINT_EDIT_FRAME *	aFrame,
		PAGED_DIALOG *	aParent
	)

Definition at line 170 of file panel_fp_editor_defaults.cpp.

                                                                            :
         PANEL_FP_EDITOR_DEFAULTS_BASE( aParent->GetTreebook() ),
         m_brdSettings( aFrame->GetDesignSettings() ),
         m_frame( aFrame ),
         m_parent( aParent )
 {
     m_textItemsGrid->SetDefaultRowSize( m_textItemsGrid->GetDefaultRowSize() + 4 );
     m_layerClassesGrid->SetDefaultRowSize( m_layerClassesGrid->GetDefaultRowSize() + 4 );
 
     m_textItemsGrid->SetTable( new TEXT_ITEMS_GRID_TABLE(), true );
 
     wxGridCellAttr* attr = new wxGridCellAttr;
     attr->SetRenderer( new wxGridCellBoolRenderer() );
     attr->SetReadOnly();    // not really; we delegate interactivity to GRID_TRICKS
     m_textItemsGrid->SetColAttr( 1, attr );
 
     attr = new wxGridCellAttr;
     attr->SetRenderer( new GRID_CELL_LAYER_RENDERER( m_frame ) );
     attr->SetEditor( new GRID_CELL_LAYER_SELECTOR( m_frame, {} ) );
     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_layerClassesGrid->AppendRows( 1 );
     m_layerClassesGrid->DeleteRows( m_layerClassesGrid->GetNumberRows() - 1, 1 );
 
     m_layerClassesGrid->PushEventHandler( new GRID_TRICKS( m_layerClassesGrid ) );
 
     wxFont infoFont = wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT );
     infoFont.SetSymbolicSize( wxFONTSIZE_SMALL );
     m_staticTextInfo->SetFont( infoFont );
 }

References m_frame, PANEL_FP_EDITOR_DEFAULTS_BASE::m_layerClassesGrid, PANEL_FP_EDITOR_DEFAULTS_BASE::m_staticTextInfo, PANEL_FP_EDITOR_DEFAULTS_BASE::m_textItemsGrid, and WX_GRID::SetTable().

◆ ~PANEL_FP_EDITOR_DEFAULTS()

PANEL_FP_EDITOR_DEFAULTS::~PANEL_FP_EDITOR_DEFAULTS ( )

override

Definition at line 205 of file panel_fp_editor_defaults.cpp.

 {
     // destroy GRID_TRICKS before m_layerClassesGrid.
     m_layerClassesGrid->PopEventHandler( true );
 }

References PANEL_FP_EDITOR_DEFAULTS_BASE::m_layerClassesGrid.

Member Function Documentation

◆ getGridValue()

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

private

Definition at line 301 of file panel_fp_editor_defaults.cpp.

 {
     return ValueFromString( m_frame->GetUserUnits(),
                             m_layerClassesGrid->GetCellValue( aRow, aCol ) );
 }

References EDA_BASE_FRAME::GetUserUnits(), m_frame, PANEL_FP_EDITOR_DEFAULTS_BASE::m_layerClassesGrid, and ValueFromString().

Referenced by TransferDataFromWindow(), and validateData().

◆ OnAddTextItem()

void PANEL_FP_EDITOR_DEFAULTS::OnAddTextItem ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PANEL_FP_EDITOR_DEFAULTS_BASE.

Definition at line 374 of file panel_fp_editor_defaults.cpp.

 {
     if( !m_textItemsGrid->CommitPendingChanges() || !m_layerClassesGrid->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_layerClassesGrid, 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 394 of file panel_fp_editor_defaults.cpp.

 {
     if( !m_textItemsGrid->CommitPendingChanges() || !m_layerClassesGrid->CommitPendingChanges() )
         return;
 
     int curRow = m_textItemsGrid->GetGridCursorRow();
 
     if( curRow < 2 )    // First two rows are required
         return;
 
     m_textItemsGrid->GetTable()->DeleteRows( curRow, 1 );
 
     curRow = std::max( 0, curRow - 1 );
     m_textItemsGrid->MakeCellVisible( curRow, m_textItemsGrid->GetGridCursorCol() );
     m_textItemsGrid->SetGridCursor( curRow, m_textItemsGrid->GetGridCursorCol() );
 }

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

◆ OnGridSize()

virtual void PANEL_FP_EDITOR_DEFAULTS_BASE::OnGridSize ( wxSizeEvent & event )

inlineprotectedvirtualinherited

Definition at line 49 of file panel_fp_editor_defaults_base.h.

49 { 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().

◆ Show()

bool PANEL_FP_EDITOR_DEFAULTS::Show ( bool aShow )

overrideprivate

Definition at line 278 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_layerClassesGrid->SetColSize( 0, m_layerClassesGrid->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_layerClassesGrid, small_plus, and small_trash.

◆ TransferDataFromWindow()

bool PANEL_FP_EDITOR_DEFAULTS::TransferDataFromWindow ( )

overrideprivate

Definition at line 332 of file panel_fp_editor_defaults.cpp.

 {
     if( !validateData() )
         return false;
 
     for( int i = 0; i < ROW_COUNT; ++i )
     {
         m_brdSettings.m_LineThickness[ i ] = getGridValue( i, COL_LINE_THICKNESS );
 
         if( i == ROW_EDGES || i == ROW_COURTYARD )
             continue;
 
         m_brdSettings.m_TextSize[ i ] = wxSize( getGridValue( i, COL_TEXT_WIDTH ),
                                                 getGridValue( i, COL_TEXT_HEIGHT ) );
         m_brdSettings.m_TextThickness[ i ] = getGridValue( i, COL_TEXT_THICKNESS );
 
         wxString msg = m_layerClassesGrid->GetCellValue( i, COL_TEXT_ITALIC );
         m_brdSettings.m_TextItalic[ i ] = wxGridCellBoolEditor::IsTrueValue( msg );
     }
 
     // Footprint defaults
     wxGridTableBase* table = m_textItemsGrid->GetTable();
     m_brdSettings.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 );
 
         m_brdSettings.m_DefaultFPTextItems.emplace_back( text, visible, layer );
     }
 
     m_frame->GetDesignSettings() = m_brdSettings;
 
     if( FOOTPRINT_EDITOR_SETTINGS* cfg = m_frame->GetSettings() )
         cfg->m_DesignSettings = m_brdSettings;
 
     return true;
 }

References COL_LINE_THICKNESS, COL_TEXT_HEIGHT, COL_TEXT_ITALIC, COL_TEXT_THICKNESS, COL_TEXT_WIDTH, FOOTPRINT_EDIT_FRAME::GetDesignSettings(), getGridValue(), FOOTPRINT_EDIT_FRAME::GetSettings(), m_brdSettings, BOARD_DESIGN_SETTINGS::m_DefaultFPTextItems, m_frame, PANEL_FP_EDITOR_DEFAULTS_BASE::m_layerClassesGrid, 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, ROW_COUNT, ROW_COURTYARD, ROW_EDGES, text, and validateData().

◆ TransferDataToWindow()

bool PANEL_FP_EDITOR_DEFAULTS::TransferDataToWindow ( )

overrideprivate

Definition at line 212 of file panel_fp_editor_defaults.cpp.

 {
     wxColour disabledColour = wxSystemSettings::GetColour( wxSYS_COLOUR_BACKGROUND );
 
 #define SET_MILS_CELL( row, col, val ) \
     m_layerClassesGrid->SetCellValue( row, col, StringFromValue( m_frame->GetUserUnits(), val, true ) )
 
 #define DISABLE_CELL( row, col ) \
     m_layerClassesGrid->SetReadOnly( row, col ); m_layerClassesGrid->SetCellBackgroundColour( row, col, disabledColour );
 
     for( int i = 0; i < ROW_COUNT; ++i )
     {
         SET_MILS_CELL( i, COL_LINE_THICKNESS, m_brdSettings.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, m_brdSettings.m_TextSize[ i ].x );
             SET_MILS_CELL( i, COL_TEXT_HEIGHT, m_brdSettings.m_TextSize[ i ].y );
             SET_MILS_CELL( i, COL_TEXT_THICKNESS, m_brdSettings.m_TextThickness[ i ] );
             m_layerClassesGrid->SetCellValue( i, COL_TEXT_ITALIC, m_brdSettings.m_TextItalic[ i ] ? "1" : "" );
 
             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_layerClassesGrid->SetAttr( i, COL_TEXT_ITALIC, attr );
         }
     }
 
     // Footprint defaults
     m_textItemsGrid->GetTable()->AppendRows( m_brdSettings.m_DefaultFPTextItems.size() );
 
     for( size_t i = 0; i < m_brdSettings.m_DefaultFPTextItems.size(); ++i )
     {
         TEXT_ITEM_INFO item = m_brdSettings.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_layerClassesGrid->GetNumberCols(); col++ )
     {
         // Set the minimal width to the column label size.
         m_layerClassesGrid->SetColMinimalWidth( col, m_layerClassesGrid->GetVisibleWidth( col, true, false, false ) );
 
         // Set the width to see the full contents
         if( m_layerClassesGrid->IsColShown( col ) )
             m_layerClassesGrid->SetColSize( col, m_layerClassesGrid->GetVisibleWidth( col, true, true, true ) );
     }
 
     m_layerClassesGrid->SetRowLabelSize( m_layerClassesGrid->GetVisibleWidth( -1, true, true, true ) );
 
     Layout();
 
     return true;
 }

References COL_LINE_THICKNESS, COL_TEXT_HEIGHT, COL_TEXT_ITALIC, COL_TEXT_THICKNESS, COL_TEXT_WIDTH, DISABLE_CELL, WX_GRID::GetVisibleWidth(), m_brdSettings, BOARD_DESIGN_SETTINGS::m_DefaultFPTextItems, TEXT_ITEM_INFO::m_Layer, PANEL_FP_EDITOR_DEFAULTS_BASE::m_layerClassesGrid, 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.

◆ validateData()

bool PANEL_FP_EDITOR_DEFAULTS::validateData ( )

private

Definition at line 308 of file panel_fp_editor_defaults.cpp.

 {
     if( !m_textItemsGrid->CommitPendingChanges() || !m_layerClassesGrid->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_layerClassesGrid, row, COL_TEXT_THICKNESS );
             return false;
         }
     }
 
     return true;
 }