pyface.tasks.action.task_action module

class pyface.tasks.action.task_action.TaskAction[source]

Bases: ListeningAction

An Action that makes a callback to a Task.

Note that this is a convenience class. Actions associated with a Task need not inherit TaskAction, although they must, of course, inherit Action.

task = Instance(Task)

The Task with which the action is associated. Set by the framework.

destroy()[source]

Called when the action is no longer required.

Removes all the task listeners.

class pyface.tasks.action.task_action.TaskWindowAction[source]

Bases: TaskAction

An Action that makes a callback to a Task’s window.

class pyface.tasks.action.task_action.CentralPaneAction[source]

Bases: TaskAction

An Action that makes a callback to a Task’s central pane.

central_pane = Property(Instance(ITaskPane), observe="task")

The central pane with which the action is associated.

class pyface.tasks.action.task_action.DockPaneAction[source]

Bases: TaskAction

An Action the makes a callback to one of a Task’s dock panes.

dock_pane = Property(Instance(ITaskPane), observe="task")

The dock pane with which the action is associated. Set by the framework.

dock_pane_id = Str()

The ID of the dock pane with which the action is associated.

class pyface.tasks.action.task_action.EditorAction[source]

Bases: CentralPaneAction

An action that makes a callback to the active editor in an editor pane.

active_editor = Property(

The active editor in the central pane with which the action is associated.