KiCad PCB EDA Suite
ee_selection.h
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) 2019 CERN
5  * Copyright (C) 2019-2020 KiCad Developers, see CHANGELOG.TXT for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
25 #ifndef EE_SELECTION_H
26 #define EE_SELECTION_H
27 
28 class SCH_REFERENCE_LIST;
29 class SCH_SCREEN;
30 class SCH_SHEET_PATH;
31 
32 #include <tool/selection.h>
33 #include <sch_sheet_path.h> // SCH_MULTI_UNIT_REFERENCE_MAP
34 
35 
36 class EE_SELECTION : public SELECTION
37 {
42 
43 public:
44  EE_SELECTION( SCH_SCREEN* aScreen = nullptr );
45 
46  EDA_ITEM* GetTopLeftItem( bool onlyModules = false ) const override;
47 
48  EDA_RECT GetBoundingBox() const override;
49 
50  void SetScreen( SCH_SCREEN* aScreen ) { m_screen = aScreen; }
51  SCH_SCREEN* GetScreen() { return m_screen; }
52 
63  void GetSymbols( SCH_REFERENCE_LIST& aReferences, const SCH_SHEET_PATH& aSelectionPath,
64  bool aIncludePowerSymbols = true, bool aForceIncludeOrphanSymbols = false );
65 
77  const SCH_SHEET_PATH& aSelectionPath,
78  bool aIncludePowerSymbols = true );
79 
85  bool AllItemsHaveLineStroke() const;
86 };
87 
88 #endif // EE_SELECTION_H
void SetScreen(SCH_SCREEN *aScreen)
Definition: ee_selection.h:50
SCH_SCREEN * GetScreen()
Definition: ee_selection.h:51
EDA_RECT GetBoundingBox() const override
EE_SELECTION(SCH_SCREEN *aScreen=nullptr)
SCH_SCREEN * m_screen
Screen of selected objects.
Definition: ee_selection.h:41
Container to create a flattened list of symbols because in a complex hierarchy, a symbol can be used ...
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
void GetMultiUnitSymbols(SCH_MULTI_UNIT_REFERENCE_MAP &aRefList, const SCH_SHEET_PATH &aSelectionPath, bool aIncludePowerSymbols=true)
Add a SCH_REFERENCE_LIST object to aRefList for each same-reference set of multi-unit parts in the se...
std::map< wxString, SCH_REFERENCE_LIST > SCH_MULTI_UNIT_REFERENCE_MAP
Container to map reference designators for multi-unit parts.
bool AllItemsHaveLineStroke() const
Checks if all items in the selection support line strokes.
EDA_ITEM * GetTopLeftItem(bool onlyModules=false) const override
Handle the component boundary box.
Definition: eda_rect.h:42
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:100
Definition of the SCH_SHEET_PATH and SCH_SHEET_LIST classes for Eeschema.
void GetSymbols(SCH_REFERENCE_LIST &aReferences, const SCH_SHEET_PATH &aSelectionPath, bool aIncludePowerSymbols=true, bool aForceIncludeOrphanSymbols=false)
Adds SCH_REFERENCE object to aReferences for each symbol in the selection.