1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2020 KiCad Developers, see AUTHORS.txt for contributors.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, you may find one here:
18  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19  * or you may search the http://www.gnu.org website for the version 2 license,
20  * or you may write to the Free Software Foundation, Inc.,
21  * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
22  */
23 
24 #include <tool/tool_manager.h>
25 #include <tools/pcb_actions.h>
26 #include <tools/pcb_picker_tool.h>
27 #include <pcb_base_edit_frame.h>
28 #include <pcb_group.h>
29 #include <status_popup.h>
30 #include <board_commit.h>
31 #include <bitmaps.h>
32 #include <dialogs/dialog_group_properties.h>
33 
34 
DIALOG_GROUP_PROPERTIES(PCB_BASE_EDIT_FRAME * aParent,PCB_GROUP * aGroup)35 DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES( PCB_BASE_EDIT_FRAME* aParent,
36                                                   PCB_GROUP* aGroup ) :
37         DIALOG_GROUP_PROPERTIES_BASE( aParent ),
38         m_brdEditor( aParent ),
39         m_toolMgr( aParent->GetToolManager() ),
40         m_group( aGroup )
41 {
42     m_bpAddMember->SetBitmap( KiBitmap( BITMAPS::small_plus ) );
43     m_bpRemoveMember->SetBitmap( KiBitmap( BITMAPS::small_trash ) );
44 
45     m_nameCtrl->SetValue( m_group->GetName() );
46 
47     m_locked->SetValue( m_group->IsLocked() );
48     m_locked->Show( dynamic_cast<PCB_EDIT_FRAME*>( aParent ) != nullptr );
49 
50     for( BOARD_ITEM* item : m_group->GetItems() )
51         m_membersList->Append( item->GetSelectMenuText( m_brdEditor->GetUserUnits() ), item );
52 
53     m_sdbSizerOK->SetDefault();
54 
55     SetInitialFocus( m_nameCtrl );
56 
57     // Now all widgets have the size fixed, call FinishDialogSettings
58     finishDialogSettings();
59 }
60 
61 
~DIALOG_GROUP_PROPERTIES()62 DIALOG_GROUP_PROPERTIES::~DIALOG_GROUP_PROPERTIES()
63 {
64     if( m_brdEditor->IsBeingDeleted() )
65         return;
66 
67     m_brdEditor->FocusOnItem( nullptr );
68     m_brdEditor->GetCanvas()->Refresh();
69 }
70 
71 
TransferDataToWindow()72 bool DIALOG_GROUP_PROPERTIES::TransferDataToWindow()
73 {
74     // Don't do anything here; it gets called every time we re-show the dialog after
75     // picking a new member.
76     return true;
77 }
78 
79 
TransferDataFromWindow()80 bool DIALOG_GROUP_PROPERTIES::TransferDataFromWindow()
81 {
82     BOARD_COMMIT commit( m_brdEditor );
83     commit.Modify( m_group );
84 
85     m_group->RunOnDescendants(
86             [&]( BOARD_ITEM* descendant )
87             {
88                 commit.Modify( descendant );
89             } );
90 
91     for( size_t ii = 0; ii < m_membersList->GetCount(); ++ii )
92     {
93         BOARD_ITEM* item = static_cast<BOARD_ITEM*>( m_membersList->GetClientData( ii ) );
94         PCB_GROUP*  existingGroup = item->GetParentGroup();
95 
96         if( existingGroup != m_group )
97         {
98             commit.Modify( item );
99 
100             if( existingGroup )
101                 commit.Modify( existingGroup );
102         }
103     }
104 
105     m_group->SetName( m_nameCtrl->GetValue() );
106     m_group->SetLocked( m_locked->GetValue() );
107 
108     m_toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );
109     m_group->RemoveAll();
110 
111     for( size_t ii = 0; ii < m_membersList->GetCount(); ++ii )
112     {
113         BOARD_ITEM* item = static_cast<BOARD_ITEM*>( m_membersList->GetClientData( ii ) );
114         m_group->AddItem( item );
115     }
116 
117     m_toolMgr->RunAction( PCB_ACTIONS::selectItem, true, m_group );
118 
119     commit.Push( _( "Modified group" ) );
120     return true;
121 }
122 
123 
OnMemberSelected(wxCommandEvent & aEvent)124 void DIALOG_GROUP_PROPERTIES::OnMemberSelected( wxCommandEvent& aEvent )
125 {
126     int selected = m_membersList->GetSelection();
127 
128     if( selected >= 0 )
129     {
130         WINDOW_THAWER thawer( m_brdEditor );
131         BOARD_ITEM*   item = static_cast<BOARD_ITEM*>( m_membersList->GetClientData( selected ) );
132 
133         m_brdEditor->FocusOnItem( item );
134         m_brdEditor->GetCanvas()->Refresh();
135     }
136 
137     aEvent.Skip();
138 }
139 
140 
OnAddMember(wxCommandEvent & event)141 void DIALOG_GROUP_PROPERTIES::OnAddMember( wxCommandEvent& event )
142 {
143     m_toolMgr->RunAction( PCB_ACTIONS::pickNewGroupMember, true );
144 }
145 
146 
DoAddMember(EDA_ITEM * aItem)147 void DIALOG_GROUP_PROPERTIES::DoAddMember( EDA_ITEM* aItem )
148 {
149     for( size_t ii = 0; ii < m_membersList->GetCount(); ++ii )
150     {
151         if( aItem == static_cast<BOARD_ITEM*>( m_membersList->GetClientData( ii ) ) )
152             return;
153     }
154 
155     if( aItem == m_group )
156         return;
157 
158     m_membersList->Append( aItem->GetSelectMenuText( m_brdEditor->GetUserUnits() ), aItem );
159 }
160 
161 
OnRemoveMember(wxCommandEvent & event)162 void DIALOG_GROUP_PROPERTIES::OnRemoveMember( wxCommandEvent& event )
163 {
164     int selected = m_membersList->GetSelection();
165 
166     if( selected >= 0 )
167         m_membersList->Delete( selected );
168 
169     m_brdEditor->FocusOnItem( nullptr );
170     m_brdEditor->GetCanvas()->Refresh();
171 }
172 
173 
174