PLUGIN_ACTION Struct Reference

An action performed by a plugin via the IPC API. More...

#include <api_plugin.h>

Public Member Functions
	PLUGIN_ACTION (const API_PLUGIN &aPlugin)

Public Attributes
wxString	identifier
wxString	name
wxString	description
bool	show_button = false
wxString	entrypoint
std::set< PLUGIN_ACTION_SCOPE >	scopes
std::vector< wxString >	args
wxBitmapBundle	icon_light
wxBitmapBundle	icon_dark
const API_PLUGIN &	plugin

Detailed Description

An action performed by a plugin via the IPC API.

Definition at line 70 of file api_plugin.h.

Constructor & Destructor Documentation

PLUGIN_ACTION()

PLUGIN_ACTION::PLUGIN_ACTION ( const API_PLUGIN & aPlugin )

inline

Definition at line 72 of file api_plugin.h.

References plugin.

Member Data Documentation

args

std::vector<wxString> PLUGIN_ACTION::args

Definition at line 82 of file api_plugin.h.

Referenced by API_PLUGIN::createActionFromJson(), and API_PLUGIN_MANAGER::doInvokeAction().

description

wxString PLUGIN_ACTION::description

Definition at line 78 of file api_plugin.h.

Referenced by API_PLUGIN::createActionFromJson(), and PANEL_PCBNEW_ACTION_PLUGINS::TransferDataToWindow().

entrypoint

wxString PLUGIN_ACTION::entrypoint

Definition at line 80 of file api_plugin.h.

Referenced by API_PLUGIN::createActionFromJson(), and API_PLUGIN_MANAGER::doInvokeAction().

icon_dark

wxBitmapBundle PLUGIN_ACTION::icon_dark

Definition at line 84 of file api_plugin.h.

Referenced by API_PLUGIN::createActionFromJson(), and PANEL_PCBNEW_ACTION_PLUGINS::TransferDataToWindow().

icon_light

wxBitmapBundle PLUGIN_ACTION::icon_light

Definition at line 83 of file api_plugin.h.

Referenced by API_PLUGIN::createActionFromJson(), and PANEL_PCBNEW_ACTION_PLUGINS::TransferDataToWindow().

identifier

wxString PLUGIN_ACTION::identifier

Definition at line 76 of file api_plugin.h.

Referenced by API_PLUGIN::ActionSettingsKey(), API_PLUGIN::createActionFromJson(), API_PLUGIN_MANAGER::doInvokeAction(), EDA_DRAW_FRAME::IsPluginActionButtonVisible(), and PANEL_PCBNEW_ACTION_PLUGINS::TransferDataToWindow().

name

wxString PLUGIN_ACTION::name

Definition at line 77 of file api_plugin.h.

Referenced by API_PLUGIN::createActionFromJson(), and PANEL_PCBNEW_ACTION_PLUGINS::TransferDataToWindow().

plugin

const API_PLUGIN& PLUGIN_ACTION::plugin

Definition at line 86 of file api_plugin.h.

Referenced by API_PLUGIN_MANAGER::doInvokeAction(), PLUGIN_ACTION(), and PANEL_PCBNEW_ACTION_PLUGINS::TransferDataToWindow().

scopes

std::set<PLUGIN_ACTION_SCOPE> PLUGIN_ACTION::scopes

Definition at line 81 of file api_plugin.h.

Referenced by API_PLUGIN::createActionFromJson().

show_button

bool PLUGIN_ACTION::show_button = false

Definition at line 79 of file api_plugin.h.

Referenced by API_PLUGIN::createActionFromJson(), EDA_DRAW_FRAME::IsPluginActionButtonVisible(), and PANEL_PCBNEW_ACTION_PLUGINS::TransferDataToWindow().

---

The documentation for this struct was generated from the following file:

• api_plugin.h