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

#include <qlistview.h>

Inheritance diagram for QListView:

Collaboration diagram for QListView:

Public Types
enum	Movement { Static , Free , Snap }

enum	Flow { LeftToRight , TopToBottom }

enum	ResizeMode { Fixed , Adjust }

enum	LayoutMode { SinglePass , Batched }

enum	ViewMode { ListMode , IconMode }

Public Types inherited from QAbstractItemView
enum	SelectionMode { NoSelection , SingleSelection , MultiSelection , ExtendedSelection , ContiguousSelection }

enum	SelectionBehavior { SelectItems , SelectRows , SelectColumns }

enum	ScrollHint { EnsureVisible , PositionAtTop , PositionAtBottom , PositionAtCenter }

enum	EditTrigger { NoEditTriggers = 0 , CurrentChanged = 1 , DoubleClicked = 2 , SelectedClicked = 4 , EditKeyPressed = 8 , AnyKeyPressed = 16 , AllEditTriggers = 31 }

enum	ScrollMode { ScrollPerItem , ScrollPerPixel }

Signals
void	indexesMoved (const QModelIndexList &indexes)

Signals inherited from QAbstractItemView
void	pressed (const QModelIndex &index)

void	clicked (const QModelIndex &index)

void	doubleClicked (const QModelIndex &index)

void	activated (const QModelIndex &index)

void	entered (const QModelIndex &index)

void	viewportEntered ()

void	iconSizeChanged (const QSize &size)

Public Member Functions
	QListView (QWidget *parent=nullptr)

	~QListView ()

void	setMovement (Movement movement)

Movement	movement () const

void	setFlow (Flow flow)

Flow	flow () const

void	setWrapping (bool enable)

bool	isWrapping () const

void	setResizeMode (ResizeMode mode)

ResizeMode	resizeMode () const

void	setLayoutMode (LayoutMode mode)

LayoutMode	layoutMode () const

void	setSpacing (int space)

int	spacing () const

void	setBatchSize (int batchSize)

int	batchSize () const

void	setGridSize (const QSize &size)

QSize	gridSize () const

void	setViewMode (ViewMode mode)

ViewMode	viewMode () const

void	clearPropertyFlags ()

bool	isRowHidden (int row) const

void	setRowHidden (int row, bool hide)

void	setModelColumn (int column)

int	modelColumn () const

void	setUniformItemSizes (bool enable)

bool	uniformItemSizes () const

void	setWordWrap (bool on)

bool	wordWrap () const

void	setSelectionRectVisible (bool show)

bool	isSelectionRectVisible () const

void	setItemAlignment (Qt::Alignment alignment)

Qt::Alignment	itemAlignment () const

QRect	visualRect (const QModelIndex &index) const override

void	scrollTo (const QModelIndex &index, ScrollHint hint=EnsureVisible) override

QModelIndex	indexAt (const QPoint &p) const override

void	doItemsLayout () override

void	reset () override

void	setRootIndex (const QModelIndex &index) override

Public Member Functions inherited from QAbstractItemView
	QAbstractItemView (QWidget *parent=nullptr)

	~QAbstractItemView ()

virtual void	setModel (QAbstractItemModel *model)

QAbstractItemModel *	model () const

virtual void	setSelectionModel (QItemSelectionModel *selectionModel)

QItemSelectionModel *	selectionModel () const

void	setItemDelegate (QAbstractItemDelegate *delegate)

QAbstractItemDelegate *	itemDelegate () const

void	setSelectionMode (QAbstractItemView::SelectionMode mode)

QAbstractItemView::SelectionMode	selectionMode () const

void	setSelectionBehavior (QAbstractItemView::SelectionBehavior behavior)

QAbstractItemView::SelectionBehavior	selectionBehavior () const

QModelIndex	currentIndex () const

QModelIndex	rootIndex () const

void	setEditTriggers (EditTriggers triggers)

EditTriggers	editTriggers () const

void	setVerticalScrollMode (ScrollMode mode)

ScrollMode	verticalScrollMode () const

void	resetVerticalScrollMode ()

void	setHorizontalScrollMode (ScrollMode mode)

ScrollMode	horizontalScrollMode () const

void	resetHorizontalScrollMode ()

void	setAutoScroll (bool enable)

bool	hasAutoScroll () const

void	setAutoScrollMargin (int margin)

int	autoScrollMargin () const

void	setTabKeyNavigation (bool enable)

bool	tabKeyNavigation () const

void	setAlternatingRowColors (bool enable)

bool	alternatingRowColors () const

void	setIconSize (const QSize &size)

QSize	iconSize () const

void	setTextElideMode (Qt::TextElideMode mode)

Qt::TextElideMode	textElideMode () const

virtual void	keyboardSearch (const QString &search)

QSize	sizeHintForIndex (const QModelIndex &index) const

virtual int	sizeHintForRow (int row) const

virtual int	sizeHintForColumn (int column) const

void	openPersistentEditor (const QModelIndex &index)

void	closePersistentEditor (const QModelIndex &index)

bool	isPersistentEditorOpen (const QModelIndex &index) const

void	setIndexWidget (const QModelIndex &index, QWidget *widget)

QWidget *	indexWidget (const QModelIndex &index) const

void	setItemDelegateForRow (int row, QAbstractItemDelegate *delegate)

QAbstractItemDelegate *	itemDelegateForRow (int row) const

void	setItemDelegateForColumn (int column, QAbstractItemDelegate *delegate)

QAbstractItemDelegate *	itemDelegateForColumn (int column) const

virtual QAbstractItemDelegate *	itemDelegateForIndex (const QModelIndex &index) const

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const override

Protected Member Functions
	QListView (QListViewPrivate &, QWidget *parent=nullptr)

bool	event (QEvent *e) override

void	scrollContentsBy (int dx, int dy) override

void	resizeContents (int width, int height)

QSize	contentsSize () const

void	dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QList< int > &roles=QList< int >()) override

void	rowsInserted (const QModelIndex &parent, int start, int end) override

void	rowsAboutToBeRemoved (const QModelIndex &parent, int start, int end) override

void	mouseMoveEvent (QMouseEvent *e) override

void	mouseReleaseEvent (QMouseEvent *e) override

void	timerEvent (QTimerEvent *e) override

void	resizeEvent (QResizeEvent *e) override

void	initViewItemOption (QStyleOptionViewItem *option) const override

void	paintEvent (QPaintEvent *e) override

int	horizontalOffset () const override

int	verticalOffset () const override

QModelIndex	moveCursor (CursorAction cursorAction, Qt::KeyboardModifiers modifiers) override

QRect	rectForIndex (const QModelIndex &index) const

void	setPositionForIndex (const QPoint &position, const QModelIndex &index)

void	setSelection (const QRect &rect, QItemSelectionModel::SelectionFlags command) override

QRegion	visualRegionForSelection (const QItemSelection &selection) const override

QModelIndexList	selectedIndexes () const override

void	updateGeometries () override

bool	isIndexHidden (const QModelIndex &index) const override

void	selectionChanged (const QItemSelection &selected, const QItemSelection &deselected) override

void	currentChanged (const QModelIndex &current, const QModelIndex &previous) override

QSize	viewportSizeHint () const override

Protected Member Functions inherited from QAbstractItemView
	QAbstractItemView (QAbstractItemViewPrivate &, QWidget *parent=nullptr)

virtual bool	edit (const QModelIndex &index, EditTrigger trigger, QEvent *event)

virtual QItemSelectionModel::SelectionFlags	selectionCommand (const QModelIndex &index, const QEvent *event=nullptr) const

State	state () const

void	setState (State state)

void	scheduleDelayedItemsLayout ()

void	executeDelayedItemsLayout ()

void	setDirtyRegion (const QRegion &region)

void	scrollDirtyRegion (int dx, int dy)

QPoint	dirtyRegionOffset () const

void	startAutoScroll ()

void	stopAutoScroll ()

void	doAutoScroll ()

bool	focusNextPrevChild (bool next) override

bool	event (QEvent *event) override

bool	viewportEvent (QEvent *event) override

void	mousePressEvent (QMouseEvent *event) override

void	mouseMoveEvent (QMouseEvent *event) override

void	mouseReleaseEvent (QMouseEvent *event) override

void	mouseDoubleClickEvent (QMouseEvent *event) override

void	focusInEvent (QFocusEvent *event) override

void	focusOutEvent (QFocusEvent *event) override

void	keyPressEvent (QKeyEvent *event) override

void	resizeEvent (QResizeEvent *event) override

void	timerEvent (QTimerEvent *event) override

void	inputMethodEvent (QInputMethodEvent *event) override

bool	eventFilter (QObject object, QEvent event) override

QSize	viewportSizeHint () const override

Properties
Movement	movement
	whether the items can be moved freely, are snapped to a grid, or cannot be moved at all. More...

Flow	flow
	which direction the items layout should flow. More...

bool	isWrapping
	whether the items layout should wrap. More...

ResizeMode	resizeMode
	whether the items are laid out again when the view is resized. More...

LayoutMode	layoutMode
	determines whether the layout of items should happen immediately or be delayed. More...

int	spacing
	the space around the items in the layout More...

QSize	gridSize
	the size of the layout grid More...

ViewMode	viewMode
	the view mode of the QListView. More...

int	modelColumn
	the column in the model that is visible More...

bool	uniformItemSizes
	whether all items in the listview have the same size More...

int	batchSize
	the number of items laid out in each batch if \l layoutMode is set to \l Batched More...

bool	wordWrap
	the item text word-wrapping policy More...

bool	selectionRectVisible
	if the selection rectangle should be visible More...

Qt::Alignment	itemAlignment
	the alignment of each item in its cell More...

Properties inherited from QAbstractItemView
bool	autoScroll
	whether autoscrolling in drag move events is enabled More...

int	autoScrollMargin
	the size of the area when auto scrolling is triggered More...

EditTriggers	editTriggers
	which actions will initiate item editing More...

bool	tabKeyNavigation
	whether item navigation with tab and backtab is enabled. More...

bool	alternatingRowColors
	whether to draw the background using alternating colors More...

SelectionMode	selectionMode
	which selection mode the view operates in More...

SelectionBehavior	selectionBehavior
	which selection behavior the view uses More...

QSize	iconSize
	the size of items' icons More...

Qt::TextElideMode	textElideMode
	the position of the "..." in elided text. More...

ScrollMode	verticalScrollMode
	how the view scrolls its contents in the vertical direction More...

ScrollMode	horizontalScrollMode
	how the view scrolls its contents in the horizontal direction More...

Friends
class	QCommonListViewBase

Additional Inherited Members
Public Slots inherited from QAbstractItemView
virtual void	selectAll ()

void	edit (const QModelIndex &index)

void	clearSelection ()

void	setCurrentIndex (const QModelIndex &index)

void	scrollToTop ()

void	scrollToBottom ()

void	update (const QModelIndex &index)

Protected Types inherited from QAbstractItemView
enum	CursorAction { MoveUp , MoveDown , MoveLeft , MoveRight , MoveHome , MoveEnd , MovePageUp , MovePageDown , MoveNext , MovePrevious }

enum	State { NoState , DraggingState , DragSelectingState , EditingState , ExpandingState , CollapsingState , AnimatingState }

Protected Slots inherited from QAbstractItemView
virtual void	updateEditorData ()

virtual void	updateEditorGeometries ()

virtual void	verticalScrollbarAction (int action)

virtual void	horizontalScrollbarAction (int action)

virtual void	verticalScrollbarValueChanged (int value)

virtual void	horizontalScrollbarValueChanged (int value)

virtual void	closeEditor (QWidget *editor, QAbstractItemDelegate::EndEditHint hint)

virtual void	commitData (QWidget *editor)

virtual void	editorDestroyed (QObject *editor)

Detailed Description

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

\inmodule QtWidgets

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 \l{Model/View Classes} and is part of Qt's \l{Model/View Programming}{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 \l ListMode, the items are displayed in the form of a simple list; in \l 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 \l 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().

Definition at line 52 of file qlistview.h.

Member Enumeration Documentation

◆ Flow

enum QListView::Flow

\value LeftToRight The items are laid out in the view from the left to the right. \value TopToBottom The items are laid out in the view from the top to the bottom.

Enumerator
LeftToRight
TopToBottom

Definition at line 73 of file qlistview.h.

◆ LayoutMode

enum QListView::LayoutMode

\value SinglePass The items are laid out all at once. \value Batched The items are laid out in batches of \l batchSize items.

See also: batchSize

Enumerator
SinglePass
Batched

Definition at line 77 of file qlistview.h.

◆ Movement

enum QListView::Movement

\value Static The items cannot be moved by the user. \value Free The items can be moved freely by the user. \value Snap The items snap to the specified grid when moved; see setGridSize().

Enumerator
Static
Free
Snap

Definition at line 71 of file qlistview.h.

◆ ResizeMode

enum QListView::ResizeMode

\value Fixed The items will only be laid out the first time the view is shown. \value Adjust The items will be laid out every time the view is resized.

Enumerator
Fixed
Adjust

Definition at line 75 of file qlistview.h.

◆ ViewMode

enum QListView::ViewMode

\value ListMode The items are laid out using TopToBottom flow, with Small size and Static movement \value IconMode The items are laid out using LeftToRight flow, with Large size and Free movement

Enumerator
ListMode
IconMode

Definition at line 79 of file qlistview.h.

Constructor & Destructor Documentation

◆ QListView() [1/2]

QListView::QListView ( QWidget * parent = nullptr )

explicit

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

Definition at line 181 of file qlistview.cpp.

◆ ~QListView()

QListView::~QListView ( )

Destroys the view.

Definition at line 207 of file qlistview.cpp.

◆ QListView() [2/2]

QListView::QListView	(	QListViewPrivate &	dd,
		QWidget *	parent = `nullptr`
	)

protected

Definition at line 194 of file qlistview.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ batchSize()

int QListView::batchSize ( ) const

Definition at line 408 of file qlistview.cpp.

◆ clearPropertyFlags()

void QListView::clearPropertyFlags ( )

Clears the QListView-specific property flags. See \l{viewMode}.

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

Definition at line 524 of file qlistview.cpp.

◆ contentsSize()

QSize QListView::contentsSize ( ) const

protected

Definition at line 728 of file qlistview.cpp.

Here is the caller graph for this function:

◆ currentChanged()

void QListView::currentChanged	(	const QModelIndex &	current,
		const QModelIndex &	previous
	)

overrideprotectedvirtual

\reimp

Reimplemented from QAbstractItemView.

Definition at line 3429 of file qlistview.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dataChanged()

void QListView::dataChanged	(	const QModelIndex &	topLeft,
		const QModelIndex &	bottomRight,
		const QList< int > &	roles = `QList<int>()`
	)

overrideprotectedvirtual

\reimp

Reimplemented from QAbstractItemView.

Reimplemented in QListWidgetDataChanged.

Definition at line 737 of file qlistview.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doItemsLayout()

void QListView::doItemsLayout ( )

overridevirtual

Reimplemented from QAbstractItemView.

Definition at line 1568 of file qlistview.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ event()

bool QListView::event ( QEvent * e )

overrideprotected

\reimp

Definition at line 1771 of file qlistview.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ flow()

QListView::Flow QListView::flow ( ) const

Definition at line 275 of file qlistview.cpp.

◆ gridSize()

QSize QListView::gridSize ( ) const

Definition at line 437 of file qlistview.cpp.

◆ horizontalOffset()

int QListView::horizontalOffset ( ) const

overrideprotectedvirtual

\reimp

Implements QAbstractItemView.

Definition at line 1146 of file qlistview.cpp.

Here is the caller graph for this function:

◆ indexAt()

QModelIndex QListView::indexAt ( const QPoint & p ) const

overridevirtual

\reimp

Implements QAbstractItemView.

Definition at line 1131 of file qlistview.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ indexesMoved

void QListView::indexesMoved ( const QModelIndexList & indexes )

signal

Since: 4.2

This signal is emitted when the specified indexes are moved in the view.

◆ initViewItemOption()

void QListView::initViewItemOption ( QStyleOptionViewItem * option ) const

overrideprotectedvirtual

\reimp

Reimplemented from QAbstractItemView.

Reimplemented in QComboBoxListView.

Definition at line 993 of file qlistview.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isIndexHidden()

bool QListView::isIndexHidden ( const QModelIndex & index ) const

overrideprotectedvirtual

\reimp

Implements QAbstractItemView.

Definition at line 1632 of file qlistview.cpp.

Here is the caller graph for this function:

◆ isRowHidden()

bool QListView::isRowHidden ( int row ) const

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

Definition at line 533 of file qlistview.cpp.

◆ isSelectionRectVisible()

bool QListView::isSelectionRectVisible ( ) const

Definition at line 1736 of file qlistview.cpp.

◆ isWrapping()

bool QListView::isWrapping ( ) const

Definition at line 304 of file qlistview.cpp.

◆ itemAlignment()

Qt::Alignment QListView::itemAlignment ( ) const

Definition at line 1762 of file qlistview.cpp.

◆ layoutMode()

QListView::LayoutMode QListView::layoutMode ( ) const

Definition at line 354 of file qlistview.cpp.

◆ modelColumn()

int QListView::modelColumn ( ) const

Definition at line 1656 of file qlistview.cpp.

◆ mouseMoveEvent()

void QListView::mouseMoveEvent ( QMouseEvent * e )

overrideprotected

\reimp

Definition at line 782 of file qlistview.cpp.

Here is the call graph for this function:

◆ mouseReleaseEvent()

void QListView::mouseReleaseEvent ( QMouseEvent * e )

overrideprotected

\reimp

Definition at line 802 of file qlistview.cpp.

Here is the call graph for this function:

◆ moveCursor()

QModelIndex QListView::moveCursor	(	CursorAction	cursorAction,
		Qt::KeyboardModifiers	modifiers
	)

overrideprotectedvirtual

\reimp

Implements QAbstractItemView.

Definition at line 1162 of file qlistview.cpp.

Here is the call graph for this function:

◆ movement()

QListView::Movement QListView::movement ( ) const

Definition at line 244 of file qlistview.cpp.

◆ paintEvent()

void QListView::paintEvent ( QPaintEvent * e )

overrideprotected

\reimp

Definition at line 1020 of file qlistview.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rectForIndex()

QRect QListView::rectForIndex ( const QModelIndex & index ) const

protected

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

See also: visualRect()

Definition at line 1337 of file qlistview.cpp.

Here is the caller graph for this function:

◆ reset()

void QListView::reset ( )

overridevirtual

Reset the internal state of the view.

Warning: This function will reset open editors, scroll bar positions, selections, etc. Existing changes will not be committed. If you would like to save your changes when resetting the view, you can reimplement this function, commit your changes, and then call the superclass' implementation.

Reimplemented from QAbstractItemView.

Definition at line 679 of file qlistview.cpp.

Here is the call graph for this function:

◆ resizeContents()

void QListView::resizeContents	(	int	width,
		int	height
	)

protected

Definition at line 719 of file qlistview.cpp.

Here is the caller graph for this function:

◆ resizeEvent()

void QListView::resizeEvent ( QResizeEvent * e )

overrideprotected

\reimp

Definition at line 861 of file qlistview.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resizeMode()

QListView::ResizeMode QListView::resizeMode ( ) const

Definition at line 329 of file qlistview.cpp.

◆ rowsAboutToBeRemoved()

void QListView::rowsAboutToBeRemoved	(	const QModelIndex &	parent,
		int	start,
		int	end
	)

overrideprotectedvirtual

\reimp

Reimplemented from QAbstractItemView.

Definition at line 759 of file qlistview.cpp.

Here is the call graph for this function:

◆ rowsInserted()

void QListView::rowsInserted	(	const QModelIndex &	parent,
		int	start,
		int	end
	)

overrideprotectedvirtual

\reimp

Reimplemented from QAbstractItemView.

Definition at line 747 of file qlistview.cpp.

Here is the call graph for this function:

◆ scrollContentsBy()

void QListView::scrollContentsBy	(	int	dx,
		int	dy
	)

overrideprotected

\reimp

Scroll the view contents by dx and dy.

Definition at line 706 of file qlistview.cpp.

◆ scrollTo()

void QListView::scrollTo	(	const QModelIndex &	index,
		ScrollHint	hint = `EnsureVisible`
	)

overridevirtual

\reimp

Implements QAbstractItemView.

Definition at line 567 of file qlistview.cpp.

◆ selectedIndexes()

QModelIndexList QListView::selectedIndexes ( ) const

overrideprotectedvirtual

\reimp

Reimplemented from QAbstractItemView.

Definition at line 1549 of file qlistview.cpp.

Here is the call graph for this function:

◆ selectionChanged()

void QListView::selectionChanged	(	const QItemSelection &	selected,
		const QItemSelection &	deselected
	)

overrideprotectedvirtual

\reimp

Reimplemented from QAbstractItemView.

Definition at line 3447 of file qlistview.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setBatchSize()

void QListView::setBatchSize ( int batchSize )

Definition at line 398 of file qlistview.cpp.

◆ setFlow()

void QListView::setFlow ( Flow flow )

Definition at line 267 of file qlistview.cpp.

◆ setGridSize()

void QListView::setGridSize ( const QSize & size )

Definition at line 429 of file qlistview.cpp.

◆ setItemAlignment()

void QListView::setItemAlignment ( Qt::Alignment alignment )

Definition at line 1752 of file qlistview.cpp.

◆ setLayoutMode()

void QListView::setLayoutMode ( LayoutMode mode )

Definition at line 348 of file qlistview.cpp.

◆ setModelColumn()

void QListView::setModelColumn ( int column )

Definition at line 1647 of file qlistview.cpp.

Here is the caller graph for this function:

◆ setMovement()

void QListView::setMovement ( Movement movement )

Definition at line 230 of file qlistview.cpp.

Here is the caller graph for this function:

◆ setPositionForIndex()

void QListView::setPositionForIndex	(	const QPoint &	position,
		const QModelIndex &	index
	)

protected

Since: 4.1

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.

Definition at line 1350 of file qlistview.cpp.

Here is the call graph for this function:

◆ setResizeMode()

void QListView::setResizeMode ( ResizeMode mode )

Definition at line 322 of file qlistview.cpp.

Here is the caller graph for this function:

◆ setRootIndex()

void QListView::setRootIndex ( const QModelIndex & index )

overridevirtual

\reimp

Reimplemented from QAbstractItemView.

Definition at line 690 of file qlistview.cpp.

Here is the caller graph for this function:

◆ setRowHidden()

void QListView::setRowHidden	(	int	row,
		bool	hide
	)

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

Definition at line 543 of file qlistview.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSelection()

void QListView::setSelection	(	const QRect &	rect,
		QItemSelectionModel::SelectionFlags	command
	)

overrideprotectedvirtual

\reimp

Implements QAbstractItemView.

Reimplemented in SetSelectionTestView.

Definition at line 1366 of file qlistview.cpp.

Here is the caller graph for this function:

◆ setSelectionRectVisible()

void QListView::setSelectionRectVisible ( bool show )

Definition at line 1729 of file qlistview.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSpacing()

void QListView::setSpacing ( int space )

Definition at line 374 of file qlistview.cpp.

Here is the caller graph for this function:

◆ setUniformItemSizes()

void QListView::setUniformItemSizes ( bool enable )

Definition at line 1673 of file qlistview.cpp.

Here is the caller graph for this function:

◆ setViewMode()

void QListView::setViewMode ( ViewMode mode )

Definition at line 458 of file qlistview.cpp.

Here is the caller graph for this function:

◆ setWordWrap()

void QListView::setWordWrap ( bool on )

Definition at line 1699 of file qlistview.cpp.

◆ setWrapping()

void QListView::setWrapping ( bool enable )

Definition at line 296 of file qlistview.cpp.

Here is the caller graph for this function:

◆ spacing()

int QListView::spacing ( ) const

Definition at line 382 of file qlistview.cpp.

◆ timerEvent()

void QListView::timerEvent ( QTimerEvent * e )

overrideprotected

\reimp

Definition at line 845 of file qlistview.cpp.

Here is the call graph for this function:

◆ uniformItemSizes()

bool QListView::uniformItemSizes ( ) const

Definition at line 1679 of file qlistview.cpp.

◆ updateGeometries()

void QListView::updateGeometries ( )

overrideprotectedvirtual

\reimp

Reimplemented from QAbstractItemView.

Definition at line 1594 of file qlistview.cpp.

Here is the caller graph for this function:

◆ verticalOffset()

int QListView::verticalOffset ( ) const

overrideprotectedvirtual

\reimp

Implements QAbstractItemView.

Definition at line 1154 of file qlistview.cpp.

Here is the caller graph for this function:

◆ viewMode()

QListView::ViewMode QListView::viewMode ( ) const

Definition at line 509 of file qlistview.cpp.

◆ viewportSizeHint()

QSize QListView::viewportSizeHint ( ) const

overrideprotected

Since: 5.2 \reimp

Definition at line 3490 of file qlistview.cpp.

Here is the call graph for this function:

◆ visualRect()

QRect QListView::visualRect ( const QModelIndex & index ) const

overridevirtual

\reimp

Implements QAbstractItemView.

Definition at line 558 of file qlistview.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ visualRegionForSelection()

QRegion QListView::visualRegionForSelection ( const QItemSelection & selection ) const

overrideprotectedvirtual

\reimp

Since 4.7, the returned region only contains rectangles intersecting (or included in) the viewport.

Implements QAbstractItemView.

Definition at line 1508 of file qlistview.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ wordWrap()

bool QListView::wordWrap ( ) const

Definition at line 1708 of file qlistview.cpp.

Friends And Related Function Documentation

◆ QCommonListViewBase

friend class QCommonListViewBase

friend

Definition at line 197 of file qlistview.h.

Property Documentation

◆ batchSize

QListView::batchSize

readwrite

the number of items laid out in each batch if \l layoutMode is set to \l Batched

The default value is 100.

Since: 4.2

Definition at line 203 of file qlistview.h.

◆ flow

QListView::flow

readwrite

which direction the items layout should flow.

If this property is \l LeftToRight, the items will be laid out left to right. If the \l isWrapping property is true, the layout will wrap when it reaches the right side of the visible area. If this property is \l TopToBottom, the items will be laid out from the top of the visible area, wrapping when it reaches the bottom.

Setting this property when the view is visible will cause the items to be laid out again.

By default, this property is set to \l TopToBottom.

See also: viewMode

Definition at line 203 of file qlistview.h.

◆ gridSize

QListView::gridSize

readwrite

the size of the layout grid

This property is the size of the grid in which the items are laid out. The default is an empty size which means that there is no grid and the layout is not done in a grid. Setting this property to a non-empty size switches on the grid layout. (When a grid layout is in force the \l spacing property is ignored.)

Setting this property when the view is visible will cause the items to be laid out again.

See also: viewMode

Definition at line 203 of file qlistview.h.

◆ isWrapping

QListView::isWrapping

readwrite

whether the items layout should wrap.

This property holds whether the layout should wrap when there is no more space in the visible area. The point at which the layout wraps depends on the \l flow property.

Setting this property when the view is visible will cause the items to be laid out again.

By default, this property is false.

See also: viewMode

Definition at line 203 of file qlistview.h.

◆ itemAlignment

QListView::itemAlignment

readwrite

the alignment of each item in its cell

Since: 5.12

This is only supported in ListMode with TopToBottom flow and with wrapping enabled. The default alignment is 0, which means that an item fills its cell entirely.

Definition at line 203 of file qlistview.h.

◆ layoutMode

QListView::layoutMode

readwrite

determines whether the layout of items should happen immediately or be delayed.

This property holds the layout mode for the items. When the mode is \l SinglePass (the default), the items are laid out all in one go. When the mode is \l Batched, the items are laid out in batches of \l batchSize items, while processing events. This makes it possible to instantly view and interact with the visible items while the rest are being laid out.

See also: viewMode

Definition at line 203 of file qlistview.h.

◆ modelColumn

QListView::modelColumn

readwrite

the column in the model that is visible

By default, this property contains 0, indicating that the first column in the model will be shown.

Definition at line 203 of file qlistview.h.

◆ movement

QListView::movement

readwrite

whether the items can be moved freely, are snapped to a grid, or cannot be moved at all.

This property determines how the user can move the items in the view. \l Static means that the items can't be moved by the user. \l Free means that the user can drag and drop the items to any position in the view. \l Snap means that the user can drag and drop the items, but only to the positions in a notional grid signified by the gridSize property.

Setting this property when the view is visible will cause the items to be laid out again.

By default, this property is set to \l Static.

See also: gridSize, resizeMode, viewMode

Definition at line 203 of file qlistview.h.

◆ resizeMode

QListView::resizeMode

readwrite

whether the items are laid out again when the view is resized.

If this property is \l Adjust, the items will be laid out again when the view is resized. If the value is \l Fixed, the items will not be laid out when the view is resized.

By default, this property is set to \l Fixed.

See also: movement, gridSize, viewMode

Definition at line 203 of file qlistview.h.

◆ selectionRectVisible

QListView::selectionRectVisible

readwrite

if the selection rectangle should be visible

Since: 4.3

If this property is true then the selection rectangle is visible; otherwise it will be hidden.

Note: The selection rectangle will only be visible if the selection mode is in a mode where more than one item can be selected; i.e., it will not draw a selection rectangle if the selection mode is QAbstractItemView::SingleSelection.

By default, this property is false.

Definition at line 203 of file qlistview.h.

◆ spacing

QListView::spacing

readwrite

the space around the items in the layout

This property is the size of the empty space that is padded around an item in the layout.

Setting this property when the view is visible will cause the items to be laid out again.

By default, this property contains a value of 0.

See also: viewMode

Definition at line 203 of file qlistview.h.

◆ uniformItemSizes

QListView::uniformItemSizes

readwrite

whether all items in the listview have the same size

Since: 4.1

This property should only be set to true if it is guaranteed that all items in the view have the same size. This enables the view to do some optimizations for performance purposes.

By default, this property is false.

Definition at line 203 of file qlistview.h.

◆ viewMode

QListView::viewMode

readwrite

the view mode of the QListView.

This property will change the other unset properties to conform with the set view mode. QListView-specific properties that have already been set will not be changed, unless clearPropertyFlags() has been called.

Setting the view mode will enable or disable drag and drop based on the selected movement. For ListMode, the default movement is \l Static (drag and drop disabled); for IconMode, the default movement is \l Free (drag and drop enabled).

See also: isWrapping, spacing, gridSize, flow, movement, resizeMode

Definition at line 203 of file qlistview.h.

◆ wordWrap

QListView::wordWrap

readwrite

the item text word-wrapping policy

Since: 4.2

If this property is true then the item text is wrapped where necessary at word-breaks; otherwise it is not wrapped at all. This property is false by default.

Please note that even if wrapping is enabled, the cell will not be expanded to make room for the text. It will print ellipsis for text that cannot be shown, according to the view's \l{QAbstractItemView::}{textElideMode}.

Definition at line 203 of file qlistview.h.

The documentation for this class was generated from the following files:

src/widgets/itemviews/qlistview.h
src/widgets/itemviews/qlistview.cpp

Public Types

Signals

Public Member Functions

Protected Member Functions

Properties

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Flow

◆ LayoutMode

◆ Movement

◆ ResizeMode

◆ ViewMode

Constructor & Destructor Documentation

◆ QListView() [1/2]

◆ ~QListView()

◆ QListView() [2/2]

Member Function Documentation

◆ batchSize()

◆ clearPropertyFlags()

◆ contentsSize()

◆ currentChanged()

◆ dataChanged()

◆ doItemsLayout()

◆ event()

◆ flow()

◆ gridSize()

◆ horizontalOffset()

◆ indexAt()

◆ indexesMoved

◆ initViewItemOption()

◆ isIndexHidden()

◆ isRowHidden()

◆ isSelectionRectVisible()

◆ isWrapping()

◆ itemAlignment()

◆ layoutMode()

◆ modelColumn()

◆ mouseMoveEvent()

◆ mouseReleaseEvent()

◆ moveCursor()

◆ movement()

◆ paintEvent()

◆ rectForIndex()

◆ reset()

◆ resizeContents()

◆ resizeEvent()

◆ resizeMode()

◆ rowsAboutToBeRemoved()

◆ rowsInserted()

◆ scrollContentsBy()

◆ scrollTo()

◆ selectedIndexes()

◆ selectionChanged()

◆ setBatchSize()

◆ setFlow()

◆ setGridSize()

◆ setItemAlignment()

◆ setLayoutMode()

◆ setModelColumn()

◆ setMovement()

◆ setPositionForIndex()

◆ setResizeMode()

◆ setRootIndex()

◆ setRowHidden()

◆ setSelection()

◆ setSelectionRectVisible()

◆ setSpacing()

◆ setUniformItemSizes()

◆ setViewMode()

◆ setWordWrap()

◆ setWrapping()

◆ spacing()

◆ timerEvent()

◆ uniformItemSizes()

◆ updateGeometries()

◆ verticalOffset()

◆ viewMode()

◆ viewportSizeHint()