KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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_SCOPEscopes
 
std::vector< wxString > args
 
wxBitmapBundle icon_light
 
wxBitmapBundle icon_dark
 
const API_PLUGINplugin
 

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

◆ description

wxString PLUGIN_ACTION::description

Definition at line 88 of file api_plugin.h.

Referenced by API_PLUGIN::createActionFromJson().

◆ entrypoint

wxString PLUGIN_ACTION::entrypoint

◆ 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

◆ 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().


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