KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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_SCH_CONTEXT_H
22#define KICAD_SCH_CONTEXT_H
23
24#include <memory>
25
26#include <wx/string.h>
27
28class KIWAY;
29class PROJECT;
30class SCHEMATIC;
31class SCH_EDIT_FRAME;
32class TOOL_MANAGER;
33
34
37{
38public:
39 virtual ~SCH_CONTEXT() = default;
40
41 virtual SCHEMATIC* GetSchematic() const = 0;
42
43 virtual PROJECT& Prj() const = 0;
44
45 virtual TOOL_MANAGER* GetToolManager() const = 0;
46
47 virtual KIWAY* GetKiway() const = 0;
48
49 virtual wxString GetCurrentFileName() const = 0;
50
51 virtual bool CanAcceptApiCommands() const = 0;
52};
53
54
55std::shared_ptr<SCH_CONTEXT> CreateSchFrameContext( SCH_EDIT_FRAME* aFrame );
56
57#endif
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
virtual bool CanAcceptApiCommands() const =0
virtual wxString GetCurrentFileName() const =0
virtual TOOL_MANAGER * GetToolManager() const =0
virtual SCHEMATIC * GetSchematic() const =0
virtual ~SCH_CONTEXT()=default
virtual KIWAY * GetKiway() const =0
virtual PROJECT & Prj() const =0
Schematic editor (Eeschema) main window.
Master controller class:
std::shared_ptr< SCH_CONTEXT > CreateSchFrameContext(SCH_EDIT_FRAME *aFrame)