dialog_group_properties.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * 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 <tool/tool_manager.h>
#include <tool/actions.h>
#include <eda_draw_frame.h>
#include <eda_group.h>
#include <status_popup.h>
#include <commit.h>
#include <bitmaps.h>
#include <widgets/std_bitmap_button.h>
#include <dialogs/dialog_group_properties.h>
#include <wx/msgdlg.h>
 
 
DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES( EDA_DRAW_FRAME* aParent, EDA_GROUP* aGroup,
                                                  const std::shared_ptr<COMMIT>& aCommit ) :
        DIALOG_GROUP_PROPERTIES_BASE( aParent ),
        m_frame( aParent ),
        m_toolMgr( aParent->GetToolManager() ),
        m_group( aGroup ),
        m_commit( aCommit )
{
    // Properties dialogs don't really want state-saving/restoring
    OptOut( this );
 
    m_bpAddMember->SetBitmap( KiBitmapBundle( BITMAPS::small_plus ) );
    m_bpRemoveMember->SetBitmap( KiBitmapBundle( BITMAPS::small_trash ) );
 
    m_nameCtrl->SetValue( m_group->GetName() );
    m_locked->SetValue( aGroup->AsEdaItem()->IsLocked() );
    m_libraryLink->SetValue( m_group->GetDesignBlockLibId().Format() );
 
    if( aGroup->AsEdaItem()->Type() != PCB_GROUP_T )
        m_locked->Hide();
 
    for( EDA_ITEM* item : m_group->GetItems() )
        m_membersList->Append( item->GetItemDescription( m_frame, true ), item );
 
    SetupStandardButtons();
 
    SetInitialFocus( m_nameCtrl );
 
    // Now all widgets have the size fixed, call FinishDialogSettings
    finishDialogSettings();
}
 
 
DIALOG_GROUP_PROPERTIES::~DIALOG_GROUP_PROPERTIES()
{
    if( m_frame->IsBeingDeleted() )
        return;
 
    m_frame->ClearFocus();
    m_frame->GetCanvas()->Refresh();
}
 
 
bool DIALOG_GROUP_PROPERTIES::TransferDataToWindow()
{
    // Don't do anything here; it gets called every time we re-show the dialog after
    // picking a new member.
    return true;
}
 
 
bool DIALOG_GROUP_PROPERTIES::TransferDataFromWindow()
{
    m_commit->Modify( m_group->AsEdaItem(), m_frame->GetScreen(), RECURSE_MODE::RECURSE );
 
    for( size_t ii = 0; ii < m_membersList->GetCount(); ++ii )
    {
        EDA_ITEM*  item = static_cast<EDA_ITEM*>( m_membersList->GetClientData( ii ) );
        EDA_GROUP* existingGroup = item->GetParentGroup();
 
        if( existingGroup != m_group )
        {
            m_commit->Modify( item, m_frame->GetScreen() );
 
            if( existingGroup )
                m_commit->Modify( existingGroup->AsEdaItem(), m_frame->GetScreen(), RECURSE_MODE::NO_RECURSE );
        }
    }
 
    m_group->SetName( m_nameCtrl->GetValue() );
    m_group->AsEdaItem()->SetLocked( m_locked->GetValue() );
 
    if( !m_libraryLink->GetValue().IsEmpty() )
    {
        LIB_ID libId;
 
        if( libId.Parse( m_libraryLink->GetValue(), true ) >= 0 )
        {
            wxString error;
            error.Printf( _( "Invalid library link: '%s'" ), m_libraryLink->GetValue() );
            wxMessageBox( error, _( "Error" ), wxOK | wxICON_ERROR, m_frame );
            return false;
        }
 
        m_group->SetDesignBlockLibId( libId );
    }
    else
    {
        m_group->SetDesignBlockLibId( LIB_ID() );
    }
 
    m_toolMgr->RunAction( ACTIONS::selectionClear );
    m_group->RemoveAll();
 
    for( size_t ii = 0; ii < m_membersList->GetCount(); ++ii )
    {
        EDA_ITEM* item = static_cast<EDA_ITEM*>( m_membersList->GetClientData( ii ) );
        m_group->AddItem( item );
    }
 
    m_toolMgr->RunAction<EDA_ITEM*>( ACTIONS::selectItem, m_group->AsEdaItem() );
 
    m_commit->Push( _( "Edit Group Properties" ) );
    return true;
}
 
 
void DIALOG_GROUP_PROPERTIES::OnMemberSelected( wxCommandEvent& aEvent )
{
    int selected = m_membersList->GetSelection();
 
    if( selected >= 0 )
    {
        WINDOW_THAWER thawer( m_frame );
        EDA_ITEM*     item = static_cast<EDA_ITEM*>( m_membersList->GetClientData( selected ) );
 
        m_frame->FocusOnItem( item );
        m_frame->GetCanvas()->Refresh();
    }
 
    aEvent.Skip();
}
 
 
void DIALOG_GROUP_PROPERTIES::OnAddMember( wxCommandEvent& event )
{
    m_toolMgr->RunAction( ACTIONS::pickNewGroupMember );
}
 
 
void DIALOG_GROUP_PROPERTIES::DoAddMember( EDA_ITEM* aItem )
{
 
    for( size_t ii = 0; ii < m_membersList->GetCount(); ++ii )
    {
        if( aItem == static_cast<EDA_ITEM*>( m_membersList->GetClientData( ii ) ) )
            return;
    }
 
    if( aItem == m_group->AsEdaItem() )
    {
        m_frame->ShowInfoBarWarning( _( "A group cannot contain itself." ) );
        return;
    }
 
    if( const EDA_GROUP* group = dynamic_cast<const EDA_GROUP*>( aItem ) )
    {
        if( group->ContainsItem( m_group->AsEdaItem() ) )
        {
            m_frame->ShowInfoBarWarning( _( "Cannot add this group because it already contains the current group." ) );
            return;
        }
    }
 
    m_membersList->Append( aItem->GetItemDescription( m_frame, true ), aItem );
}
 
 
void DIALOG_GROUP_PROPERTIES::OnRemoveMember( wxCommandEvent& event )
{
    int selected = m_membersList->GetSelection();
 
    if( selected >= 0 )
        m_membersList->Delete( selected );
 
    m_frame->ClearFocus();
    m_frame->GetCanvas()->Refresh();
}