QListView

The QListView class provides a list or icon view onto a model. More

Inheritance diagram of PySide2.QtWidgets.QListView

Inherited by: QHelpIndexWidget, QListWidget, QUndoView

Synopsis

Functions

Signals

Detailed Description

../../_images/windows-listview.png

A QListView presents items stored in a model, either as a simple non-hierarchical list, or as a collection of icons. This class is used to provide lists and icon views that were previously provided by the QListBox and QIconView classes, but using the more flexible approach provided by Qt’s model/view architecture.

The QListView class is one of the Model/View Classes and is part of Qt’s model/view framework .

This view does not display horizontal or vertical headers; to display a list of items with a horizontal header, use QTreeView instead.

QListView implements the interfaces defined by the QAbstractItemView class to allow it to display data provided by models derived from the QAbstractItemModel class.

Items in a list view can be displayed using one of two view modes: In ListMode , the items are displayed in the form of a simple list; in IconMode , the list view takes the form of an icon view in which the items are displayed with icons like files in a file manager. By default, the list view is in ListMode . To change the view mode, use the setViewMode() function, and to determine the current view mode, use viewMode() .

Items in these views are laid out in the direction specified by the flow() of the list view. The items may be fixed in place, or allowed to move, depending on the view’s movement() state.

If the items in the model cannot be completely laid out in the direction of flow, they can be wrapped at the boundary of the view widget; this depends on isWrapping() . This property is useful when the items are being represented by an icon view.

The resizeMode() and layoutMode() govern how and when the items are laid out. Items are spaced according to their spacing() , and can exist within a notional grid of size specified by gridSize() . The items can be rendered as large or small icons depending on their iconSize() .

Improving Performance

It is possible to give the view hints about the data it is handling in order to improve its performance when displaying large numbers of items. One approach that can be taken for views that are intended to display items with equal sizes is to set the uniformItemSizes property to true.

See also

View Classes Item Views Puzzle Example QTreeView QTableView QListWidget

class QListView([parent=None])
param parent

QWidget

Creates a new QListView with the given parent to view a model. Use setModel() to set the model.

PySide2.QtWidgets.QListView.Movement

Constant

Description

QListView.Static

The items cannot be moved by the user.

QListView.Free

The items can be moved freely by the user.

QListView.Snap

The items snap to the specified grid when moved; see setGridSize() .

PySide2.QtWidgets.QListView.Flow

Constant

Description

QListView.LeftToRight

The items are laid out in the view from the left to the right.

QListView.TopToBottom

The items are laid out in the view from the top to the bottom.

PySide2.QtWidgets.QListView.ResizeMode

Constant

Description

QListView.Fixed

The items will only be laid out the first time the view is shown.

QListView.Adjust

The items will be laid out every time the view is resized.

PySide2.QtWidgets.QListView.LayoutMode

Constant

Description

QListView.SinglePass

The items are laid out all at once.

QListView.Batched

The items are laid out in batches of batchSize items.

See also

batchSize

PySide2.QtWidgets.QListView.ViewMode

Constant

Description

QListView.ListMode

The items are laid out using TopToBottom flow, with Small size and Static movement

QListView.IconMode

The items are laid out using LeftToRight flow, with Large size and Free movement

PySide2.QtWidgets.QListView.batchSize()
Return type

int

See also

setBatchSize()

PySide2.QtWidgets.QListView.clearPropertyFlags()

Clears the QListView -specific property flags. See viewMode .

Properties inherited from QAbstractItemView are not covered by the property flags. Specifically, dragEnabled and acceptsDrops are computed by QListView when calling setMovement() or setViewMode() .

PySide2.QtWidgets.QListView.contentsSize()
Return type

QSize

PySide2.QtWidgets.QListView.flow()
Return type

Flow

See also

setFlow()

PySide2.QtWidgets.QListView.gridSize()
Return type

QSize

See also

setGridSize()

PySide2.QtWidgets.QListView.indexesMoved(indexes)
Parameters

indexesQModelIndexList

PySide2.QtWidgets.QListView.isRowHidden(row)
Parameters

rowint

Return type

bool

Returns true if the row is hidden; otherwise returns false .

PySide2.QtWidgets.QListView.isSelectionRectVisible()
Return type

bool

PySide2.QtWidgets.QListView.isWrapping()
Return type

bool

PySide2.QtWidgets.QListView.itemAlignment()
Return type

Alignment

PySide2.QtWidgets.QListView.layoutMode()
Return type

LayoutMode

See also

setLayoutMode()

PySide2.QtWidgets.QListView.modelColumn()
Return type

int

See also

setModelColumn()

PySide2.QtWidgets.QListView.movement()
Return type

Movement

See also

setMovement()

PySide2.QtWidgets.QListView.rectForIndex(index)
Parameters

indexQModelIndex

Return type

QRect

Returns the rectangle of the item at position index in the model. The rectangle is in contents coordinates.

See also

visualRect()

PySide2.QtWidgets.QListView.resizeContents(width, height)
Parameters
  • widthint

  • heightint

Resize the internal contents to width and height and set the scroll bar ranges accordingly.

PySide2.QtWidgets.QListView.resizeMode()
Return type

ResizeMode

See also

setResizeMode()

PySide2.QtWidgets.QListView.setBatchSize(batchSize)
Parameters

batchSizeint

See also

batchSize()

PySide2.QtWidgets.QListView.setFlow(flow)
Parameters

flowFlow

See also

flow()

PySide2.QtWidgets.QListView.setGridSize(size)
Parameters

sizeQSize

See also

gridSize()

PySide2.QtWidgets.QListView.setItemAlignment(alignment)
Parameters

alignmentAlignment

See also

itemAlignment()

PySide2.QtWidgets.QListView.setLayoutMode(mode)
Parameters

modeLayoutMode

See also

layoutMode()

PySide2.QtWidgets.QListView.setModelColumn(column)
Parameters

columnint

See also

modelColumn()

PySide2.QtWidgets.QListView.setMovement(movement)
Parameters

movementMovement

See also

movement()

PySide2.QtWidgets.QListView.setPositionForIndex(position, index)
Parameters
  • positionQPoint

  • indexQModelIndex

Sets the contents position of the item at index in the model to the given position . If the list view’s movement mode is Static or its view mode is ListView , this function will have no effect.

PySide2.QtWidgets.QListView.setResizeMode(mode)
Parameters

modeResizeMode

See also

resizeMode()

PySide2.QtWidgets.QListView.setRowHidden(row, hide)
Parameters
  • rowint

  • hidebool

If hide is true, the given row will be hidden; otherwise the row will be shown.

See also

isRowHidden()

PySide2.QtWidgets.QListView.setSelectionRectVisible(show)
Parameters

showbool

PySide2.QtWidgets.QListView.setSpacing(space)
Parameters

spaceint

See also

spacing()

PySide2.QtWidgets.QListView.setUniformItemSizes(enable)
Parameters

enablebool

PySide2.QtWidgets.QListView.setViewMode(mode)
Parameters

modeViewMode

See also

viewMode()

PySide2.QtWidgets.QListView.setWordWrap(on)
Parameters

onbool

See also

wordWrap()

PySide2.QtWidgets.QListView.setWrapping(enable)
Parameters

enablebool

See also

isWrapping()

PySide2.QtWidgets.QListView.spacing()
Return type

int

See also

setSpacing()

PySide2.QtWidgets.QListView.uniformItemSizes()
Return type

bool

PySide2.QtWidgets.QListView.viewMode()
Return type

ViewMode

See also

setViewMode()

PySide2.QtWidgets.QListView.wordWrap()
Return type

bool

See also

setWordWrap()