match_properties.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 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 <https://www.gnu.org/licenses/>.
 */
 
#ifndef MATCH_PROPERTIES_H
#define MATCH_PROPERTIES_H
 
#include <set>
#include <vector>
 
#include <wx/string.h>
 
class EDA_ITEM;
 
 
struct MATCH_PROPERTIES_RESULT
{
    explicit operator bool() const { return m_Error.IsEmpty(); }
 
    int      m_Changed = 0;
    wxString m_Error;
};
 
 
namespace MATCH_PROPERTIES_CATALOG
{
 
wxString Family( const EDA_ITEM& aItem );
wxString DisplayLabel( const wxString& aKey );

wxString FamilyLabel( const wxString& aFamily );

wxString PropertyLabel( const wxString& aKey );

std::set<wxString> FamiliesFor( const wxString& aKey );

bool PropertyIsRegistered( const wxString& aFamily, const wxString& aName );
bool Compatible( const EDA_ITEM& aSource, const EDA_ITEM& aTarget );
std::vector<EDA_ITEM*> CompatibleTargets( const EDA_ITEM& aSource, const std::vector<EDA_ITEM*>& aCandidates );

bool AnyEnabledFor( const EDA_ITEM& aItem, const std::set<wxString>& aEnabledKeys );

const std::set<wxString>& AllSafeKeys();

const std::set<wxString>& DefaultKeys();
 
MATCH_PROPERTIES_RESULT Copy( const EDA_ITEM& aSource, EDA_ITEM& aTarget,
                              const std::set<wxString>& aEnabledKeys );
 
}
 
#endif