CheckableTool

class glue.viewers.common.tool.CheckableTool(viewer=None)

Bases: glue.viewers.common.tool.Tool

A tool that is checkable.

When checked, the activate method is executed, and when unchecked, the deactivate method is executed.

Attributes Summary

action_text
enabled	A property that callback functions can be added to.
icon
shortcut
status_tip
tool_id
tool_tip

Methods Summary

activate(self)	Fired when the toolbar button is activated
close(self)
deactivate(self)	Fired when the toolbar button is deactivated
menu_actions(self)	List of QtWidgets.QActions to be attached to this tool as a context menu.

Attributes Documentation

action_text = None

enabled

A property that callback functions can be added to.

When a callback property changes value, each callback function is called with information about the state change. Otherwise, callback properties behave just like normal instance variables.

CallbackProperties must be defined at the class level. Use the helper function add_callback() to attach a callback to a specific instance of a class with CallbackProperties

Parameters

default

The initial value for the property

docstringstr

The docstring for the property

getter, setterfunc

Custom getter and setter functions (advanced)

icon = None

shortcut = None

status_tip = None

tool_id = None

tool_tip = None

Methods Documentation

activate(self)

Fired when the toolbar button is activated

close(self)

deactivate(self)

Fired when the toolbar button is deactivated

menu_actions(self)

List of QtWidgets.QActions to be attached to this tool as a context menu.