dialog_label_properties.cpp

Go to the documentation of this file.

/*
 * 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 <[email protected]>
 * Copyright The 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, see <https://www.gnu.org/licenses/>.
 */
 
#include <template_fieldnames.h>
#include <widgets/bitmap_button.h>
#include <widgets/font_choice.h>
#include <widgets/std_bitmap_button.h>
#include <widgets/color_swatch.h>
#include <widgets/filter_combobox.h>
#include <settings/color_settings.h>
#include <sch_edit_frame.h>
#include <tool/tool_manager.h>
#include <gr_text.h>
#include <confirm.h>
#include <schematic.h>
#include <dialogs/html_message_box.h>
#include <dialog_label_properties.h>
#include <string_utils.h>
#include <kiface_base.h>
#include <sch_label.h>
#include <sch_commit.h>
 
 
DIALOG_LABEL_PROPERTIES::DIALOG_LABEL_PROPERTIES( SCH_EDIT_FRAME* aParent, SCH_LABEL_BASE* aLabel, bool aNew ) :
        DIALOG_LABEL_PROPERTIES_BASE( aParent ),
        m_Parent( aParent ),
        m_currentLabel( aLabel ),
        m_activeTextEntry( nullptr ),
        m_netNameValidator( true ),
        m_fields( nullptr ),
        m_textSize( aParent, m_textSizeLabel, m_textSizeCtrl, m_textSizeUnits, false ),
        m_helpWindow( nullptr ),
        m_labelList( nullptr )
{
    COLOR_SETTINGS* colorSettings = m_Parent->GetColorSettings();
    COLOR4D         schematicBackground = colorSettings->GetColor( LAYER_SCHEMATIC_BACKGROUND );
 
    std::vector<EMBEDDED_FILES*> embeddedFilesStack;
    embeddedFilesStack.push_back( m_currentLabel->Schematic() );
 
    m_fields = new FIELDS_GRID_TABLE( this, aParent, m_grid, m_currentLabel, embeddedFilesStack );
    m_delayedFocusRow = -1;
    m_delayedFocusColumn = FDC_VALUE;
 
    if( m_currentLabel->Type() == SCH_GLOBAL_LABEL_T || m_currentLabel->Type() == SCH_LABEL_T )
    {
        m_activeTextEntry = m_valueCombo;
        SetInitialFocus( m_valueCombo->GetTextCtrl() );
 
        m_labelSingleLine->Show( false );
        m_valueSingleLine->Show( false );
    }
    else if( m_currentLabel->Type() == SCH_HIER_LABEL_T )
    {
        m_activeTextEntry = m_valueSingleLine;
        SetInitialFocus( m_valueSingleLine );
 
        m_labelCombo->Show( false );
        m_valueCombo->Show( false );
    }
    else if( m_currentLabel->Type() == SCH_DIRECTIVE_LABEL_T )
    {
        SetInitialFocus( m_grid );
        m_delayedFocusRow = 0;
 
        m_labelSingleLine->Show( false );
        m_valueSingleLine->Show( false );
        m_labelCombo->Show( false );
        m_valueCombo->Show( false );
        m_syntaxHelp->Show( false );
        m_textEntrySizer->Show( false );
        m_labelCombo->Show( false );
        m_valueCombo->Show( false );
        m_cbMultiLine->Show( false );
 
        m_textSizeLabel->SetLabel( _( "Pin length:" ) );
    }
 
    if( !aNew )
        m_cbMultiLine->Show( false );
 
    // multiline set of labels can be used only to create new labels
    m_multilineAllowed = aNew && m_cbMultiLine->IsShown();
 
    switch( m_currentLabel->Type() )
    {
    case SCH_GLOBAL_LABEL_T:    SetTitle( _( "Global Label Properties" ) );           break;
    case SCH_HIER_LABEL_T:      SetTitle( _( "Hierarchical Label Properties" ) );     break;
    case SCH_LABEL_T:           SetTitle( _( "Label Properties" ) );                  break;
    case SCH_DIRECTIVE_LABEL_T: SetTitle( _( "Directive Label Properties" ) );        break;
    case SCH_SHEET_PIN_T:       SetTitle( _( "Hierarchical Sheet Pin Properties" ) ); break;
    default:                    UNIMPLEMENTED_FOR( m_currentLabel->GetClass() );      break;
    }
 
    m_grid->SetTable( m_fields );
    m_grid->PushEventHandler( new FIELDS_GRID_TRICKS( m_grid, this, embeddedFilesStack,
                                                      [&]( wxCommandEvent& aEvent )
                                                      {
                                                          OnAddField( aEvent );
                                                      } ) );
    m_grid->SetSelectionMode( wxGrid::wxGridSelectRows );
    m_grid->ShowHideColumns( "0 1 2 3 4 5 6 7" );
    m_shownColumns = m_grid->GetShownColumns();
 
    // Configure button logos
    m_bpAdd->SetBitmap( KiBitmapBundle( BITMAPS::small_plus ) );
    m_bpDelete->SetBitmap( KiBitmapBundle( BITMAPS::small_trash ) );
    m_bpMoveUp->SetBitmap( KiBitmapBundle( BITMAPS::small_up ) );
    m_bpMoveDown->SetBitmap( KiBitmapBundle( BITMAPS::small_down ) );
 
    m_separator1->SetIsSeparator();
 
    m_bold->SetIsCheckButton();
    m_bold->SetBitmap( KiBitmapBundle( BITMAPS::text_bold ) );
    m_italic->SetIsCheckButton();
    m_italic->SetBitmap( KiBitmapBundle( BITMAPS::text_italic ) );
 
    m_separator2->SetIsSeparator();
 
    m_spin0->SetIsRadioButton();
    m_spin1->SetIsRadioButton();
    m_spin2->SetIsRadioButton();
    m_spin3->SetIsRadioButton();
 
    m_separator3->SetIsSeparator();
 
    m_textColorSwatch->SetDefaultColor( COLOR4D::UNSPECIFIED );
    m_textColorSwatch->SetSwatchBackground( schematicBackground );
 
    // Show/hide relevant controls
    if( m_currentLabel->Type() == SCH_GLOBAL_LABEL_T || m_currentLabel->Type() == SCH_HIER_LABEL_T )
    {
        m_dot->Hide();
        m_circle->Hide();
        m_diamond->Hide();
        m_rectangle->Hide();
 
        m_spin0->SetBitmap( KiBitmapBundle( BITMAPS::label_align_left ) );
        m_spin1->SetBitmap( KiBitmapBundle( BITMAPS::label_align_right ) );
        m_spin2->SetBitmap( KiBitmapBundle( BITMAPS::label_align_bottom ) );
        m_spin3->SetBitmap( KiBitmapBundle( BITMAPS::label_align_top ) );
    }
    else if( m_currentLabel->Type() == SCH_DIRECTIVE_LABEL_T )
    {
        m_input->Hide();
        m_output->Hide();
        m_bidirectional->Hide();
        m_triState->Hide();
        m_passive->Hide();
 
        m_fontLabel->SetLabel( _( "Orientation:" ) );
        m_fontCtrl->Hide();
        m_separator1->Hide();
        m_bold->Hide();
        m_italic->Hide();
        m_separator2->Hide();
        m_spin0->SetBitmap( KiBitmapBundle( BITMAPS::pinorient_down ) );
        m_spin1->SetBitmap( KiBitmapBundle( BITMAPS::pinorient_up ) );
        m_spin2->SetBitmap( KiBitmapBundle( BITMAPS::pinorient_right ) );
        m_spin3->SetBitmap( KiBitmapBundle( BITMAPS::pinorient_left ) );
        m_separator3->Hide();
 
        m_formattingGB->Detach( m_fontCtrl );
        m_formattingGB->Detach( m_iconBar );
        m_formattingGB->Add( m_iconBar, wxGBPosition( 0, 1 ), wxGBSpan( 1, 1 ), wxEXPAND | wxRIGHT, 5 );
    }
    else
    {
        m_shapeSizer->Show( false );
 
        m_spin0->SetBitmap( KiBitmapBundle( BITMAPS::text_align_left ) );
        m_spin1->SetBitmap( KiBitmapBundle( BITMAPS::text_align_right ) );
        m_spin2->SetBitmap( KiBitmapBundle( BITMAPS::text_align_bottom ) );
        m_spin3->SetBitmap( KiBitmapBundle( BITMAPS::text_align_top ) );
    }
 
    if( !m_currentLabel->AutoRotateOnPlacementSupported() )
    {
        m_autoRotate->Hide();
        wxSizer* parentSizer = m_autoRotate->GetContainingSizer();
        parentSizer->Detach( m_autoRotate );
        parentSizer->Layout();
    }
 
    SetupStandardButtons();
 
    // DIALOG_SHIM needs a unique hash_key because classname is not sufficient because the
    // various versions have different controls so we want to store sizes for each version.
    m_hash_key = TO_UTF8( GetTitle() );
 
    m_spin0->Bind( wxEVT_BUTTON, &DIALOG_LABEL_PROPERTIES::onSpinButton, this );
    m_spin1->Bind( wxEVT_BUTTON, &DIALOG_LABEL_PROPERTIES::onSpinButton, this );
    m_spin2->Bind( wxEVT_BUTTON, &DIALOG_LABEL_PROPERTIES::onSpinButton, this );
    m_spin3->Bind( wxEVT_BUTTON, &DIALOG_LABEL_PROPERTIES::onSpinButton, this );
 
    // wxFormBuilder doesn't include this event...
    m_grid->Connect( wxEVT_GRID_CELL_CHANGING,
                     wxGridEventHandler( DIALOG_LABEL_PROPERTIES::OnGridCellChanging ), nullptr,
                     this );
 
    // Now all widgets have the size fixed, call FinishDialogSettings
    finishDialogSettings();
}
 
 
DIALOG_LABEL_PROPERTIES::~DIALOG_LABEL_PROPERTIES()
{
    // Prevents crash bug in wxGrid's d'tor
    m_grid->DestroyTable( m_fields );
 
    m_grid->Disconnect( wxEVT_GRID_CELL_CHANGING,
                        wxGridEventHandler( DIALOG_LABEL_PROPERTIES::OnGridCellChanging ), nullptr,
                        this );
 
    // Delete the GRID_TRICKS.
    m_grid->PopEventHandler( true );
 
    if( m_helpWindow )
        m_helpWindow->Destroy();
}
 
 
bool DIALOG_LABEL_PROPERTIES::TransferDataToWindow()
{
    if( !wxDialog::TransferDataToWindow() )
        return false;
 
    // Respond to previously-saved state of multilable checkbox
    wxCommandEvent dummy;
    onMultiLabelCheck( dummy );
 
    wxString text;
 
    if( m_activeTextEntry )
    {
        // show control characters in a human-readable format
        text = UnescapeString( m_currentLabel->GetText() );
 
        // show text variable cross-references in a human-readable format
        text = m_currentLabel->Schematic()->ConvertKIIDsToRefs( text );
    }
 
    if( m_currentLabel->Type() == SCH_GLOBAL_LABEL_T || m_currentLabel->Type() == SCH_LABEL_T )
    {
        // Load the combobox with the existing labels of the same type
        std::set<wxString> existingLabels;
        SCH_SCREENS        allScreens( m_Parent->Schematic().Root() );
 
        for( SCH_SCREEN* screen = allScreens.GetFirst(); screen; screen = allScreens.GetNext() )
        {
            for( SCH_ITEM* item : screen->Items().OfType( m_currentLabel->Type() ) )
            {
                const SCH_LABEL_BASE* label = static_cast<const SCH_LABEL_BASE*>( item );
                existingLabels.insert( UnescapeString( label->GetText() ) );
            }
 
            // Add global power labels from power symbols
            if( m_currentLabel->Type() == SCH_GLOBAL_LABEL_T )
            {
                for( SCH_ITEM* item : screen->Items().OfType( SCH_SYMBOL_LOCATE_POWER_T ) )
                {
                    const SCH_SYMBOL* power = static_cast<const SCH_SYMBOL*>( item );
 
                    // Ensure the symbol has the Power (i.e. equivalent to a global label
                    // before adding its value in list
                    if( power->IsSymbolLikePowerGlobalLabel() )
                    {
                        const SCH_FIELD* valueField = power->GetField( FIELD_T::VALUE );
                        existingLabels.insert( UnescapeString( valueField->GetText() ) );
                    }
                }
            }
 
            // Add local power labels from power symbols
            if( m_currentLabel->Type() == SCH_LABEL_T )
            {
                for( SCH_ITEM* item : screen->Items().OfType( SCH_SYMBOL_LOCATE_POWER_T ) )
                {
                    const SCH_SYMBOL* power = static_cast<const SCH_SYMBOL*>( item );
 
                    // Ensure the symbol has the Power (i.e. equivalent to a local label
                    // before adding its value in list
                    if( power->IsSymbolLikePowerLocalLabel() )
                    {
                        const SCH_FIELD* valueField = power->GetField( FIELD_T::VALUE );
                        existingLabels.insert( UnescapeString( valueField->GetText() ) );
                    }
                }
            }
        }
 
        // Add bus aliases to label list
        for( const std::shared_ptr<BUS_ALIAS>& busAlias : m_Parent->Schematic().GetAllBusAliases() )
            existingLabels.insert( wxT( "{" ) + busAlias->GetName() + wxT( "}" ) );
 
        for( const wxString& label : existingLabels )
            m_existingLabelArray.push_back( label );
 
        m_valueCombo->SetStringList( m_existingLabelArray );
        m_valueCombo->SetSelectedString( text );
    }
    else if( m_activeTextEntry )
    {
        m_activeTextEntry->SetValue( text );
    }
 
    // Push a copy of each field into m_updateFields
    for( SCH_FIELD& field : m_currentLabel->GetFields() )
    {
        SCH_FIELD field_copy( field );
 
        // change offset to be symbol-relative
        field_copy.Offset( -m_currentLabel->GetPosition() );
 
        m_fields->push_back( field_copy );
    }
 
    // notify the grid
    wxGridTableMessage msg( m_fields, wxGRIDTABLE_NOTIFY_ROWS_APPENDED, (int) m_fields->size() );
    m_grid->ProcessTableMessage( msg );
 
    if( m_shapeSizer->AreAnyItemsShown() )
    {
        switch( m_currentLabel->GetShape() )
        {
        case LABEL_FLAG_SHAPE::L_INPUT:       m_input->SetValue( true );         break;
        case LABEL_FLAG_SHAPE::L_OUTPUT:      m_output->SetValue( true );        break;
        case LABEL_FLAG_SHAPE::L_BIDI:        m_bidirectional->SetValue( true ); break;
        case LABEL_FLAG_SHAPE::L_TRISTATE:    m_triState->SetValue( true );      break;
        case LABEL_FLAG_SHAPE::L_UNSPECIFIED: m_passive->SetValue( true );       break;
        case LABEL_FLAG_SHAPE::F_DOT:         m_dot->SetValue( true );           break;
        case LABEL_FLAG_SHAPE::F_ROUND:       m_circle->SetValue( true );        break;
        case LABEL_FLAG_SHAPE::F_DIAMOND:     m_diamond->SetValue( true );       break;
        case LABEL_FLAG_SHAPE::F_RECTANGLE:   m_rectangle->SetValue( true );     break;
        }
    }
 
    m_fontCtrl->SetFontSelection( m_currentLabel->GetFont() );
 
    if( m_currentLabel->Type() == SCH_DIRECTIVE_LABEL_T )
        m_textSize.SetValue( static_cast<SCH_DIRECTIVE_LABEL*>( m_currentLabel )->GetPinLength() );
    else
        m_textSize.SetValue( m_currentLabel->GetTextWidth() );
 
    m_bold->Check( m_currentLabel->IsBold() );
    m_italic->Check( m_currentLabel->IsItalic() );
    m_textColorSwatch->SetSwatchColor( m_currentLabel->GetTextColor(), false );
 
    switch( m_currentLabel->GetSpinStyle() )
    {
    case SPIN_STYLE::RIGHT:  m_spin0->Check( true ); break;
    case SPIN_STYLE::LEFT:   m_spin1->Check( true ); break;
    case SPIN_STYLE::UP:     m_spin2->Check( true ); break;
    case SPIN_STYLE::BOTTOM: m_spin3->Check( true ); break;
    }
 
    if( m_currentLabel->AutoRotateOnPlacementSupported() )
        m_autoRotate->SetValue( m_currentLabel->AutoRotateOnPlacement() );
 
    // Recalculate layout after grid population
    m_grid->Layout();
    Layout();
    GetSizer()->SetSizeHints( this );
 
    wxSize minSize = GetMinSize();
    wxSize curSize = GetSize();
 
    if( curSize.x < minSize.x || curSize.y < minSize.y )
        SetSize( wxSize( std::max( curSize.x, minSize.x ), std::max( curSize.y, minSize.y ) ) );
 
    SendSizeEvent( wxSEND_EVENT_POST );
 
    return true;
}
 
 
void DIALOG_LABEL_PROPERTIES::OnEnterKey( wxCommandEvent& aEvent )
{
    wxPostEvent( this, wxCommandEvent( wxEVT_COMMAND_BUTTON_CLICKED, wxID_OK ) );
}
 
 
void DIALOG_LABEL_PROPERTIES::OnCBValueCharHook( wxKeyEvent& aEvent )
{
    // If the key is WXK_RETURN/WXK_NUMPAD_ENTER because m_valueCombo is the source event, we do not skip
    // the key event because the default action is to show the m_valueCombo dropdown list,
    // and we only want to accept the entered string.
    if(( aEvent.GetKeyCode() == WXK_RETURN ) || (aEvent.GetKeyCode() == WXK_NUMPAD_ENTER))
    {
        wxPostEvent( this, wxCommandEvent( wxEVT_COMMAND_BUTTON_CLICKED, wxID_OK ) );
    }
    else if( aEvent.GetKeyCode() == WXK_SPACE )
    {
        // our FILTER_COMBOBOX uses the space as special command, not wanted here,
        // to open the dropdown list of labels.
        // So just add the space char to the current text, at current insertion point,
        // and do not skip this event
        m_activeTextEntry->WriteText( wxT(" " ) );
    }
    else
    {
        aEvent.Skip();
    }
}
 
 
void DIALOG_LABEL_PROPERTIES::OnValueCharHook( wxKeyEvent& aEvent )
{
    if( aEvent.GetKeyCode() == WXK_TAB )
    {
        if( aEvent.ShiftDown() )
        {
            m_textSizeCtrl->SetFocusFromKbd();
        }
        else if( !m_fields->empty() )
        {
            m_grid->SetFocusFromKbd();
            m_grid->MakeCellVisible( 0, 0 );
            m_grid->SetGridCursor( 0, 0 );
        }
        else
        {
            m_textSizeCtrl->SetFocusFromKbd();
        }
    }
    else
    {
        aEvent.Skip();
    }
}
 
 
static bool positioningChanged( const SCH_FIELD& a, const SCH_FIELD& b )
{
    return a.GetPosition() != b.GetPosition()
            || a.GetHorizJustify() != b.GetHorizJustify()
            || a.GetVertJustify() != b.GetVertJustify()
            || a.GetTextAngle() != b.GetTextAngle();
}
 
 
static bool positioningChanged( FIELDS_GRID_TABLE* a, std::vector<SCH_FIELD>& b )
{
    for( size_t i = 0; i < a->size() && i < b.size(); ++i )
    {
        if( positioningChanged( a->at( i ), b.at( i ) ) )
            return true;
    }
 
    return false;
}
 
 
bool DIALOG_LABEL_PROPERTIES::TransferDataFromWindow()
{
    if( !m_grid->CommitPendingChanges() )
        return false;
 
    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::MM ) )
        return false;
 
    wxString text;
 
    if( m_activeTextEntry )
    {
        // labels need escaping
        text = EscapeString( m_activeTextEntry->GetValue(), CTX_NETNAME );
 
        // convert any text variable cross-references to their UUIDs
        text = m_currentLabel->Schematic()->ConvertRefsToKIIDs( text );
 
#ifdef __WXMAC__
        // On macOS CTRL+Enter produces '\r' instead of '\n' regardless of EOL setting
        text.Replace( wxS( "\r" ), wxS( "\n" ) );
#endif
 
        wxString visibleText = text;
        visibleText.Trim( false ).Trim( true );
 
        if( visibleText.IsEmpty() )
        {
            DisplayError( this, _( "Label can not be empty." ) );
            return false;
        }
    }
 
    // Stage only after validation, because a staged commit that is never pushed leaves the
    // connectivity revision ahead of the published rows
    SCH_COMMIT commit( m_Parent );
 
    /* save old text in undo list if not already in edit */
    if( m_currentLabel->GetEditFlags() == 0 )
        commit.Modify( m_currentLabel, m_Parent->GetScreen() );
 
    m_Parent->GetCanvas()->Refresh();
 
    if( m_activeTextEntry )
        m_currentLabel->SetText( text );
 
    // change all field positions from relative to absolute
    for( SCH_FIELD& field : *m_fields )
    {
        field.Offset( m_currentLabel->GetPosition() );
 
        if( field.GetUntranslatedName() == wxT( "Netclass" ) )
        {
            field.SetLayer( LAYER_NETCLASS_REFS );
        }
        else if( field.GetId() == FIELD_T::INTERSHEET_REFS )
        {
            if( field.IsVisible() != m_Parent->Schematic().Settings().m_IntersheetRefsShow )
            {
                DisplayInfoMessage( this, _( "Intersheet reference visibility is controlled globally from "
                                             "Schematic Setup > General > Formatting" ) );
            }
 
            field.SetLayer( LAYER_INTERSHEET_REFS );
        }
        else
        {
            field.SetLayer( LAYER_FIELDS );
        }
    }
 
    if( positioningChanged( m_fields, m_currentLabel->GetFields() ) )
        m_currentLabel->SetFieldsAutoplaced( AUTOPLACE_NONE );
 
    for( int ii = m_fields->GetNumberRows() - 1; ii >= 0; ii-- )
    {
        SCH_FIELD&      field = m_fields->at( ii );
        const wxString& fieldName = field.GetUntranslatedName();
        const wxString& fieldText = field.GetText();
 
        if( fieldName.IsEmpty() && fieldText.IsEmpty() )
        {
            // delete empty, unnamed fields
            m_fields->erase( m_fields->begin() + ii );
        }
        else if( fieldName == wxT( "Netclass" ) && fieldText.IsEmpty() )
        {
            // delete empty Netclass fields if there are other Netclass fields present
            int netclassFieldCount = 0;
 
            for( int jj = 0; jj < m_fields->GetNumberRows(); ++jj )
            {
                if( m_fields->at( jj ).GetUntranslatedName() == wxT( "Netclass" ) )
                    netclassFieldCount++;
            }
 
            if( netclassFieldCount > 1 )
                m_fields->erase( m_fields->begin() + ii );
        }
        else if( fieldName.IsEmpty() )
        {
            // give non-empty, unnamed fields a name
            field.SetName( _( "untitled" ) );
        }
    }
 
    int ordinal = 42;   // Arbitrarily larger than any mandatory FIELD_T ids.
 
    for( SCH_FIELD& field : *m_fields )
    {
        if( !field.IsMandatory() )
            field.SetOrdinal( ordinal++, FIELD_T::USER );
    }
 
    m_currentLabel->SetFields( *m_fields );
 
    if( m_shapeSizer->AreAnyItemsShown() )
    {
        if(      m_bidirectional->GetValue() ) m_currentLabel->SetShape( LABEL_FLAG_SHAPE::L_BIDI );
        else if( m_input->GetValue() )         m_currentLabel->SetShape( LABEL_FLAG_SHAPE::L_INPUT );
        else if( m_output->GetValue() )        m_currentLabel->SetShape( LABEL_FLAG_SHAPE::L_OUTPUT );
        else if( m_triState->GetValue() )      m_currentLabel->SetShape( LABEL_FLAG_SHAPE::L_TRISTATE );
        else if( m_passive->GetValue() )       m_currentLabel->SetShape( LABEL_FLAG_SHAPE::L_UNSPECIFIED );
        else if( m_dot->GetValue() )           m_currentLabel->SetShape( LABEL_FLAG_SHAPE::F_DOT );
        else if( m_circle->GetValue() )        m_currentLabel->SetShape( LABEL_FLAG_SHAPE::F_ROUND );
        else if( m_diamond->GetValue() )       m_currentLabel->SetShape( LABEL_FLAG_SHAPE::F_DIAMOND );
        else if( m_rectangle->GetValue() )     m_currentLabel->SetShape( LABEL_FLAG_SHAPE::F_RECTANGLE );
    }
 
    if( m_fontCtrl->HaveFontSelection() )
        m_currentLabel->SetFont( m_fontCtrl->GetFontSelection( m_bold->IsChecked(), m_italic->IsChecked() ) );
 
    if( m_currentLabel->Type() == SCH_DIRECTIVE_LABEL_T )
        static_cast<SCH_DIRECTIVE_LABEL*>( m_currentLabel )->SetPinLength( m_textSize.GetIntValue() );
    else if( m_currentLabel->GetTextWidth() != m_textSize.GetIntValue() )
        m_currentLabel->SetTextSize( VECTOR2I( m_textSize.GetIntValue(), m_textSize.GetIntValue() ) );
 
    // Must come after SetTextSize()
    m_currentLabel->SetBold( m_bold->IsChecked() );
    m_currentLabel->SetItalic( m_italic->IsChecked() );
 
    m_currentLabel->SetTextColor( m_textColorSwatch->GetSwatchColor() );
 
    SPIN_STYLE selectedSpinStyle= SPIN_STYLE::LEFT;
 
    if( m_spin0->IsChecked() )      selectedSpinStyle = SPIN_STYLE::RIGHT;
    else if( m_spin1->IsChecked() ) selectedSpinStyle = SPIN_STYLE::LEFT;
    else if( m_spin2->IsChecked() ) selectedSpinStyle = SPIN_STYLE::UP;
    else if( m_spin3->IsChecked() ) selectedSpinStyle = SPIN_STYLE::BOTTOM;
 
    if( m_currentLabel->AutoRotateOnPlacementSupported() )
    {
        SCH_EDIT_FRAME* frame = static_cast<SCH_EDIT_FRAME*>( m_parentFrame );
        m_currentLabel->SetAutoRotateOnPlacement( m_autoRotate->IsChecked() );
        frame->AutoRotateItem( frame->GetScreen(), m_currentLabel );
    }
    else
    {
        m_currentLabel->SetAutoRotateOnPlacement( false );
    }
 
    if( !m_currentLabel->AutoRotateOnPlacement() && m_currentLabel->GetSpinStyle() != selectedSpinStyle )
        m_currentLabel->SetSpinStyle( selectedSpinStyle );
 
    AUTOPLACE_ALGO fieldsAutoplaced = m_currentLabel->GetFieldsAutoplaced();
 
    if( fieldsAutoplaced == AUTOPLACE_AUTO || fieldsAutoplaced == AUTOPLACE_MANUAL )
        m_currentLabel->AutoplaceFields( m_Parent->GetScreen(), fieldsAutoplaced );
 
    if( !commit.Empty() )
    {
        commit.Push( _( "Edit Label Properties" ) );
    }
    else if( m_activeTextEntry && m_labelList )
    {
        text = m_activeTextEntry->GetValue();
        // On macOS CTRL+Enter produces '\r' instead of '\n' regardless of EOL setting
        text.Replace( wxS( "\r" ), wxS( "\n" ) );
        wxArrayString lines = wxSplit( text, '\n' );
 
        for( const wxString& line : lines )
        {
            text = EscapeString( line, CTX_NETNAME );
            text.Trim( false ).Trim( true );
 
            if( text.empty() )
                continue;
 
            // convert any text variable cross-references to their UUIDs
            text = m_currentLabel->Schematic()->ConvertRefsToKIIDs( text );
 
            switch ( m_currentLabel->Type() )
            {
            case SCH_GLOBAL_LABEL_T:
            {
                SCH_GLOBALLABEL* label = new SCH_GLOBALLABEL( *static_cast<SCH_GLOBALLABEL*>( m_currentLabel ) );
                const_cast<KIID&>( label->m_Uuid ) = KIID();     // Gives a new UUID to the copy
                label->SetText( text );
                m_labelList->push_back( std::unique_ptr<SCH_LABEL_BASE>( label ) );
                break;
            }
            case SCH_HIER_LABEL_T:
            {
                SCH_HIERLABEL* label = new SCH_HIERLABEL( *static_cast<SCH_HIERLABEL*>( m_currentLabel ) );
                const_cast<KIID&>( label->m_Uuid ) = KIID();
                label->SetText( text );
                m_labelList->push_back( std::unique_ptr<SCH_LABEL_BASE>( label ) );
                break;
            }
            case SCH_LABEL_T:
            {
                SCH_LABEL* label = new SCH_LABEL( *static_cast<SCH_LABEL*>( m_currentLabel ) );
                const_cast<KIID&>( label->m_Uuid ) = KIID();
                label->SetText( text );
                m_labelList->push_back( std::unique_ptr<SCH_LABEL_BASE>( label ) );
                break;
            }
            default:
                break;
            }
        }
    }
    else if( m_labelList && m_currentLabel->Type() == SCH_DIRECTIVE_LABEL_T )
    {
        SCH_DIRECTIVE_LABEL* label = new SCH_DIRECTIVE_LABEL( *static_cast<SCH_DIRECTIVE_LABEL*>( m_currentLabel ) );
        m_labelList->push_back( std::unique_ptr<SCH_LABEL_BASE>( label ) );
    }
 
    return true;
}
 
 
void DIALOG_LABEL_PROPERTIES::onSpinButton( wxCommandEvent& aEvent )
{
    for( BITMAP_BUTTON* btn : { m_spin0, m_spin1, m_spin2, m_spin3 } )
    {
        if( btn->IsChecked() && btn != aEvent.GetEventObject() )
            btn->Check( false );
    }
}
 
 
void DIALOG_LABEL_PROPERTIES::OnFormattingHelp( wxHyperlinkEvent& aEvent )
{
    m_helpWindow = SCH_LABEL_BASE::ShowSyntaxHelp( this );
}
 
 
void DIALOG_LABEL_PROPERTIES::OnGridCellChanging( wxGridEvent& event )
{
    wxGridCellEditor* editor = m_grid->GetCellEditor( event.GetRow(), event.GetCol() );
    wxControl*        control = editor->GetControl();
 
    if( control && control->GetValidator() && !control->GetValidator()->Validate( control ) )
    {
        event.Veto();
        m_delayedFocusRow = event.GetRow();
        m_delayedFocusColumn = event.GetCol();
    }
    else if( event.GetCol() == FDC_NAME )
    {
        wxString newName = event.GetString();
        bool     isGlobalLabel = m_currentLabel->Type() == SCH_GLOBAL_LABEL_T;
 
        for( int i = 0; i < m_grid->GetNumberRows(); ++i )
        {
            if( i == event.GetRow() )
                continue;
 
            wxString existing = m_grid->GetCellValue( i, FDC_NAME );
 
            // Only global labels have a mandatory field (Intersheet References).  Hierarchical,
            // regular, and directive labels carry only user fields, which compare case-sensitively.
            bool duplicate = isGlobalLabel
                    ? FieldNamesAreDuplicates( newName, existing, GLOBALLABEL_MANDATORY_FIELDS )
                    : FieldNamesAreDuplicates( newName, existing, {} );
 
            if( duplicate )
            {
                DisplayError( this, wxString::Format( _( "Field name '%s' already in use." ),
                                                      newName ) );
                event.Veto();
                m_delayedFocusRow = event.GetRow();
                m_delayedFocusColumn = event.GetCol();
                break;
            }
        }
    }
 
    editor->DecRef();
}
 
 
void DIALOG_LABEL_PROPERTIES::OnAddField( wxCommandEvent& event )
{
    m_grid->OnAddRow(
            [&]() -> std::pair<int, int>
            {
                wxString fieldName = wxT( "Netclass" );
 
                for( SCH_FIELD& field : *m_fields )
                {
                    if( field.GetId() != FIELD_T::INTERSHEET_REFS && field.GetName() != wxT( "Netclass" ) )
                    {
                        fieldName = wxEmptyString;
                        break;
                    }
                }
 
                fieldName = SCH_LABEL_BASE::GetDefaultFieldName( fieldName, true );
 
                SCH_FIELD newField( m_currentLabel, FIELD_T::USER, fieldName );
 
                if( m_fields->size() > 0 )
                {
                    // SetAttributes() also covers text angle, size, italic and bold
                    newField.SetAttributes( m_fields->at( m_fields->size() - 1 ) );
                    newField.SetVisible( m_fields->at( m_fields->size() - 1 ).IsVisible() );
                }
                else
                {
                    newField.SetVisible( true );
                    newField.SetItalic( true );
                }
 
                m_fields->push_back( newField );
 
                // notify the grid
                wxGridTableMessage msg( m_fields, wxGRIDTABLE_NOTIFY_ROWS_APPENDED, 1 );
                m_grid->ProcessTableMessage( msg );
                return { m_fields->GetNumberRows() - 1, FDC_NAME };
            } );
}
 
 
void DIALOG_LABEL_PROPERTIES::OnDeleteField( wxCommandEvent& event )
{
    m_grid->OnDeleteRows(
            [&]( int row )
            {
                if( row < m_fields->GetMandatoryRowCount() )
                {
                    DisplayError( this, _( "The first field is mandatory." ) );
                    return false;
                }
 
                return true;
            },
            [&]( int row )
            {
                if( !m_fields->EraseRow( row ) )
                    return;
 
                // notify the grid
                wxGridTableMessage msg( m_fields, wxGRIDTABLE_NOTIFY_ROWS_DELETED, row, 1 );
                m_grid->ProcessTableMessage( msg );
            } );
}
 
 
void DIALOG_LABEL_PROPERTIES::OnMoveUp( wxCommandEvent& event )
{
    m_grid->OnMoveRowUp(
            [&]( int row )
            {
                return row > m_fields->GetMandatoryRowCount();
            },
            [&]( int row )
            {
                m_fields->SwapRows( row, row - 1 );
                m_grid->ForceRefresh();
            } );
}
 
 
void DIALOG_LABEL_PROPERTIES::OnMoveDown( wxCommandEvent& event )
{
    m_grid->OnMoveRowDown(
            [&]( int row )
            {
                return row >= m_fields->GetMandatoryRowCount();
            },
            [&]( int row )
            {
                m_fields->SwapRows( row, row + 1 );
                m_grid->ForceRefresh();
            } );
}
 
 
void DIALOG_LABEL_PROPERTIES::OnUpdateUI( wxUpdateUIEvent& event )
{
    std::bitset<64> shownColumns = m_grid->GetShownColumns();
 
    if( shownColumns != m_shownColumns )
    {
        m_shownColumns = shownColumns;
 
        if( !m_grid->IsCellEditControlShown() )
            m_grid->SetGridWidthsDirty();
    }
 
    // Handle a delayed focus
    if( m_delayedFocusRow >= 0 && m_delayedFocusRow < m_grid->GetNumberRows() )
    {
        m_grid->SetFocus();
        m_grid->MakeCellVisible( m_delayedFocusRow, m_delayedFocusColumn );
        m_grid->SetGridCursor( m_delayedFocusRow, m_delayedFocusColumn );
    }
 
    m_delayedFocusRow = -1;
    m_delayedFocusColumn = -1;
}
 
 
void DIALOG_LABEL_PROPERTIES::onMultiLabelCheck( wxCommandEvent& event )
{
    bool multiLine = m_multilineAllowed && m_cbMultiLine->IsChecked();
 
    if( m_currentLabel->Type() == SCH_GLOBAL_LABEL_T || m_currentLabel->Type() == SCH_LABEL_T )
    {
        m_labelCombo->Show( !multiLine );
        m_valueCombo->Show( !multiLine );
        m_labelMultiLine->Show( multiLine );
        m_valueMultiLine->Show( multiLine );
 
        if( multiLine )
        {
            m_valueMultiLine->SetValue( m_valueCombo->GetValue() );
            m_activeTextEntry = m_valueMultiLine;
            SetInitialFocus( m_valueMultiLine );
        }
        else
        {
            wxString multiText = m_valueMultiLine->GetValue();
            m_valueCombo->SetValue( multiText.BeforeFirst( '\n' ) );
            m_activeTextEntry = m_valueCombo;
            SetInitialFocus( m_valueCombo->GetTextCtrl() );
        }
    }
    else if( m_currentLabel->Type() == SCH_HIER_LABEL_T )
    {
        m_labelSingleLine->Show( !multiLine );
        m_valueSingleLine->Show( !multiLine );
        m_labelMultiLine->Show( multiLine );
        m_valueMultiLine->Show( multiLine );
 
        if( multiLine )
        {
            m_valueMultiLine->SetValue( m_valueSingleLine->GetValue() );
            m_activeTextEntry = m_valueMultiLine;
            SetInitialFocus( m_valueMultiLine );
        }
        else
        {
            wxString multiText = m_valueMultiLine->GetValue();
            m_valueSingleLine->SetValue( multiText.BeforeFirst( '\n' ) );
            m_activeTextEntry = m_valueSingleLine;
            SetInitialFocus( m_valueSingleLine );
        }
    }
 
    Layout();
}