KiCad PCB EDA Suite
Loading...
Searching...
No Matches
embed_tool.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) 2024 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 EMBED_TOOL_H
21#define EMBED_TOOL_H
22
24
25class wxFileName;
26class EMBEDDED_FILES;
27
29{
30public:
31 EMBED_TOOL();
32
33 EMBED_TOOL( const std::string& aName );
34
35 virtual ~EMBED_TOOL() = default;
36
38 bool Init() override;
39
41 void Reset( RESET_REASON aReason ) override;
42
43 int AddFile( const TOOL_EVENT& aEvent );
44
45 int RemoveFile( const TOOL_EVENT& aEvent );
46
47 std::vector<wxString> GetFileList();
48protected:
49
51 void setTransitions() override;
52
53private:
55};
56
57#endif /* EMBED_TOOL_H */
virtual ~EMBED_TOOL()=default
bool Init() override
Init() is called once upon a registration of the tool.
Definition: embed_tool.cpp:44
EMBEDDED_FILES * m_files
Definition: embed_tool.h:54
int AddFile(const TOOL_EVENT &aEvent)
Definition: embed_tool.cpp:59
std::vector< wxString > GetFileList()
Definition: embed_tool.cpp:75
int RemoveFile(const TOOL_EVENT &aEvent)
Definition: embed_tool.cpp:67
void setTransitions() override
<
Definition: embed_tool.cpp:87
RESET_REASON
Determine the reason of reset for a tool.
Definition: tool_base.h:78
Generic, UI-independent tool event.
Definition: tool_event.h:167
void Reset() override