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, event)
actions(self)
activateWindow(self)
addAction(...)
addActions(self, actions)
adjustSize(self)
autoFillBackground(self)
backgroundRole(self)
backingStore(self)
baseSize(self)
blockSignals(self, b)
changeEvent(self, event)
check_groupbox_state()
childAt(...)
childEvent(self, event)
children(self)
childrenRect(self)
childrenRegion(self)
clearFocus(self)
clearMask(self)
close(self)
closeEvent(self, event)
colorCount(self)
connect(...)
connectNotify(self, signal)
contentsMargins(self)
contentsRect(self)
contextMenuEvent(self, event)
contextMenuPolicy(self)
create(self[, arg__1, initializeWindow, ...])
createWinId(self)
createWindowContainer(window[, parent, flags])
cursor(self)
customEvent(self, event)
deleteLater(self)
depth(self)
destroy(self[, destroyWindow, destroySubWindows])
devType(self)
devicePixelRatio(self)
devicePixelRatioF(self)
devicePixelRatioFScale()
disconnect(...)
disconnectNotify(self, signal)
dragEnterEvent(self, event)
dragLeaveEvent(self, event)
dragMoveEvent(self, event)
dropEvent(self, event)
dumpObjectInfo(self)
dumpObjectTree(self)
dynamicPropertyNames(self)
effectiveWinId(self)
emit(self, arg__1, *args)
encodeMetricF(metric, value)
ensurePolished(self)
enterEvent(self, event)
event(self, event)
eventFilter(self, watched, event)
find(arg__1)
findChild(self, type[, name, options])
findChildren() -> Iterable[~PlaceHolderType] ))
focusInEvent(self, event)
focusNextChild(self)
focusNextPrevChild(self, next)
focusOutEvent(self, event)
focusPolicy(self)
focusPreviousChild(self)
focusProxy(self)
focusWidget(self)
font(self)
fontInfo(self)
fontMetrics(self)
foregroundRole(self)
frameGeometry(self)
frameSize(self)
geometry(self)
get_value()	This should be implemented for each widget
grab(self[, rectangle])
grabGesture(self, type[, flags])
grabKeyboard(self)
grabMouse(-> None)
grabShortcut(self, key[, context])
graphicsEffect(self)
graphicsProxyWidget(self)
groupbox_toggled(checked)
hasFocus(self)
hasHeightForWidth(self)
hasMouseTracking(self)
hasTabletTracking(self)
height(self)
heightForWidth(self, arg__1)
heightMM(self)
hide(self)
hideEvent(self, event)
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, event)
inputMethodHints(self)
inputMethodQuery(self, arg__1)
insertAction(self, before, action)
insertActions(self, before, actions)
installEventFilter(self, filterObj)
internalWinId(self)
isActiveWindow(self)
isAncestorOf(self, child)
isEnabled(self)
isEnabledTo(self, arg__1)
isFullScreen(self)
isHidden(self)
isLeftToRight(self)
isMaximized(self)
isMinimized(self)
isModal(self)
isQuickItemType(self)
isRightToLeft(self)
isSignalConnected(self, signal)
isTopLevel(self)
isVisible(self)
isVisibleTo(self, arg__1)
isWidgetType(self)
isWindow(self)
isWindowModified(self)
isWindowType(self)
keyPressEvent(self, event)
keyReleaseEvent(self, event)
keyboardGrabber()
killTimer(-> None)
layout(self)
layoutDirection(self)
leaveEvent(self, event)
locale(self)
logicalDpiX(self)
logicalDpiY(self)
lower(self)
mapFrom(-> PySide6.QtCore.QPoint)
mapFromGlobal(-> PySide6.QtCore.QPoint)
mapFromParent(-> PySide6.QtCore.QPoint)
mapTo(-> PySide6.QtCore.QPoint)
mapToGlobal(-> PySide6.QtCore.QPoint)
mapToParent(-> PySide6.QtCore.QPoint)
mask(self)
maximumHeight(self)
maximumSize(self)
maximumWidth(self)
metaObject(self)
metric(self, arg__1)
minimumHeight(self)
minimumSize(self)
minimumSizeHint(self)
minimumWidth(self)
mouseDoubleClickEvent(self, event)
mouseGrabber()
mouseMoveEvent(self, event)
mousePressEvent(self, event)
mouseReleaseEvent(self, event)
move(-> None)
moveEvent(self, event)
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, event)
paintingActive(self)
palette(self)
parent(self)
parentWidget(self)
physicalDpiX(self)
physicalDpiY(self)
pos(self)
previousInFocusChain(self)
property(self, name)
raise_(self)
read_param()
receivers(self, signal)
rect(self)
redirected(self, offset)
releaseKeyboard(self)
releaseMouse(self)
releaseShortcut(self, id)
removeAction(self, action)
removeEventFilter(self, obj)
render(, sourceRegion, ...)
repaint(-> None  -> None  -> None)
resize(-> None)
resizeEvent(self, event)
restoreGeometry(self, geometry)
saveGeometry(self)
save_param()
screen(self)
scroll(-> None)
sender(self)
senderSignalIndex(self)
setAcceptDrops(self, on)
setAccessibleDescription(self, description)
setAccessibleName(self, name)
setAttribute(self, arg__1[, on])
setAutoFillBackground(self, enabled)
setBackgroundRole(self, arg__1)
setBaseSize(-> None)
setContentsMargins(-> None)
setContextMenuPolicy(self, policy)
setCursor(self, arg__1)
setDisabled(self, arg__1)
setEnabled(self, arg__1)
setFixedHeight(self, h)
setFixedSize(-> None)
setFixedWidth(self, w)
setFocus(-> None)
setFocusPolicy(self, policy)
setFocusProxy(self, arg__1)
setFont(self, arg__1)
setForegroundRole(self, arg__1)
setGeometry(-> None)
setGraphicsEffect(self, effect)
setHidden(self, hidden)
setInputMethodHints(self, hints)
setLayout(self, arg__1)
setLayoutDirection(self, direction)
setLocale(self, locale)
setMask(-> None)
setMaximumHeight(self, maxh)
setMaximumSize(-> None)
setMaximumWidth(self, maxw)
setMinimumHeight(self, minh)
setMinimumSize(-> None)
setMinimumWidth(self, minw)
setMouseTracking(self, enable)
setObjectName(self, name)
setPalette(self, arg__1)
setParent(-> None)
setProperty(self, name, value)
setScreen(self, arg__1)
setShortcutAutoRepeat(self, id[, enable])
setShortcutEnabled(self, id[, enable])
setSizeIncrement(-> None)
setSizePolicy(-> None)
setStatusTip(self, arg__1)
setStyle(self, arg__1)
setStyleSheet(self, styleSheet)
setTabOrder(arg__1, arg__2)
setTabletTracking(self, enable)
setToolTip(self, arg__1)
setToolTipDuration(self, msec)
setUpdatesEnabled(self, enable)
setVisible(self, visible)
setWhatsThis(self, arg__1)
setWindowFilePath(self, filePath)
setWindowFlag(self, arg__1[, on])
setWindowFlags(self, type)
setWindowIcon(self, icon)
setWindowIconText(self, arg__1)
setWindowModality(self, windowModality)
setWindowModified(self, arg__1)
setWindowOpacity(self, level)
setWindowRole(self, arg__1)
setWindowState(self, state)
setWindowTitle(self, arg__1)
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, event)
showFullScreen(self)
showMaximized(self)
showMinimized(self)
showNormal(self)
signalsBlocked(self)
size(self)
sizeHint(self)
sizeIncrement(self)
sizePolicy(self)
stackUnder(self, arg__1)
startTimer(self, interval[, timerType])
statusTip(self)
style(self)
styleSheet(self)
tabletEvent(self, event)
testAttribute(self, arg__1)
thread(self)
timerEvent(self, event)
toolTip(self)
toolTipDuration(self)
topLevelWidget(self)
tr(self, sourceText[, disambiguation, n])
underMouse(self)
ungrabGesture(self, type)
unsetCursor(self)
unsetLayoutDirection(self)
unsetLocale(self)
update(-> None  -> None  -> None)
updateGeometry(self)
updateMicroFocus(self[, query])
updatesEnabled(self)
visibleRegion(self)
whatsThis(self)
wheelEvent(self, event)
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

customContextMenuRequested
destroyed
objectNameChanged
painters
paramChanged
staticMetaObject
windowIconChanged
windowIconTextChanged
windowTitleChanged