Skip to content

FileTree

Qt Base Class: QTreeView

Signature: QTreeView(self, parent: Optional[PySide6.QtWidgets.QWidget] = None) -> None

Base classes

Name Children Inherits
TreeView
prettyqt.widgets.treeview

⋔ Inheritance diagram

graph TD
  1473367133104["custom_widgets.FileTree"]
  1473296360320["widgets.TreeView"]
  1473296343728["widgets.TreeViewMixin"]
  1473293692144["widgets.AbstractItemViewMixin"]
  1473293679456["widgets.AbstractScrollAreaMixin"]
  1473293662864["widgets.FrameMixin"]
  1473293688240["widgets.WidgetMixin"]
  1473299815024["core.ObjectMixin"]
  140713234304496["builtins.object"]
  1473245548480["gui.PaintDeviceMixin"]
  1473241448160["QtWidgets.QTreeView"]
  1473241438400["QtWidgets.QAbstractItemView"]
  1473290616416["QtWidgets.QAbstractScrollArea"]
  1473290626176["QtWidgets.QFrame"]
  1473290849680["QtWidgets.QWidget"]
  1473288842240["QtCore.QObject"]
  1473291690208["Shiboken.Object"]
  1473300082368["QtGui.QPaintDevice"]
  1473296360320 --> 1473367133104
  1473296343728 --> 1473296360320
  1473293692144 --> 1473296343728
  1473293679456 --> 1473293692144
  1473293662864 --> 1473293679456
  1473293688240 --> 1473293662864
  1473299815024 --> 1473293688240
  140713234304496 --> 1473299815024
  1473245548480 --> 1473293688240
  140713234304496 --> 1473245548480
  1473241448160 --> 1473296360320
  1473241438400 --> 1473241448160
  1473290616416 --> 1473241438400
  1473290626176 --> 1473290616416
  1473290849680 --> 1473290626176
  1473288842240 --> 1473290849680
  1473291690208 --> 1473288842240
  140713234304496 --> 1473291690208
  1473300082368 --> 1473290849680
  1473291690208 --> 1473300082368

🛈 DocStrings

Bases: TreeView

Source code in prettyqt\custom_widgets\itemviews\filetree.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
class FileTree(widgets.TreeView):
    def __init__(self, *args, filters: list[str] | None = None, **kwargs):
        super().__init__(*args, **kwargs)
        self.setRootIsDecorated(True)
        self.setup_dragdrop_move()
        model = widgets.FileSystemModel()
        model.resolve_sym_links(False)
        if filters:
            model.set_name_filters(filters, hide=False)
        self.set_model(model)
        self._expanded_ids = []

    def get_expanded_state(self, root_index: core.ModelIndex | None = None) -> list[str]:
        """Get a list of all expanded paths.

        Can be used to re-expand to the same state.
        """
        root = root_index or self.rootIndex()
        model = self.model()
        self._expanded_ids = []

        def _save_expanded_on_level(index: core.ModelIndex):
            if not self.isExpanded(index):
                return None
            model = self.model()
            if index.isValid():
                path = model.data(index, model.Roles.FilePathRole)
                self._expanded_ids.append(path)
            for i in range(model.rowCount(index)):
                val = model.index(i, 0, index)
                _save_expanded_on_level(val)

        for i in range(model.rowCount(root)):
            _save_expanded_on_level(model.index(i, 0, root))
        return self._expanded_ids

    def set_expanded_state(
        self, state: list[str], root_index: core.ModelIndex | None = None
    ):
        """Set all indexes which correspond to given paths to expanded."""
        root = root_index or self.rootIndex()
        model = self.model()
        self._expanded_ids = state

        def _restore_expanded_on_level(index: core.ModelIndex):
            model = self.model()
            path = model.data(index, model.Roles.FilePathRole)
            if path not in self._expanded_ids:
                return None
            self.setExpanded(index, True)
            if not model.hasChildren(index):
                return None
            path = pathlib.Path(path)
            for it in path.iterdir():
                child_index = model.index(str(path / it))
                _restore_expanded_on_level(child_index)

        with self.updates_off():
            for i in range(model.rowCount(root)):
                _restore_expanded_on_level(model.index(i, 0))

    def set_root_path(self, path: datatypes.PathType):
        """Set tree rootpath to given path."""
        path = os.fspath(path)
        self.model().set_root_path(path)
        index = self.model().index(path)
        self.setRootIndex(index)

get_expanded_state(root_index: core.ModelIndex | None = None) -> list[str]

Get a list of all expanded paths.

Can be used to re-expand to the same state.

Source code in prettyqt\custom_widgets\itemviews\filetree.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
def get_expanded_state(self, root_index: core.ModelIndex | None = None) -> list[str]:
    """Get a list of all expanded paths.

    Can be used to re-expand to the same state.
    """
    root = root_index or self.rootIndex()
    model = self.model()
    self._expanded_ids = []

    def _save_expanded_on_level(index: core.ModelIndex):
        if not self.isExpanded(index):
            return None
        model = self.model()
        if index.isValid():
            path = model.data(index, model.Roles.FilePathRole)
            self._expanded_ids.append(path)
        for i in range(model.rowCount(index)):
            val = model.index(i, 0, index)
            _save_expanded_on_level(val)

    for i in range(model.rowCount(root)):
        _save_expanded_on_level(model.index(i, 0, root))
    return self._expanded_ids

set_expanded_state(state: list[str], root_index: core.ModelIndex | None = None)

Set all indexes which correspond to given paths to expanded.

Source code in prettyqt\custom_widgets\itemviews\filetree.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
def set_expanded_state(
    self, state: list[str], root_index: core.ModelIndex | None = None
):
    """Set all indexes which correspond to given paths to expanded."""
    root = root_index or self.rootIndex()
    model = self.model()
    self._expanded_ids = state

    def _restore_expanded_on_level(index: core.ModelIndex):
        model = self.model()
        path = model.data(index, model.Roles.FilePathRole)
        if path not in self._expanded_ids:
            return None
        self.setExpanded(index, True)
        if not model.hasChildren(index):
            return None
        path = pathlib.Path(path)
        for it in path.iterdir():
            child_index = model.index(str(path / it))
            _restore_expanded_on_level(child_index)

    with self.updates_off():
        for i in range(model.rowCount(root)):
            _restore_expanded_on_level(model.index(i, 0))

set_root_path(path: datatypes.PathType)

Set tree rootpath to given path.

Source code in prettyqt\custom_widgets\itemviews\filetree.py 
75
76
77
78
79
80
def set_root_path(self, path: datatypes.PathType):
    """Set tree rootpath to given path."""
    path = os.fspath(path)
    self.model().set_root_path(path)
    index = self.model().index(path)
    self.setRootIndex(index)

⌗ Property table

Qt Property Type Doc
objectName QString
modal bool
windowModality Qt::WindowModality
enabled bool
geometry QRect
frameGeometry QRect
normalGeometry QRect
x int
y int
pos QPoint
frameSize QSize
size QSize
width int
height int
rect QRect
childrenRect QRect
childrenRegion QRegion
sizePolicy QSizePolicy
minimumSize QSize
maximumSize QSize
minimumWidth int
minimumHeight int
maximumWidth int
maximumHeight int
sizeIncrement QSize
baseSize QSize
palette QPalette
font QFont
cursor QCursor
mouseTracking bool
tabletTracking bool
isActiveWindow bool
focusPolicy Qt::FocusPolicy
focus bool
contextMenuPolicy Qt::ContextMenuPolicy
updatesEnabled bool
visible bool
minimized bool
maximized bool
fullScreen bool
sizeHint QSize
minimumSizeHint QSize
acceptDrops bool
windowTitle QString
windowIcon QIcon
windowIconText QString
windowOpacity double
windowModified bool
toolTip QString
toolTipDuration int
statusTip QString
whatsThis QString
accessibleName QString
accessibleDescription QString
layoutDirection Qt::LayoutDirection
autoFillBackground bool
styleSheet QString
locale QLocale
windowFilePath QString
inputMethodHints QFlags
frameShape QFrame::Shape
frameShadow QFrame::Shadow
lineWidth int
midLineWidth int
frameWidth int
frameRect QRect
verticalScrollBarPolicy Qt::ScrollBarPolicy
horizontalScrollBarPolicy Qt::ScrollBarPolicy
sizeAdjustPolicy QAbstractScrollArea::SizeAdjustPolicy
autoScroll bool
autoScrollMargin int
editTriggers QFlags
tabKeyNavigation bool
showDropIndicator bool
dragEnabled bool
dragDropOverwriteMode bool
dragDropMode QAbstractItemView::DragDropMode
defaultDropAction Qt::DropAction
alternatingRowColors bool
selectionMode QAbstractItemView::SelectionMode
selectionBehavior QAbstractItemView::SelectionBehavior
iconSize QSize
textElideMode Qt::TextElideMode
verticalScrollMode QAbstractItemView::ScrollMode
horizontalScrollMode QAbstractItemView::ScrollMode
autoExpandDelay int
indentation int
rootIsDecorated bool
uniformRowHeights bool
itemsExpandable bool
sortingEnabled bool
animated bool
allColumnsShowFocus bool
wordWrap bool
headerHidden bool
expandsOnDoubleClick bool