#include <panel_pcbnew_action_plugins.h>

Inheritance diagram for PANEL_PCBNEW_ACTION_PLUGINS:

Public Member Functions
	PANEL_PCBNEW_ACTION_PLUGINS (PCB_EDIT_FRAME aFrame, PAGED_DIALOG aWindow)

bool	TransferDataFromWindow () override

bool	TransferDataToWindow () override

	~PANEL_PCBNEW_ACTION_PLUGINS () override

void	OnGridCellClick (wxGridEvent &event) override
	Selects a whole row. More...

void	OnMoveUpButtonClick (wxCommandEvent &event) override
	Moves plugin up in the grid. More...

void	OnMoveDownButtonClick (wxCommandEvent &event) override
	Moves plugin down in the grid. More...

void	OnOpenDirectoryButtonClick (wxCommandEvent &event) override
	Opens user's action plugin directory. More...

void	OnReloadButtonClick (wxCommandEvent &event) override
	Reloads plugins and updates grid. More...

void	OnShowErrorsButtonClick (wxCommandEvent &event) override
	Shows plugin import errors. More...

Protected Attributes
WX_GRID *	m_grid

wxBitmapButton *	m_moveUpButton

wxBitmapButton *	m_moveDownButton

wxBitmapButton *	m_openDirectoryButton

wxBitmapButton *	m_reloadButton

wxBitmapButton *	m_showErrorsButton

Private Types
enum	GRID_COLUMNS { COLUMN_ICON, COLUMN_VISIBLE, COLUMN_NAME, COLUMN_CATEGORY, COLUMN_DESCRIPTION, COLUMN_PATH }

Private Member Functions
void	SwapRows (int aRowA, int aRowB)

void	SelectRow (int aRow)

Private Attributes
PCB_EDIT_FRAME *	m_frame

wxBitmap	m_genericIcon

Detailed Description

Definition at line 23 of file panel_pcbnew_action_plugins.h.

Member Enumeration Documentation

◆ GRID_COLUMNS

enum PANEL_PCBNEW_ACTION_PLUGINS::GRID_COLUMNS

private

Enumerator
COLUMN_ICON
COLUMN_VISIBLE
COLUMN_NAME
COLUMN_CATEGORY
COLUMN_DESCRIPTION
COLUMN_PATH

Definition at line 64 of file panel_pcbnew_action_plugins.h.

     {
         COLUMN_ICON,
         COLUMN_VISIBLE,
         COLUMN_NAME,
         COLUMN_CATEGORY,
         COLUMN_DESCRIPTION,
         COLUMN_PATH
     };

Constructor & Destructor Documentation

◆ PANEL_PCBNEW_ACTION_PLUGINS()

PANEL_PCBNEW_ACTION_PLUGINS::PANEL_PCBNEW_ACTION_PLUGINS	(	PCB_EDIT_FRAME *	aFrame,
		PAGED_DIALOG *	aWindow
	)

Definition at line 42 of file panel_pcbnew_action_plugins.cpp.

                                                                                   :
         PANEL_PCBNEW_ACTION_PLUGINS_BASE( aWindow->GetTreebook() ),
         m_frame( aFrame )
 {
     m_genericIcon = KiBitmap( BITMAPS::puzzle_piece );
     m_grid->PushEventHandler( new GRID_TRICKS( m_grid ) );
 
     m_moveUpButton->SetBitmap( KiBitmap( BITMAPS::small_up ) );
     m_moveDownButton->SetBitmap( KiBitmap( BITMAPS::small_down ) );
     m_openDirectoryButton->SetBitmap( KiBitmap( BITMAPS::small_folder ) );
     m_reloadButton->SetBitmap( KiBitmap( BITMAPS::small_refresh ) );
     m_showErrorsButton->SetBitmap( KiBitmap( BITMAPS::small_warning ) );
 }

References KiBitmap(), m_genericIcon, PANEL_PCBNEW_ACTION_PLUGINS_BASE::m_grid, PANEL_PCBNEW_ACTION_PLUGINS_BASE::m_moveDownButton, PANEL_PCBNEW_ACTION_PLUGINS_BASE::m_moveUpButton, PANEL_PCBNEW_ACTION_PLUGINS_BASE::m_openDirectoryButton, PANEL_PCBNEW_ACTION_PLUGINS_BASE::m_reloadButton, PANEL_PCBNEW_ACTION_PLUGINS_BASE::m_showErrorsButton, puzzle_piece, small_down, small_folder, small_refresh, small_up, and small_warning.

◆ ~PANEL_PCBNEW_ACTION_PLUGINS()

PANEL_PCBNEW_ACTION_PLUGINS::~PANEL_PCBNEW_ACTION_PLUGINS ( )

override

Definition at line 58 of file panel_pcbnew_action_plugins.cpp.

 {
     m_grid->PopEventHandler( true );
 }

References PANEL_PCBNEW_ACTION_PLUGINS_BASE::m_grid.

Member Function Documentation

◆ OnGridCellClick()

void PANEL_PCBNEW_ACTION_PLUGINS::OnGridCellClick ( wxGridEvent & event )

overridevirtual

Selects a whole row.

Reimplemented from PANEL_PCBNEW_ACTION_PLUGINS_BASE.

Definition at line 64 of file panel_pcbnew_action_plugins.cpp.

 {
     SelectRow( event.GetRow() );
 }

References SelectRow().

◆ OnMoveDownButtonClick()

void PANEL_PCBNEW_ACTION_PLUGINS::OnMoveDownButtonClick ( wxCommandEvent & event )

overridevirtual

Moves plugin down in the grid.

Reimplemented from PANEL_PCBNEW_ACTION_PLUGINS_BASE.

Definition at line 99 of file panel_pcbnew_action_plugins.cpp.

 {
     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() )
     {
         wxBell();
         return;
     }
 
     SwapRows( selectedRow, selectedRow + 1 );
 
     SelectRow( selectedRow + 1 );
 }

References PANEL_PCBNEW_ACTION_PLUGINS_BASE::m_grid, SelectRow(), and SwapRows().

◆ OnMoveUpButtonClick()

void PANEL_PCBNEW_ACTION_PLUGINS::OnMoveUpButtonClick ( wxCommandEvent & event )

overridevirtual

Moves plugin up in the grid.

Reimplemented from PANEL_PCBNEW_ACTION_PLUGINS_BASE.

Definition at line 77 of file panel_pcbnew_action_plugins.cpp.

 {
     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 )
     {
         wxBell();
         return;
     }
 
     SwapRows( selectedRow, selectedRow - 1 );
 
     SelectRow( selectedRow - 1 );
 }

References PANEL_PCBNEW_ACTION_PLUGINS_BASE::m_grid, SelectRow(), and SwapRows().

◆ OnOpenDirectoryButtonClick()

void PANEL_PCBNEW_ACTION_PLUGINS::OnOpenDirectoryButtonClick ( wxCommandEvent & event )

overridevirtual

Opens user's action plugin directory.

Reimplemented from PANEL_PCBNEW_ACTION_PLUGINS_BASE.

Definition at line 237 of file panel_pcbnew_action_plugins.cpp.

 {
     m_frame->PythonPluginsShowFolder();
 }

References m_frame, and PCB_EDIT_FRAME::PythonPluginsShowFolder().

◆ OnReloadButtonClick()

void PANEL_PCBNEW_ACTION_PLUGINS::OnReloadButtonClick ( wxCommandEvent & event )

overridevirtual

Reloads plugins and updates grid.

Reimplemented from PANEL_PCBNEW_ACTION_PLUGINS_BASE.

Definition at line 144 of file panel_pcbnew_action_plugins.cpp.

 {
     m_frame->PythonPluginsReload();
     TransferDataToWindow();
 }

References m_frame, PCB_EDIT_FRAME::PythonPluginsReload(), and TransferDataToWindow().

◆ OnShowErrorsButtonClick()

void PANEL_PCBNEW_ACTION_PLUGINS::OnShowErrorsButtonClick ( wxCommandEvent & event )

overridevirtual

Shows plugin import errors.

Reimplemented from PANEL_PCBNEW_ACTION_PLUGINS_BASE.

Definition at line 242 of file panel_pcbnew_action_plugins.cpp.

 {
     wxString trace;
     pcbnewGetWizardsBackTrace( trace );
 
     // Now display the filtered trace in our dialog
     // (a simple wxMessageBox is really not suitable for long messages)
     DIALOG_FOOTPRINT_WIZARD_LOG logWindow( this );
     logWindow.m_Message->SetValue( trace );
     logWindow.ShowModal();
 }

References DIALOG_FOOTPRINT_WIZARD_LOG::m_Message, and pcbnewGetWizardsBackTrace().

◆ SelectRow()

void PANEL_PCBNEW_ACTION_PLUGINS::SelectRow ( int aRow )

private

Definition at line 70 of file panel_pcbnew_action_plugins.cpp.

 {
     m_grid->ClearSelection();
     m_grid->SelectRow( aRow );
 }

References PANEL_PCBNEW_ACTION_PLUGINS_BASE::m_grid.

Referenced by OnGridCellClick(), OnMoveDownButtonClick(), and OnMoveUpButtonClick().

◆ SwapRows()

void PANEL_PCBNEW_ACTION_PLUGINS::SwapRows	(	int	aRowA,
		int	aRowB
	)

private

Definition at line 121 of file panel_pcbnew_action_plugins.cpp.

 {
     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, COLUMN_ICON );
     m_grid->SetCellRenderer( aRowA, COLUMN_ICON, m_grid->GetCellRenderer( aRowB, COLUMN_ICON ) );
     m_grid->SetCellRenderer( aRowB, COLUMN_ICON, cellRenderer );
 
     m_grid->Thaw();
 }

References COLUMN_ICON, and PANEL_PCBNEW_ACTION_PLUGINS_BASE::m_grid.

Referenced by OnMoveDownButtonClick(), and OnMoveUpButtonClick().

◆ TransferDataFromWindow()

bool PANEL_PCBNEW_ACTION_PLUGINS::TransferDataFromWindow ( )

override

Definition at line 151 of file panel_pcbnew_action_plugins.cpp.

 {
     PCBNEW_SETTINGS* settings = dynamic_cast<PCBNEW_SETTINGS*>( Kiface().KifaceSettings() );
     wxASSERT( settings );
 
     if( settings )
     {
         settings->m_VisibleActionPlugins.clear();
 
         for( int ii = 0; ii < m_grid->GetNumberRows(); ii++ )
         {
             settings->m_VisibleActionPlugins.emplace_back( std::make_pair(
                     m_grid->GetCellValue( ii, COLUMN_PATH ),
                     m_grid->GetCellValue( ii, COLUMN_VISIBLE ) == wxT( "1" ) ) );
         }
     }
 
     return true;
 }

References COLUMN_PATH, COLUMN_VISIBLE, Kiface(), and PANEL_PCBNEW_ACTION_PLUGINS_BASE::m_grid.

◆ TransferDataToWindow()

bool PANEL_PCBNEW_ACTION_PLUGINS::TransferDataToWindow ( )

override

Definition at line 172 of file panel_pcbnew_action_plugins.cpp.

 {
     m_grid->Freeze();
 
     if( m_grid->GetNumberRows() != 0 )
         m_grid->DeleteRows( 0, m_grid->GetNumberRows() );
 
     const auto& orderedPlugins = m_frame->GetOrderedActionPlugins();
     m_grid->AppendRows( orderedPlugins.size() );
 
     for( size_t row = 0; row < orderedPlugins.size(); row++ )
     {
         ACTION_PLUGIN* ap = orderedPlugins[row];
 
         // Icon
         m_grid->SetCellRenderer( row, COLUMN_ICON, new GRID_CELL_ICON_RENDERER(
                                  ap->iconBitmap.IsOk() ? ap->iconBitmap : m_genericIcon ) );
 
         // Toolbar button checkbox
         m_grid->SetCellRenderer( row, COLUMN_VISIBLE, new wxGridCellBoolRenderer() );
         m_grid->SetCellAlignment( row, COLUMN_VISIBLE, wxALIGN_CENTER, wxALIGN_CENTER );
 
         bool showButton = m_frame->GetActionPluginButtonVisible( ap->GetPluginPath(),
                                                                  ap->GetShowToolbarButton() );
 
         m_grid->SetCellValue( row, COLUMN_VISIBLE, showButton ? wxT( "1" ) : wxEmptyString );
 
         m_grid->SetCellValue( row, COLUMN_NAME, ap->GetName() );
         m_grid->SetCellValue( row, COLUMN_CATEGORY, ap->GetCategoryName() );
         m_grid->SetCellValue( row, COLUMN_DESCRIPTION, ap->GetDescription() );
         m_grid->SetCellValue( row, COLUMN_PATH, ap->GetPluginPath() );
     }
 
     for( int col = 0; col < m_grid->GetNumberCols(); col++ )
     {
         const wxString& heading = m_grid->GetColLabelValue( col );
         int             headingWidth = GetTextExtent( heading ).x + 2 * GRID_CELL_MARGIN;
 
         // Set the minimal width to the column label size.
         m_grid->SetColMinimalWidth( col, headingWidth );
         // Set the width to see the full contents
         m_grid->SetColSize( col, m_grid->GetVisibleWidth( col, true, true, false ) );
     }
 
     m_grid->AutoSizeRows();
 
     m_grid->Thaw();
 
     // Show errors button should be disabled if there are no errors.
     wxString trace;
     pcbnewGetWizardsBackTrace( trace );
     if( trace.empty() )
     {
         m_showErrorsButton->Disable();
         m_showErrorsButton->Hide();
     }
     else
     {
         m_showErrorsButton->Enable();
         m_showErrorsButton->Show();
     }
 
     return true;
 }