kiway_holder.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef KIWAY_HOLDER_H_
#define KIWAY_HOLDER_H_
 
#include <kicommon.h>
 
#include <wx/debug.h>
 
 
class KIWAY;
class PROJECT;
class wxWindow;

class KICOMMON_API KIWAY_HOLDER
{
public:
    enum HOLDER_TYPE { DIALOG, FRAME, PANEL };
 
    KIWAY_HOLDER( KIWAY* aKiway, HOLDER_TYPE aType ) :
        m_kiway( aKiway ),
        m_type( aType )
    {}
 
    HOLDER_TYPE GetType() const { return m_type; }

    KIWAY& Kiway() const
    {
        wxASSERT( m_kiway );    // smoke out bugs in Debug build, then Release runs fine.
        return *m_kiway;
    }

    bool HasKiway() const
    {
        return m_kiway != nullptr;
    }

    PROJECT& Prj() const;

    void SetKiway( wxWindow* aDest, KIWAY* aKiway );
 
private:
    // private, all setting is done through SetKiway().
    KIWAY*          m_kiway;            // no ownership.
    HOLDER_TYPE     m_type;
};
 
 
#endif // KIWAY_HOLDER_H_