/* * This program source code file is part of KiCad, a free EDA CAD application. * * Copyright (C) 2013 Jean-Pierre Charras, jp.charras at wanadoo.fr * Copyright (C) 2013 Wayne Stambaugh * 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 #include #include DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES( SCH_EDIT_FRAME* aParent, SCH_ITEM* aTextItem ) : DIALOG_TEXT_PROPERTIES_BASE( aParent ), m_frame( aParent ), m_currentItem( aTextItem ), m_currentText( dynamic_cast( aTextItem ) ), m_textSize( aParent, m_textSizeLabel, m_textSizeCtrl, m_textSizeUnits ), m_borderWidth( aParent, m_borderWidthLabel, m_borderWidthCtrl, m_borderWidthUnits ), m_scintillaTricks( nullptr ), m_helpWindow( nullptr ) { if( aTextItem->Type() == SCH_TEXTBOX_T ) { SetTitle( _( "Text Box Properties" ) ); m_borderColorSwatch->SetDefaultColor( COLOR4D::UNSPECIFIED ); for( const std::pair& typeEntry : lineTypeNames ) m_borderStyleCombo->Append( typeEntry.second.name, KiBitmap( typeEntry.second.bitmap ) ); m_borderStyleCombo->Append( DEFAULT_STYLE ); m_fillColorSwatch->SetDefaultColor( COLOR4D::UNSPECIFIED ); } else { m_spin1->Show( false ); m_spin4->Show( false ); m_borderCheckbox->Show( false ); m_borderWidth.Show( false ); m_borderColorLabel->Show( false ); m_panelBorderColor->Show( false ); m_borderStyleLabel->Show( false ); m_borderStyleCombo->Show( false ); m_fillColorLabel->Show( false ); m_panelFillColor->Show( false ); m_filledCtrl->Show( false ); } m_textCtrl->SetEOLMode( wxSTC_EOL_LF ); m_scintillaTricks = new SCINTILLA_TRICKS( m_textCtrl, wxT( "{}" ), false, [this]() { wxPostEvent( this, wxCommandEvent( wxEVT_COMMAND_BUTTON_CLICKED, wxID_OK ) ); } ); m_textEntrySizer->AddGrowableRow( 0 ); SetInitialFocus( m_textCtrl ); m_separator1->SetIsSeparator(); m_bold->SetIsCheckButton(); m_bold->SetBitmap( KiBitmap( BITMAPS::text_bold ) ); m_italic->SetIsCheckButton(); m_italic->SetBitmap( KiBitmap( BITMAPS::text_italic ) ); m_separator2->SetIsSeparator(); m_spin0->SetIsCheckButton(); m_spin0->SetBitmap( KiBitmap( BITMAPS::text_align_left ) ); m_spin1->SetIsCheckButton(); m_spin1->SetBitmap( KiBitmap( BITMAPS::text_align_center ) ); m_spin2->SetIsCheckButton(); m_spin2->SetBitmap( KiBitmap( BITMAPS::text_align_right ) ); m_spin3->SetIsCheckButton(); m_spin3->SetBitmap( KiBitmap( BITMAPS::text_align_bottom ) ); m_spin4->SetIsCheckButton(); m_spin4->SetBitmap( KiBitmap( BITMAPS::text_align_middle ) ); m_spin5->SetIsCheckButton(); m_spin5->SetBitmap( KiBitmap( BITMAPS::text_align_top ) ); m_separator3->SetIsSeparator(); SetupStandardButtons(); Layout(); m_textCtrl->Bind( wxEVT_STC_CHARADDED, &DIALOG_TEXT_PROPERTIES::onScintillaCharAdded, this ); m_spin0->Bind( wxEVT_BUTTON, &DIALOG_TEXT_PROPERTIES::onSpinButton, this ); m_spin1->Bind( wxEVT_BUTTON, &DIALOG_TEXT_PROPERTIES::onSpinButton, this ); m_spin2->Bind( wxEVT_BUTTON, &DIALOG_TEXT_PROPERTIES::onSpinButton, this ); m_spin3->Bind( wxEVT_BUTTON, &DIALOG_TEXT_PROPERTIES::onSpinButton, this ); m_spin4->Bind( wxEVT_BUTTON, &DIALOG_TEXT_PROPERTIES::onSpinButton, this ); m_spin5->Bind( wxEVT_BUTTON, &DIALOG_TEXT_PROPERTIES::onSpinButton, this ); // Now all widgets have the size fixed, call FinishDialogSettings finishDialogSettings(); } DIALOG_TEXT_PROPERTIES::~DIALOG_TEXT_PROPERTIES() { delete m_scintillaTricks; if( m_helpWindow ) m_helpWindow->Destroy(); } bool DIALOG_TEXT_PROPERTIES::TransferDataToWindow() { if( !wxDialog::TransferDataToWindow() ) return false; SCHEMATIC& schematic = m_frame->Schematic(); // show text variable cross-references in a human-readable format m_textCtrl->SetValue( schematic.ConvertKIIDsToRefs( m_currentText->GetText() ) ); m_fontCtrl->SetFontSelection( m_currentText->GetFont() ); m_textSize.SetValue( m_currentText->GetTextWidth() ); m_bold->Check( m_currentText->IsBold() ); m_italic->Check( m_currentText->IsItalic() ); if( m_currentItem->Type() == SCH_TEXTBOX_T ) { SCH_TEXTBOX* textBox = static_cast( m_currentItem ); m_borderCheckbox->SetValue( textBox->GetWidth() >= 0 ); if( textBox->GetWidth() >= 0 ) m_borderWidth.SetValue( textBox->GetWidth() ); m_borderColorSwatch->SetSwatchColor( textBox->GetStroke().GetColor(), false ); int style = static_cast( textBox->GetStroke().GetPlotStyle() ); if( style == -1 ) m_borderStyleCombo->SetStringSelection( DEFAULT_STYLE ); else if( style < (int) lineTypeNames.size() ) m_borderStyleCombo->SetSelection( style ); else wxFAIL_MSG( "Line type not found in the type lookup map" ); m_borderWidth.Enable( textBox->GetWidth() >= 0 ); m_borderColorLabel->Enable( textBox->GetWidth() >= 0 ); m_borderColorSwatch->Enable( textBox->GetWidth() >= 0 ); m_borderStyleLabel->Enable( textBox->GetWidth() >= 0 ); m_borderStyleCombo->Enable( textBox->GetWidth() >= 0 ); m_filledCtrl->SetValue( textBox->IsFilled() ); m_fillColorSwatch->SetSwatchColor( textBox->GetFillColor(), false ); m_fillColorLabel->Enable( textBox->IsFilled() ); m_fillColorSwatch->Enable( textBox->IsFilled() ); if( m_currentText->GetTextAngle() == ANGLE_VERTICAL ) { switch( m_currentText->GetHorizJustify() ) { case GR_TEXT_H_ALIGN_LEFT: m_spin3->Check(); break; case GR_TEXT_H_ALIGN_CENTER: m_spin4->Check(); break; case GR_TEXT_H_ALIGN_RIGHT: m_spin5->Check(); break; } } else { switch( m_currentText->GetHorizJustify() ) { case GR_TEXT_H_ALIGN_LEFT: m_spin0->Check(); break; case GR_TEXT_H_ALIGN_CENTER: m_spin1->Check(); break; case GR_TEXT_H_ALIGN_RIGHT: m_spin2->Check(); break; } } } else { TEXT_SPIN_STYLE spin = static_cast( m_currentItem )->GetTextSpinStyle(); switch( spin ) { case TEXT_SPIN_STYLE::RIGHT: m_spin0->Check( true ); break; case TEXT_SPIN_STYLE::LEFT: m_spin2->Check( true ); break; case TEXT_SPIN_STYLE::UP: m_spin3->Check( true ); break; case TEXT_SPIN_STYLE::BOTTOM: m_spin5->Check( true ); break; } } return true; } void DIALOG_TEXT_PROPERTIES::onBorderChecked( wxCommandEvent& event ) { bool border = m_borderCheckbox->GetValue(); if( border && m_borderWidth.GetValue() < 0 ) m_borderWidth.SetValue( m_frame->eeconfig()->m_Drawing.default_line_thickness ); m_borderWidth.Enable( border ); m_borderColorLabel->Enable( border ); m_borderColorSwatch->Enable( border ); m_borderStyleLabel->Enable( border ); m_borderStyleCombo->Enable( border ); } void DIALOG_TEXT_PROPERTIES::onFillChecked( wxCommandEvent& event ) { bool fill = m_filledCtrl->GetValue(); m_fillColorLabel->Enable( fill ); m_fillColorSwatch->Enable( fill ); } void DIALOG_TEXT_PROPERTIES::onScintillaCharAdded( wxStyledTextEvent &aEvent ) { wxStyledTextCtrl* te = m_textCtrl; wxArrayString autocompleteTokens; int text_pos = te->GetCurrentPos(); int start = te->WordStartPosition( text_pos, true ); wxString partial; auto textVarRef = [&]( int pos ) { return pos >= 2 && te->GetCharAt( pos-2 ) == '$' && te->GetCharAt( pos-1 ) == '{'; }; // Check for cross-reference if( start > 1 && te->GetCharAt( start-1 ) == ':' ) { int refStart = te->WordStartPosition( start-1, true ); if( textVarRef( refStart ) ) { partial = te->GetRange( start+1, text_pos ); wxString ref = te->GetRange( refStart, start-1 ); SCH_SHEET_LIST sheets = m_frame->Schematic().GetSheets(); SCH_REFERENCE_LIST refs; SCH_SYMBOL* refSymbol = nullptr; sheets.GetSymbols( refs ); for( size_t jj = 0; jj < refs.GetCount(); jj++ ) { if( refs[ jj ].GetSymbol()->GetRef( &refs[ jj ].GetSheetPath(), true ) == ref ) { refSymbol = refs[ jj ].GetSymbol(); break; } } if( refSymbol ) refSymbol->GetContextualTextVars( &autocompleteTokens ); } } else if( textVarRef( start ) ) { partial = te->GetTextRange( start, text_pos ); SCHEMATIC* schematic = m_currentItem->Schematic(); if( schematic && schematic->CurrentSheet().Last() ) schematic->CurrentSheet().Last()->GetContextualTextVars( &autocompleteTokens ); for( std::pair entry : Prj().GetTextVars() ) autocompleteTokens.push_back( entry.first ); } m_scintillaTricks->DoAutocomplete( partial, autocompleteTokens ); m_textCtrl->SetFocus(); } void DIALOG_TEXT_PROPERTIES::onSpinButton( wxCommandEvent& aEvent ) { for( BITMAP_BUTTON* btn : { m_spin0, m_spin1, m_spin2, m_spin3, m_spin4, m_spin5 } ) { if( btn->IsChecked() && btn != aEvent.GetEventObject() ) btn->Check( false ); } } bool DIALOG_TEXT_PROPERTIES::TransferDataFromWindow() { if( !wxDialog::TransferDataFromWindow() ) return false; // Don't allow text to disappear; it can be difficult to correct if you can't select it if( !m_textSize.Validate( 0.01, 1000.0, EDA_UNITS::MILLIMETRES ) ) return false; wxString text; /* save old text in undo list if not already in edit */ if( m_currentItem->GetEditFlags() == 0 ) { m_frame->SaveCopyInUndoList( m_frame->GetScreen(), m_currentItem, UNDO_REDO::CHANGED, false, false ); } m_frame->GetCanvas()->Refresh(); // convert any text variable cross-references to their UUIDs text = m_frame->Schematic().ConvertRefsToKIIDs( m_textCtrl->GetValue() ); if( !text.IsEmpty() ) { #ifdef __WXMAC__ // On macOS CTRL+Enter produces '\r' instead of '\n' regardless of EOL setting text.Replace( "\r", "\n" ); #endif m_currentText->SetText( text ); } else if( !m_currentItem->IsNew() ) { DisplayError( this, _( "Text can not be empty." ) ); return false; } if( m_currentText->GetTextWidth() != m_textSize.GetValue() ) m_currentText->SetTextSize( wxSize( m_textSize.GetValue(), m_textSize.GetValue() ) ); if( m_fontCtrl->HaveFontSelection() ) { m_currentText->SetFont( m_fontCtrl->GetFontSelection( m_bold->IsChecked(), m_italic->IsChecked() ) ); } if( m_bold->IsChecked() != m_currentText->IsBold() ) { if( m_bold->IsChecked() ) { m_currentText->SetBold( true ); m_currentText->SetTextThickness( GetPenSizeForBold( m_currentText->GetTextWidth() ) ); } else { m_currentText->SetBold( false ); m_currentText->SetTextThickness( 0 ); // Use default pen width } } m_currentText->SetItalic( m_italic->IsChecked() ); if( m_currentItem->Type() == SCH_TEXT_T ) { TEXT_SPIN_STYLE selectedSpinStyle= TEXT_SPIN_STYLE::LEFT; if( m_spin0->IsChecked() ) selectedSpinStyle = TEXT_SPIN_STYLE::RIGHT; else if( m_spin2->IsChecked() ) selectedSpinStyle = TEXT_SPIN_STYLE::LEFT; else if( m_spin3->IsChecked() ) selectedSpinStyle = TEXT_SPIN_STYLE::UP; else if( m_spin5->IsChecked() ) selectedSpinStyle = TEXT_SPIN_STYLE::BOTTOM; static_cast( m_currentItem )->SetTextSpinStyle( selectedSpinStyle ); } else { SCH_TEXTBOX* textBox = static_cast( m_currentItem ); if( m_spin0->IsChecked() ) { m_currentText->SetTextAngle( ANGLE_HORIZONTAL ); m_currentText->SetHorizJustify( GR_TEXT_H_ALIGN_LEFT ); } else if( m_spin1->IsChecked() ) { m_currentText->SetTextAngle( ANGLE_HORIZONTAL ); m_currentText->SetHorizJustify( GR_TEXT_H_ALIGN_CENTER ); } else if( m_spin2->IsChecked() ) { m_currentText->SetTextAngle( ANGLE_HORIZONTAL ); m_currentText->SetHorizJustify( GR_TEXT_H_ALIGN_RIGHT ); } else if( m_spin3->IsChecked() ) { m_currentText->SetTextAngle( ANGLE_VERTICAL ); m_currentText->SetHorizJustify( GR_TEXT_H_ALIGN_LEFT ); } else if( m_spin4->IsChecked() ) { m_currentText->SetTextAngle( ANGLE_VERTICAL ); m_currentText->SetHorizJustify( GR_TEXT_H_ALIGN_CENTER ); } else if( m_spin5->IsChecked() ) { m_currentText->SetTextAngle( ANGLE_VERTICAL ); m_currentText->SetHorizJustify( GR_TEXT_H_ALIGN_RIGHT ); } STROKE_PARAMS stroke = textBox->GetStroke(); if( m_borderCheckbox->GetValue() ) { if( !m_borderWidth.IsIndeterminate() ) stroke.SetWidth( m_borderWidth.GetValue() ); } else { stroke.SetWidth( -1 ); } auto it = lineTypeNames.begin(); std::advance( it, m_borderStyleCombo->GetSelection() ); if( it == lineTypeNames.end() ) stroke.SetPlotStyle( PLOT_DASH_TYPE::DEFAULT ); else stroke.SetPlotStyle( it->first ); stroke.SetColor( m_borderColorSwatch->GetSwatchColor() ); textBox->SetStroke( stroke ); textBox->SetFillMode( m_filledCtrl->GetValue() ? FILL_T::FILLED_WITH_COLOR : FILL_T::NO_FILL ); textBox->SetFillColor( m_fillColorSwatch->GetSwatchColor() ); } m_frame->UpdateItem( m_currentItem, false, true ); m_frame->GetCanvas()->Refresh(); m_frame->OnModify(); return true; } void DIALOG_TEXT_PROPERTIES::OnFormattingHelp( wxHyperlinkEvent& aEvent ) { m_helpWindow = SCH_TEXT::ShowSyntaxHelp( this ); } void DIALOG_TEXT_PROPERTIES::onMultiLineTCLostFocus( wxFocusEvent& event ) { if( m_scintillaTricks ) m_scintillaTricks->CancelAutocomplete(); event.Skip(); }