/* * This program source code file is part of KiCad, a free EDA CAD application. * * Copyright (C) 1992-2022 KiCad Developers, see AUTHORS.txt for contributors. * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License * as published by the Free Software Foundation; either version 2 * of the License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, you may find one here: * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html * or you may search the http://www.gnu.org website for the version 2 license, * or you may write to the Free Software Foundation, Inc., * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA */ #include #include #include #include #include #include #include #include #include #include #include #include class TEXT_ITEMS_GRID_TABLE : public wxGridTableBase { std::vector m_items; public: TEXT_ITEMS_GRID_TABLE() { } int GetNumberRows() override { return m_items.size(); } int GetNumberCols() override { return 3; } wxString GetColLabelValue( int aCol ) override { switch( aCol ) { case 0: return _( "Text Items" ); case 1: return _( "Show" ); case 2: return _( "Layer" ); default: return wxEmptyString; } } wxString GetRowLabelValue( int aRow ) override { switch( aRow ) { case 0: return _( "Reference designator" ); case 1: return _( "Value" ); default: return wxEmptyString; } } bool CanGetValueAs( int aRow, int aCol, const wxString& aTypeName ) override { switch( aCol ) { case 0: return aTypeName == wxGRID_VALUE_STRING; case 1: return aTypeName == wxGRID_VALUE_BOOL; case 2: return aTypeName == wxGRID_VALUE_NUMBER; default: wxFAIL; return false; } } bool CanSetValueAs( int aRow, int aCol, const wxString& aTypeName ) override { return CanGetValueAs( aRow, aCol, aTypeName ); } wxString GetValue( int row, int col ) override { return m_items[row].m_Text; } void SetValue( int row, int col, const wxString& value ) override { if( col == 0 ) m_items[row].m_Text = value; } bool GetValueAsBool( int row, int col ) override { return m_items[row].m_Visible; } void SetValueAsBool( int row, int col, bool value ) override { if( col == 1 ) m_items[row].m_Visible = value; } long GetValueAsLong( int row, int col ) override { return m_items[row].m_Layer; } void SetValueAsLong( int row, int col, long value ) override { if( col == 2 ) m_items[row].m_Layer = (int) value; } bool AppendRows( size_t aNumRows = 1 ) override { for( size_t i = 0; i < aNumRows; ++i ) m_items.emplace_back( wxT( "" ), true, F_SilkS ); if( GetView() ) { wxGridTableMessage msg( this, wxGRIDTABLE_NOTIFY_ROWS_APPENDED, aNumRows ); GetView()->ProcessTableMessage( msg ); } return true; } bool DeleteRows( size_t aPos, size_t aNumRows ) override { // aPos may be a large positive, e.g. size_t(-1), and the sum of // aPos+aNumRows may wrap here, so both ends of the range are tested. if( aPos < m_items.size() && aPos + aNumRows <= m_items.size() ) { m_items.erase( m_items.begin() + aPos, m_items.begin() + aPos + aNumRows ); if( GetView() ) { wxGridTableMessage msg( this, wxGRIDTABLE_NOTIFY_ROWS_DELETED, aPos, aNumRows ); GetView()->ProcessTableMessage( msg ); } return true; } return false; } }; // Columns of graphics grid enum { COL_LINE_THICKNESS = 0, COL_TEXT_WIDTH, COL_TEXT_HEIGHT, COL_TEXT_THICKNESS, COL_TEXT_ITALIC }; enum { ROW_SILK = 0, ROW_COPPER, ROW_EDGES, ROW_COURTYARD, ROW_FAB, ROW_OTHERS, ROW_COUNT }; PANEL_FP_EDITOR_DEFAULTS::PANEL_FP_EDITOR_DEFAULTS( wxWindow* aParent, UNITS_PROVIDER* aUnitsProvider ) : PANEL_FP_EDITOR_DEFAULTS_BASE( aParent ) { m_parent = dynamic_cast( aParent->GetParent()->GetParent() ); wxASSERT_MSG( m_parent, wxS( "Incorrect parent window passed" ) ); m_textItemsGrid->SetDefaultRowSize( m_textItemsGrid->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 ); m_graphicsGrid->SetUnitsProvider( aUnitsProvider ); m_graphicsGrid->SetAutoEvalCols( { COL_LINE_THICKNESS, COL_TEXT_WIDTH, COL_TEXT_HEIGHT, COL_TEXT_THICKNESS } ); m_graphicsGrid->SetDefaultRowSize( m_graphicsGrid->GetDefaultRowSize() + 4 ); // 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() ); } PANEL_FP_EDITOR_DEFAULTS::~PANEL_FP_EDITOR_DEFAULTS() { // destroy GRID_TRICKS before grids. m_textItemsGrid->PopEventHandler( true ); m_graphicsGrid->PopEventHandler( true ); } void PANEL_FP_EDITOR_DEFAULTS::loadFPSettings( FOOTPRINT_EDITOR_SETTINGS* aCfg ) { wxColour disabledColour = wxSystemSettings::GetColour( wxSYS_COLOUR_BACKGROUND ); auto disableCell = [&]( int row, int col ) { m_graphicsGrid->SetReadOnly( row, col ); m_graphicsGrid->SetCellBackgroundColour( row, col, disabledColour ); }; for( int i = 0; i < ROW_COUNT; ++i ) { m_graphicsGrid->SetUnitValue( i, COL_LINE_THICKNESS, aCfg->m_DesignSettings.m_LineThickness[ i ] ); if( i == ROW_EDGES || i == ROW_COURTYARD ) { disableCell( i, COL_TEXT_WIDTH ); disableCell( i, COL_TEXT_HEIGHT ); disableCell( i, COL_TEXT_THICKNESS ); disableCell( i, COL_TEXT_ITALIC ); } else { m_graphicsGrid->SetUnitValue( i, COL_TEXT_WIDTH, aCfg->m_DesignSettings.m_TextSize[ i ].x ); m_graphicsGrid->SetUnitValue( i, COL_TEXT_HEIGHT, aCfg->m_DesignSettings.m_TextSize[ i ].y ); m_graphicsGrid->SetUnitValue( 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(); } bool PANEL_FP_EDITOR_DEFAULTS::TransferDataToWindow() { SETTINGS_MANAGER& mgr = Pgm().GetSettingsManager(); FOOTPRINT_EDITOR_SETTINGS* cfg = mgr.GetAppSettings(); loadFPSettings( cfg ); return true; } bool PANEL_FP_EDITOR_DEFAULTS::Show( bool aShow ) { 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; } bool PANEL_FP_EDITOR_DEFAULTS::validateData() { 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( m_graphicsGrid->GetUnitValue( row, COL_TEXT_WIDTH ), m_graphicsGrid->GetUnitValue( row, COL_TEXT_HEIGHT ) ); int thickness = m_graphicsGrid->GetUnitValue( row, COL_TEXT_THICKNESS ); if( 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; } bool PANEL_FP_EDITOR_DEFAULTS::TransferDataFromWindow() { if( !validateData() ) return false; SETTINGS_MANAGER& mgr = Pgm().GetSettingsManager(); BOARD_DESIGN_SETTINGS& cfg = mgr.GetAppSettings()->m_DesignSettings; for( int i = 0; i < ROW_COUNT; ++i ) { cfg.m_LineThickness[ i ] = m_graphicsGrid->GetUnitValue( i, COL_LINE_THICKNESS ); if( i == ROW_EDGES || i == ROW_COURTYARD ) continue; cfg.m_TextSize[i] = VECTOR2I( m_graphicsGrid->GetUnitValue( i, COL_TEXT_WIDTH ), m_graphicsGrid->GetUnitValue( i, COL_TEXT_HEIGHT ) ); cfg.m_TextThickness[ i ] = m_graphicsGrid->GetUnitValue( i, COL_TEXT_THICKNESS ); wxString msg = m_graphicsGrid->GetCellValue( i, COL_TEXT_ITALIC ); cfg.m_TextItalic[ i ] = wxGridCellBoolEditor::IsTrueValue( msg ); } // Footprint defaults wxGridTableBase* table = m_textItemsGrid->GetTable(); cfg.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_DefaultFPTextItems.emplace_back( text, visible, layer ); } return true; } void PANEL_FP_EDITOR_DEFAULTS::OnAddTextItem( wxCommandEvent& event ) { 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(); } void PANEL_FP_EDITOR_DEFAULTS::OnDeleteTextItem( wxCommandEvent& event ) { 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() ); } } } void PANEL_FP_EDITOR_DEFAULTS::ResetPanel() { FOOTPRINT_EDITOR_SETTINGS cfg; cfg.Load(); // Loading without a file will init to defaults loadFPSettings( &cfg ); }