KiCad PCB EDA Suite
kiway_holder.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 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 #ifndef KIWAY_HOLDER_H_
25 #define KIWAY_HOLDER_H_
26 
27 #include <wx/frame.h>
28 
29 
30 class KIWAY;
31 class PROJECT;
32 
33 
40 {
41 public:
43 
44  KIWAY_HOLDER( KIWAY* aKiway, HOLDER_TYPE aType ) :
45  m_kiway( aKiway ),
46  m_type( aType )
47  {}
48 
49  HOLDER_TYPE GetType() { return m_type; }
50 
56  KIWAY& Kiway() const
57  {
58  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
59  return *m_kiway;
60  }
61 
66  PROJECT& Prj() const;
67 
77  void SetKiway( wxWindow* aDest, KIWAY* aKiway );
78 
79 private:
80  // private, all setting is done through SetKiway().
81  KIWAY* m_kiway; // no ownership.
83 };
84 
85 
86 
87 #endif // KIWAY_HOLDER_H_
Class KIWAY_HOLDER is a mix in class which holds the location of a wxWindow's KIWAY.
Definition: kiway_holder.h:39
void SetKiway(wxWindow *aDest, KIWAY *aKiway)
Function SetKiway.
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
Class PROJECT holds project specific data.
Definition: project.h:58
KIWAY * m_kiway
Definition: kiway_holder.h:81
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
Class KIWAY is a minimalistic software bus for communications between various DLLs/DSOs (DSOs) within...
Definition: kiway.h:258
HOLDER_TYPE GetType()
Definition: kiway_holder.h:49
KIWAY_HOLDER(KIWAY *aKiway, HOLDER_TYPE aType)
Definition: kiway_holder.h:44
HOLDER_TYPE m_type
Definition: kiway_holder.h:82