KiCad PCB EDA Suite
dialog_group_properties.cpp
Go to the documentation of this file.
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>
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>
33
34
36 PCB_GROUP* aGroup ) :
38 m_brdEditor( aParent ),
39 m_toolMgr( aParent->GetToolManager() ),
40 m_group( aGroup )
41{
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 ), item );
52
54
56
57 // Now all widgets have the size fixed, call FinishDialogSettings
59}
60
61
63{
64 if( m_brdEditor->IsBeingDeleted() )
65 return;
66
67 m_brdEditor->FocusOnItem( nullptr );
69}
70
71
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
81{
82 BOARD_COMMIT commit( m_brdEditor );
83 commit.Modify( m_group );
84
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
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
118
119 commit.Push( _( "Modified group" ) );
120 return true;
121}
122
123
124void 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 );
135 }
136
137 aEvent.Skip();
138}
139
140
141void DIALOG_GROUP_PROPERTIES::OnAddMember( wxCommandEvent& event )
142{
144}
145
146
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 ), aItem );
159}
160
161
162void 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 );
171}
172
173
wxBitmap KiBitmap(BITMAPS aBitmap, int aHeightTag)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
Definition: bitmap.cpp:105
virtual void Push(const wxString &aMessage=wxT("A commit"), int aCommitFlags=0) override
Revert the commit by restoring the modified items state.
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:50
PCB_GROUP * GetParentGroup() const
Definition: board_item.h:62
virtual bool IsLocked() const
Definition: board_item.cpp:65
COMMIT & Modify(EDA_ITEM *aItem)
Create an undo entry for an item that has been already modified.
Definition: commit.h:103
Class DIALOG_GROUP_PROPERTIES_BASE.
DIALOG_GROUP_PROPERTIES(PCB_BASE_EDIT_FRAME *aParent, PCB_GROUP *aTarget)
void OnRemoveMember(wxCommandEvent &event) override
void DoAddMember(EDA_ITEM *aItem)
void OnAddMember(wxCommandEvent &event) override
void OnMemberSelected(wxCommandEvent &event) override
PCB_BASE_EDIT_FRAME * m_brdEditor
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:97
void SetupStandardButtons(std::map< int, wxString > aLabels={})
void finishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:85
virtual wxString GetSelectMenuText(UNITS_PROVIDER *aUnitsProvider) const
Return the text to display to be used in the selection clarification context menu when multiple items...
Definition: eda_item.cpp:108
static TOOL_ACTION selectionClear
Clear the current selection.
Definition: pcb_actions.h:59
static TOOL_ACTION pickNewGroupMember
Definition: pcb_actions.h:246
static TOOL_ACTION selectItem
Select an item (specified as the event parameter).
Definition: pcb_actions.h:62
Common, abstract interface for edit frames.
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void FocusOnItem(BOARD_ITEM *aItem, PCB_LAYER_ID aLayer=UNDEFINED_LAYER)
The main frame for Pcbnew.
A set of BOARD_ITEMs (i.e., without duplicates).
Definition: pcb_group.h:51
std::unordered_set< BOARD_ITEM * > & GetItems()
Definition: pcb_group.h:68
void RemoveAll()
Definition: pcb_group.cpp:65
void SetName(const wxString &aName)
Definition: pcb_group.h:66
bool AddItem(BOARD_ITEM *aItem)
Add item to group.
Definition: pcb_group.cpp:40
wxString GetName() const
Definition: pcb_group.h:65
void RunOnDescendants(const std::function< void(BOARD_ITEM *)> &aFunction) const
Invoke a function on all descendants of the group.
Definition: pcb_group.cpp:363
void SetLocked(bool aLocked) override
Create a duplicate of this item with linked list members set to NULL.
Definition: pcb_group.cpp:147
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Run the specified action.
Definition: tool_manager.h:142
#define _(s)