KiCad PCB EDA Suite
Loading...
Searching...
No Matches
plugin_common_choose_project.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) 2023 KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software: you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation, either version 3 of the License, or (at your
9 * option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License along
17 * with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20#ifndef PLUGIN_COMMON_CHOOSE_PROJECT_H
21#define PLUGIN_COMMON_CHOOSE_PROJECT_H
22
23#include <functional>
24#include <map>
25#include <wx/string.h>
26
31{
32 wxString ComboName;
33 wxString PCBName;
34 wxString SchematicName;
35
36 wxString ComboId;
37 wxString PCBId;
38 wxString SchematicId;
39
41};
42
47using CHOOSE_PROJECT_HANDLER = std::function<std::vector<IMPORT_PROJECT_DESC>( const std::vector<IMPORT_PROJECT_DESC>& )>;
48
49
54{
55public:
63 virtual void RegisterCallback( CHOOSE_PROJECT_HANDLER aChooseProjectHandler )
64 {
65 m_choose_project_handler = aChooseProjectHandler;
66 }
67
68 virtual ~PROJECT_CHOOSER_PLUGIN() = default;
69
70protected:
72};
73
74#endif // PLUGIN_COMMON_CHOOSE_PROJECT_H
Plugin class for import plugins that support choosing a project.
virtual ~PROJECT_CHOOSER_PLUGIN()=default
CHOOSE_PROJECT_HANDLER m_choose_project_handler
Callback to choose projects to import.
virtual void RegisterCallback(CHOOSE_PROJECT_HANDLER aChooseProjectHandler)
Register a different handler to be called when a non-KiCad project contains multiple PCB+Schematic co...
std::function< std::vector< IMPORT_PROJECT_DESC >(const std::vector< IMPORT_PROJECT_DESC > &)> CHOOSE_PROJECT_HANDLER
Pointer to a function that takes descriptions of the source projects and removes the ones that are no...
Describes how non-KiCad boards and schematics should be imported as KiCad projects.