KiCad PCB EDA Suite
board_item_container.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) 2016 CERN
5  * Copyright (C) 2016-2017 KiCad Developers, see change_log.txt for contributors.
6  *
7  * @author Maciej Suminski <maciej.suminski@cern.ch>
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; either version 2
12  * of the License, or (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, you may find one here:
21  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
22  * or you may search the http://www.gnu.org website for the version 2 license,
23  * or you may write to the Free Software Foundation, Inc.,
24  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25  */
26 
27 #ifndef BOARD_ITEM_CONTAINER_H
28 #define BOARD_ITEM_CONTAINER_H
29 
30 #include <board_item.h>
31 #include <zone_settings.h>
32 
33 enum class ADD_MODE
34 {
35  INSERT,
36  APPEND,
39 };
40 
41 enum class REMOVE_MODE
42 {
43  NORMAL,
44  BULK
45 };
46 
53 {
54 public:
56  : BOARD_ITEM( aParent, aType )
57  {
58  }
59 
64  virtual void Add( BOARD_ITEM* aItem, ADD_MODE aMode = ADD_MODE::INSERT ) = 0;
65 
69  virtual void Remove( BOARD_ITEM* aItem, REMOVE_MODE aMode = REMOVE_MODE::NORMAL ) = 0;
70 
74  virtual void Delete( BOARD_ITEM* aItem )
75  {
76  Remove( aItem );
77  delete aItem;
78  }
79 
83  virtual const ZONE_SETTINGS& GetZoneSettings() const
84  {
85  return m_zoneSettings;
86  }
87 
92  virtual void SetZoneSettings( const ZONE_SETTINGS& aSettings )
93  {
94  m_zoneSettings = aSettings;
95  }
96 
97 private:
99 };
100 
101 #endif /* BOARD_ITEM_CONTAINER_H */
virtual void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_MODE::INSERT)=0
Adds an item to the container.
virtual void SetZoneSettings(const ZONE_SETTINGS &aSettings)
Set the zone settings for this container.
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:80
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:77
virtual const ZONE_SETTINGS & GetZoneSettings() const
Fetch the zone settings for this container.
ZONE_SETTINGS handles zones parameters.
Definition: zone_settings.h:67
virtual void Delete(BOARD_ITEM *aItem)
Removes an item from the container and deletes it.
virtual void Remove(BOARD_ITEM *aItem, REMOVE_MODE aMode=REMOVE_MODE::NORMAL)=0
Removes an item from the container.
Abstract interface for BOARD_ITEMs capable of storing other items inside.
BOARD_ITEM_CONTAINER(BOARD_ITEM *aParent, KICAD_T aType)