KiCad PCB EDA Suite
pcbnew_action_plugins.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) 2017-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 2
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/old-licenses/gpl-2.0.html
19 * or you may search the http://www.gnu.org website for the version 2 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
29#ifndef PCBNEW_ACTION_PLUGINS_H
30#define PCBNEW_ACTION_PLUGINS_H
31
32#undef HAVE_CLOCK_GETTIME // macro is defined in Python.h and causes redefine warning
33#include <Python.h>
34#undef HAVE_CLOCK_GETTIME
35
36#include <vector>
37#include <action_plugin.h>
38
39
41{
42public:
43 PYTHON_ACTION_PLUGIN( PyObject* action );
45 wxString GetCategoryName() override;
46 wxString GetName() override;
47 wxString GetDescription() override;
48 bool GetShowToolbarButton() override;
49 wxString GetIconFileName( bool aDark ) override;
50 wxString GetPluginPath() override;
51 void Run() override;
52 void* GetObject() override;
53
54private:
55 PyObject* m_PyAction;
56 PyObject* CallMethod( const char* aMethod, PyObject* aArglist = nullptr );
57 wxString CallRetStrMethod( const char* aMethod, PyObject* aArglist = nullptr );
58};
59
60
62{
63public:
64 static void register_action( PyObject* aPyAction );
65 static void deregister_action( PyObject* aPyAction );
66};
67
68#endif /* PCBNEW_ACTION_PLUGINS_H */
Class PCBNEW_ACTION_PLUGINS.
This is the parent class from where any action plugin class must derive.
Definition: action_plugin.h:39
static void deregister_action(PyObject *aPyAction)
static void register_action(PyObject *aPyAction)
bool GetShowToolbarButton() override
wxString CallRetStrMethod(const char *aMethod, PyObject *aArglist=nullptr)
PyObject * CallMethod(const char *aMethod, PyObject *aArglist=nullptr)
wxString GetCategoryName() override
wxString GetName() override
wxString GetDescription() override
wxString GetPluginPath() override
PYTHON_ACTION_PLUGIN(PyObject *action)
void Run() override
This method the the action.
wxString GetIconFileName(bool aDark) override
void * GetObject() override
This method gets the pointer to the object from where this action constructs.