From 83de569ac7d269c87021e5fadb3fc3e3888d5d3c Mon Sep 17 00:00:00 2001 From: qu1ck Date: Wed, 15 Aug 2018 02:26:32 -0700 Subject: [PATCH] Add toolbar buttons for action plugins Add icons to action menu items as well Fix backwards compatibility for plugins that don't define icon Fix compilation errors for action plugin icon code Fixes compilation with actio menu option off. Fixes compilation error on non windows platforms. Make showing toolbar button optional for action plugins Add "Action Plugins" panel stub in pcbnew settings Add action plugin grid form and stub Load action plugin list in pcbnew prefs Add category, description and path to action plugin grid Store and read action plugin settings display buttons accordingly Add action plugin ordering buttons in preferences Don't show error on icon load failure Fix build with actions menu disabled Adjust action plugins grid properties --- common/widgets/grid_icon_text_helpers.cpp | 40 +- include/widgets/grid_icon_text_helpers.h | 19 +- pcbnew/CMakeLists.txt | 9 +- pcbnew/action_plugin.cpp | 54 ++ pcbnew/action_plugin.h | 60 ++- pcbnew/dialogs/panel_pcbnew_action_plugins.cpp | 203 ++++++++ pcbnew/dialogs/panel_pcbnew_action_plugins.h | 59 +++ .../dialogs/panel_pcbnew_action_plugins_base.cpp | 96 ++++ .../dialogs/panel_pcbnew_action_plugins_base.fbp | 578 +++++++++++++++++++++ pcbnew/dialogs/panel_pcbnew_action_plugins_base.h | 56 ++ pcbnew/pcb_edit_frame.cpp | 2 + pcbnew/pcb_edit_frame.h | 39 +- pcbnew/pcb_general_settings.cpp | 45 ++ pcbnew/pcb_general_settings.h | 5 + pcbnew/pcbnew_config.cpp | 4 + pcbnew/swig/pcbnew_action_plugins.cpp | 147 +++++- pcbnew/swig/pcbnew_action_plugins.h | 3 + pcbnew/tool_pcb_editor.cpp | 4 + scripting/kicadplugins.i | 25 +- 19 files changed, 1433 insertions(+), 15 deletions(-) create mode 100644 pcbnew/dialogs/panel_pcbnew_action_plugins.cpp create mode 100644 pcbnew/dialogs/panel_pcbnew_action_plugins.h create mode 100644 pcbnew/dialogs/panel_pcbnew_action_plugins_base.cpp create mode 100644 pcbnew/dialogs/panel_pcbnew_action_plugins_base.fbp create mode 100644 pcbnew/dialogs/panel_pcbnew_action_plugins_base.h diff --git a/common/widgets/grid_icon_text_helpers.cpp b/common/widgets/grid_icon_text_helpers.cpp index 8d348c7..3a776f1 100644 --- a/common/widgets/grid_icon_text_helpers.cpp +++ b/common/widgets/grid_icon_text_helpers.cpp @@ -27,7 +27,7 @@ #include -//---- Grid helpers: custom wxGridCellRenderer ------------------------------------------ +//---- Grid helpers: custom wxGridCellRenderer that renders icon and a label ------------ GRID_CELL_ICON_TEXT_RENDERER::GRID_CELL_ICON_TEXT_RENDERER( const std::vector& icons, @@ -68,6 +68,44 @@ void GRID_CELL_ICON_TEXT_RENDERER::Draw( wxGrid& aGrid, wxGridCellAttr& aAttr, w aGrid.DrawTextRectangle( aDC, value, rect, wxALIGN_LEFT, wxALIGN_CENTRE ); } +//---- Grid helpers: custom wxGridCellRenderer that renders just an icon ---------------- +// +// Note: this renderer is supposed to be used with read only cells + +GRID_CELL_ICON_RENDERER::GRID_CELL_ICON_RENDERER(const wxBitmap& icon) : m_icon( icon ) +{ +} + + +void GRID_CELL_ICON_RENDERER::Draw( wxGrid& aGrid, wxGridCellAttr& aAttr, wxDC& aDC, + const wxRect& aRect, int aRow, int aCol, bool isSelected ) +{ + wxRect rect = aRect; + rect.Inflate( -1 ); + + // erase background + wxGridCellRenderer::Draw( aGrid, aAttr, aDC, aRect, aRow, aCol, isSelected ); + + // Draw icon + if( m_icon.IsOk() ) + { + aDC.DrawBitmap( m_icon, + rect.GetLeft() + (rect.GetWidth() - m_icon.GetWidth()) / 2, + rect.GetTop() + (rect.GetHeight() - m_icon.GetHeight()) / 2, + true ); + } +} + +wxSize GRID_CELL_ICON_RENDERER::GetBestSize(wxGrid& grid, wxGridCellAttr& attr, wxDC& dc, int row, int col) +{ + return wxSize( m_icon.GetWidth() + 6, m_icon.GetHeight() + 4 ); +} + + +wxGridCellRenderer* GRID_CELL_ICON_RENDERER::Clone() const +{ + return new GRID_CELL_ICON_RENDERER( m_icon ); +} //---- Grid helpers: custom wxGridCellEditor ------------------------------------------ diff --git a/include/widgets/grid_icon_text_helpers.h b/include/widgets/grid_icon_text_helpers.h index 9e14829..e859f11 100644 --- a/include/widgets/grid_icon_text_helpers.h +++ b/include/widgets/grid_icon_text_helpers.h @@ -34,7 +34,7 @@ class wxGrid; -//---- Grid helpers: custom wxGridCellRenderer ------------------------------------------ +//---- Grid helpers: custom wxGridCellRenderer that renders icon and a label ------------ class GRID_CELL_ICON_TEXT_RENDERER : public wxGridCellStringRenderer { @@ -49,6 +49,23 @@ private: const wxArrayString& m_names; }; +//---- Grid helpers: custom wxGridCellRenderer that renders just an icon ---------------- +// +// Note: use with read only cells + +class GRID_CELL_ICON_RENDERER : public wxGridCellRenderer +{ +public: + GRID_CELL_ICON_RENDERER( const wxBitmap& icon ); + + void Draw( wxGrid& aGrid, wxGridCellAttr& aAttr, wxDC& aDC, + const wxRect& aRect, int aRow, int aCol, bool isSelected ) override; + wxSize GetBestSize(wxGrid & grid, wxGridCellAttr & attr, wxDC & dc, int row, int col) override; + wxGridCellRenderer* Clone() const override; + +private: + const wxBitmap& m_icon; +}; //---- Grid helpers: custom wxGridCellEditor ------------------------------------------ // diff --git a/pcbnew/CMakeLists.txt b/pcbnew/CMakeLists.txt index d9f55dd..99d9ad4 100644 --- a/pcbnew/CMakeLists.txt +++ b/pcbnew/CMakeLists.txt @@ -152,8 +152,6 @@ set( PCBNEW_DIALOGS dialogs/panel_modedit_settings_base.cpp dialogs/panel_pcbnew_display_options.cpp dialogs/panel_pcbnew_display_options_base.cpp - dialogs/panel_pcbnew_display_options.cpp - dialogs/panel_pcbnew_display_options_base.cpp dialogs/panel_pcbnew_settings.cpp dialogs/panel_pcbnew_settings_base.cpp dialogs/panel_setup_mask_and_paste.cpp @@ -174,6 +172,13 @@ set( PCBNEW_DIALOGS ${GITHUB_3DLIBRARIES_WIZARD} ) +if( KICAD_SCRIPTING AND KICAD_SCRIPTING_ACTION_MENU ) + set( PCBNEW_DIALOGS ${PCBNEW_DIALOGS} + dialogs/panel_pcbnew_action_plugins.cpp + dialogs/panel_pcbnew_action_plugins_base.cpp + ) +endif() + set( PCBNEW_IMPORT_DXF import_dxf/dialog_dxf_import.cpp import_dxf/dialog_dxf_import_base.cpp diff --git a/pcbnew/action_plugin.cpp b/pcbnew/action_plugin.cpp index c10d0fa..c79a299 100644 --- a/pcbnew/action_plugin.cpp +++ b/pcbnew/action_plugin.cpp @@ -79,6 +79,46 @@ int ACTION_PLUGINS::GetActionMenu( int aIndex ) } +ACTION_PLUGIN* ACTION_PLUGINS::GetActionByButton( int aButton ) +{ + int max = GetActionsCount(); + + for( int i = 0; i < max; i++ ) + { + if( m_actionsList[i]->m_actionButtonId == aButton ) + return m_actionsList[i]; + } + + return NULL; +} + + +void ACTION_PLUGINS::SetActionButton( ACTION_PLUGIN* aAction, int idButton ) +{ + aAction->m_actionButtonId = idButton; +} + + +int ACTION_PLUGINS::GetActionButton( int aIndex ) +{ + return m_actionsList[aIndex]->m_actionButtonId; +} + + +ACTION_PLUGIN* ACTION_PLUGINS::GetActionByPath(const wxString& aPath) +{ + for( int i = 0; i < GetActionsCount() ; i++ ) + { + if( m_actionsList[ i ]->GetPluginPath() == aPath) + { + return m_actionsList[ i ]; + } + } + + return NULL; +} + + ACTION_PLUGIN* ACTION_PLUGINS::GetAction( const wxString& aName ) { int max = GetActionsCount(); @@ -127,6 +167,20 @@ void ACTION_PLUGINS::register_action( ACTION_PLUGIN* aAction ) } } + // Load icon if supplied + if (!aAction->GetIconFileName().IsEmpty()) + { + { + wxLogNull eat_errors; + aAction->iconBitmap.LoadFile( aAction->GetIconFileName() , wxBITMAP_TYPE_PNG ); + } + + if ( !aAction->iconBitmap.IsOk() ) + { + wxLogVerbose( "Failed to load icon " + aAction->GetIconFileName() + " for action plugin " ); + } + } + m_actionsList.push_back( aAction ); } diff --git a/pcbnew/action_plugin.h b/pcbnew/action_plugin.h index ff3ed14..23f3b41 100644 --- a/pcbnew/action_plugin.h +++ b/pcbnew/action_plugin.h @@ -44,9 +44,16 @@ public: // m_actionMenuId set to 0 means the corresponding menuitem to call this // action is not yet created int m_actionMenuId; + // Same for button id + int m_actionButtonId; + // Icon for the action button and menu entry + wxBitmap iconBitmap; + // If show_on_toolbar is true a button will be added to top toolbar + bool show_on_toolbar; public: - ACTION_PLUGIN() : m_actionMenuId( 0 ) {} + ACTION_PLUGIN() : m_actionMenuId( 0 ), m_actionButtonId( 0 ), + show_on_toolbar( false ) {} virtual ~ACTION_PLUGIN(); /** @@ -69,6 +76,24 @@ public: virtual wxString GetDescription() = 0; /** + * Function GetShowToolbarButton + * @return true if button should be shown on top toolbar + */ + virtual bool GetShowToolbarButton() = 0; + + /** + * Function GetIconFileName + * @return a path to icon for the action plugin button + */ + virtual wxString GetIconFileName() = 0; + + /** + * Function GetPluginPath + * @return a path this plugin was loaded from + */ + virtual wxString GetPluginPath() = 0; + + /** * Function GetObject * This method gets the pointer to the object from where this action constructs * @return it's a void pointer, as it could be a PyObject or any other @@ -137,7 +162,6 @@ public: */ static void SetActionMenu( int aIndex, int idMenu ); - /** * Function GetActionMenu * Provide menu id for a plugin index @@ -146,7 +170,6 @@ public: */ static int GetActionMenu( int aIndex ); - /** * Function GetActionByMenu * find action plugin associated to a menu id @@ -155,6 +178,37 @@ public: */ static ACTION_PLUGIN* GetActionByMenu( int aMenu ); + /** + * Function SetActionButton + * Associate a button id to an action plugin + * @param aAction is the action + * @param idButton is the associated menuitem id + */ + static void SetActionButton( ACTION_PLUGIN* aAction, int idButton ); + + /** + * Function GetActionButton + * Provide button id for a plugin index + * @param aIndex is the action index + * @return associated menuitem id + */ + static int GetActionButton( int aIndex ); + + /** + * Function GetActionByButton + * find action plugin associated to a button id + * @param aMenu is the button id (defined with SetActionButton) + * @return the associated ACTION_PLUGIN (or null if not found) + */ + static ACTION_PLUGIN* GetActionByButton( int aButton ); + + /** + * Function GetActionByPath + * find action plugin by module path + * @param aPath the path of plugin + * @return the corresponding ACTION_PLUGIN (or null if not found) + */ + static ACTION_PLUGIN* GetActionByPath( const wxString& aPath ); /** * Function GetAction diff --git a/pcbnew/dialogs/panel_pcbnew_action_plugins.cpp b/pcbnew/dialogs/panel_pcbnew_action_plugins.cpp new file mode 100644 index 0000000..fb2b051 --- /dev/null +++ b/pcbnew/dialogs/panel_pcbnew_action_plugins.cpp @@ -0,0 +1,203 @@ +/* + * This program source code file is part of KiCad, a free EDA CAD application. + * + * Copyright (C) 2018 Andrew Lutsenko, anlutsenko at gmail dot com + * Copyright (C) 1992-2018 KiCad Developers, see AUTHORS.txt for contributors. + * + * This program is free software: you can redistribute it and/or modify it + * under the terms of the GNU General Public License as published by the + * Free Software Foundation, either version 3 of the License, or (at your + * option) any later version. + * + * This program is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program. If not, see . + */ + +#include +#include +#include +#include +#include +#include +#include + + +PANEL_PCBNEW_ACTION_PLUGINS::PANEL_PCBNEW_ACTION_PLUGINS( PCB_EDIT_FRAME* aFrame, PAGED_DIALOG* aWindow ) : + PANEL_PCBNEW_ACTION_PLUGINS_BASE( aWindow->GetTreebook() ), + m_frame( aFrame ) +{ + m_genericIcon = KiBitmap( hammer_xpm ); + m_grid->PushEventHandler( new GRID_TRICKS( m_grid ) ); + + m_moveUpButton->SetBitmap( KiBitmap( up_xpm ) ); + m_moveDownButton->SetBitmap( KiBitmap( down_xpm ) ); + m_reloadButton->SetBitmap( KiBitmap( reload_xpm ) ); +} + + +PANEL_PCBNEW_ACTION_PLUGINS::~PANEL_PCBNEW_ACTION_PLUGINS() +{ + m_grid->PopEventHandler( true ); +} + + +void PANEL_PCBNEW_ACTION_PLUGINS::OnGridCellClick( wxGridEvent& event ) +{ + SelectRow( event.GetRow() ); +} + + +void PANEL_PCBNEW_ACTION_PLUGINS::SelectRow( int aRow ) +{ + m_grid->ClearSelection(); + m_grid->SelectRow( aRow ); +} + + +void PANEL_PCBNEW_ACTION_PLUGINS::OnMoveUpButtonClick( wxCommandEvent& event ) +{ + auto selectedRows = m_grid->GetSelectedRows(); + + // If nothing is selected or multiple rows are selected don't do anything. + if( selectedRows.size() != 1) + { + return; + } + + int selectedRow = selectedRows[ 0 ]; + + // If first row is selected, then it can't go any further up. + if( selectedRow == 0 ) + { + return; + } + + SwapRows( selectedRow, selectedRow - 1 ); + + SelectRow( selectedRow - 1 ); +} + + +void PANEL_PCBNEW_ACTION_PLUGINS::OnMoveDownButtonClick( wxCommandEvent& event ) +{ + auto selectedRows = m_grid->GetSelectedRows(); + + // If nothing is selected or multiple rows are selected don't do anything. + if( selectedRows.size() != 1) + { + return; + } + + int selectedRow = selectedRows[ 0 ]; + + // If last row is selected, then it can't go any further down. + if( selectedRow + 1 == m_grid->GetNumberRows() ) + { + return; + } + + SwapRows( selectedRow, selectedRow + 1 ); + + SelectRow( selectedRow + 1 ); +} + + +void PANEL_PCBNEW_ACTION_PLUGINS::SwapRows( int aRowA, int aRowB ) +{ + m_grid->Freeze(); + + // Swap all columns except icon + wxString tempStr; + + for( int column = 1; column < m_grid->GetNumberCols(); column++ ) + { + tempStr = m_grid->GetCellValue( aRowA, column ); + m_grid->SetCellValue( aRowA, column, m_grid->GetCellValue( aRowB, column ) ); + m_grid->SetCellValue( aRowB, column, tempStr ); + } + + // Swap icon column renderers + auto cellRenderer = m_grid->GetCellRenderer( aRowA, 0 ); + m_grid->SetCellRenderer( aRowA, 0, m_grid->GetCellRenderer( aRowB, 0) ); + m_grid->SetCellRenderer( aRowB, 0, cellRenderer ); + + m_grid->Thaw(); +} + + +void PANEL_PCBNEW_ACTION_PLUGINS::OnReloadButtonClick( wxCommandEvent& event ) +{ + m_frame->PythonPluginsReload(); + TransferDataToWindow(); +} + + +bool PANEL_PCBNEW_ACTION_PLUGINS::TransferDataFromWindow() +{ + std::vector< std::pair > pluginSettings; + + for( int ii = 0; ii < m_grid->GetNumberRows(); ii++ ) + { + pluginSettings.push_back( std::make_pair( + m_grid->GetCellValue( ii, 5 ), + m_grid->GetCellValue( ii, 1 ) == wxT("1") ? wxT( "Visible" ) : wxT( "Hidden" ) + ) ); + } + + m_frame->SetActionPluginSettings( pluginSettings ); + + return true; +} + + +bool PANEL_PCBNEW_ACTION_PLUGINS::TransferDataToWindow() +{ + m_grid->Freeze(); + m_grid->DeleteRows( 0, m_grid->GetNumberRows() ); + + const auto& orderedPlugins = m_frame->GetOrderedActionPlugins(); + m_grid->AppendRows( orderedPlugins.size() ); + + for( const auto& entry : orderedPlugins ) + { + int row = entry.first; + ACTION_PLUGIN* ap = entry.second; + + // Icon + m_grid->SetCellRenderer( row, 0, new GRID_CELL_ICON_RENDERER( + ap->iconBitmap.IsOk() ? ap->iconBitmap : m_genericIcon ) ); + + // Toolbar button checkbox + m_grid->SetCellRenderer( row, 1, new wxGridCellBoolRenderer() ); + m_grid->SetCellAlignment( row, 1, wxALIGN_CENTER, wxALIGN_CENTER ); + + bool showButton = m_frame->GetActionPluginButtonVisible( + ap->GetPluginPath(), ap->GetShowToolbarButton() ); + + m_grid->SetCellValue( row, 1, showButton ? wxT( "1" ) : wxEmptyString ); + + // Name + m_grid->SetCellValue( row, 2, ap->GetName() ); + + // Category + m_grid->SetCellValue( row, 3, ap->GetCategoryName() ); + + // Description + m_grid->SetCellValue( row, 4, ap->GetDescription() ); + + // Path + m_grid->SetCellValue( row, 5, ap->GetPluginPath() ); + } + + m_grid->AutoSizeColumns(); + m_grid->AutoSizeRows(); + + m_grid->Thaw(); + + return true; +} diff --git a/pcbnew/dialogs/panel_pcbnew_action_plugins.h b/pcbnew/dialogs/panel_pcbnew_action_plugins.h new file mode 100644 index 0000000..4a4d434 --- /dev/null +++ b/pcbnew/dialogs/panel_pcbnew_action_plugins.h @@ -0,0 +1,59 @@ +/* + * This program source code file is part of KiCad, a free EDA CAD application. + * + * Copyright (C) 2018 Andrew Lutsenko, anlutsenko at gmail dot com + * Copyright (C) 1992-2018 KiCad Developers, see AUTHORS.txt for contributors. + * + * This program is free software: you can redistribute it and/or modify it + * under the terms of the GNU General Public License as published by the + * Free Software Foundation, either version 3 of the License, or (at your + * option) any later version. + * + * This program is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program. If not, see . + */ + +#include "panel_pcbnew_action_plugins_base.h" + +class PANEL_PCBNEW_ACTION_PLUGINS : public PANEL_PCBNEW_ACTION_PLUGINS_BASE +{ +public: + PANEL_PCBNEW_ACTION_PLUGINS ( PCB_EDIT_FRAME* aFrame, PAGED_DIALOG* aWindow ); + + bool TransferDataFromWindow() override; + bool TransferDataToWindow() override; + ~PANEL_PCBNEW_ACTION_PLUGINS() override; + + /** + * Selects a whole row + */ + void OnGridCellClick( wxGridEvent& event ) override; + + /** + * Moves plugin up in the grid + */ + void OnMoveUpButtonClick( wxCommandEvent& event ) override; + + /** + * Moves plugin down in the grid + */ + void OnMoveDownButtonClick( wxCommandEvent& event ) override; + + /** + * Reloads plugins and updates grid + */ + void OnReloadButtonClick( wxCommandEvent& event ) override; + +private: + PCB_EDIT_FRAME* m_frame; + wxBitmap m_genericIcon; + + void SwapRows( int aRowA, int aRowB ); + void SelectRow( int aRow ); +}; + diff --git a/pcbnew/dialogs/panel_pcbnew_action_plugins_base.cpp b/pcbnew/dialogs/panel_pcbnew_action_plugins_base.cpp new file mode 100644 index 0000000..3519b91 --- /dev/null +++ b/pcbnew/dialogs/panel_pcbnew_action_plugins_base.cpp @@ -0,0 +1,96 @@ +/////////////////////////////////////////////////////////////////////////// +// C++ code generated with wxFormBuilder (version Jul 11 2018) +// http://www.wxformbuilder.org/ +// +// PLEASE DO *NOT* EDIT THIS FILE! +/////////////////////////////////////////////////////////////////////////// + +#include "panel_pcbnew_action_plugins_base.h" + +/////////////////////////////////////////////////////////////////////////// + +PANEL_PCBNEW_ACTION_PLUGINS_BASE::PANEL_PCBNEW_ACTION_PLUGINS_BASE( wxWindow* parent, wxWindowID id, const wxPoint& pos, const wxSize& size, long style ) : wxPanel( parent, id, pos, size, style ) +{ + wxBoxSizer* bPanelSizer; + bPanelSizer = new wxBoxSizer( wxHORIZONTAL ); + + wxBoxSizer* bGridSizer; + bGridSizer = new wxBoxSizer( wxVERTICAL ); + + m_grid = new wxGrid( this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxBORDER_SIMPLE ); + + // Grid + m_grid->CreateGrid( 3, 6 ); + m_grid->EnableEditing( false ); + m_grid->EnableGridLines( true ); + m_grid->EnableDragGridSize( false ); + m_grid->SetMargins( 0, 0 ); + + // Columns + m_grid->AutoSizeColumns(); + m_grid->EnableDragColMove( false ); + m_grid->EnableDragColSize( true ); + m_grid->SetColLabelSize( 22 ); + m_grid->SetColLabelValue( 0, wxT("Icon") ); + m_grid->SetColLabelValue( 1, wxT("Show button") ); + m_grid->SetColLabelValue( 2, wxT("Name") ); + m_grid->SetColLabelValue( 3, wxT("Category") ); + m_grid->SetColLabelValue( 4, wxT("Description") ); + m_grid->SetColLabelValue( 5, wxT("Path") ); + m_grid->SetColLabelAlignment( wxALIGN_CENTRE, wxALIGN_CENTRE ); + + // Rows + m_grid->EnableDragRowSize( true ); + m_grid->SetRowLabelSize( 0 ); + m_grid->SetRowLabelAlignment( wxALIGN_CENTRE, wxALIGN_CENTRE ); + + // Label Appearance + + // Cell Defaults + m_grid->SetDefaultCellAlignment( wxALIGN_LEFT, wxALIGN_CENTRE ); + bGridSizer->Add( m_grid, 1, wxALL|wxEXPAND, 5 ); + + + bPanelSizer->Add( bGridSizer, 1, wxALIGN_LEFT|wxEXPAND|wxLEFT, 0 ); + + wxBoxSizer* bButtonsSizer; + bButtonsSizer = new wxBoxSizer( wxVERTICAL ); + + m_moveUpButton = new wxBitmapButton( this, wxID_ANY, wxNullBitmap, wxDefaultPosition, wxDefaultSize, 0 ); + m_moveUpButton->SetMinSize( wxSize( 32,32 ) ); + + bButtonsSizer->Add( m_moveUpButton, 0, wxALIGN_TOP|wxALL, 5 ); + + m_moveDownButton = new wxBitmapButton( this, wxID_ANY, wxNullBitmap, wxDefaultPosition, wxDefaultSize, 0 ); + m_moveDownButton->SetMinSize( wxSize( 32,32 ) ); + + bButtonsSizer->Add( m_moveDownButton, 0, wxALL, 5 ); + + m_reloadButton = new wxBitmapButton( this, wxID_ANY, wxNullBitmap, wxDefaultPosition, wxDefaultSize, 0 ); + m_reloadButton->SetMinSize( wxSize( 32,32 ) ); + + bButtonsSizer->Add( m_reloadButton, 0, wxALL, 5 ); + + + bPanelSizer->Add( bButtonsSizer, 0, wxALIGN_RIGHT|wxALIGN_TOP, 0 ); + + + this->SetSizer( bPanelSizer ); + this->Layout(); + + // Connect Events + m_grid->Connect( wxEVT_GRID_CELL_LEFT_CLICK, wxGridEventHandler( PANEL_PCBNEW_ACTION_PLUGINS_BASE::OnGridCellClick ), NULL, this ); + m_moveUpButton->Connect( wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler( PANEL_PCBNEW_ACTION_PLUGINS_BASE::OnMoveUpButtonClick ), NULL, this ); + m_moveDownButton->Connect( wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler( PANEL_PCBNEW_ACTION_PLUGINS_BASE::OnMoveDownButtonClick ), NULL, this ); + m_reloadButton->Connect( wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler( PANEL_PCBNEW_ACTION_PLUGINS_BASE::OnReloadButtonClick ), NULL, this ); +} + +PANEL_PCBNEW_ACTION_PLUGINS_BASE::~PANEL_PCBNEW_ACTION_PLUGINS_BASE() +{ + // Disconnect Events + m_grid->Disconnect( wxEVT_GRID_CELL_LEFT_CLICK, wxGridEventHandler( PANEL_PCBNEW_ACTION_PLUGINS_BASE::OnGridCellClick ), NULL, this ); + m_moveUpButton->Disconnect( wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler( PANEL_PCBNEW_ACTION_PLUGINS_BASE::OnMoveUpButtonClick ), NULL, this ); + m_moveDownButton->Disconnect( wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler( PANEL_PCBNEW_ACTION_PLUGINS_BASE::OnMoveDownButtonClick ), NULL, this ); + m_reloadButton->Disconnect( wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler( PANEL_PCBNEW_ACTION_PLUGINS_BASE::OnReloadButtonClick ), NULL, this ); + +} diff --git a/pcbnew/dialogs/panel_pcbnew_action_plugins_base.fbp b/pcbnew/dialogs/panel_pcbnew_action_plugins_base.fbp new file mode 100644 index 0000000..a5329cb --- /dev/null +++ b/pcbnew/dialogs/panel_pcbnew_action_plugins_base.fbp @@ -0,0 +1,578 @@ + + + + + + C++ + 1 + source_name + 0 + 0 + res + UTF-8 + connect + panel_pcbnew_action_plugins_base + 1000 + none + 0 + 0 + PanelPcbnewActionPlugins + + . + + 1 + 1 + 1 + 1 + UI + 1 + 0 + + 0 + wxAUI_MGR_DEFAULT + + + 1 + 1 + impl_virtual + + + 0 + wxID_ANY + + + PANEL_PCBNEW_ACTION_PLUGINS_BASE + + 485,200 + ; forward_declare + + + + wxTAB_TRAVERSAL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + bPanelSizer + wxHORIZONTAL + none + + 0 + wxALIGN_LEFT|wxEXPAND|wxLEFT + 1 + + + bGridSizer + wxVERTICAL + none + + 5 + wxALL|wxEXPAND + 1 + + 1 + 1 + 1 + 1 + + + + + 1 + 0 + + + + 1 + + + wxALIGN_LEFT + + wxALIGN_CENTRE + 0 + 1 + wxALIGN_CENTRE + 22 + "Icon" "Show button" "Name" "Category" "Description" "Path" + wxALIGN_CENTRE + 6 + + + 1 + 0 + Dock + 0 + Left + 0 + 1 + 0 + 1 + 0 + 1 + + 1 + + + 1 + 0 + 0 + wxID_ANY + + + + 0 + 0 + + 0 + + + 0 + + 1 + m_grid + 1 + + + protected + 1 + + Resizable + wxALIGN_CENTRE + 0 + + wxALIGN_CENTRE + + 3 + 1 + + ; forward_declare + 0 + + + + wxBORDER_SIMPLE + + + + + + + + + + + + OnGridCellClick + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 0 + wxALIGN_RIGHT|wxALIGN_TOP + 0 + + + bButtonsSizer + wxVERTICAL + none + + 5 + wxALIGN_TOP|wxALL + 0 + + 1 + 1 + 1 + 1 + + + + + + + + + 1 + 0 + 1 + + 1 + + 0 + 0 + + Dock + 0 + Left + 1 + + 1 + + + 0 + 0 + wxID_ANY + Move Up + + 0 + + 0 + + + 0 + 32,32 + 1 + m_moveUpButton + 1 + + + protected + 1 + + + + Resizable + 1 + + + ; forward_declare + 0 + + + wxFILTER_NONE + wxDefaultValidator + + + + + + + + + + + OnMoveUpButtonClick + + + + + + + + + + + + + + + + + + + + + + + + + + + + 5 + wxALL + 0 + + 1 + 1 + 1 + 1 + + + + + + + + + 1 + 0 + 1 + + 1 + + 0 + 0 + + Dock + 0 + Left + 1 + + 1 + + + 0 + 0 + wxID_ANY + Move Down + + 0 + + 0 + + + 0 + 32,32 + 1 + m_moveDownButton + 1 + + + protected + 1 + + + + Resizable + 1 + + + ; forward_declare + 0 + + + wxFILTER_NONE + wxDefaultValidator + + + + + + + + + + + OnMoveDownButtonClick + + + + + + + + + + + + + + + + + + + + + + + + + + + + 5 + wxALL + 0 + + 1 + 1 + 1 + 1 + + + + + + + + + 1 + 0 + 1 + + 1 + + 0 + 0 + + Dock + 0 + Left + 1 + + 1 + + + 0 + 0 + wxID_ANY + Reload Plugins + + 0 + + 0 + + + 0 + 32,32 + 1 + m_reloadButton + 1 + + + protected + 1 + + + + Resizable + 1 + + + ; forward_declare + 0 + + + wxFILTER_NONE + wxDefaultValidator + + + + + + + + + + + OnReloadButtonClick + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/pcbnew/dialogs/panel_pcbnew_action_plugins_base.h b/pcbnew/dialogs/panel_pcbnew_action_plugins_base.h new file mode 100644 index 0000000..53f0392 --- /dev/null +++ b/pcbnew/dialogs/panel_pcbnew_action_plugins_base.h @@ -0,0 +1,56 @@ +/////////////////////////////////////////////////////////////////////////// +// C++ code generated with wxFormBuilder (version Jul 11 2018) +// http://www.wxformbuilder.org/ +// +// PLEASE DO *NOT* EDIT THIS FILE! +/////////////////////////////////////////////////////////////////////////// + +#ifndef __PANEL_PCBNEW_ACTION_PLUGINS_BASE_H__ +#define __PANEL_PCBNEW_ACTION_PLUGINS_BASE_H__ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +/////////////////////////////////////////////////////////////////////////// + +/////////////////////////////////////////////////////////////////////////////// +/// Class PANEL_PCBNEW_ACTION_PLUGINS_BASE +/////////////////////////////////////////////////////////////////////////////// +class PANEL_PCBNEW_ACTION_PLUGINS_BASE : public wxPanel +{ + private: + + protected: + wxGrid* m_grid; + wxBitmapButton* m_moveUpButton; + wxBitmapButton* m_moveDownButton; + wxBitmapButton* m_reloadButton; + + // Virtual event handlers, overide them in your derived class + virtual void OnGridCellClick( wxGridEvent& event ) { event.Skip(); } + virtual void OnMoveUpButtonClick( wxCommandEvent& event ) { event.Skip(); } + virtual void OnMoveDownButtonClick( wxCommandEvent& event ) { event.Skip(); } + virtual void OnReloadButtonClick( wxCommandEvent& event ) { event.Skip(); } + + + public: + + PANEL_PCBNEW_ACTION_PLUGINS_BASE( wxWindow* parent, wxWindowID id = wxID_ANY, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxSize( 485,200 ), long style = wxTAB_TRAVERSAL ); + ~PANEL_PCBNEW_ACTION_PLUGINS_BASE(); + +}; + +#endif //__PANEL_PCBNEW_ACTION_PLUGINS_BASE_H__ diff --git a/pcbnew/pcb_edit_frame.cpp b/pcbnew/pcb_edit_frame.cpp index 9149d4b..49f20b8 100644 --- a/pcbnew/pcb_edit_frame.cpp +++ b/pcbnew/pcb_edit_frame.cpp @@ -1249,6 +1249,8 @@ void PCB_EDIT_FRAME::PythonPluginsReload() // Action plugins can be modified, therefore the plugins menu // must be updated: RebuildActionPluginMenus(); + // Recreate top toolbar to add action plugin buttons + ReCreateHToolbar(); #endif #endif } diff --git a/pcbnew/pcb_edit_frame.h b/pcbnew/pcb_edit_frame.h index 4179353..2921e98 100644 --- a/pcbnew/pcb_edit_frame.h +++ b/pcbnew/pcb_edit_frame.h @@ -25,13 +25,14 @@ #define WXPCB_STRUCT_H_ #include +#include #include "pcb_base_edit_frame.h" #include "config_params.h" #include "undo_redo_container.h" #include "zones.h" - /* Forward declarations of classes. */ +class ACTION_PLUGIN; class PCB_SCREEN; class BOARD; class BOARD_COMMIT; @@ -122,6 +123,12 @@ protected: void RebuildActionPluginMenus(); /** + * Function AddActionPluginTools + * Append action plugin buttons to main toolbar + */ + void AddActionPluginTools(); + + /** * Function OnActionPlugin * Launched by the menu when an action is called * @param aEvent sent by wx @@ -379,6 +386,36 @@ public: // Configurations: void Process_Config( wxCommandEvent& event ); +#if defined(KICAD_SCRIPTING) && defined(KICAD_SCRIPTING_ACTION_MENU) + + /** + * Function SetActionPluginSettings + * Set a set of plugins that have visible buttons on toolbar + * Plugins are identified by their module path + */ + void SetActionPluginSettings( const std::vector< std::pair >& aPluginsWithButtons ); + + /** + * Function GetActionPluginSettings + * Get a set of plugins that have visible buttons on toolbar + */ + std::vector< std::pair > GetActionPluginSettings(); + + /** + * Function GetActionPluginButtonVisible + * Returns true if button visibility action plugin setting was set to true + * or it is unset and plugin defaults to true. + */ + bool GetActionPluginButtonVisible( const wxString& aPluginPath, bool aPluginDefault ); + + /** + * Function GetOrderedActionPlugins + * Returns ordered set of plugins in sequence in which they should appear on toolbar or in settings + */ + std::map< int, ACTION_PLUGIN* > GetOrderedActionPlugins(); + +#endif + /** * Function GetProjectFileParameters * returns a project file parameter list for Pcbnew. diff --git a/pcbnew/pcb_general_settings.cpp b/pcbnew/pcb_general_settings.cpp index a8c70cd..021a9c3 100644 --- a/pcbnew/pcb_general_settings.cpp +++ b/pcbnew/pcb_general_settings.cpp @@ -22,6 +22,7 @@ */ #include +#include PCB_GENERAL_SETTINGS::PCB_GENERAL_SETTINGS( FRAME_T aFrameType ) : m_frameType( aFrameType ), m_colorsSettings( aFrameType ) @@ -54,6 +55,32 @@ PCB_GENERAL_SETTINGS::PCB_GENERAL_SETTINGS( FRAME_T aFrameType ) void PCB_GENERAL_SETTINGS::Load( wxConfigBase* aCfg ) { m_colorsSettings.Load( aCfg ); + +#if defined(KICAD_SCRIPTING) && defined(KICAD_SCRIPTING_ACTION_MENU) + + m_pluginSettings.clear(); + + wxString pluginSettings = aCfg->Read( "ActionPluginButtons" ); + + wxStringTokenizer pluginSettingsTokenizer = wxStringTokenizer( pluginSettings, ";" ); + + while( pluginSettingsTokenizer.HasMoreTokens() ) + { + wxString plugin = pluginSettingsTokenizer.GetNextToken(); + wxStringTokenizer pluginTokenizer = wxStringTokenizer( plugin, "=" ); + + if ( pluginTokenizer.CountTokens() != 2 ) + { + // Bad config + continue; + } + + plugin = pluginTokenizer.GetNextToken(); + m_pluginSettings.push_back( std::make_pair( plugin, pluginTokenizer.GetNextToken() ) ); + } + +#endif + SETTINGS::Load( aCfg ); } @@ -61,6 +88,24 @@ void PCB_GENERAL_SETTINGS::Load( wxConfigBase* aCfg ) void PCB_GENERAL_SETTINGS::Save( wxConfigBase* aCfg ) { m_colorsSettings.Save( aCfg ); + +#if defined(KICAD_SCRIPTING) && defined(KICAD_SCRIPTING_ACTION_MENU) + + wxString pluginSettings; + + for( auto const& entry : m_pluginSettings ) + { + if( !pluginSettings.IsEmpty() ) + { + pluginSettings = pluginSettings + wxT( ";" ); + } + pluginSettings = pluginSettings + entry.first + wxT( "=" ) + entry.second; + } + + aCfg->Write( "ActionPluginButtons" , pluginSettings ); + +#endif + SETTINGS::Save( aCfg ); } diff --git a/pcbnew/pcb_general_settings.h b/pcbnew/pcb_general_settings.h index bc8f953..a422f75 100644 --- a/pcbnew/pcb_general_settings.h +++ b/pcbnew/pcb_general_settings.h @@ -25,6 +25,7 @@ #define __PCBNEW_GENERAL_SETTINGS_H #include +#include class wxConfigBase; class wxString; @@ -65,6 +66,10 @@ public: MAGNETIC_PAD_OPTION_VALUES m_magneticPads = CAPTURE_CURSOR_IN_TRACK_TOOL; MAGNETIC_PAD_OPTION_VALUES m_magneticTracks = CAPTURE_CURSOR_IN_TRACK_TOOL; +#if defined(KICAD_SCRIPTING) && defined(KICAD_SCRIPTING_ACTION_MENU) + std::vector< std::pair > m_pluginSettings; // Settings for action plugins +#endif + protected: const FRAME_T m_frameType; COLORS_DESIGN_SETTINGS m_colorsSettings; diff --git a/pcbnew/pcbnew_config.cpp b/pcbnew/pcbnew_config.cpp index ae164fd..b6025a5 100644 --- a/pcbnew/pcbnew_config.cpp +++ b/pcbnew/pcbnew_config.cpp @@ -45,6 +45,7 @@ #include #include #include +#include #include #include #include @@ -97,6 +98,9 @@ void PCB_EDIT_FRAME::InstallPreferences( PAGED_DIALOG* aParent ) book->AddPage( new PANEL_PCBNEW_SETTINGS( this, aParent ), _( "Pcbnew" ) ); book->AddSubPage( new PANEL_PCBNEW_DISPLAY_OPTIONS( this, aParent ), _( "Display Options" ) ); +#if defined(KICAD_SCRIPTING) && defined(KICAD_SCRIPTING_ACTION_MENU) + book->AddSubPage( new PANEL_PCBNEW_ACTION_PLUGINS( this, aParent ), _( "Action Plugins" ) ); +#endif } diff --git a/pcbnew/swig/pcbnew_action_plugins.cpp b/pcbnew/swig/pcbnew_action_plugins.cpp index 4fb232e..7c59f4e 100644 --- a/pcbnew/swig/pcbnew_action_plugins.cpp +++ b/pcbnew/swig/pcbnew_action_plugins.cpp @@ -140,6 +140,32 @@ wxString PYTHON_ACTION_PLUGIN::GetDescription() } +bool PYTHON_ACTION_PLUGIN::GetShowToolbarButton() +{ + PyLOCK lock; + + PyObject* result = CallMethod( "GetShowToolbarButton"); + + return PyObject_IsTrue(result); +} + + +wxString PYTHON_ACTION_PLUGIN::GetIconFileName() +{ + PyLOCK lock; + + return CallRetStrMethod( "GetIconFileName" ); +} + + +wxString PYTHON_ACTION_PLUGIN::GetPluginPath() +{ + PyLOCK lock; + + return CallRetStrMethod( "GetPluginPath" ); +} + + void PYTHON_ACTION_PLUGIN::Run() { PyLOCK lock; @@ -177,6 +203,11 @@ void PCB_EDIT_FRAME::OnActionPlugin( wxCommandEvent& aEvent ) ACTION_PLUGIN* actionPlugin = ACTION_PLUGINS::GetActionByMenu( id ); + if ( !actionPlugin ) { + // Try looking by button + actionPlugin = ACTION_PLUGINS::GetActionByButton( id ); + } + if( actionPlugin ) { PICKED_ITEMS_LIST itemsList; @@ -416,19 +447,28 @@ void PCB_EDIT_FRAME::RebuildActionPluginMenus() for( int ii = 0; ii < ACTION_PLUGINS::GetActionsCount(); ii++ ) { wxMenuItem* item; + ACTION_PLUGIN* ap = ACTION_PLUGINS::GetAction( ii ); + const wxBitmap& bitmap = ap->iconBitmap.IsOk() ? ap->iconBitmap : KiBitmap( hammer_xpm ); if( ii < (int) available_menus.size() ) { item = available_menus[ii]; - item->SetItemLabel( ACTION_PLUGINS::GetAction( ii )->GetName() ); - item->SetHelp( ACTION_PLUGINS::GetAction( ii )->GetDescription() ); + item->SetItemLabel( ap->GetName() ); + item->SetHelp( ap->GetDescription() ); + + // On windows we need to set "unchecked" bitmap + #if defined(__WXMSW__) + item->SetBitmap( bitmap, false ); + #else + item->SetBitmap( bitmap ); + #endif } else { item = AddMenuItem( actionMenu, wxID_ANY, - ACTION_PLUGINS::GetAction( ii )->GetName(), - ACTION_PLUGINS::GetAction( ii )->GetDescription(), - KiBitmap( hammer_xpm ) ); + ap->GetName(), + ap->GetDescription(), + bitmap ); Connect( item->GetId(), wxEVT_COMMAND_MENU_SELECTED, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & @@ -440,4 +480,101 @@ void PCB_EDIT_FRAME::RebuildActionPluginMenus() } +void PCB_EDIT_FRAME::AddActionPluginTools() +{ + bool need_separator = true; + const auto& orderedPlugins = GetOrderedActionPlugins(); + + for( const auto& entry : orderedPlugins ) + { + ACTION_PLUGIN* ap = entry.second; + + if( GetActionPluginButtonVisible( ap->GetPluginPath(), ap->GetShowToolbarButton() ) ) + { + + if ( need_separator ) + { + KiScaledSeparator( m_mainToolBar, this ); + need_separator = false; + } + + // Add button + wxBitmap bitmap = ap->iconBitmap.IsOk() ? ap->iconBitmap : KiBitmap( hammer_xpm ); + wxAuiToolBarItem* button = m_mainToolBar->AddTool( + wxID_ANY, wxEmptyString, bitmap, ap->GetName() ); + + Connect( button->GetId(), wxEVT_COMMAND_MENU_SELECTED, + (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & + PCB_EDIT_FRAME::OnActionPlugin ); + + // Link action plugin to button + ACTION_PLUGINS::SetActionButton( ap, button->GetId() ); + } + } +} + + +void PCB_EDIT_FRAME::SetActionPluginSettings( const std::vector< std::pair >& aPluginSettings ) +{ + m_configSettings.m_pluginSettings = aPluginSettings; + ReCreateHToolbar(); +} + + +std::vector< std::pair > PCB_EDIT_FRAME::GetActionPluginSettings() +{ + return m_configSettings.m_pluginSettings; +} + +std::map< int, ACTION_PLUGIN* > PCB_EDIT_FRAME::GetOrderedActionPlugins() +{ + std::map pluginToPosition; + + const auto& pluginSettings = GetActionPluginSettings(); + + for( size_t ii = 0; ii < pluginSettings.size(); ii++ ) + { + ACTION_PLUGIN* ap = ACTION_PLUGINS::GetActionByPath( pluginSettings[ ii ].first ); + if( ap ) + { + pluginToPosition.insert( { ap , ii } ); + } + } + + for( int ii = 0; ii < ACTION_PLUGINS::GetActionsCount(); ii++ ) + { + if( pluginToPosition.find( ACTION_PLUGINS::GetAction( ii ) ) == pluginToPosition.end() ) + { + pluginToPosition.insert( {ACTION_PLUGINS::GetAction( ii ), pluginToPosition.size() } ); + } + } + + std::map orderedPlugins; + + for( const auto& entry : pluginToPosition ) + { + orderedPlugins.insert( { entry.second, entry.first } ); + } + + return orderedPlugins; +} + +bool PCB_EDIT_FRAME::GetActionPluginButtonVisible( const wxString& aPluginPath, bool aPluginDefault ) +{ + auto& settings = m_configSettings.m_pluginSettings; + + for(const auto& entry : settings ) + { + if (entry.first == aPluginPath ) + { + return entry.second == wxT( "Visible" ); + } + } + + // Plugin is not in settings, return default. + return aPluginDefault; + +} + + #endif diff --git a/pcbnew/swig/pcbnew_action_plugins.h b/pcbnew/swig/pcbnew_action_plugins.h index 08dfa14..a1d6d9f 100644 --- a/pcbnew/swig/pcbnew_action_plugins.h +++ b/pcbnew/swig/pcbnew_action_plugins.h @@ -47,6 +47,9 @@ public: wxString GetCategoryName() override; wxString GetName() override; wxString GetDescription() override; + bool GetShowToolbarButton() override; + wxString GetIconFileName() override; + wxString GetPluginPath() override; void Run() override; void* GetObject() override; }; diff --git a/pcbnew/tool_pcb_editor.cpp b/pcbnew/tool_pcb_editor.cpp index 66b6223..b5c64c3 100644 --- a/pcbnew/tool_pcb_editor.cpp +++ b/pcbnew/tool_pcb_editor.cpp @@ -321,6 +321,10 @@ void PCB_EDIT_FRAME::ReCreateHToolbar() m_mainToolBar->AddTool( ID_TOOLBARH_PCB_SCRIPTING_CONSOLE, wxEmptyString, KiScaledBitmap( py_script_xpm, this ), _( "Show/Hide the Python Scripting console" ), wxITEM_CHECK ); + +#if defined(KICAD_SCRIPTING) && defined(KICAD_SCRIPTING_ACTION_MENU) + AddActionPluginTools(); +#endif } #endif diff --git a/scripting/kicadplugins.i b/scripting/kicadplugins.i index 8c1781d..d1615a2 100644 --- a/scripting/kicadplugins.i +++ b/scripting/kicadplugins.i @@ -260,14 +260,17 @@ def LoadPlugins(bundlepath=None): if module == '__init__.py' or module[-3:] != '.py': continue - LoadOnePlugin(plugins_dir, module); - + LoadOnePlugin(plugins_dir, module) + class KiCadPlugin: def __init__(self): pass def register(self): + import inspect + import os + if isinstance(self,FilePlugin): pass # register to file plugins in C++ @@ -276,6 +279,13 @@ class KiCadPlugin: return if isinstance(self,ActionPlugin): + """ + Get path to .py or .pyc that has definition of plugin class. + If path is binary but source also exists, assume definition is in source. + """ + self.__plugin_path = inspect.getfile(self.__class__) + if self.__plugin_path.endswith('.pyc') and os.path.isfile(self.__plugin_path[:-1]): + self.__plugin_path = self.__plugin_path[:-1] PYTHON_ACTION_PLUGINS.register_action(self) return @@ -295,6 +305,9 @@ class KiCadPlugin: return + def GetPluginPath( self ): + return self.__plugin_path + class FilePlugin(KiCadPlugin): def __init__(self): @@ -633,6 +646,8 @@ class FootprintWizardPlugin(KiCadPlugin, object): class ActionPlugin(KiCadPlugin, object): def __init__( self ): KiCadPlugin.__init__( self ) + self.icon_file_name = "" + self.show_toolbar_button = False self.defaults() def defaults( self ): @@ -649,6 +664,12 @@ class ActionPlugin(KiCadPlugin, object): def GetDescription( self ): return self.description + def GetShowToolbarButton( self ): + return self.show_toolbar_button + + def GetIconFileName( self ): + return self.icon_file_name + def Run(self): return -- 2.7.4