labscript_utils.qtwidgets

Helper Widgets

class labscript_utils.qtwidgets.dragdroptab.DragDropTabBar(parent, group_id)

Bases: labscript_utils.qtwidgets.dragdroptab._BaseDragDropTabBar

FLUSH_GAP = 5

SCROLL_BUTTON_GAP = 2

SCROLL_BUTTON_WIDTH = 15

property drag_in_progress

property dragged_tab_index

property dragged_tab_parent

ensure_visible(index, prefer_left=True)

insertion_index_at(pos)

Compute at which index the tab with given upper left corner position in global coordinates should be inserted into the tabBar.

is_dragged_tab(index)

Return whether the tab at the given index is currently being dragged

limbo = None

minimumSizeHint(self) → QSize

mouseMoveEvent(event)

Update the parent of the tab to be the DragDropTabWidget under the mouse, if any, otherwise update it to the limbo object. Update the position of the tab in the widget it’s in.

mousePressEvent(event)

Take note of the tab that was clicked so it can be dragged on mouseMoveEvents

mouseReleaseEvent(event)

Same as mouseMove event - update the DragDropTabWidget and position of the tab to the current mouse position. Unless the mouse position is outside of any widgets at the time of mouse release, in which case move the tab to its last known parent and position.

on_scroll_button_clicked(button)

paintEvent(self, QPaintEvent)

paint_tab(index, painter, option)

setUsesScrollButtons(self, bool)

set_tab_parent(dest, index=None, pos=None)

Move the tab to the given parent DragDropTabBar if it’s not already there. index=None will determined the insertion index from the given mouse position.

sizeHint(self) → QSize

tabAt(self, QPoint) → int

tabInserted(self, int)

tabLayoutChange(self)

tabRect(self, int) → QRect

tabRemoved(self, int)

tab_widgets = {}

update(self)

update(self, QRect) update(self, QRegion) update(self, int, int, int, int)

update_dragged_tab_animation_pos(pos)

update_scroll_button_state()

update_tab_index(index, pos)

Check if the tab at the given index, being dragged by the mouse at the given position, needs to be moved. Move it and return the new index.

widgetAt(pos)

If the given position is over a DragDropTabBar belonging to the current group, return the DragDropTabBar. If it is over a TabWidget in the same group that has no tabs, or the dragged tab as its only tab, return its DragDropTabBar. Otherwise return the limbo object.

class labscript_utils.qtwidgets.dragdroptab.DragDropTabWidget(group_id=None, accept_drops_bar_only=False)

Bases: PyQt5.QtWidgets.QTabWidget

A tab widget that supports dragging and dropping of tabs between tab widgets that share a group_id. a group_id of None indicates that tab dragging is disabled.

setElideMode(self, Qt.TextElideMode)

setUsesScrollButtons(self, bool)

class labscript_utils.qtwidgets.dragdroptab.Tab(widget, text, data, text_color, tooltip, whats_this, button_left, button_right, icon)

Bases: tuple

property button_left

Alias for field number 6

property button_right

Alias for field number 7

property data

Alias for field number 2

property icon

Alias for field number 8

property text

Alias for field number 1

property text_color

Alias for field number 3

property tooltip

Alias for field number 4

property whats_this

Alias for field number 5

property widget

Alias for field number 0

class labscript_utils.qtwidgets.dragdroptab.TabAnimation(parent)

Bases: PyQt5.QtCore.QAbstractAnimation

animate_limbo(limbo, index)

If the floating tab in limbo is being sucked back into one of our tabs, then we can animate that by hiding the relevant tab rect off to the side somwhere whilst the floating tab swoops in.

duration(self) → int

ensure_running()

on_tab_moved(source_index, dest_index)

tabInserted(index)

tabRemoved(index)

target(i)

Return the target position we are animating toward for a tab

tau = 60.0

updateCurrentTime(self, int)

class labscript_utils.qtwidgets.dragdroptab.debug

Bases: object

DEBUG = False

depth = 0

classmethod trace(f)

decorator to print function entries and exits

class labscript_utils.qtwidgets.elide_label.ElideScrollArea(*args, **kwargs)

Bases: PyQt5.QtWidgets.QScrollArea

A ScrollArea for containing a label that we want to elide. The elision is attained by just letting the text we don’t want to see be scrolled off to the side with the scrollbars hidden.

event(self, QEvent) → bool

minimumSizeHint(self) → QSize

setElideMode(elideMode)

setWidget(self, QWidget)

sizeHint(self) → QSize

class labscript_utils.qtwidgets.elide_label.ElidedLabelContainer(label)

Bases: PyQt5.QtWidgets.QWidget

A QWidget to contain a QLabel with a single line of (possibly rich) text that we want to elide. The elision is obtained by putting the QLabel in a QScrollArea and having the QScrollarea only show the part of the text we want to see. An extra label with the elision indication “…” is also inserted next to the QScrollArea.

elideMode()

event(self, QEvent) → bool

minimumSizeHint(self) → QSize

setElideMode(elideMode)

sizeHint(self) → QSize

update_elide_widget()

labscript_utils.qtwidgets.elide_label.elide_label(label, layout, elide_mode)

Take an existing label that is in a layout, and wrap it in our widgets that elide the text, and insert it back into the layout. This is a hack that allows us to elide a QLabel with a single line of (possibly rich) text, a task that seems pretty much impossible to do in any kosher way.

This function is for modifying an existing label already in a layout, but if you are programatically creating a label, then you can wrap it in ElidedLabelContainer(label) before inserting it into a layout or other container widget, which is more flexible than this function which only works if the label is in a QBoxLayout

class labscript_utils.qtwidgets.fingertab.FingerTabBarWidget(parent=None, *args, **kwargs)

Bases: PyQt5.QtWidgets.QTabBar

paintEvent(self, QPaintEvent)

tabSizeHint(self, int) → QSize

class labscript_utils.qtwidgets.fingertab.FingerTabWidget(parent, *args)

Bases: PyQt5.QtWidgets.QTabWidget

A QTabWidget equivalent which uses our FingerTabBarWidget

class labscript_utils.qtwidgets.headerview_with_widgets.HorizontalHeaderViewWithWidgets(model, parent=None)

Bases: PyQt5.QtWidgets.QHeaderView

A QHeaderView that supports inserting arbitrary widgets into sections. Use setWidget(logical_index, widget) to set and setWidget(logical_index, None) to unset. Decorations, checkboxes or anything other than text in the headers containing widgets is unsupported, and may result in garbled output

do_update_widget_positions()

eventFilter(target, event)

Ensure we don’t leave the curor set as a resize handle when the mouse moves onto a child widget:

hideSection(self, int)

on_columnsInserted(parent, logical_first, logical_last)

on_columnsRemoved(parent, logical_first, logical_last)

sectionSizeFromContents(self, int) → QSize

setSectionHidden(self, int, bool)

setStyleSheet(self, str)

setWidget(logical_index, widget=None)

showEvent(self, QShowEvent)

showSection(self, int)

stylesheet = '\n QHeaderView::section {\n /* Will be set dynamically: */\n padding-top: %dpx;\n padding-bottom: %dpx;\n /* Required, otherwise set to zero upon setting any stylesheet at all: */\n padding-left: 4px;\n /* Required for some reason, otherwise other settings ignored: */\n color: black;\n }\n\n /* Any other style goes here: */\n %s\n '

thinspace = '\u2009'

update_indents()

update_widget_positions()

viewportEvent(self, QEvent) → bool

class labscript_utils.qtwidgets.InputPlotWindow.PlotWindow(*args, **kwargs)

Bases: zprocess.process_tree.Process

run(connection_name, hardware_name, device_name)

The method that gets called in the subprocess. To be overridden by subclasses

setTopLevelWindow()

update_plot(new_data)

class labscript_utils.qtwidgets.outputbox.OutputBox(container, scrollback_lines=1000)

Bases: qtutils.outputbox.OutputBox

A subclass of qtutils.outputbox.OutputBox configured with security from labconfig.

class labscript_utils.qtwidgets.toolpalette.ToolPalette(parent, name, *args, **kwargs)

Bases: PyQt5.QtWidgets.QScrollArea

addWidget(widget, force_relayout=True)

insertWidget(index, widget, force_relayout=True)

minimumSize(self) → QSize

minimumSizeHint(self) → QSize

resizeEvent(self, QResizeEvent)

sizeHint(self) → QSize

updateMinimumSize()

class labscript_utils.qtwidgets.toolpalette.ToolPaletteGroup(*args, **kwargs)

Bases: PyQt5.QtWidgets.QVBoxLayout

add_to_linked_width_group(width_group_name, name)

append_new_palette(name, *args, **kwargs)

create_linked_width_group(width_group_name, names)

get_index_from_name(name)

get_name_from_index(index)

get_palette(name)

get_palette_by_index(index)

has_palette(name)

hide_palette(name)

hide_palette_by_index(index)

insert_new_palette(index, name, *args, **kwargs)

remove(name)

remove_by_index(index)

remove_from_linked_width_group(width_group_name, name)

reorder_palette(name, new_index)

reorder_palette_by_index(old_index, new_index)

show_palette(name)

show_palette_by_index(index)

property widths_linked

Input/Output Widgets

class labscript_utils.qtwidgets.analoginput.AnalogInput(device_name, hardware_name, connection_name='-', display_name=None, horizontal_alignment=False, parent=None)

Bases: PyQt5.QtWidgets.QWidget

get_AI()

open_plot_window()

set_AI(AI, notify_old_AI=True, notify_new_AI=True)

set_value(value)

class labscript_utils.qtwidgets.analogoutput.AnalogOutput(hardware_name, connection_name='-', display_name=None, horizontal_alignment=False, parent=None)

Bases: PyQt5.QtWidgets.QWidget

block_combobox_signals()

block_spinbox_signals()

connect_value_change(func)

disconnect_value_change()

eventFilter(self, QObject, QEvent) → bool

get_AO()

lock(notify_ao=True)

property selected_unit

set_AO(AO, notify_old_AO=True, notify_new_AO=True)

set_combobox_model(model)

set_limits(lower, upper)

set_num_decimals(decimals)

set_selected_unit(unit)

set_spinbox_value(value, unit)

set_step_size(step)

unblock_combobox_signals()

unblock_spinbox_signals()

unlock(notify_ao=True)

class labscript_utils.qtwidgets.analogoutput.NoStealFocusDoubleSpinBox(*args, **kwargs)

Bases: PyQt5.QtWidgets.QDoubleSpinBox

A QDoubleSpinBox that doesn’t steal focus as you scroll over it with a mouse wheel.

focusInEvent(self, QFocusEvent)

focusOutEvent(self, QFocusEvent)

wheelEvent(self, QWheelEvent)

class labscript_utils.qtwidgets.ddsoutput.DDSOutput(hardware_name, connection_name='-', parent=None)

Bases: PyQt5.QtWidgets.QWidget

get_sub_widget(subchnl)

hide_sub_widget(subchnl)

show_sub_widget(subchnl)

class labscript_utils.qtwidgets.digitaloutput.DigitalOutput(*args, **kwargs)

Bases: PyQt5.QtWidgets.QPushButton

eventFilter(self, QObject, QEvent) → bool

get_DO()

lock(notify_do=True)

set_DO(DO, notify_old_DO=True, notify_new_DO=True)

property state

unlock(notify_do=True)

class labscript_utils.qtwidgets.digitaloutput.InvertedDigitalOutput(*args, **kwargs)

Bases: labscript_utils.qtwidgets.digitaloutput.DigitalOutput

property state

class labscript_utils.qtwidgets.enumoutput.EnumOutput(hardware_name, connection_name='-', display_name=None, horizontal_alignment=False, parent=None)

Bases: PyQt5.QtWidgets.QWidget

block_combobox_signals()

connect_value_change(func)

disconnect_value_change()

eventFilter(self, QObject, QEvent) → bool

get_EO()

lock(notify_eo=True)

property selected_index

property selected_option

set_EO(EO, notify_old_EO=True, notify_new_EO=True)

set_combobox_model(model)

unblock_combobox_signals()

unlock(notify_eo=True)

class labscript_utils.qtwidgets.imageoutput.BrowseButton(image_output, *args, **kwargs)

Bases: PyQt5.QtWidgets.QPushButton

browse()

eventFilter(self, QObject, QEvent) → bool

class labscript_utils.qtwidgets.imageoutput.ImageOutput(name, width, height, *args, **kwargs)

Bases: PyQt5.QtWidgets.QWidget

eventFilter(self, QObject, QEvent) → bool

get_Image()

imageUpdated

lock(notify_Image=True)

set_Image(Image, notify_old_Image=True, notify_new_Image=True)

unlock(notify_Image=True)

property value

class labscript_utils.qtwidgets.imageoutput.ImageView(*args, **kwargs)

Bases: PyQt5.QtWidgets.QGraphicsView

contextMenuEvent(self, QContextMenuEvent)