KiCad PCB EDA Suite
pcb_scripting_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) 2021 KiCad Developers, see AUTHORS.TXT for contributors.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 3
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, you may find one here:
18  * http://www.gnu.org/licenses/gpl-3.0.html
19  * or you may search the http://www.gnu.org website for the version 3 license,
20  * or you may write to the Free Software Foundation, Inc.,
21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22  */
23 
24 #ifndef PCBNEW_PCB_SCRIPTING_TOOL_H_
25 #define PCBNEW_PCB_SCRIPTING_TOOL_H_
26 
27 
28 #include <tools/pcb_tool_base.h>
29 
30 class ACTION_MENU;
31 
36 {
37 public:
40 
42  void Reset( RESET_REASON aReason ) override;
43 
45  bool Init() override;
46 
47 private:
48 
50  int reloadPlugins( const TOOL_EVENT& aEvent );
51 
54  void callLoadPlugins();
55 
57  int showPluginFolder( const TOOL_EVENT& aEvent );
58 
60  void setTransitions() override;
61 
62 };
63 
64 
65 #endif /* PCBNEW_PCB_SCRIPTING_TOOL_H_ */
int reloadPlugins(const TOOL_EVENT &aEvent)
< Reload Python plugins and reset toolbar (if in pcbnew)
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:48
void Reset(RESET_REASON aReason) override
Basic initialization.
int showPluginFolder(const TOOL_EVENT &aEvent)
Bind handlers to corresponding TOOL_ACTIONs.
Tool relating to pads and pad settings.
void setTransitions() override
This method is meant to be overridden in order to specify handlers for events.
void callLoadPlugins()
Open the user's plugin folder in the system browser.
Generic, UI-independent tool event.
Definition: tool_event.h:152
bool Init() override
Init() is called once upon a registration of the tool.
~SCRIPTING_TOOL()
React to model/view changes.
RESET_REASON
Determine the reason of reset for a tool.
Definition: tool_base.h:77