Skip to content

ListViewMixin

Base classes

Name Children Inherits
AbstractItemViewMixin
prettyqt.widgets.abstractitemview

Subclasses

Class Module Description
ListView prettyqt.widgets.listview
ListWidget prettyqt.widgets.listwidget
UndoView prettyqt.widgets.undoview
HelpIndexWidget prettyqt.qthelp.helpindexwidget

â‹” Inheritance diagram

graph TD
  1473296328112["widgets.ListViewMixin"]
  1473293692144["widgets.AbstractItemViewMixin"]
  1473293679456["widgets.AbstractScrollAreaMixin"]
  1473293662864["widgets.FrameMixin"]
  1473293688240["widgets.WidgetMixin"]
  1473299815024["core.ObjectMixin"]
  140713234304496["builtins.object"]
  1473245548480["gui.PaintDeviceMixin"]
  1473293692144 --> 1473296328112
  1473293679456 --> 1473293692144
  1473293662864 --> 1473293679456
  1473293688240 --> 1473293662864
  1473299815024 --> 1473293688240
  140713234304496 --> 1473299815024
  1473245548480 --> 1473293688240
  140713234304496 --> 1473245548480

🛈 DocStrings

Bases: AbstractItemViewMixin

Source code in prettyqt\widgets\listview.py 
 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
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
class ListViewMixin(widgets.AbstractItemViewMixin):
    def _get_map(self):
        maps = super()._get_map()
        maps |= {
            "viewMode": VIEW_MODE,
            "resizeMode": RESIZE_MODE,
            "layoutMode": LAYOUT_MODE,
            "movement": MOVEMENT,
            "flow": FLOW,
        }
        return maps

    def set_view_mode(self, mode: ViewModeStr | widgets.QListView.ViewMode):
        """Set view mode.

        Args:
            mode: view mode to use
        """
        self.setViewMode(VIEW_MODE.get_enum_value(mode))

    def get_view_mode(self) -> ViewModeStr:
        """Return view mode.

        Returns:
            view mode
        """
        return VIEW_MODE.inverse[self.viewMode()]

    def set_resize_mode(self, mode: ResizeModeStr | widgets.QListView.ResizeMode):
        """Set resize mode.

        Args:
            mode: resize mode to use
        """
        self.setResizeMode(RESIZE_MODE.get_enum_value(mode))

    def get_resize_mode(self) -> ResizeModeStr:
        """Return resize mode.

        Returns:
            resize mode
        """
        return RESIZE_MODE.inverse[self.resizeMode()]

    def set_layout_mode(self, mode: LayoutModeStr | widgets.QListView.LayoutMode):
        """Set layout mode.

        Args:
            mode: layout mode to use
        """
        self.setLayoutMode(LAYOUT_MODE.get_enum_value(mode))

    def get_layout_mode(self) -> LayoutModeStr:
        """Return layout mode.

        Returns:
            layout mode
        """
        return LAYOUT_MODE.inverse[self.layoutMode()]

    def set_movement(self, mode: MovementStr | widgets.QListView.Movement):
        """Set movement mode.

        Args:
            mode: movement mode to use
        """
        self.setMovement(MOVEMENT.get_enum_value(mode))

    def get_movement(self) -> MovementStr:
        """Return movement mode.

        Returns:
            movement mode
        """
        return MOVEMENT.inverse[self.movement()]

    def set_flow(self, mode: FlowStr | widgets.QListView.Flow):
        """Set flow mode.

        Args:
            mode: flow mode to use
        """
        self.setFlow(FLOW.get_enum_value(mode))

    def get_flow(self) -> FlowStr:
        """Return flow mode.

        Returns:
            flow mode
        """
        return FLOW.inverse[self.flow()]

    def set_grid_size(self, size: datatypes.SizeType):
        self.setGridSize(datatypes.to_size(size))

    def get_grid_size(self) -> core.Size:
        return core.Size(self.gridSize())

get_flow() -> FlowStr

Return flow mode.

Source code in prettyqt\widgets\listview.py 
129
130
131
132
133
134
135
def get_flow(self) -> FlowStr:
    """Return flow mode.

    Returns:
        flow mode
    """
    return FLOW.inverse[self.flow()]

get_layout_mode() -> LayoutModeStr

Return layout mode.

Source code in prettyqt\widgets\listview.py 
 97
 98
 99
100
101
102
103
def get_layout_mode(self) -> LayoutModeStr:
    """Return layout mode.

    Returns:
        layout mode
    """
    return LAYOUT_MODE.inverse[self.layoutMode()]

get_movement() -> MovementStr

Return movement mode.

Source code in prettyqt\widgets\listview.py 
113
114
115
116
117
118
119
def get_movement(self) -> MovementStr:
    """Return movement mode.

    Returns:
        movement mode
    """
    return MOVEMENT.inverse[self.movement()]

get_resize_mode() -> ResizeModeStr

Return resize mode.

Source code in prettyqt\widgets\listview.py 
81
82
83
84
85
86
87
def get_resize_mode(self) -> ResizeModeStr:
    """Return resize mode.

    Returns:
        resize mode
    """
    return RESIZE_MODE.inverse[self.resizeMode()]

get_view_mode() -> ViewModeStr

Return view mode.

Source code in prettyqt\widgets\listview.py 
65
66
67
68
69
70
71
def get_view_mode(self) -> ViewModeStr:
    """Return view mode.

    Returns:
        view mode
    """
    return VIEW_MODE.inverse[self.viewMode()]

set_flow(mode: FlowStr | widgets.QListView.Flow)

Set flow mode.

Parameters:

Name Type Description Default
mode FlowStr | Flow

flow mode to use

 required
Source code in prettyqt\widgets\listview.py 
121
122
123
124
125
126
127
def set_flow(self, mode: FlowStr | widgets.QListView.Flow):
    """Set flow mode.

    Args:
        mode: flow mode to use
    """
    self.setFlow(FLOW.get_enum_value(mode))

set_layout_mode(mode: LayoutModeStr | widgets.QListView.LayoutMode)

Set layout mode.

Parameters:

Name Type Description Default
mode LayoutModeStr | LayoutMode

layout mode to use

 required
Source code in prettyqt\widgets\listview.py 
89
90
91
92
93
94
95
def set_layout_mode(self, mode: LayoutModeStr | widgets.QListView.LayoutMode):
    """Set layout mode.

    Args:
        mode: layout mode to use
    """
    self.setLayoutMode(LAYOUT_MODE.get_enum_value(mode))

set_movement(mode: MovementStr | widgets.QListView.Movement)

Set movement mode.

Parameters:

Name Type Description Default
mode MovementStr | Movement

movement mode to use

 required
Source code in prettyqt\widgets\listview.py 
105
106
107
108
109
110
111
def set_movement(self, mode: MovementStr | widgets.QListView.Movement):
    """Set movement mode.

    Args:
        mode: movement mode to use
    """
    self.setMovement(MOVEMENT.get_enum_value(mode))

set_resize_mode(mode: ResizeModeStr | widgets.QListView.ResizeMode)

Set resize mode.

Parameters:

Name Type Description Default
mode ResizeModeStr | ResizeMode

resize mode to use

 required
Source code in prettyqt\widgets\listview.py 
73
74
75
76
77
78
79
def set_resize_mode(self, mode: ResizeModeStr | widgets.QListView.ResizeMode):
    """Set resize mode.

    Args:
        mode: resize mode to use
    """
    self.setResizeMode(RESIZE_MODE.get_enum_value(mode))

set_view_mode(mode: ViewModeStr | widgets.QListView.ViewMode)

Set view mode.

Parameters:

Name Type Description Default
mode ViewModeStr | ViewMode

view mode to use

 required
Source code in prettyqt\widgets\listview.py 
57
58
59
60
61
62
63
def set_view_mode(self, mode: ViewModeStr | widgets.QListView.ViewMode):
    """Set view mode.

    Args:
        mode: view mode to use
    """
    self.setViewMode(VIEW_MODE.get_enum_value(mode))