KiCad PCB EDA Suite
Loading...
Searching...
No Matches
headless_sch_context.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 The KiCad Developers, see AUTHORS.txt for contributors.
5 * @author Jon Evans <[email protected]>
6 *
7 * This program is free software: you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation, either version 3 of the License, or (at your
10 * option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License along
18 * with this program. If not, see <http://www.gnu.org/licenses/>.
19 */
20
21#ifndef KICAD_HEADLESS_SCH_CONTEXT_H
22#define KICAD_HEADLESS_SCH_CONTEXT_H
23
24#include <memory>
25
26#include <wx/string.h>
27
28#include <api/sch_context.h>
29
30class KIWAY;
31class PROJECT;
32class SCHEMATIC;
33class TOOL_MANAGER;
34
35
37{
38public:
39 HEADLESS_SCH_CONTEXT( SCHEMATIC* aSchematic, PROJECT* aProject, KIWAY* aKiway = nullptr );
40
42
43 SCHEMATIC* GetSchematic() const override;
44
45 PROJECT& Prj() const override;
46
47 TOOL_MANAGER* GetToolManager() const override;
48
49 KIWAY* GetKiway() const override { return m_kiway; }
50
51 wxString GetCurrentFileName() const override;
52
53 bool CanAcceptApiCommands() const override { return true; }
54
55private:
56 // All owned by caller (the kiface)
60 std::unique_ptr<TOOL_MANAGER> m_toolManager;
61};
62
63#endif
SCHEMATIC * GetSchematic() const override
~HEADLESS_SCH_CONTEXT() override
PROJECT & Prj() const override
TOOL_MANAGER * GetToolManager() const override
HEADLESS_SCH_CONTEXT(SCHEMATIC *aSchematic, PROJECT *aProject, KIWAY *aKiway=nullptr)
KIWAY * GetKiway() const override
bool CanAcceptApiCommands() const override
wxString GetCurrentFileName() const override
std::unique_ptr< TOOL_MANAGER > m_toolManager
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition kiway.h:315
Container for project specific data.
Definition project.h:66
Holds all the data relating to one schematic.
Definition schematic.h:89
An interface for the frame surface that the SCH API handlers need; to enable headless mode.
Definition sch_context.h:37
Master controller class: