mne_pipeline_hd.gui.parameter_widgets.Param#
- class mne_pipeline_hd.gui.parameter_widgets.Param(data, name, alias=None, default=None, param_unit=None, groupbox_layout=True, none_select=False, description=None, depending_on=None)#
Base-Class Parameter-GUIs, not to be called directly Inherited Clases should have “Gui” in their name to get identified correctly.
- paramChanged#
This signal is emmited when the parameter changes.
- Type:
Signal
- init_ui(layout=None)#
Base layout initialization, which adds the given layout to a group-box with the parameters name if groupbox_layout is enabled. Else the layout will be horizontal with a QLabel for the name.
- __init__(data, name, alias=None, default=None, param_unit=None, groupbox_layout=True, none_select=False, description=None, depending_on=None)#
- Parameters:
data (dict | Controller | QSettings) –
The data-structure, in which the value of the parameter is stored (depends on the scenario how the Parameter-Widget is used,
e.g. displaying parameters from Project or displaying Settings from Main-Window).
name (str) – The name of the key, which stores the value in the data-structure.
alias (str | None) – An optional alias-name for the parameter for display (if you want to use a name, which is more readable, but can’t or shouldn’t be used as a key in Python).
default (object) – The default value depending on GUI-Type.
param_unit (str | None) – Supply an optional suffix with the name of the unit.
groupbox_layout (bool) – If a groupbox should be used as layout (otherwise it is just a label), if None no label
none_select (bool) – Set True if it should be possible to set the value to None by unchecking the GroupBox (on the left of the name).
description (str | None) – Supply an optional description for the parameter, which will displayed as a Tool-Tip when the mouse is hovered over the Widget.
depending_on (str | None) –
- Supply the name of another Paramter here and connect it
to this widget.
Methods
__init__(data, name[, alias, default, ...])acceptDrops(self)accessibleDescription(self)accessibleName(self)actionEvent(self, a0)actions(self)activateWindow(self)addAction(self, action)addActions(self, actions)adjustSize(self)autoFillBackground(self)backgroundRole(self)baseSize(self)blockSignals(self, b)changeEvent(self, a0)check_groupbox_state()childAt(-> Optional[QWidget])childEvent(self, a0)children(self)childrenRect(self)childrenRegion(self)clearFocus(self)clearMask(self)close(self)closeEvent(self, a0)colorCount(self)connectNotify(self, signal)contentsMargins(self)contentsRect(self)contextMenuEvent(self, a0)contextMenuPolicy(self)create(self[, window, initializeWindow, ...])createWindowContainer(window[, parent, flags])cursor(self)customEvent(self, a0)deleteLater(self)depth(self)destroy(self[, destroyWindow, destroySubWindows])devType(self)devicePixelRatio(self)devicePixelRatioF(self)devicePixelRatioFScale()disconnect(-> bool)disconnectNotify(self, signal)dragEnterEvent(self, a0)dragLeaveEvent(self, a0)dragMoveEvent(self, a0)dropEvent(self, a0)dumpObjectInfo(self)dumpObjectTree(self)dynamicPropertyNames(self)effectiveWinId(self)ensurePolished(self)enterEvent(self, a0)event(self, a0)eventFilter(self, a0, a1)find(a0)findChild(-> QObjectT)findChildren(...)focusInEvent(self, a0)focusNextChild(self)focusNextPrevChild(self, next)focusOutEvent(self, a0)focusPolicy(self)focusPreviousChild(self)focusProxy(self)focusWidget(self)font(self)fontInfo(self)fontMetrics(self)foregroundRole(self)frameGeometry(self)frameSize(self)geometry(self)getContentsMargins(self)get_value()This should be implemented for each widget
grab(self[, rectangle])grabGesture(self, type[, flags])grabKeyboard(self)grabMouse()grabShortcut(self, key[, context])graphicsEffect(self)graphicsProxyWidget(self)groupbox_toggled(checked)hasFocus(self)hasHeightForWidth(self)hasMouseTracking(self)hasTabletTracking(self)height(self)heightForWidth(self, a0)heightMM(self)hide(self)hideEvent(self, a0)inherits(self, classname)initPainter(self, painter)init_ui([layout])Base layout initialization, which adds the given layout to a group-box with the parameters name if groupbox_layout is enabled.
inputMethodEvent(self, a0)inputMethodHints(self)inputMethodQuery(self, a0)insertAction(self, before, action)insertActions(self, before, actions)installEventFilter(self, a0)isActiveWindow(self)isAncestorOf(self, child)isEnabled(self)isEnabledTo(self, a0)isFullScreen(self)isHidden(self)isLeftToRight(self)isMaximized(self)isMinimized(self)isModal(self)isRightToLeft(self)isSignalConnected(self, signal)isVisible(self)isVisibleTo(self, a0)isWidgetType(self)isWindow(self)isWindowModified(self)isWindowType(self)keyPressEvent(self, a0)keyReleaseEvent(self, a0)keyboardGrabber()killTimer(self, id)layout(self)layoutDirection(self)leaveEvent(self, a0)locale(self)logicalDpiX(self)logicalDpiY(self)lower(self)mapFrom(self, a0, a1)mapFromGlobal(self, a0)mapFromParent(self, a0)mapTo(self, a0, a1)mapToGlobal(self, a0)mapToParent(self, a0)mask(self)maximumHeight(self)maximumSize(self)maximumWidth(self)metaObject(self)metric(self, a0)minimumHeight(self)minimumSize(self)minimumSizeHint(self)minimumWidth(self)mouseDoubleClickEvent(self, a0)mouseGrabber()mouseMoveEvent(self, a0)mousePressEvent(self, a0)mouseReleaseEvent(self, a0)move()moveEvent(self, a0)moveToThread(self, thread)nativeEvent(self, eventType, message)nativeParentWidget(self)nextInFocusChain(self)normalGeometry(self)objectName(self)overrideWindowFlags(self, type)overrideWindowState(self, state)paintEngine(self)paintEvent(self, a0)paintingActive(self)palette(self)parent(self)parentWidget(self)physicalDpiX(self)physicalDpiY(self)pos(self)previousInFocusChain(self)property(self, name)pyqtConfigure(...)Each keyword argument is either the name of a Qt property or a Qt signal.
raise_(self)read_param()receivers(self, signal)rect(self)releaseKeyboard(self)releaseMouse(self)releaseShortcut(self, id)removeAction(self, action)removeEventFilter(self, a0)render(, sourceRegion, flags, ...)repaint(-> None -> None)resize()resizeEvent(self, a0)restoreGeometry(self, geometry)saveGeometry(self)save_param()screen(self)scroll()sender(self)senderSignalIndex(self)setAcceptDrops(self, on)setAccessibleDescription(self, description)setAccessibleName(self, name)setAttribute(self, attribute[, on])setAutoFillBackground(self, enabled)setBackgroundRole(self, a0)setBaseSize()setContentsMargins()setContextMenuPolicy(self, policy)setCursor(self, a0)setDisabled(self, a0)setEnabled(self, a0)setFixedHeight(self, h)setFixedSize()setFixedWidth(self, w)setFocus()setFocusPolicy(self, policy)setFocusProxy(self, a0)setFont(self, a0)setForegroundRole(self, a0)setGeometry()setGraphicsEffect(self, effect)setHidden(self, hidden)setInputMethodHints(self, hints)setLayout(self, a0)setLayoutDirection(self, direction)setLocale(self, locale)setMask()setMaximumHeight(self, maxh)setMaximumSize()setMaximumWidth(self, maxw)setMinimumHeight(self, minh)setMinimumSize()setMinimumWidth(self, minw)setMouseTracking(self, enable)setObjectName(self, name)setPalette(self, a0)setParent()setProperty(self, name, value)setShortcutAutoRepeat(self, id[, enabled])setShortcutEnabled(self, id[, enabled])setSizeIncrement()setSizePolicy()setStatusTip(self, a0)setStyle(self, a0)setStyleSheet(self, styleSheet)setTabOrder(a0, a1)setTabletTracking(self, enable)setToolTip(self, a0)setToolTipDuration(self, msec)setUpdatesEnabled(self, enable)setVisible(self, visible)setWhatsThis(self, a0)setWindowFilePath(self, filePath)setWindowFlag(self, a0[, on])setWindowFlags(self, type)setWindowIcon(self, icon)setWindowIconText(self, a0)setWindowModality(self, windowModality)setWindowModified(self, a0)setWindowOpacity(self, level)setWindowRole(self, a0)setWindowState(self, state)setWindowTitle(self, a0)set_param(value)Set parameter externally to gui and parameters.
set_value(value)This should be implemented for each widget
sharedPainter(self)show(self)showEvent(self, a0)showFullScreen(self)showMaximized(self)showMinimized(self)showNormal(self)signalsBlocked(self)size(self)sizeHint(self)sizeIncrement(self)sizePolicy(self)stackUnder(self, a0)startTimer(self, interval[, timerType])statusTip(self)style(self)styleSheet(self)tabletEvent(self, a0)testAttribute(self, attribute)thread(self)timerEvent(self, a0)toolTip(self)toolTipDuration(self)tr(self, sourceText[, disambiguation, n])underMouse(self)ungrabGesture(self, type)unsetCursor(self)unsetLayoutDirection(self)unsetLocale(self)update(-> None -> None)updateGeometry(self)updateMicroFocus(self)updatesEnabled(self)visibleRegion(self)whatsThis(self)wheelEvent(self, a0)width(self)widthMM(self)winId(self)window(self)windowFilePath(self)windowFlags(self)windowHandle(self)windowIcon(self)windowIconText(self)windowModality(self)windowOpacity(self)windowRole(self)windowState(self)windowTitle(self)windowType(self)x(self)y(self)Attributes
DrawChildrenDrawWindowBackgroundIgnoreMaskPdmDepthPdmDevicePixelRatioPdmDevicePixelRatioScaledPdmDpiXPdmDpiYPdmHeightPdmHeightMMPdmNumColorsPdmPhysicalDpiXPdmPhysicalDpiYPdmWidthPdmWidthMMcustomContextMenuRequestedint = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
destroyedint = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
objectNameChangedint = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
staticMetaObjectwindowIconChangedint = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
windowIconTextChangedint = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
windowTitleChangedint = ..., arguments: Sequence = ...) -> PYQT_SIGNAL