PLUGIN_ACTION Struct Reference

An action performed by a plugin via the IPC API (not to be confused with ACTION_PLUGIN, the old SWIG plugin system, which will be removed in the future) 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 (not to be confused with ACTION_PLUGIN, the old SWIG plugin system, which will be removed in the future)

Definition at line 80 of file api_plugin.h.

Constructor & Destructor Documentation

PLUGIN_ACTION()

PLUGIN_ACTION::PLUGIN_ACTION ( const API_PLUGIN &  aPlugin )

inline

Definition at line 82 of file api_plugin.h.

Member Data Documentation

args

std::vector<wxString> PLUGIN_ACTION::args

Definition at line 92 of file api_plugin.h.

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

description

wxString PLUGIN_ACTION::description

Definition at line 88 of file api_plugin.h.

Referenced by API_PLUGIN::createActionFromJson().

entrypoint

wxString PLUGIN_ACTION::entrypoint

Definition at line 90 of file api_plugin.h.

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

icon_dark

wxBitmapBundle PLUGIN_ACTION::icon_dark

Definition at line 94 of file api_plugin.h.

Referenced by API_PLUGIN::createActionFromJson().

icon_light

wxBitmapBundle PLUGIN_ACTION::icon_light

Definition at line 93 of file api_plugin.h.

Referenced by API_PLUGIN::createActionFromJson().

identifier

wxString PLUGIN_ACTION::identifier

Definition at line 86 of file api_plugin.h.

Referenced by API_PLUGIN::ActionSettingsKey(), API_PLUGIN::createActionFromJson(), API_PLUGIN_MANAGER::InvokeAction(), and EDA_DRAW_FRAME::IsPluginActionButtonVisible().

name

wxString PLUGIN_ACTION::name

Definition at line 87 of file api_plugin.h.

Referenced by API_PLUGIN::createActionFromJson().

plugin

const API_PLUGIN& PLUGIN_ACTION::plugin

Definition at line 96 of file api_plugin.h.

Referenced by API_PLUGIN_MANAGER::InvokeAction().

scopes

std::set<PLUGIN_ACTION_SCOPE> PLUGIN_ACTION::scopes

Definition at line 91 of file api_plugin.h.

Referenced by API_PLUGIN::createActionFromJson().

show_button

bool PLUGIN_ACTION::show_button = false

Definition at line 89 of file api_plugin.h.

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

---

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

• api_plugin.h