nexxT.services.gui.BrowserWidget module

This module provides a widget for browsing the filesystem.

class nexxT.services.gui.BrowserWidget.BrowserWidget(parent=None)[source]

Bases: QWidget

This class puts together a TabCompletionLineEdit and a list view of teh FolderListModel in one single widget.

__init__(self, /, parent: PySide6.QtWidgets.QWidget | None = None, f: PySide6.QtCore.Qt.WindowType = Default(Qt.WindowFlags), *, modal: bool | None = None, windowModality: PySide6.QtCore.Qt.WindowModality | None = None, enabled: bool | None = None, geometry: PySide6.QtCore.QRect | None = None, frameGeometry: PySide6.QtCore.QRect | None = None, normalGeometry: PySide6.QtCore.QRect | None = None, x: int | None = None, y: int | None = None, pos: PySide6.QtCore.QPoint | None = None, frameSize: PySide6.QtCore.QSize | None = None, size: PySide6.QtCore.QSize | None = None, width: int | None = None, height: int | None = None, rect: PySide6.QtCore.QRect | None = None, childrenRect: PySide6.QtCore.QRect | None = None, childrenRegion: PySide6.QtGui.QRegion | None = None, sizePolicy: PySide6.QtWidgets.QSizePolicy | None = None, minimumSize: PySide6.QtCore.QSize | None = None, maximumSize: PySide6.QtCore.QSize | None = None, minimumWidth: int | None = None, minimumHeight: int | None = None, maximumWidth: int | None = None, maximumHeight: int | None = None, sizeIncrement: PySide6.QtCore.QSize | None = None, baseSize: PySide6.QtCore.QSize | None = None, palette: PySide6.QtGui.QPalette | None = None, font: PySide6.QtGui.QFont | None = None, cursor: PySide6.QtGui.QCursor | None = None, mouseTracking: bool | None = None, tabletTracking: bool | None = None, isActiveWindow: bool | None = None, focusPolicy: PySide6.QtCore.Qt.FocusPolicy | None = None, focus: bool | None = None, contextMenuPolicy: PySide6.QtCore.Qt.ContextMenuPolicy | None = None, updatesEnabled: bool | None = None, visible: bool | None = None, minimized: bool | None = None, maximized: bool | None = None, fullScreen: bool | None = None, sizeHint: PySide6.QtCore.QSize | None = None, minimumSizeHint: PySide6.QtCore.QSize | None = None, acceptDrops: bool | None = None, windowTitle: str | None = None, windowIcon: PySide6.QtGui.QIcon | None = None, windowIconText: str | None = None, windowOpacity: float | None = None, windowModified: bool | None = None, toolTip: str | None = None, toolTipDuration: int | None = None, statusTip: str | None = None, whatsThis: str | None = None, accessibleName: str | None = None, accessibleDescription: str | None = None, layoutDirection: PySide6.QtCore.Qt.LayoutDirection | None = None, autoFillBackground: bool | None = None, styleSheet: str | None = None, locale: PySide6.QtCore.QLocale | None = None, windowFilePath: str | None = None, inputMethodHints: PySide6.QtCore.Qt.InputMethodHint | None = None) → None[source]: Initialize self. See help(type(self)) for accurate signature.

activateNext()[source]: Load next recording in the current directory.

activatePrev()[source]: Load previous recording in the current directory.

activated

active()[source]

The currently activated file

Returns:: a string instance

current()[source]

A synonym for active()

Returns:: a string instance

folder()[source]

Returns the current folder

Returns:: a Path instance

scrollTo(item)[source]

Scrolls to the given item.

Parameters:: item – a string instance
Returns:

setActive(activeFile)[source]

set the activated file

Parameters:: activeFile – a string or Path instance
Returns:

setFilter(flt)[source]

Set the name filter of the file browser

Parameters:: flt – a string instance or a list of strings
Returns:

setFolder(folder)[source]

Sets the current folder

Parameters:: folder – a string or a Path instance
Returns:

staticMetaObject = PySide6.QtCore.QMetaObject("BrowserWidget" inherits "QWidget": Methods: #33 type=Signal, signature=activated(QString), parameters=QString )

class nexxT.services.gui.BrowserWidget.FolderListModel(parent)[source]

Bases: QAbstractTableModel

This class provides a model for browsing a folder.

__init__(self, /, parent: PySide6.QtCore.QObject | None = None) → None[source]: Initialize self. See help(type(self)) for accurate signature.

columnCount(index=<PySide6.QtCore.QModelIndex(-1, -1, 0x0, QObject(0x0))>)[source]

overwritten from base class

Parameters:: index
Returns:

data(index, role)[source]

overwritten from base class

Parameters:

index
role

Returns:

fileToIndex(filename)[source]

return the given file name to a model index.

Parameters:: filename – a string or Path instance
Returns:: a QModelIndex instance

filter()[source]

Return the current filter

Returns:: a list of strings

folder()[source]

Return the current folder.

Returns:: a Path instance

folderChanged

headerData(section, orientation, role)[source]

overwritten from base class

Parameters:

section
orientation
role

Returns:

rowCount(index=<PySide6.QtCore.QModelIndex(-1, -1, 0x0, QObject(0x0))>)[source]

overwritten from base class

Parameters:: index
Returns:

setFilter(flt)[source]

Set the filter of this browser

Parameters:: flt – string or a list of strings containing glob-style patterns
Returns:

setFolder(folder)[source]

set the folder of this browser

Parameters:: folder – a Path or string instance
Returns:

statCache = <nexxT.services.gui.BrowserWidget.StatCache object>

staticMetaObject = PySide6.QtCore.QMetaObject("FolderListModel" inherits "QAbstractTableModel": Methods: #76 type=Signal, signature=folderChanged(QString), parameters=QString )

class nexxT.services.gui.BrowserWidget.StatCache[source]

Bases: object

Class for caching file-system related accesses to prevent unnecessary slowliness for network drives.

MAX_NUM_CACHE_ENTRIES = 1048576

__init__()[source]

class nexxT.services.gui.BrowserWidget.TabCompletionLineEdit(completer, parent=None)[source]

Bases: QLineEdit

This class provides a line edit which changes the tab-key semantics to interact with a completer.

__init__(self, arg__1: str, /, parent: PySide6.QtWidgets.QWidget | None = None, *, inputMask: str | None = None, text: str | None = None, maxLength: int | None = None, frame: bool | None = None, echoMode: PySide6.QtWidgets.QLineEdit.EchoMode | None = None, displayText: str | None = None, cursorPosition: int | None = None, alignment: PySide6.QtCore.Qt.AlignmentFlag | None = None, modified: bool | None = None, hasSelectedText: bool | None = None, selectedText: str | None = None, dragEnabled: bool | None = None, readOnly: bool | None = None, undoAvailable: bool | None = None, redoAvailable: bool | None = None, acceptableInput: bool | None = None, placeholderText: str | None = None, cursorMoveStyle: PySide6.QtCore.Qt.CursorMoveStyle | None = None, clearButtonEnabled: bool | None = None) → None[source]
__init__(self, /, parent: PySide6.QtWidgets.QWidget | None = None, *, inputMask: str | None = None, text: str | None = None, maxLength: int | None = None, frame: bool | None = None, echoMode: PySide6.QtWidgets.QLineEdit.EchoMode | None = None, displayText: str | None = None, cursorPosition: int | None = None, alignment: PySide6.QtCore.Qt.AlignmentFlag | None = None, modified: bool | None = None, hasSelectedText: bool | None = None, selectedText: str | None = None, dragEnabled: bool | None = None, readOnly: bool | None = None, undoAvailable: bool | None = None, redoAvailable: bool | None = None, acceptableInput: bool | None = None, placeholderText: str | None = None, cursorMoveStyle: PySide6.QtCore.Qt.CursorMoveStyle | None = None, clearButtonEnabled: bool | None = None) → None: Initialize self. See help(type(self)) for accurate signature.

event(event)[source]

overwritten from base class

Parameters:: event
Returns:

keyPressEvent(event)[source]: Overwritten from QWidget, intermit paste events to log in the text directly after pasting.

nextCompletion(direction)[source]

interacts with the completer, selects next / previous item

Parameters:: direction – the direction, either -1 or +1
Returns:

pasted

staticMetaObject = PySide6.QtCore.QMetaObject("TabCompletionLineEdit" inherits "QLineEdit": Methods: #49 type=Signal, signature=pasted() )