DefineScanFrame#

DefineScanFrame documentation with own methods only
DefineScanFrame documentation with inherited methods too

DefineScanFrame with own methods only#

class pydidas.gui.frames.DefineScanFrame(**kwargs: dict)#

Frame for managing the global scan setup.

build_frame()#: Populate the frame with widgets.

connect_signals()#: Connect all required signals and slots.

export_to_file()#

Save ScanContext to a file.

This method will open a QFileDialog to select a filename for the file in which the information shall be written.

finalize_ui()#: Finalize the UI initialization.

load_from_file()#

Load ScanContext from a file.

This method will open a QFileDialog to select the file to be read.

move_dim(dim_index: int, direction: int)#

Move the selected dimension’ position in the scan.

Parameters:

dim_index (int) – The index of the selected dimension.
direction (int) – The direction. Use -1 for up and 1 for down.

reset_entries()#: Reset all ScanSetting entries to their default values.

set_new_base_directory(basedir: str)#

Set the new base directory for the scan.

Parameters:: basedir (str) – The new base directory

update_dim_visibility()#: Update the visibility of dimensions based on the selected number of scan dimensions.

DefineScanFrame with inherited methods too#

class pydidas.gui.frames.DefineScanFrame(**kwargs: dict)

Frame for managing the global scan setup.

class PaintDeviceMetric

class RenderFlag

class RenderFlags
class RenderFlags(f: QWidget.RenderFlags | QWidget.RenderFlag)
class RenderFlags(a0: QWidget.RenderFlags)

acceptDrops(self) → bool

accessibleDescription(self) → str

accessibleName(self) → str

actionEvent(self, a0: QActionEvent | None)

actions(self) → List[QAction]

activateWindow(self)

addAction(self, action: QAction | None)

addActions(self, actions: Iterable[QAction])

add_any_widget(ref: str | None, widget_instance: QWidget, **kwargs: dict)

Add any existing widget to the layout and apply settings to it.

Parameters:

ref (Union[str, None]) – The widget reference key.
widget_instance (QWidget) – The widget instance.
**kwargs (dict) – Any attributes supported by the specific QWidget with a setAttribute method are valid kwargs. In addition, ‘layout_kwargs’ is a valid key to pass a dictionary with attributes for the widget’s layout.

add_param(param: Parameter)

Add a parameter to the ParameterCollection.

This is a wrapper for the ParameterCollection.add_parameter method.

Parameters:: param (Parameter) – An instance of a Parameter object.

add_params(*params: tuple[Parameter | dict | ParameterCollection])

Add parameters to the object.

This method adds Parameters to the ParameterCollection of the object. Parameters can be either supplies as args or a ParameterCollection or dictionary in the form of <ref_key>: <Parameter>. This method is explicitly separate from the __init__ method to allow subclasses full control over args and kwargs.

Parameters:: *params (Tuple[Union[Parameter, dict, ParameterCollection]]) – Any Parameter or ParameterCollection

adjustSize(self)

autoFillBackground(self) → bool

backgroundRole(self) → QPalette.ColorRole

baseSize(self) → QSize

blockSignals(self, b: bool) → bool

build_frame(): Populate the frame with widgets.

changeEvent(self, a0: QEvent | None)

childAt(self, p: QPoint) → QWidget | None
childAt(self, ax: int, ay: int) → QWidget | None

childEvent(self, a0: QChildEvent | None)

children(self) → List[QObject]

childrenRect(self) → QRect

childrenRegion(self) → QRegion

clearFocus(self)

clearMask(self)

close(self) → bool

closeEvent(event: QEvent)

Reimplement the closeEvent to emit a signal about the closing.

Parameters:: event (QtCore.QEvent) – The event which triggered the closeEvent.

colorCount(self) → int

connectNotify(self, signal: QMetaMethod)

connect_signals(): Connect all required signals and slots.

contentsMargins(self) → QMargins

contentsRect(self) → QRect

contextMenuEvent(self, a0: QContextMenuEvent | None)

contextMenuPolicy(self) → Qt.ContextMenuPolicy

create(self, window: PyQt5.sip.voidptr = None, initializeWindow: bool = True, destroyOldWindow: bool = True)

createWindowContainer(window: QWindow | None, parent: QWidget | None = None, flags: Qt.WindowFlags | Qt.WindowType = 0) → QWidget

create_any_widget(ref: str | None, widget_class: type, *args: Tuple, **kwargs: Dict)

Create any widget with any settings and add it to the layout.

Note

Widgets must support generic args and kwargs arguments. This means that generic PyQt widgets cannot be created using this method. They can be added, however, using the add_any_widget method.

Parameters:

ref (Union[str, None]) – The reference name in the _widgets dictionary.
widget_class (type) – The class type of the widget.
*args (args) – Any arguments for the widget creation.
**kwargs (dict) – Keyword arguments for the widget creation.

Raises:

TypeError – If the reference “ref” is not of type string.

create_button(ref: str | None, text: str, **kwargs: Dict)

Create a QPushButton and store the widget.

Parameters:

ref (Union[str, None]) – The reference string for storing the widget.
**kwargs (dict) – Any attributes supported by QPushButton with a setAttribute method are valid kwargs. In addition, the ‘gridPos’ keyword can be used to specify the button’s position in its parent’s layout. The ‘fontsize_offset’, ‘bold’, ‘italic’, ‘underline’ keywords can be used to control the font properties. The button’s clicked method can be connected directly, by specifing the slot through the ‘clicked’ kwarg.

create_check_box(ref: str | None, text, **kwargs: Dict)

Create a PydidasCheckBox and store the widget.

Parameters:

ref (Union[str, None]) – The reference string for storing the widget.
text (str) – The CheckBox’s descriptive text.
**kwargs (dict) – Any attributes supported by QCheckBox with a setAttribute method are valid kwargs. In addition, the ‘gridPos’ keyword can be used to specify the QProgressBar’s position in its parent’s layout. The ‘fontsize_offset’, ‘bold’, ‘italic’, ‘underline’ can be used to control the font properties or generic Qt properties.

create_combo_box(ref: str | None, **kwargs: Dict)

Create a PydidasComboBox and store the widget.

Parameters:

ref (Union[str, None]) – The reference string for storing the widget.
**kwargs (dict) – Any attributes supported by QComboBox with a setAttribute method are valid kwargs. In addition, the ‘gridPos’ keyword can be used to specify the QComboBox’s position in its parent’s layout. The ‘fontsize_offset’, ‘bold’, ‘italic’, ‘underline’ can be used to control the font properties or generic Qt properties.

create_empty_widget(ref: str | None, **kwargs: Dict)

Create an ampty QWidget with a agrid layout.

Parameters:

ref (Union[str, None]) – The reference string for storing the widget.
**kwargs (dict) – Any attributes supported by the generic QWidget with a setAttribute method are valid kwargs. In addition, the ‘gridPos’ keyword can be used to specify the QWidget’s position in its parent’s layout.

create_label(ref: str | None, text: str, **kwargs: dict)

Create a PydidasLabel and store the widget.

Parameters:

ref (Union[str, None]) – The reference string for storing the widget.
text (str) – The label’s displayed text.
**kwargs (dict) – Any attributes supported by QLabel with a setAttribute method are valid kwargs. In addition, the ‘gridPos’ keyword can be used to specify the label’s position in its parent’s layout. The ‘fontsize_offset’, ‘bold’, ‘italic’, ‘underline’ keywords can be used to control the font properties.

create_line(ref: str | None, **kwargs: Dict)

Create a line widget.

This method creates a line widget (implemented as flat QFrame) as separator and adds it to the parent widget.

Parameters:: **kwargs (dict) – Any additional keyword arguments. All QFrame attributes with setAttribute implementation are valid kwargs.

create_lineedit(ref: str | None, **kwargs: Dict)

Create a PydidasLineEdit and store the widget.

Parameters:

ref (Union[str, None]) – The reference string for storing the widget.
**kwargs (dict) – Any attributes supported by QLineEdit with a setAttribute method are valid kwargs. In addition, the ‘gridPos’ keyword can be used to specify the LineEdit’s position in its parent’s layout. The ‘fontsize_offset’, ‘bold’, ‘italic’, ‘underline’ keywords can be used to control the font properties.

create_param_widget(param: Parameter, **kwargs: dict)

Add a name label and input widget for a specific parameter to the widget.

Parameters:

param (Parameter) – A Parameter class instance.
**kwargs (dict) – Optional keyword arguments.

Keyword Arguments:

gridPos (tuple, optional) – The grid position in the layout. The default is (-1, 0, 1, 1)
width_text (float, optional) – The relative width of the text field for the Parameter name. The default is 0.5.
width_unit (float, optional) – The relative width of the text field for the Parameter unit. The default is 0.07.
width_io (int, optional) – The relative width of the input widget. The default is 0.43.
linebreak (bool, optional) – Keyword to toggle a line break between the text label and the input widget. The default is False.
halign_io (QtCore.Qt.Alignment, optional) – The horizontal alignment for the input widget. The default is QtCore.Qt.AlignRight.
halign_text (QtCore.Qt.Alignment, optional) – The horizontal alignment for the text (label) widget. The default is QtCore.Qt.AlignRight.
parent_widget (Union[QWidget, str, None], optional) – The widget to which the label is added. If a string, this picks up the calling class’s ._widgets dictionary and selects the string key’s value. The default is self.

create_progress_bar(ref: str | None, **kwargs: Dict)

Create a QProgressBar and store the widget.

Parameters:

ref (Union[str, None]) – The reference string for storing the widget.
**kwargs (dict) – Any attributes supported by QProgressBar with a setAttribute method are valid kwargs. In addition, the ‘gridPos’ keyword can be used to specify the QProgressBar’s position in its parent’s layout.

create_radio_button_group(ref: str | None, entries: List, **kwargs: Dict)

Create a RadioButtonGroup widget and set its properties.

Parameters:

ref (Union[str, None]) – The reference string for storing the widget.
text (str) – The CheckBox’s descriptive text.
**kwargs (dict) – Any attributes supported by the generic QWidget with a setAttribute method are valid kwargs. In addition, the ‘gridPos’ keyword can be used to specify the RadioButtonGroup’s position in its parent’s layout. The ‘fontsize_offset’, ‘bold’, ‘italic’, ‘underline’ can be used to control the font properties or generic Qt properties. The ‘entries’ keyword takes a list of entries for the buttons and the number of rows and columns can be specified with the ‘rows’ and ‘columns’ keywords, respectively.

create_spacer(ref: str | None, **kwargs: Dict)

Create a QSpacerItem and set its properties.

Parameters:

ref (Union[str, None]) – The widget reference string. If None, an internal reference will be used.
**kwargs (dict) – Any attributes supported by QSpacerItem with a setAttribute method are valid kwargs. In addition, the gridPos key allows to specify the spacer’s position in its parent’s layout.

create_spin_box(ref: str | None, **kwargs: Dict)

Create a QSpinBox and store the widget.

Parameters:

ref (Union[str, None]) – The reference string for storing the widget.
**kwargs (dict) – Any attributes supported by QSpinBox with a setAttribute method are valid kwargs. In addition, the ‘gridPos’ keyword can be used to specify the SpinBox’s position in its parent’s layout. The default range is set to (0, 1), if it is not overridden with the ‘range’ keyword.

cursor(self) → QCursor

customEvent(self, a0: QEvent | None)

deleteLater(self)

depth(self) → int

destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)

devType(self) → int

devicePixelRatio(self) → int

devicePixelRatioF(self) → float

devicePixelRatioFScale() → float

disconnect(a0: QMetaObject.Connection) → bool
disconnect(self) → None

disconnectNotify(self, signal: QMetaMethod)

dragEnterEvent(self, a0: QDragEnterEvent | None)

dragLeaveEvent(self, a0: QDragLeaveEvent | None)

dragMoveEvent(self, a0: QDragMoveEvent | None)

dropEvent(self, a0: QDropEvent | None)

dumpObjectInfo(self)

dumpObjectTree(self)

dynamicPropertyNames(self) → List[QByteArray]

effectiveWinId(self) → PyQt5.sip.voidptr

ensurePolished(self)

enterEvent(self, a0: QEvent | None)

event(self, a0: QEvent | None) → bool

eventFilter(self, a0: QObject | None, a1: QEvent | None) → bool

export_state()

Export the state of the Frame for saving.

Returns:

frame_index (int) – The frame index which can be used as key for referencing the state.
information (dict) – A dictionary with all the information required to export the frame’s state.

export_to_file()

Save ScanContext to a file.

This method will open a QFileDialog to select a filename for the file in which the information shall be written.

finalize_ui(): Finalize the UI initialization.

find(a0: PyQt5.sip.voidptr) → QWidget | None

findChild(self, type: Type[QObjectT], name: str | None = '', options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) → QObjectT
findChild(self, types: Tuple[Type[QObjectT], ...], name: str | None = '', options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) → QObjectT

findChildren(self, type: Type[QObjectT], name: str | None = '', options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) → List[QObjectT]
findChildren(self, types: Tuple[Type[QObjectT], ...], name: str | None = '', options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) → List[QObjectT]
findChildren(self, type: Type[QObjectT], regExp: QRegExp, options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) → List[QObjectT]
findChildren(self, types: Tuple[Type[QObjectT], ...], regExp: QRegExp, options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) → List[QObjectT]
findChildren(self, type: Type[QObjectT], re: QRegularExpression, options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) → List[QObjectT]
findChildren(self, types: Tuple[Type[QObjectT], ...], re: QRegularExpression, options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) → List[QObjectT]

focusInEvent(self, a0: QFocusEvent | None)

focusNextChild(self) → bool

focusNextPrevChild(self, next: bool) → bool

focusOutEvent(self, a0: QFocusEvent | None)

focusPolicy(self) → Qt.FocusPolicy

focusPreviousChild(self) → bool

focusProxy(self) → QWidget | None

focusWidget(self) → QWidget | None

font(self) → QFont

fontInfo(self) → QFontInfo

fontMetrics(self) → QFontMetrics

foregroundRole(self) → QPalette.ColorRole

frameGeometry(self) → QRect

frameSize(self) → QSize

frame_activated(index: int)

Received signal that frame has been activated.

This method is called when this frame becomes activated by the central widget. By default, this method will perform no actions. If specific frames require any actions, they will need to overwrite this method.

Parameters:: index (int) – The index of the activated frame.

geometry(self) → QRect

getContentsMargins(self)

classmethod get_default_params_copy() → ParameterCollection

Get a copy of the default ParameterCollection.

Returns:: A copy of the default ParameterCollection.
Return type:: ParameterCollection

get_param(param_key: str) → Parameter

Get a parameter.

Note: This method returns the Parameter itself, not a copy.

Parameters:: param_key (str) – The key name of the Parameter.
Returns:: The Parameter object.
Return type:: Parameter

get_param_keys() → list[str]

Get the keys of all registered Parameters.

Returns:: The keys of all registered Parameters.
Return type:: list

get_param_value(param_key: str, *default: object, dtype: type | None = None, for_export: bool = False) → object

Get a Parameter value.

Parameters:

param_key (str) – The key name of the Parameter.
default (object) – The default value if the param_key does not exist.
dtype (type, optional) – A datatype to convert the value into. If None, the native datatype is returned. The default is None.
for_export (bool, optional) – An optional flag to force converting the Parameter value to an export-compatible format. This flag is not compatible with a specific dtype. The default is False.

Returns:

The value of the Parameter.

Return type:

object

get_param_values_as_dict(filter_types_for_export: bool = False) → dict

Get a dictionary with Parameter names and values only.

Parameters:: filter_types_for_export (bool) – Flag to return objects in types suitable for exporting (i.e. pickleable).
Returns:: name_val_pairs – The dictionary with Parameter <name>: <value> pairs.
Return type:: dict

get_params(*param_keys: tuple[str, ...]) → list[Parameter]

Get multiple parameters based on their reference keys.

Parameters:: *param_keys (Tuple[str, ...]) – Any number of reference keys.
Returns:: A list with the Parameter instances referenced by the supplied keys.
Return type:: list

grab(self, rectangle: QRect = QRect(QPoint(0, 0), QSize(-1, -1))) → QPixmap

grabGesture(self, type: Qt.GestureType, flags: Qt.GestureFlags | Qt.GestureFlag = Qt.GestureFlags())

grabKeyboard(self)

grabMouse(self)
grabMouse(self, a0: QCursor | Qt.CursorShape) → None

grabShortcut(self, key: QKeySequence | QKeySequence.StandardKey | str | None | int, context: Qt.ShortcutContext = Qt.WindowShortcut) → int

graphicsEffect(self) → QGraphicsEffect | None

graphicsProxyWidget(self) → QGraphicsProxyWidget | None

hasFocus(self) → bool

hasHeightForWidth(self) → bool

hasMouseTracking(self) → bool

hasTabletTracking(self) → bool

height(self) → int

heightForWidth(self, a0: int) → int

heightMM(self) → int

hide(self)

hideEvent(self, a0: QHideEvent | None)

inherits(self, classname: str | None) → bool

initPainter(self, painter: QPainter | None)

inputMethodEvent(self, a0: QInputMethodEvent | None)

inputMethodHints(self) → Qt.InputMethodHints

inputMethodQuery(self, a0: Qt.InputMethodQuery) → Any

insertAction(self, before: QAction | None, action: QAction | None)

insertActions(self, before: QAction | None, actions: Iterable[QAction])

installEventFilter(self, a0: QObject | None)

isActiveWindow(self) → bool

isAncestorOf(self, child: QWidget | None) → bool

isEnabled(self) → bool

isEnabledTo(self, a0: QWidget | None) → bool

isFullScreen(self) → bool

isHidden(self) → bool

isLeftToRight(self) → bool

isMaximized(self) → bool

isMinimized(self) → bool

isModal(self) → bool

isRightToLeft(self) → bool

isSignalConnected(self, signal: QMetaMethod) → bool

isVisible(self) → bool

isVisibleTo(self, a0: QWidget | None) → bool

isWidgetType(self) → bool

isWindow(self) → bool

isWindowModified(self) → bool

isWindowType(self) → bool

keyPressEvent(self, a0: QKeyEvent | None)

keyReleaseEvent(self, a0: QKeyEvent | None)

keyboardGrabber() → QWidget | None

killTimer(self, id: int)

layout(self) → QLayout | None

layoutDirection(self) → Qt.LayoutDirection

leaveEvent(self, a0: QEvent | None)

load_from_file()

Load ScanContext from a file.

This method will open a QFileDialog to select the file to be read.

locale(self) → QLocale

logicalDpiX(self) → int

logicalDpiY(self) → int

lower(self)

mapFrom(self, a0: QWidget | None, a1: QPoint) → QPoint

mapFromGlobal(self, a0: QPoint) → QPoint

mapFromParent(self, a0: QPoint) → QPoint

mapTo(self, a0: QWidget | None, a1: QPoint) → QPoint

mapToGlobal(self, a0: QPoint) → QPoint

mapToParent(self, a0: QPoint) → QPoint

mask(self) → QRegion

maximumHeight(self) → int

maximumSize(self) → QSize

maximumWidth(self) → int

metaObject(self) → QMetaObject | None

metric(self, a0: QPaintDevice.PaintDeviceMetric) → int

minimumHeight(self) → int

minimumSize(self) → QSize

minimumSizeHint(self) → QSize

minimumWidth(self) → int

mouseDoubleClickEvent(self, a0: QMouseEvent | None)

mouseGrabber() → QWidget | None

mouseMoveEvent(self, a0: QMouseEvent | None)

mousePressEvent(self, a0: QMouseEvent | None)

mouseReleaseEvent(self, a0: QMouseEvent | None)

move(self, a0: QPoint)
move(self, ax: int, ay: int) → None

moveEvent(self, a0: QMoveEvent | None)

moveToThread(self, thread: QThread | None)

move_dim(dim_index: int, direction: int)

Move the selected dimension’ position in the scan.

Parameters:

dim_index (int) – The index of the selected dimension.
direction (int) – The direction. Use -1 for up and 1 for down.

nativeEvent(self, eventType: QByteArray | bytes | bytearray, message: PyQt5.sip.voidptr | None)

nativeParentWidget(self) → QWidget | None

nextInFocusChain(self) → QWidget | None

normalGeometry(self) → QRect

objectName(self) → str

overrideWindowFlags(self, type: Qt.WindowFlags | Qt.WindowType)

overrideWindowState(self, state: Qt.WindowStates | Qt.WindowState)

paintEngine(self) → QPaintEngine | None

paintEvent(self, a0: QPaintEvent | None)

paintingActive(self) → bool

palette(self) → QPalette

property param_keys: list[str]

Get the keys of all stored Parameters.

Returns:: The keys of all stored Parameters.
Return type:: list[str]

property param_values: dict

Get the values of all stored Parameters along with their refkeys.

Returns:: The refkey, value pairs for all stored Parameters.
Return type:: Dict

parent(self) → QObject | None

parentWidget(self) → QWidget | None

physicalDpiX(self) → int

physicalDpiY(self) → int

pos(self) → QPoint

previousInFocusChain(self) → QWidget | None

print_param_values(): Print the name and value of all Parameters.

property(self, name: str | None) → Any

pyqtConfigure(...): Each keyword argument is either the name of a Qt property or a Qt signal. For properties the property is set to the given value which should be of an appropriate type. For signals the signal is connected to the given value which should be a callable.

q_settings_get(key: str, dtype: type | None = None, default: object | None = None) → object

Get the value from a QSetting key.

Parameters:

key (str) – The QSetting reference key.
dtype (Union[type, None], optional) – A return datatype. If not None, the output will be returned as dtype(value), otherwise, the generic string/int will be returned. The default is None.
default (type, optional) – The default value which is returned if the key defaults to None. The default is None.

Returns:

value – The value, converted to the type associated with the Parameter referenced by param_key or dtype, if given.

Return type:

object

q_settings_set(key: str, value: object)

Set the value of a QSettings key.

Parameters:

key (str) – The name of the key.
value (object) – The value to be stored.

raise_(self)

receivers(self, signal: PYQT_SIGNAL) → int

rect(self) → QRect

releaseKeyboard(self)

releaseMouse(self)

releaseShortcut(self, id: int)

removeAction(self, action: QAction | None)

removeEventFilter(self, a0: QObject | None)

render(self, target: QPaintDevice | None, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: QWidget.RenderFlags | QWidget.RenderFlag = QWidget.RenderFlags(QWidget.RenderFlag.DrawWindowBackground | QWidget.RenderFlag.DrawChildren))
render(self, painter: QPainter | None, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: QWidget.RenderFlags | QWidget.RenderFlag = QWidget.RenderFlags(QWidget.RenderFlag.DrawWindowBackground | QWidget.RenderFlag.DrawChildren)) → None

repaint(self)
repaint(self, x: int, y: int, w: int, h: int) → None
repaint(self, a0: QRect) → None
repaint(self, a0: QRegion) → None

reset_entries(): Reset all ScanSetting entries to their default values.

resize(self, a0: QSize)
resize(self, w: int, h: int) → None

resizeEvent(self, a0: QResizeEvent | None)

restoreGeometry(self, geometry: QByteArray | bytes | bytearray) → bool

restore_all_defaults(confirm: bool = False)

Restore the default values to all entries.

Parameters:: confirm (bool) – Confirmation flag as safety feature.

restore_state(state: dict)

Restore the frame’s state from stored information.

The default implementation in the BaseFrame will update all Parameters (and associated widgets) and restore the visibility of all widgets. If the frame has not yet been built, the state information is only stored internally and not yet applied. It will be applied at the next frame activation.

Parameters:: state (dict) – A dictionary with ‘params’ and ‘visibility’ keys and the respective information for both.

saveGeometry(self) → QByteArray

screen(self) → QScreen | None

scroll(self, dx: int, dy: int)
scroll(self, dx: int, dy: int, a2: QRect) → None

sender(self) → QObject | None

senderSignalIndex(self) → int

setAcceptDrops(self, on: bool)

setAccessibleDescription(self, description: str | None)

setAccessibleName(self, name: str | None)

setAttribute(self, attribute: Qt.WidgetAttribute, on: bool = True)

setAutoFillBackground(self, enabled: bool)

setBackgroundRole(self, a0: QPalette.ColorRole)

setBaseSize(self, basew: int, baseh: int)
setBaseSize(self, s: QSize) → None

setContentsMargins(self, left: int, top: int, right: int, bottom: int)
setContentsMargins(self, margins: QMargins) → None

setContextMenuPolicy(self, policy: Qt.ContextMenuPolicy)

setCursor(self, a0: QCursor | Qt.CursorShape)

setDisabled(self, a0: bool)

setEnabled(self, a0: bool)

setFixedHeight(self, h: int)

setFixedSize(self, a0: QSize)
setFixedSize(self, w: int, h: int) → None

setFixedWidth(self, w: int)

setFocus(self)
setFocus(self, reason: Qt.FocusReason) → None

setFocusPolicy(self, policy: Qt.FocusPolicy)

setFocusProxy(self, a0: QWidget | None)

setFont(self, a0: QFont)

setForegroundRole(self, a0: QPalette.ColorRole)

setGeometry(self, a0: QRect)
setGeometry(self, ax: int, ay: int, aw: int, ah: int) → None

setGraphicsEffect(self, effect: QGraphicsEffect | None)

setHidden(self, hidden: bool)

setInputMethodHints(self, hints: Qt.InputMethodHints | Qt.InputMethodHint)

setLayout(self, a0: QLayout | None)

setLayoutDirection(self, direction: Qt.LayoutDirection)

setLocale(self, locale: QLocale)

setMask(self, a0: QBitmap)
setMask(self, a0: QRegion) → None

setMaximumHeight(self, maxh: int)

setMaximumSize(self, maxw: int, maxh: int)
setMaximumSize(self, s: QSize) → None

setMaximumWidth(self, maxw: int)

setMinimumHeight(self, minh: int)

setMinimumSize(self, minw: int, minh: int)
setMinimumSize(self, s: QSize) → None

setMinimumWidth(self, minw: int)

setMouseTracking(self, enable: bool)

setObjectName(self, name: str | None)

setPalette(self, a0: QPalette)

setParent(self, parent: QWidget | None)
setParent(self, parent: QWidget | None, f: Qt.WindowFlags | Qt.WindowType) → None

setProperty(self, name: str | None, value: Any) → bool

setShortcutAutoRepeat(self, id: int, enabled: bool = True)

setShortcutEnabled(self, id: int, enabled: bool = True)

setSizeIncrement(self, w: int, h: int)
setSizeIncrement(self, s: QSize) → None

setSizePolicy(self, a0: QSizePolicy)
setSizePolicy(self, hor: QSizePolicy.Policy, ver: QSizePolicy.Policy) → None

setStatusTip(self, a0: str | None)

setStyle(self, a0: QStyle | None)

setStyleSheet(self, styleSheet: str | None)

setTabOrder(a0: QWidget | None, a1: QWidget | None)

setTabletTracking(self, enable: bool)

setToolTip(self, a0: str | None)

setToolTipDuration(self, msec: int)

setUpdatesEnabled(self, enable: bool)

setVisible(self, visible: bool)

setWhatsThis(self, a0: str | None)

setWindowFilePath(self, filePath: str | None)

setWindowFlag(self, a0: Qt.WindowType, on: bool = True)

setWindowFlags(self, type: Qt.WindowFlags | Qt.WindowType)

setWindowIcon(self, icon: QIcon)

setWindowIconText(self, a0: str | None)

setWindowModality(self, windowModality: Qt.WindowModality)

setWindowModified(self, a0: bool)

setWindowOpacity(self, level: float)

setWindowRole(self, a0: str | None)

setWindowState(self, state: Qt.WindowStates | Qt.WindowState)

setWindowTitle(self, a0: str | None)

set_default_params()

Set default entries.

This method will go through the supplied defaults iterable. If there are no entries for the Parameter keys, it will add a Parameter with default value.

set_new_base_directory(basedir: str)

Set the new base directory for the scan.

Parameters:: basedir (str) – The new base directory

set_param_value(param_key: str, value: object)

Set a parameter value.

Parameters:

param_key (str) – The key name of the Parameter.
value (object) – The value to be set. This has to be the datatype associated with the Parameter.

set_param_value_and_widget(key: str, value: object)

Update a parameter value both in the Parameter and the widget.

This method will update the parameter referenced by <key> and update both the Parameter.value as well as the displayed widget entry.

Parameters:

key (str) – The reference key for the Parameter.
value (object) – The new parameter value. This must be of the same type as the Parameter datatype.

Raises:

KeyError – If no parameter or widget has been registered with this key.

set_param_values(**kwargs: dict)

Set multiple parameter values at once.

Parameters:: **kwargs (dict) – The reference key and value pairs for all Parameters to be set.

set_param_values_from_dict(value_dict: dict)

Set the Parameter values from a dict with name, value paris.

Parameters:: value_dict (dict) – The dictionary with the stored information.

set_status(text: str)

Emit a status message to the main window.

Parameters:: text (str) – The status message to be emitted.

sharedPainter(self) → QPainter | None

show(self)

showEvent(self, a0: QShowEvent | None)

showFullScreen(self)

showMaximized(self)

showMinimized(self)

showNormal(self)

signalsBlocked(self) → bool

size(self) → QSize

sizeHint(self) → QSize

sizeIncrement(self) → QSize

sizePolicy(self) → QSizePolicy

stackUnder(self, a0: QWidget | None)

startTimer(self, interval: int, timerType: Qt.TimerType = Qt.CoarseTimer) → int

statusTip(self) → str

style(self) → QStyle | None

styleSheet(self) → str

tabletEvent(self, a0: QTabletEvent | None)

testAttribute(self, attribute: Qt.WidgetAttribute) → bool

thread(self) → QThread | None

timerEvent(self, a0: QTimerEvent | None)

toggle_param_widget_visibility(key: str, visible: bool)

Toggle the visibility of widgets referenced with key.

This method allows to show/hide the label and input widget for a parameter referenced with <key>.

Parameters:

key (str) – The reference key for the Parameter..
visible (bool) – The boolean setting for the visibility.

Raises:

KeyError – If no widget has been registered with this key.

toolTip(self) → str

toolTipDuration(self) → int

tr(self, sourceText: str | None, disambiguation: str | None = None, n: int = -1) → str

underMouse(self) → bool

ungrabGesture(self, type: Qt.GestureType)

unsetCursor(self)

unsetLayoutDirection(self)

unsetLocale(self)

update(self)
update(self, a0: QRect) → None
update(self, a0: QRegion) → None
update(self, ax: int, ay: int, aw: int, ah: int) → None

updateGeometry(self)

updateMicroFocus(self)

update_dim_visibility(): Update the visibility of dimensions based on the selected number of scan dimensions.

update_param_values_from_kwargs(**kwargs: dict)

Update the Parameter values corresponding to the given keys.

Parameters:: **kwargs (dict) – The dictionary with Parameter refkeys and values.

update_params_from_init(*args: tuple, **kwargs: dict)

Update the Parameters from the given init args and kwargs.

Parameters:

*args (Tuple) – The input arguments.
**kwargs (Dict) – The input keyword arguments.

update_widget_value(param_key: str, value: object)

Update the value stored in a widget without changing the Parameter.

Parameters:

param_key (str) – The Parameter reference key.
value (object) – The value. The type depends on the Parameter’s value.

updatesEnabled(self) → bool

visibleRegion(self) → QRegion

whatsThis(self) → str

wheelEvent(self, a0: QWheelEvent | None)

width(self) → int

widthMM(self) → int

winId(self) → PyQt5.sip.voidptr

window(self) → QWidget | None

windowFilePath(self) → str

windowFlags(self) → Qt.WindowFlags

windowHandle(self) → QWindow | None

windowIcon(self) → QIcon

windowIconText(self) → str

windowModality(self) → Qt.WindowModality

windowOpacity(self) → float

windowRole(self) → str

windowState(self) → Qt.WindowStates

windowTitle(self) → str

windowType(self) → Qt.WindowType

x(self) → int

y(self) → int