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 KiCad Developers, see CHANGELOG.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 #include <Python.h>
32 #include <vector>
33 #include <class_action_plugin.h>
34 
35 
37 {
38  PyObject* m_PyAction;
39  PyObject* CallMethod( const char* aMethod,
40  PyObject* aArglist = NULL );
41  wxString CallRetStrMethod( const char* aMethod,
42  PyObject* aArglist = NULL );
43 
44 public:
45  PYTHON_ACTION_PLUGIN( PyObject* action );
47  wxString GetCategoryName() override;
48  wxString GetName() override;
49  wxString GetDescription() override;
50  void Run() override;
51  void* GetObject() override;
52 };
53 
54 
56 {
57 public:
58  static void register_action( PyObject* aPyAction );
59  static void deregister_action( PyObject* aPyAction );
60 };
61 
62 #endif /* PCBNEW_ACTION_PLUGINS_H */
Class ACTION_PLUGIN This is the parent class from where any action plugin class must derive...
wxString GetName() override
Function GetName.
wxString CallRetStrMethod(const char *aMethod, PyObject *aArglist=NULL)
Class PCBNEW_ACTION_PLUGINS.
static void deregister_action(PyObject *aPyAction)
void * GetObject() override
Function GetObject This method gets the pointer to the object from where this action constructs...
wxString GetDescription() override
Function GetDescription.
void Run() override
Function Run This method the the action.
PYTHON_ACTION_PLUGIN(PyObject *action)
PyObject * CallMethod(const char *aMethod, PyObject *aArglist=NULL)
static void register_action(PyObject *aPyAction)
wxString GetCategoryName() override
Function GetCategoryName.