Files
kicad-source-mirror/include/inspectable.h
T
Seth Hillbrand 6c9c75eb07 Remove property.h and property_mgr.h from inspectable.h
This breaks the view_item.h -> inspectable.h -> property.h chain that
pulled wx/propgrid/property.h into 150-200 TUs. The lean inspectable.h
now includes only wx/any.h, wx/string.h, wx/variant.h.

Headers using DECLARE_ENUM_TO_WXANY (board_item.h, sch_item.h) retain
their property.h include since the macro requires it.
2026-02-13 19:54:46 -08:00

64 lines
1.8 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2020 CERN
* Copyright The KiCad Developers, see AUTHORS.txt for contributors.
* @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
* @author Maciej Suminski <maciej.suminski@cern.ch>
*
* 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 3
* 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 <http://www.gnu.org/licenses/>.
*/
#ifndef INSPECTABLE_H
#define INSPECTABLE_H
#include <wx/any.h>
#include <wx/string.h>
#include <wx/variant.h>
#include <optional>
class PROPERTY_BASE;
/**
* Class that other classes need to inherit from, in order to be inspectable.
*/
class INSPECTABLE
{
public:
virtual ~INSPECTABLE()
{
}
bool Set( PROPERTY_BASE* aProperty, wxAny& aValue, bool aNotify = true );
template <typename T>
bool Set( PROPERTY_BASE* aProperty, T aValue, bool aNotify = true );
bool Set( PROPERTY_BASE* aProperty, wxVariant aValue, bool aNotify = true );
template <typename T>
bool Set( const wxString& aProperty, T aValue, bool aNotify = true );
wxAny Get( PROPERTY_BASE* aProperty ) const;
template <typename T>
T Get( PROPERTY_BASE* aProperty ) const;
template <typename T>
std::optional<T> Get( const wxString& aProperty ) const;
};
#endif /* INSPECTABLE_H */