Skip to content

Index

__all__ module-attribute

__all__ = ['MdiArea', 'FileExplorer', 'JupyterWidget', 'PropertyWidget']

FileExplorer

Bases: QTreeView

File explorer widget that allows for browsing files and directories.

fileSystem instance-attribute

fileSystem: QFileSystemModel = QtGui.QFileSystemModel()

__init__

__init__(parent: QWidget | None = None, **kwargs)

JupyterWidget

Bases: QtInProcessRichJupyterWidget, QWidget, QObject

Jupyter Qt Console Widget

finished class-attribute

finished: SignalInstance = QtCore.Signal(bool)

Code execution finished.

variables instance-attribute

variables: dict[str, ...] = {}

The variables that are pushed to the kernel.

__init__

__init__(*args, **kwargs)

execute

execute(source=None, hidden=False, interactive=False)

push

push(**kwargs)

Push variables to the kernel.

PARAMETER DESCRIPTION
**kwargs

The variables to push to the kernel.

DEFAULT: {}

MdiArea

Bases: QMdiArea

Custom MDI area that adds a context menu.

contextMenuEvent

contextMenuEvent(event: QContextMenuEvent)

Show a context menu at the specified position.

setActiveSubWindow

setActiveSubWindow(window: QMdiSubWindow)

PropertyWidget

Bases: QWidget, QObject

Widget for displaying property items.

label instance-attribute

label = create_widget(QtWidgets.QLabel, text=name)

name instance-attribute

name = name

valueChanged class-attribute

valueChanged: SignalInstance = QtCore.Signal(float)

valueSpinBox instance-attribute

valueSpinBox = create_widget(SpinBox, value=value)

__init__

__init__(
    name: str,
    value: float,
    enabled: bool = None,
    parent=None,
    *args,
    SpinBox: Type[QDoubleSpinBox] = QDoubleSpinBox,
    **kwargs
)

Initialize the PropertyWidget.

isEnabled

isEnabled() -> bool

Get whether the PropertyWidget is enabled.

setOptions

setOptions(
    *,
    decimals: int | None = None,
    maximum: float | None = None,
    minimum: float | None = None,
    prefix: str | None = None,
    singleStep: float | None = None,
    stepType: StepType | None = None,
    suffix: str | None = None,
    **options
)

Set the options of the PropertyWidget.

setValue

setValue(value: float)

Set the value of the PropertyWidget.

value

value() -> float

Get the value of the PropertyWidget.