KiCad PCB EDA Suite
Loading...
Searching...
No Matches
headless_board_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_BOARD_CONTEXT_H
22#define KICAD_HEADLESS_BOARD_CONTEXT_H
23
24#include <memory>
25
26#include <wx/string.h>
27
28#include <api/board_context.h>
29
31class BOARD;
32class KIWAY;
33class PROJECT;
34class TOOL_MANAGER;
35
36
38{
39public:
40 HEADLESS_BOARD_CONTEXT( std::unique_ptr<BOARD> aBoard, PROJECT* aProject,
41 APP_SETTINGS_BASE* aSettings, KIWAY* aKiway = nullptr );
42
44
45 BOARD* GetBoard() const override;
46
47 PROJECT& Prj() const override;
48
49 TOOL_MANAGER* GetToolManager() const override;
50
51 KIWAY* GetKiway() const override { return m_kiway; }
52
53 wxString GetCurrentFileName() const override;
54
55 bool CanAcceptApiCommands() const override { return true; }
56
57 bool SaveBoard() override;
58
59 bool SavePcbCopy( const wxString& aFileName, bool aCreateProject, bool aHeadless ) override;
60
61private:
62 std::unique_ptr<BOARD> m_board;
65 std::unique_ptr<TOOL_MANAGER> m_toolManager;
66};
67
68#endif
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
An interface for the frame surface that the API handlers need; to enable headless mode.
Information pertinent to a Pcbnew printed circuit board.
Definition board.h:323
PROJECT & Prj() const override
bool CanAcceptApiCommands() const override
TOOL_MANAGER * GetToolManager() const override
BOARD * GetBoard() const override
std::unique_ptr< TOOL_MANAGER > m_toolManager
HEADLESS_BOARD_CONTEXT(std::unique_ptr< BOARD > aBoard, PROJECT *aProject, APP_SETTINGS_BASE *aSettings, KIWAY *aKiway=nullptr)
std::unique_ptr< BOARD > m_board
wxString GetCurrentFileName() const override
KIWAY * GetKiway() const override
bool SavePcbCopy(const wxString &aFileName, bool aCreateProject, bool aHeadless) override
~HEADLESS_BOARD_CONTEXT() override
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
Master controller class: