dialog_lib_new_symbol.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2009 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 "dialog_lib_new_symbol.h"
#include <widgets/wx_infobar.h>
 
#include <default_values.h>
#include <eda_draw_frame.h>
#include <sch_validators.h>
#include <template_fieldnames.h>
 
 
static wxString getDerivativeName( const wxString& aParentName )
{
    return wxString::Format( "%s_1", aParentName );
}
 
 
DIALOG_LIB_NEW_SYMBOL::DIALOG_LIB_NEW_SYMBOL( EDA_DRAW_FRAME*      aParent,
                                              const wxArrayString& aSymbolNames,
                                              const wxString&      aInheritFromSymbolName,
                                              std::function<bool( const wxString& newName )> aValidator ) :
        DIALOG_LIB_NEW_SYMBOL_BASE( dynamic_cast<wxWindow*>( aParent ) ),
        m_pinTextPosition( aParent, m_staticPinTextPositionLabel, m_textPinTextPosition,
                           m_staticPinTextPositionUnits, true ),
        m_validator( std::move( aValidator ) ),
        m_inheritFromSymbolName( aInheritFromSymbolName ),
        m_nameIsDefaulted( true )
{
    if( aSymbolNames.GetCount() )
    {
        wxArrayString unescapedNames;
 
        for( const wxString& name : aSymbolNames )
            unescapedNames.Add( UnescapeString( name ) );
 
        m_comboInheritanceSelect->SetStringList( unescapedNames );
    }
 
    m_textName->SetValidator( FIELD_VALIDATOR( FIELD_T::VALUE ) );
    m_textReference->SetValidator( FIELD_VALIDATOR( FIELD_T::REFERENCE ) );
 
    m_pinTextPosition.SetValue( schIUScale.MilsToIU( DEFAULT_PIN_NAME_OFFSET ) );
 
    m_comboInheritanceSelect->Connect( FILTERED_ITEM_SELECTED,
                                       wxCommandEventHandler( DIALOG_LIB_NEW_SYMBOL::onParentSymbolSelect ),
                                       nullptr, this );
 
    m_textName->Bind( wxEVT_TEXT,
                      [this]( wxCommandEvent& aEvent )
                      {
                          m_nameIsDefaulted = false;
                      } );
 
    m_checkTransferUserFields->Connect( wxEVT_CHECKBOX,
                                        wxCommandEventHandler( DIALOG_LIB_NEW_SYMBOL::onCheckTransferUserFields ),
                                        nullptr, this );
 
    // initial focus should be on first editable field.
    m_textName->SetFocus();
 
    SetupStandardButtons();
 
    // Now all widgets have the size fixed, call FinishDialogSettings
    finishDialogSettings();
}
 
 
DIALOG_LIB_NEW_SYMBOL::~DIALOG_LIB_NEW_SYMBOL()
{
    m_comboInheritanceSelect->Disconnect( FILTERED_ITEM_SELECTED,
                                          wxCommandEventHandler( DIALOG_LIB_NEW_SYMBOL::onParentSymbolSelect ),
                                          nullptr, this );
    m_checkTransferUserFields->Disconnect( wxEVT_CHECKBOX,
                                           wxCommandEventHandler( DIALOG_LIB_NEW_SYMBOL::onCheckTransferUserFields ),
                                           nullptr, this );
}
 
 
bool DIALOG_LIB_NEW_SYMBOL::TransferDataToWindow()
{
    if( !m_inheritFromSymbolName.IsEmpty() )
    {
        m_comboInheritanceSelect->SetSelectedString( UnescapeString( m_inheritFromSymbolName ) );
        m_textName->ChangeValue( UnescapeString( getDerivativeName( m_inheritFromSymbolName ) ) );
    }
 
    CallAfter(
            [&]()
            {
                /* The combo box `m_comboInheritanceSelect` must first process an update event before the string can be read again.
                 * The CallAfter() method ensures that the string is available when onParentSymbolSelect() reads it again.
                 */
                wxCommandEvent dummyEvent;
 
                // Trigger the event handler to show/hide the info bar message.
                onParentSymbolSelect( dummyEvent );
                onCheckTransferUserFields( dummyEvent );
 
                // Trigger the event handler to handle power boxes
                onPowerCheckBox( dummyEvent );
            } );
 
    return true;
}
 
 
bool DIALOG_LIB_NEW_SYMBOL::TransferDataFromWindow()
{
    return m_validator( GetName() );
}
 
 
void DIALOG_LIB_NEW_SYMBOL::onParentSymbolSelect( wxCommandEvent& aEvent )
{
    const wxString parent = m_comboInheritanceSelect->GetValue();
 
    if( !parent.IsEmpty() )
    {
        m_infoBar->RemoveAllButtons();
        m_infoBar->ShowMessage( wxString::Format( _( "Deriving from symbol '%s'." ), UnescapeString( parent ) ),
                                wxICON_INFORMATION );
    }
    else
    {
        m_infoBar->Dismiss();
    }
 
    if( m_textName->IsEmpty() || m_nameIsDefaulted )
    {
        m_textName->SetValue( getDerivativeName( parent ) );
        m_textName->SetInsertionPointEnd();
        m_nameIsDefaulted = true;
    }
 
    syncControls( !parent.IsEmpty() );
 
    /* The banner changes the size of the dialog box, so it needs to be adjusted. */
    Fit();
}
 
 
void DIALOG_LIB_NEW_SYMBOL::syncControls( bool aIsDerivedPart )
{
    m_staticTextDes->Enable( !aIsDerivedPart );
    m_textReference->Enable( !aIsDerivedPart );
    m_staticTextUnits->Enable( !aIsDerivedPart );
    m_spinPartCount->Enable( !aIsDerivedPart );
    m_checkUnitsInterchangeable->Enable( !aIsDerivedPart );
    m_checkHasAlternateBodyStyle->Enable( !aIsDerivedPart );
    m_checkIsPowerSymbol->Enable( !aIsDerivedPart );
    m_excludeFromBomCheckBox->Enable( !aIsDerivedPart );
    m_excludeFromBoardCheckBox->Enable( !aIsDerivedPart );
    m_staticPinTextPositionLabel->Enable( !aIsDerivedPart );
    m_textPinTextPosition->Enable( !aIsDerivedPart );
    m_staticPinTextPositionUnits->Enable( !aIsDerivedPart );
 
    m_checkShowPinNumber->Enable( !aIsDerivedPart );
    m_checkShowPinName->Enable( !aIsDerivedPart );
    m_checkShowPinNameInside->Enable( !aIsDerivedPart );
 
    m_checkKeepDatasheet->Enable( aIsDerivedPart );
    m_checkKeepFootprint->Enable( aIsDerivedPart );
    m_checkTransferUserFields->Enable( aIsDerivedPart );
    m_checkKeepContentUserFields->Enable( aIsDerivedPart );
}
 
 
void DIALOG_LIB_NEW_SYMBOL::onPowerCheckBox( wxCommandEvent& aEvent )
{
    if( m_checkIsPowerSymbol->IsChecked() )
    {
        m_excludeFromBomCheckBox->SetValue( true );
        m_excludeFromBoardCheckBox->SetValue( true );
        m_excludeFromBomCheckBox->Enable( false );
        m_excludeFromBoardCheckBox->Enable( false );
    }
    else
    {
        m_excludeFromBomCheckBox->Enable( true );
        m_excludeFromBoardCheckBox->Enable( true );
    }
}
 
 
void DIALOG_LIB_NEW_SYMBOL::onCheckTransferUserFields( wxCommandEvent& aEvent )
{
    bool checked = m_checkTransferUserFields->IsChecked();
    m_checkKeepContentUserFields->Enable( checked );
}