vdat.gui.tasks – Reduction steps and buttons

exception vdat.gui.tasks.TaskError[source]

Bases: Exception

class vdat.gui.tasks.VDATStack(cls, parent=None, name='tasks_stack')[source]

Bases: PyQt5.QtWidgets.QStackedWidget

Parent widget containing the buttons to run the reduction steps

Parameters:
parent : QtWidget instance

The QtWidget that the menu is attached to

name : string

name of the widget
get_subwidget(name)[source]

Returns a sub-widget called name. Create it if needed

setCurrentWidgetByName(name)[source]

Set the current widget by name

Parameters:
name : string

name associated with the widget
class vdat.gui.tasks.VDATTaskStack(parent=None, name='tasks_stack')[source]

Bases: vdat.gui.tasks.VDATStack

Parent widget containing the buttons to run the reduction steps

Parameters:
parent : QtWidget instance

The QtWidget that the menu is attached to

name : string

name of the widget
sig_taskChanged
sig_runCommand
get_subwidget(name)[source]

Returns a sub-widget called name. Create it if needed

setCurrentWidgetByName(name)[source]

Set the current widget by name

Parameters:
name : string

name associated with the widget
taskSelected(s, d)[source]
commandTriggered(s, l)[source]
class vdat.gui.tasks.VDATButtonStack(parent=None, name='tasks_stack')[source]

Bases: vdat.gui.tasks.VDATStack

Parent widget containing the buttons to run the reduction steps

Parameters:
parent : QtWidget instance

The QtWidget that the menu is attached to

name : string

name of the widget
sig_runCommand
get_subwidget(name)[source]

Returns a sub-widget called name. Create it if needed

commandTriggered(s, l)[source]
class vdat.gui.tasks.VDATTaskWidget(parent: QWidget = None, flags: Union[Qt.WindowFlags, Qt.WindowType] = Qt.WindowFlags())[source]

Bases: PyQt5.QtWidgets.QWidget

sig_selected
sig_command
selectFirst()[source]
add_task(task_dict, tool_tip=None)[source]

Adds a button to the widget.

Parameters:
name : string

name of the button

commands : list of strings, optional

strings defining the commands

tool_tip : string, optional

text that appears as a tool tip when the user hovers their mouse over the button
add_stretch(stretch=1)[source]

Add a stretch to the layout containing the buttons

Parameters:
stretch : int, optional

stretch factor
buttonSelected(i)[source]

Slot to catch the the button pressed from the button group, and re-emit with updated information

commandTriggered(s, l)[source]

Slot to catch the button pressed from the button group, and re-emit with updated information

class vdat.gui.tasks.VDATButtonWidget(parent: QWidget = None, flags: Union[Qt.WindowFlags, Qt.WindowType] = Qt.WindowFlags())[source]

Bases: PyQt5.QtWidgets.QWidget

sig_runCommand
add_button(name, command, tool_tip=None)[source]

Adds a button to the widget.

Parameters:
name : string

name of the button

commands : list of strings, optional

strings defining the commands

tool_tip : string, optional

text that appears as a tool tip when the user hovers their mouse over the button
clicked(i)[source]
vdat.gui.tasks.setup_tasks(parent=None)[source]

Set up and return the buttons

Parameters:
parent : PyQt5.QtWidgets.QWidget

parent of the button widget
Returns:
:class:`ButtonsMenu`

button widgets container