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-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#ifndef KIWAY_HOLDER_H_
25#define KIWAY_HOLDER_H_
26
27class KIWAY;
28class PROJECT;
29class wxWindow;
30
37{
38public:
40
41 KIWAY_HOLDER( KIWAY* aKiway, HOLDER_TYPE aType ) :
42 m_kiway( aKiway ),
43 m_type( aType )
44 {}
45
46 HOLDER_TYPE GetType() const { return m_type; }
47
53 KIWAY& Kiway() const
54 {
55 wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
56 return *m_kiway;
57 }
58
63 bool HasKiway() const
64 {
65 return m_kiway != nullptr;
66 }
67
71 PROJECT& Prj() const;
72
80 void SetKiway( wxWindow* aDest, KIWAY* aKiway );
81
82private:
83 // private, all setting is done through SetKiway().
84 KIWAY* m_kiway; // no ownership.
86};
87
88
89#endif // KIWAY_HOLDER_H_
A mix in class which holds the location of a wxWindow's KIWAY.
Definition: kiway_holder.h:37
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
KIWAY * m_kiway
Definition: kiway_holder.h:84
KIWAY_HOLDER(KIWAY *aKiway, HOLDER_TYPE aType)
Definition: kiway_holder.h:41
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:53
void SetKiway(wxWindow *aDest, KIWAY *aKiway)
It is only used for debugging, since "this" is not a wxWindow*.
bool HasKiway() const
Safety check before asking for the Kiway reference.
Definition: kiway_holder.h:63
HOLDER_TYPE GetType() const
Definition: kiway_holder.h:46
HOLDER_TYPE m_type
Definition: kiway_holder.h:85
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition: kiway.h:267
Container for project specific data.
Definition: project.h:63