Difference between revisions of "Action"

Revision as of 19:22, 18 November 2012

All Actions must be derived from the Action base class, and should implement the available and execute methods.

Refer to the built-in Actions in the resources/scripts/actions directory for examples.

These attributes are read-only.

Name	Description
actionType	The Action Type
extension	If the Action implements an importer or exporter, the file extension the action works with
id	The Action class name
label	The Action label that appears in the Actions menu

Name	Description
__init__(label, menu=None, type=Action, extension=None)	Constructor - Initializes the base class. The menu can be listed separately or prefixed to the label with the '\|' character.
available()	Should return True (the default) if the Action is available. The Action should examine the current state in this method and assert (with an optional error message) that conditions are good for execution.
execute(path=None)	Called to execute the Action. UI Actions should be undoable. Importer/Exporter actions are passed the path to the file to operate on.

Name	Description
Action	A normal action that appears in the Actions menu (the default)
ShapeImporter	An Action that should appear in the Shape Import menu
ShapeExporter	An Action that should appear in the Shape Export menu
Extension	An Action that implements core functionality is bound using some other means

@@ Line 2: / Line 2: @@
 All Actions must be derived from the '''Action''' base class, and should implement the <tt>available</tt> and <tt>execute</tt> methods.
+Refer to the built-in Actions in the resources/scripts/actions directory for examples.
 === Attributes ===