KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | Private Types | Private Member Functions | Private Attributes | List of all members
PANEL_PCBNEW_ACTION_PLUGINS Class Reference

#include <panel_pcbnew_action_plugins.h>

Inheritance diagram for PANEL_PCBNEW_ACTION_PLUGINS:
PANEL_PCBNEW_ACTION_PLUGINS_BASE

Public Member Functions

 PANEL_PCBNEW_ACTION_PLUGINS (wxWindow *aParent)
 
bool TransferDataFromWindow () override
 
bool TransferDataToWindow () override
 
 ~PANEL_PCBNEW_ACTION_PLUGINS () override
 
void OnGridCellClick (wxGridEvent &event) override
 Selects a whole row.
 
void OnMoveUpButtonClick (wxCommandEvent &event) override
 Moves plugin up in the grid.
 
void OnMoveDownButtonClick (wxCommandEvent &event) override
 Moves plugin down in the grid.
 
void OnOpenDirectoryButtonClick (wxCommandEvent &event) override
 Opens user's action plugin directory.
 
void OnReloadButtonClick (wxCommandEvent &event) override
 Reloads plugins and updates grid.
 
void OnShowErrorsButtonClick (wxCommandEvent &event) override
 Shows plugin import errors.
 

Protected Attributes

WX_GRID * m_grid
 
STD_BITMAP_BUTTON * m_moveUpButton
 
STD_BITMAP_BUTTON * m_moveDownButton
 
STD_BITMAP_BUTTON * m_openDirectoryButton
 
STD_BITMAP_BUTTON * m_reloadButton
 
STD_BITMAP_BUTTON * 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

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.

Constructor & Destructor Documentation

◆ PANEL_PCBNEW_ACTION_PLUGINS()

PANEL_PCBNEW_ACTION_PLUGINS::PANEL_PCBNEW_ACTION_PLUGINS ( wxWindow *  aParent)

Definition at line 39 of file panel_pcbnew_action_plugins.cpp.

References KiBitmap(), KiBitmapBundle(), 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, and STD_BITMAP_BUTTON::SetBitmap().

◆ ~PANEL_PCBNEW_ACTION_PLUGINS()

PANEL_PCBNEW_ACTION_PLUGINS::~PANEL_PCBNEW_ACTION_PLUGINS ( )
override

Definition at line 54 of file panel_pcbnew_action_plugins.cpp.

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 60 of file panel_pcbnew_action_plugins.cpp.

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 95 of file panel_pcbnew_action_plugins.cpp.

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 73 of file panel_pcbnew_action_plugins.cpp.

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 236 of file panel_pcbnew_action_plugins.cpp.

References SCRIPTING_TOOL::ShowPluginFolder().

◆ 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 140 of file panel_pcbnew_action_plugins.cpp.

References SCRIPTING_TOOL::ReloadPlugins(), 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.

References DIALOG_FOOTPRINT_WIZARD_LOG::m_Message, pcbnewGetWizardsBackTrace(), and DIALOG_SHIM::ShowModal().

◆ SelectRow()

void PANEL_PCBNEW_ACTION_PLUGINS::SelectRow ( int  aRow)
private

Definition at line 66 of file panel_pcbnew_action_plugins.cpp.

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 117 of file panel_pcbnew_action_plugins.cpp.

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 147 of file panel_pcbnew_action_plugins.cpp.

References COLUMN_PATH, COLUMN_VISIBLE, Kiface(), KIFACE_BASE::KifaceSettings(), PANEL_PCBNEW_ACTION_PLUGINS_BASE::m_grid, and PCBNEW_SETTINGS::m_VisibleActionPlugins.

◆ TransferDataToWindow()

bool PANEL_PCBNEW_ACTION_PLUGINS::TransferDataToWindow ( )
override

Definition at line 168 of file panel_pcbnew_action_plugins.cpp.

References WX_GRID::ClearRows(), COLUMN_CATEGORY, COLUMN_DESCRIPTION, COLUMN_ICON, COLUMN_NAME, COLUMN_PATH, COLUMN_VISIBLE, STD_BITMAP_BUTTON::Enable(), PCB_EDIT_FRAME::GetActionPluginButtonVisible(), ACTION_PLUGINS::GetActionsCount(), ACTION_PLUGIN::GetCategoryName(), ACTION_PLUGIN::GetDescription(), ACTION_PLUGIN::GetName(), PCB_EDIT_FRAME::GetOrderedActionPlugins(), ACTION_PLUGIN::GetPluginPath(), ACTION_PLUGIN::GetShowToolbarButton(), WX_GRID::GetVisibleWidth(), GRID_CELL_MARGIN, ACTION_PLUGIN::iconBitmap, m_genericIcon, PANEL_PCBNEW_ACTION_PLUGINS_BASE::m_grid, PANEL_PCBNEW_ACTION_PLUGINS_BASE::m_showErrorsButton, and pcbnewGetWizardsBackTrace().

Referenced by OnReloadButtonClick().

Member Data Documentation

◆ m_genericIcon

wxBitmap PANEL_PCBNEW_ACTION_PLUGINS::m_genericIcon
private

Definition at line 74 of file panel_pcbnew_action_plugins.h.

Referenced by PANEL_PCBNEW_ACTION_PLUGINS(), and TransferDataToWindow().

◆ m_grid

WX_GRID* PANEL_PCBNEW_ACTION_PLUGINS_BASE::m_grid
protectedinherited

Definition at line 40 of file panel_pcbnew_action_plugins_base.h.

Referenced by OnMoveDownButtonClick(), OnMoveUpButtonClick(), PANEL_PCBNEW_ACTION_PLUGINS(), PANEL_PCBNEW_ACTION_PLUGINS_BASE::PANEL_PCBNEW_ACTION_PLUGINS_BASE(), SelectRow(), SwapRows(), TransferDataFromWindow(), TransferDataToWindow(), ~PANEL_PCBNEW_ACTION_PLUGINS(), and PANEL_PCBNEW_ACTION_PLUGINS_BASE::~PANEL_PCBNEW_ACTION_PLUGINS_BASE().

◆ m_moveDownButton

STD_BITMAP_BUTTON* PANEL_PCBNEW_ACTION_PLUGINS_BASE::m_moveDownButton
protectedinherited

Definition at line 42 of file panel_pcbnew_action_plugins_base.h.

Referenced by PANEL_PCBNEW_ACTION_PLUGINS(), PANEL_PCBNEW_ACTION_PLUGINS_BASE::PANEL_PCBNEW_ACTION_PLUGINS_BASE(), and PANEL_PCBNEW_ACTION_PLUGINS_BASE::~PANEL_PCBNEW_ACTION_PLUGINS_BASE().

◆ m_moveUpButton

STD_BITMAP_BUTTON* PANEL_PCBNEW_ACTION_PLUGINS_BASE::m_moveUpButton
protectedinherited

Definition at line 41 of file panel_pcbnew_action_plugins_base.h.

Referenced by PANEL_PCBNEW_ACTION_PLUGINS(), PANEL_PCBNEW_ACTION_PLUGINS_BASE::PANEL_PCBNEW_ACTION_PLUGINS_BASE(), and PANEL_PCBNEW_ACTION_PLUGINS_BASE::~PANEL_PCBNEW_ACTION_PLUGINS_BASE().

◆ m_openDirectoryButton

STD_BITMAP_BUTTON* PANEL_PCBNEW_ACTION_PLUGINS_BASE::m_openDirectoryButton
protectedinherited

Definition at line 43 of file panel_pcbnew_action_plugins_base.h.

Referenced by PANEL_PCBNEW_ACTION_PLUGINS(), PANEL_PCBNEW_ACTION_PLUGINS_BASE::PANEL_PCBNEW_ACTION_PLUGINS_BASE(), and PANEL_PCBNEW_ACTION_PLUGINS_BASE::~PANEL_PCBNEW_ACTION_PLUGINS_BASE().

◆ m_reloadButton

STD_BITMAP_BUTTON* PANEL_PCBNEW_ACTION_PLUGINS_BASE::m_reloadButton
protectedinherited

Definition at line 44 of file panel_pcbnew_action_plugins_base.h.

Referenced by PANEL_PCBNEW_ACTION_PLUGINS(), PANEL_PCBNEW_ACTION_PLUGINS_BASE::PANEL_PCBNEW_ACTION_PLUGINS_BASE(), and PANEL_PCBNEW_ACTION_PLUGINS_BASE::~PANEL_PCBNEW_ACTION_PLUGINS_BASE().

◆ m_showErrorsButton

STD_BITMAP_BUTTON* PANEL_PCBNEW_ACTION_PLUGINS_BASE::m_showErrorsButton
protectedinherited

Definition at line 45 of file panel_pcbnew_action_plugins_base.h.

Referenced by PANEL_PCBNEW_ACTION_PLUGINS(), PANEL_PCBNEW_ACTION_PLUGINS_BASE::PANEL_PCBNEW_ACTION_PLUGINS_BASE(), TransferDataToWindow(), and PANEL_PCBNEW_ACTION_PLUGINS_BASE::~PANEL_PCBNEW_ACTION_PLUGINS_BASE().

The documentation for this class was generated from the following files: