KiCad Pcbnew Python Scripting
Loading...
Searching...
No Matches
pcbnew.ActionPlugin Class Reference
Inheritance diagram for pcbnew.ActionPlugin:

Public Member Functions

 __init__ (self)
 
 defaults (self)
 
 GetClassName (self)
 
 GetName (self)
 
 GetCategoryName (self)
 
 GetDescription (self)
 
 GetShowToolbarButton (self)
 
 GetIconFileName (self, dark)
 
 Run (self)
 
- Public Member Functions inherited from pcbnew.KiCadPlugin
 __init__ (self)
 
 register (self)
 
 deregister (self)
 
 GetPluginPath (self)
 

Public Attributes

str icon_file_name = ""
 
str dark_icon_file_name = ""
 
bool show_toolbar_button = False
 
str name = "Undefined Action plugin"
 
str category = "Undefined"
 
str description = ""
 

Detailed Description

Definition at line 4937 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

pcbnew.ActionPlugin.__init__ ( self)

Definition at line 4938 of file pcbnew.py.

Member Function Documentation

◆ defaults()

pcbnew.ActionPlugin.defaults ( self)

Definition at line 4945 of file pcbnew.py.

◆ GetCategoryName()

pcbnew.ActionPlugin.GetCategoryName ( self)

Definition at line 4956 of file pcbnew.py.

◆ GetClassName()

pcbnew.ActionPlugin.GetClassName ( self)

Definition at line 4950 of file pcbnew.py.

◆ GetDescription()

pcbnew.ActionPlugin.GetDescription ( self)

Definition at line 4959 of file pcbnew.py.

◆ GetIconFileName()

pcbnew.ActionPlugin.GetIconFileName ( self,
dark )

Definition at line 4965 of file pcbnew.py.

◆ GetName()

pcbnew.ActionPlugin.GetName ( self)

Definition at line 4953 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetShowToolbarButton()

pcbnew.ActionPlugin.GetShowToolbarButton ( self)

Definition at line 4962 of file pcbnew.py.

◆ Run()

pcbnew.ActionPlugin.Run ( self)

Definition at line 4971 of file pcbnew.py.

Member Data Documentation

◆ category

str pcbnew.ActionPlugin.category = "Undefined"

Definition at line 4947 of file pcbnew.py.

◆ dark_icon_file_name

str pcbnew.ActionPlugin.dark_icon_file_name = ""

Definition at line 4941 of file pcbnew.py.

◆ description

str pcbnew.ActionPlugin.description = ""

Definition at line 4948 of file pcbnew.py.

◆ icon_file_name

str pcbnew.ActionPlugin.icon_file_name = ""

Definition at line 4940 of file pcbnew.py.

◆ name

str pcbnew.ActionPlugin.name = "Undefined Action plugin"

Definition at line 4946 of file pcbnew.py.

◆ show_toolbar_button

bool pcbnew.ActionPlugin.show_toolbar_button = False

Definition at line 4942 of file pcbnew.py.


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