KiCad PCB EDA Suite
Loading...
Searching...
No Matches
board_context.cpp
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#include <api/board_context.h>
22
23#include <pcb_edit_frame.h>
24
25
27{
28public:
30 m_frame( aFrame )
31 {
32 }
33
34 BOARD* GetBoard() const override
35 {
36 return m_frame->GetBoard();
37 }
38
39 PROJECT& Prj() const override
40 {
41 return m_frame->Prj();
42 }
43
44 TOOL_MANAGER* GetToolManager() const override
45 {
46 return m_frame->GetToolManager();
47 }
48
49 KIWAY* GetKiway() const override
50 {
51 return &m_frame->Kiway();
52 }
53
54 wxString GetCurrentFileName() const override
55 {
56 return m_frame->GetCurrentFileName();
57 }
58
59 bool CanAcceptApiCommands() const override
60 {
61 return m_frame->CanAcceptApiCommands();
62 }
63
64 bool SaveBoard() override
65 {
66 return m_frame->SaveBoard();
67 }
68
69 bool SavePcbCopy( const wxString& aFileName, bool aCreateProject, bool aHeadless ) override
70 {
71 return m_frame->SavePcbCopy( aFileName, aCreateProject, aHeadless );
72 }
73
74private:
76};
77
78
79std::shared_ptr<BOARD_CONTEXT> CreatePcbFrameContext( PCB_EDIT_FRAME* aFrame )
80{
81 return std::make_shared<PCB_EDIT_FRAME_CONTEXT>( aFrame );
82}
std::shared_ptr< BOARD_CONTEXT > CreatePcbFrameContext(PCB_EDIT_FRAME *aFrame)
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
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition kiway.h:315
TOOL_MANAGER * GetToolManager() const override
bool SavePcbCopy(const wxString &aFileName, bool aCreateProject, bool aHeadless) override
wxString GetCurrentFileName() const override
bool SaveBoard() override
PROJECT & Prj() const override
bool CanAcceptApiCommands() const override
PCB_EDIT_FRAME_CONTEXT(PCB_EDIT_FRAME *aFrame)
KIWAY * GetKiway() const override
BOARD * GetBoard() const override
PCB_EDIT_FRAME * m_frame
The main frame for Pcbnew.
Container for project specific data.
Definition project.h:66
Master controller class: