The QTableView class provides a default model/view implementation of a table view. More...

#include <qtableview.h>

Inheritance diagram for QTableView:

Collaboration diagram for QTableView:

Public Slots
void	selectRow (int row)
	Selects the given row in the table view if the current SelectionMode and SelectionBehavior allows rows to be selected.

void	selectColumn (int column)
	Selects the given column in the table view if the current SelectionMode and SelectionBehavior allows columns to be selected.

void	hideRow (int row)
	Hide the given row.

void	hideColumn (int column)
	Hide the given column.

void	showRow (int row)
	Show the given row.

void	showColumn (int column)
	Show the given column.

void	resizeRowToContents (int row)
	Resizes the given row based on the size hints of the delegate used to render each item in the row.

void	resizeRowsToContents ()
	Resizes all rows based on the size hints of the delegate used to render each item in the rows.

void	resizeColumnToContents (int column)
	Resizes the given column based on the size hints of the delegate used to render each item in the column.

void	resizeColumnsToContents ()
	Resizes all columns based on the size hints of the delegate used to render each item in the columns.

void	sortByColumn (int column, Qt::SortOrder order)
	Sorts the model by the values in the given column and order.

void	setShowGrid (bool show)

Public Slots inherited from QAbstractItemView
virtual void	reset ()
	Reset the internal state of the view.

virtual void	selectAll ()
	Selects all items in the view.

void	edit (const QModelIndex &index)
	Starts editing the item corresponding to the given index if it is editable.

void	clearSelection ()
	Deselects all selected items.

void	setCurrentIndex (const QModelIndex &index)
	Sets the current item to be the item at index.

void	scrollToTop ()
	Scrolls the view to the top.

void	scrollToBottom ()
	Scrolls the view to the bottom.

void	update (const QModelIndex &index)
	Updates the area occupied by the given index.

Public Member Functions
	QTableView (QWidget *parent=nullptr)
	Constructs a table view with a parent to represent the data.

	~QTableView ()
	Destroys the table view.

void	setModel (QAbstractItemModel *model) override
	\reimp

void	setRootIndex (const QModelIndex &index) override
	\reimp

void	setSelectionModel (QItemSelectionModel *selectionModel) override
	\reimp

void	doItemsLayout () override

QHeaderView *	horizontalHeader () const
	Returns the table view's horizontal header.

QHeaderView *	verticalHeader () const
	Returns the table view's vertical header.

void	setHorizontalHeader (QHeaderView *header)
	Sets the widget to use for the horizontal header to header.

void	setVerticalHeader (QHeaderView *header)
	Sets the widget to use for the vertical header to header.

int	rowViewportPosition (int row) const
	Returns the y-coordinate in contents coordinates of the given row.

int	rowAt (int y) const
	Returns the row in which the given y-coordinate, y, in contents coordinates is located.

void	setRowHeight (int row, int height)
	Sets the height of the given row to be height.

int	rowHeight (int row) const
	Returns the height of the given row.

int	columnViewportPosition (int column) const
	Returns the x-coordinate in contents coordinates of the given column.

int	columnAt (int x) const
	Returns the column in which the given x-coordinate, x, in contents coordinates is located.

void	setColumnWidth (int column, int width)
	Sets the width of the given column to be width.

int	columnWidth (int column) const
	Returns the width of the given column.

bool	isRowHidden (int row) const
	Returns `true` if the given row is hidden; otherwise returns `false`.

void	setRowHidden (int row, bool hide)
	If hide is true row will be hidden, otherwise it will be shown.

bool	isColumnHidden (int column) const
	Returns `true` if the given column is hidden; otherwise returns `false`.

void	setColumnHidden (int column, bool hide)
	If hide is true the given column will be hidden; otherwise it will be shown.

void	setSortingEnabled (bool enable)
	If enable is true, enables sorting for the table and immediately trigger a call to sortByColumn() with the current sort section and order.

bool	isSortingEnabled () const

bool	showGrid () const

Qt::PenStyle	gridStyle () const

void	setGridStyle (Qt::PenStyle style)

void	setWordWrap (bool on)

bool	wordWrap () const

QRect	visualRect (const QModelIndex &index) const override
	\reimp

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

QModelIndex	indexAt (const QPoint &p) const override
	Returns the index position of the model item corresponding to the table item at position pos in contents coordinates.

void	setSpan (int row, int column, int rowSpan, int columnSpan)
	Sets the span of the table element at (row, column) to the number of rows and columns specified by (rowSpanCount, columnSpanCount).

int	rowSpan (int row, int column) const
	Returns the row span of the table element at (row, column).

int	columnSpan (int row, int column) const
	Returns the column span of the table element at (row, column).

void	clearSpans ()
	Removes all row and column spans in the table view.

Public Member Functions inherited from QAbstractItemView
	QAbstractItemView (QWidget *parent=nullptr)
	Constructs an abstract item view with the given parent.

	~QAbstractItemView ()
	Destroys the view.

QAbstractItemModel *	model () const
	Returns the model that this view is presenting.

QItemSelectionModel *	selectionModel () const
	Returns the current selection model.

void	setItemDelegate (QAbstractItemDelegate *delegate)
	Sets the item delegate for this view and its model to delegate.

QAbstractItemDelegate *	itemDelegate () const
	Returns the item delegate used by this view and model.

void	setSelectionMode (QAbstractItemView::SelectionMode mode)

QAbstractItemView::SelectionMode	selectionMode () const

void	setSelectionBehavior (QAbstractItemView::SelectionBehavior behavior)

QAbstractItemView::SelectionBehavior	selectionBehavior () const

QModelIndex	currentIndex () const
	Returns the model index of the current item.

QModelIndex	rootIndex () const
	Returns the model index of the model's root item.

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)
	Moves to and selects the item best matching the string search.

QSize	sizeHintForIndex (const QModelIndex &index) const
	Returns the size hint for the item with the specified index or an invalid size for invalid indexes.

uint32_t	updateThreshold () const

void	setUpdateThreshold (uint32_t threshold)

void	openPersistentEditor (const QModelIndex &index)
	Opens a persistent editor on the item at the given index.

void	closePersistentEditor (const QModelIndex &index)
	Closes the persistent editor for the item at the given index.

bool	isPersistentEditorOpen (const QModelIndex &index) const

void	setIndexWidget (const QModelIndex &index, QWidget *widget)
	Sets the given widget on the item at the given index, passing the ownership of the widget to the viewport.

QWidget *	indexWidget (const QModelIndex &index) const
	Returns the widget for the item at the given index.

void	setItemDelegateForRow (int row, QAbstractItemDelegate *delegate)
	Sets the given item delegate used by this view and model for the given row.

QAbstractItemDelegate *	itemDelegateForRow (int row) const
	Returns the item delegate used by this view and model for the given row, or \nullptr if no delegate has been assigned.

void	setItemDelegateForColumn (int column, QAbstractItemDelegate *delegate)
	Sets the given item delegate used by this view and model for the given column.

QAbstractItemDelegate *	itemDelegateForColumn (int column) const
	Returns the item delegate used by this view and model for the given column.

virtual QAbstractItemDelegate *	itemDelegateForIndex (const QModelIndex &index) const

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

Protected Slots
void	rowMoved (int row, int oldIndex, int newIndex)
	This slot is called to change the index of the given row in the table view.

void	columnMoved (int column, int oldIndex, int newIndex)
	This slot is called to change the index of the given column in the table view.

void	rowResized (int row, int oldHeight, int newHeight)
	This slot is called to change the height of the given row.

void	columnResized (int column, int oldWidth, int newWidth)
	This slot is called to change the width of the given column.

void	rowCountChanged (int oldCount, int newCount)
	This slot is called whenever rows are added or deleted.

void	columnCountChanged (int oldCount, int newCount)
	This slot is called whenever columns are added or deleted.

Protected Slots inherited from QAbstractItemView
virtual void	dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QList< int > &roles=QList< int >())
	This slot is called when items with the given roles are changed in the model.

virtual void	rowsInserted (const QModelIndex &parent, int start, int end)
	This slot is called when rows are inserted.

virtual void	rowsAboutToBeRemoved (const QModelIndex &parent, int start, int end)
	This slot is called when rows are about to be removed.

virtual void	updateEditorData ()

virtual void	updateEditorGeometries ()

virtual void	verticalScrollbarValueChanged (int value)

virtual void	horizontalScrollbarValueChanged (int value)

virtual void	closeEditor (QWidget *editor, QAbstractItemDelegate::EndEditHint hint)
	Closes the given editor, and releases it.

virtual void	commitData (QWidget *editor)
	Commit the data in the editor to the model.

virtual void	editorDestroyed (QObject *editor)
	This function is called when the given editor has been destroyed.

Protected Member Functions
	QTableView (QTableViewPrivate &, QWidget *parent)

void	scrollContentsBy (int dx, int dy) override
	\reimp

void	initViewItemOption (QStyleOptionViewItem *option) const override
	\reimp

void	paintEvent (QPaintEvent *e) override
	Paints the table on receipt of the given paint event event.

void	timerEvent (QTimerEvent *event) override
	\reimp

int	horizontalOffset () const override
	Returns the horizontal offset of the items in the table view.

int	verticalOffset () const override
	Returns the vertical offset of the items in the table view.

QModelIndex	moveCursor (CursorAction cursorAction, Qt::KeyboardModifiers modifiers) override
	Moves the cursor in accordance with the given cursorAction, using the information provided by the modifiers.

void	setSelection (const QRect &rect, QItemSelectionModel::SelectionFlags command) override
	Selects the items within the given rect and in accordance with the specified selection flags.

QRegion	visualRegionForSelection (const QItemSelection &selection) const override
	\reimp

QModelIndexList	selectedIndexes () const override
	\reimp

void	updateGeometries () override
	\reimp

QSize	viewportSizeHint () const override
	\reimp

int	sizeHintForRow (int row) const override
	Returns the size hint for the given row's height or -1 if there is no model.

int	sizeHintForColumn (int column) const override
	Returns the size hint for the given column's width or -1 if there is no model.

void	verticalScrollbarAction (int action) override

void	horizontalScrollbarAction (int action) override

bool	isIndexHidden (const QModelIndex &index) const override
	\reimp

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

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

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

virtual bool	edit (const QModelIndex &index, EditTrigger trigger, QEvent *event)
	Starts editing the item at index, creating an editor if necessary, and returns `true` if the view's \l{State} is now EditingState; otherwise returns `false`.

virtual QItemSelectionModel::SelectionFlags	selectionCommand (const QModelIndex &index, const QEvent *event=nullptr) const
	Returns the SelectionFlags to be used when updating a selection model for the specified index.

State	state () const
	Returns the item view's state.

void	setState (State state)
	Sets the item view's state to the given state.

void	scheduleDelayedItemsLayout ()
	Schedules a layout of the items in the view to be executed when the event processing starts.

void	executeDelayedItemsLayout ()
	Executes the scheduled layouts without waiting for the event processing to begin.

void	setDirtyRegion (const QRegion &region)
	Marks the given region as dirty and schedules it to be updated.

void	scrollDirtyRegion (int dx, int dy)
	Prepares the view for scrolling by ({dx},{dy}) pixels by moving the dirty regions in the opposite direction.

QPoint	dirtyRegionOffset () const
	Returns the offset of the dirty regions in the view.

void	startAutoScroll ()

void	stopAutoScroll ()

void	doAutoScroll ()

bool	focusNextPrevChild (bool next) override
	\reimp

bool	event (QEvent *event) override
	\reimp

bool	viewportEvent (QEvent *event) override
	This function is used to handle tool tips, and What's This? mode, if the given event is a QEvent::ToolTip,or a QEvent::WhatsThis.

void	mousePressEvent (QMouseEvent *event) override
	This function is called with the given event when a mouse button is pressed while the cursor is inside the widget.

void	mouseMoveEvent (QMouseEvent *event) override
	This function is called with the given event when a mouse move event is sent to the widget.

void	mouseReleaseEvent (QMouseEvent *event) override
	This function is called with the given event when a mouse button is released, after a mouse press event on the widget.

void	mouseDoubleClickEvent (QMouseEvent *event) override
	This function is called with the given event when a mouse button is double clicked inside the widget.

void	focusInEvent (QFocusEvent *event) override
	This function is called with the given event when the widget obtains the focus.

void	focusOutEvent (QFocusEvent *event) override
	This function is called with the given event when the widget loses the focus.

void	keyPressEvent (QKeyEvent *event) override
	This function is called with the given event when a key event is sent to the widget.

void	resizeEvent (QResizeEvent *event) override
	This function is called with the given event when a resize event is sent to the widget.

void	timerEvent (QTimerEvent *event) override
	This function is called with the given event when a timer event is sent to the widget.

void	inputMethodEvent (QInputMethodEvent *event) override
	\reimp

bool	eventFilter (QObject object, QEvent event) override
	\reimp

QSize	viewportSizeHint () const override

Properties
bool	showGrid
	whether the grid is shown

Qt::PenStyle	gridStyle
	the pen style used to draw the grid.

bool	sortingEnabled
	whether sorting is enabled

bool	wordWrap
	the item text word-wrapping policy

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

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

EditTriggers	editTriggers
	which actions will initiate item editing

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

bool	alternatingRowColors
	whether to draw the background using alternating colors

SelectionMode	selectionMode
	which selection mode the view operates in

SelectionBehavior	selectionBehavior
	which selection behavior the view uses

QSize	iconSize
	the size of items' icons

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

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

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

uint32_t	updateThreshold

Friends
class	QAccessibleItemView

Additional Inherited Members
Public Types inherited from QAbstractItemView
enum	SelectionMode { NoSelection , SingleSelection , MultiSelection , ExtendedSelection , ContiguousSelection }
	This enum indicates how the view responds to user selections: More...

enum	SelectionBehavior { SelectItems , SelectRows , SelectColumns }
	\value SelectItems Selecting single items. More...

enum	ScrollHint { EnsureVisible , PositionAtTop , PositionAtBottom , PositionAtCenter }
	\value EnsureVisible Scroll to ensure that the item is visible. More...

enum	EditTrigger { NoEditTriggers = 0 , CurrentChanged = 1 , DoubleClicked = 2 , SelectedClicked = 4 , EditKeyPressed = 8 , AnyKeyPressed = 16 , AllEditTriggers = 31 }
	This enum describes actions which will initiate item editing. More...

enum	ScrollMode { ScrollPerItem , ScrollPerPixel }
	Describes how the scrollbar should behave. More...

Signals inherited from QAbstractItemView
void	pressed (const QModelIndex &index)
	This signal is emitted when a mouse button is pressed.

void	clicked (const QModelIndex &index)
	This signal is emitted when a mouse button is left-clicked.

void	doubleClicked (const QModelIndex &index)
	This signal is emitted when a mouse button is double-clicked.

void	activated (const QModelIndex &index)
	This signal is emitted when the item specified by index is activated by the user.

void	entered (const QModelIndex &index)
	This signal is emitted when the mouse cursor enters the item specified by index.

void	viewportEntered ()
	This signal is emitted when the mouse cursor enters the viewport.

void	iconSizeChanged (const QSize &size)

Protected Types inherited from QAbstractItemView
enum	CursorAction { MoveUp , MoveDown , MoveLeft , MoveRight , MoveHome , MoveEnd , MovePageUp , MovePageDown , MoveNext , MovePrevious }
	This enum describes the different ways to navigate between items,. More...

enum	State { NoState , DraggingState , DragSelectingState , EditingState , ExpandingState , CollapsingState , AnimatingState }
	Describes the different states the view can be in. More...

Detailed Description

The QTableView class provides a default model/view implementation of a table view.

\inmodule QtWidgets

A QTableView implements a table view that displays items from a model. This class is used to provide standard tables that were previously provided by the QTable class, but using the more flexible approach provided by Qt's model/view architecture.

The QTableView class is one of the \l{Model/View Classes} and is part of Qt's \l{Model/View Programming}{model/view framework}.

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

Definition at line 17 of file qtableview.h.

Constructor & Destructor Documentation

◆ QTableView() [1/2]

QTableView::QTableView ( QWidget * parent = nullptr )

explicit

Constructs a table view with a parent to represent the data.

See also: QAbstractItemModel

Definition at line 1221 of file qtableview.cpp.

◆ ~QTableView()

QTableView::~QTableView ( )

Destroys the table view.

Definition at line 1241 of file qtableview.cpp.

◆ QTableView() [2/2]

QTableView::QTableView	(	QTableViewPrivate &	dd,
		QWidget *	parent )

protected

Definition at line 1231 of file qtableview.cpp.

Member Function Documentation

◆ clearSpans()

void QTableView::clearSpans ( )

Removes all row and column spans in the table view.

See also: setSpan()

Definition at line 3457 of file qtableview.cpp.

◆ columnAt()

int QTableView::columnAt ( int x ) const

Returns the column in which the given x-coordinate, x, in contents coordinates is located.

Note: This function returns -1 if the given coordinate is not valid (has no column).

See also: rowAt()

Definition at line 2636 of file qtableview.cpp.

◆ columnCountChanged

void QTableView::columnCountChanged	(	int	oldCount,
		int	newCount )

protectedslot

This slot is called whenever columns are added or deleted.

The previous number of columns is specified by oldCount, and the new number of columns is specified by newCount.

Definition at line 2264 of file qtableview.cpp.

◆ columnMoved

void QTableView::columnMoved	(	int	column,
		int	oldIndex,
		int	newIndex )

protectedslot

This slot is called to change the index of the given column in the table view.

The old index is specified by oldIndex, and the new index by newIndex.

See also: rowMoved()

Definition at line 3211 of file qtableview.cpp.

◆ columnResized

void QTableView::columnResized	(	int	column,
		int	oldWidth,
		int	newWidth )

protectedslot

This slot is called to change the width of the given column.

The old width is specified by oldWidth, and the new width by newWidth.

See also: rowResized()

Definition at line 3038 of file qtableview.cpp.

◆ columnSpan()

int QTableView::columnSpan	(	int	row,
		int	column ) const

Returns the column span of the table element at (row, column).

The default is 1.

See also: setSpan(), rowSpan()

Definition at line 3445 of file qtableview.cpp.

◆ columnViewportPosition()

int QTableView::columnViewportPosition ( int column ) const

Returns the x-coordinate in contents coordinates of the given column.

Definition at line 2621 of file qtableview.cpp.

◆ columnWidth()

int QTableView::columnWidth ( int column ) const

Returns the width of the given column.

See also: resizeColumnToContents(), rowHeight()

Definition at line 2656 of file qtableview.cpp.

◆ currentChanged()

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

overrideprotectedvirtual

\reimp

Reimplemented from QAbstractItemView.

Definition at line 3561 of file qtableview.cpp.

◆ doItemsLayout()

void QTableView::doItemsLayout ( )

overridevirtual

Reimplemented from QAbstractItemView.

Definition at line 1309 of file qtableview.cpp.

◆ gridStyle()

Qt::PenStyle QTableView::gridStyle ( ) const

Definition at line 2792 of file qtableview.cpp.

◆ hideColumn

void QTableView::hideColumn ( int column )

slot

Hide the given column.

See also: showColumn(), hideRow()

Definition at line 3273 of file qtableview.cpp.

◆ hideRow

void QTableView::hideRow ( int row )

slot

Hide the given row.

See also: showRow(), hideColumn()

Definition at line 3262 of file qtableview.cpp.

◆ horizontalHeader()

QHeaderView * QTableView::horizontalHeader ( ) const

Returns the table view's horizontal header.

See also: setHorizontalHeader(), verticalHeader(), QAbstractItemModel::headerData()

Definition at line 1346 of file qtableview.cpp.

◆ horizontalOffset()

int QTableView::horizontalOffset ( ) const

overrideprotectedvirtual

Returns the horizontal offset of the items in the table view.

Note that the table view uses the horizontal header section positions to determine the positions of columns in the view.

See also: verticalOffset()

Implements QAbstractItemView.

Definition at line 1722 of file qtableview.cpp.

◆ horizontalScrollbarAction()

void QTableView::horizontalScrollbarAction ( int action )

overrideprotectedvirtual

Reimplemented from QAbstractItemView.

Definition at line 3389 of file qtableview.cpp.

◆ indexAt()

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

overridevirtual

Returns the index position of the model item corresponding to the table item at position pos in contents coordinates.

Implements QAbstractItemView.

Definition at line 1697 of file qtableview.cpp.

◆ initViewItemOption()

void QTableView::initViewItemOption ( QStyleOptionViewItem * option ) const

overrideprotectedvirtual

\reimp

Reimplemented from QAbstractItemView.

Definition at line 1491 of file qtableview.cpp.

◆ isColumnHidden()

bool QTableView::isColumnHidden ( int column ) const

Returns true if the given column is hidden; otherwise returns false.

See also: isRowHidden()

Definition at line 2691 of file qtableview.cpp.

◆ isIndexHidden()

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

overrideprotectedvirtual

\reimp

Implements QAbstractItemView.

Definition at line 3397 of file qtableview.cpp.

◆ isRowHidden()

bool QTableView::isRowHidden ( int row ) const

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

See also: isColumnHidden()

Definition at line 2667 of file qtableview.cpp.

◆ isSortingEnabled()

bool QTableView::isSortingEnabled ( ) const

Definition at line 2758 of file qtableview.cpp.

◆ moveCursor()

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

overrideprotectedvirtual

Moves the cursor in accordance with the given cursorAction, using the information provided by the modifiers.

See also: QAbstractItemView::CursorAction

Implements QAbstractItemView.

Definition at line 1750 of file qtableview.cpp.

◆ paintEvent()

void QTableView::paintEvent ( QPaintEvent * e )

overrideprotected

Paints the table on receipt of the given paint event event.

Definition at line 1500 of file qtableview.cpp.

◆ resizeColumnsToContents

void QTableView::resizeColumnsToContents ( )

slot

Resizes all columns based on the size hints of the delegate used to render each item in the columns.

See also: resizeColumnToContents(), sizeHintForColumn(), QHeaderView::resizeContentsPrecision()

Definition at line 3350 of file qtableview.cpp.

◆ resizeColumnToContents

void QTableView::resizeColumnToContents ( int column )

slot

Resizes the given column based on the size hints of the delegate used to render each item in the column.

Note: Only visible columns will be resized. Reimplement sizeHintForColumn() to resize hidden columns as well.

See also: resizeColumnsToContents(), sizeHintForColumn(), QHeaderView::resizeContentsPrecision()

Definition at line 3336 of file qtableview.cpp.

◆ resizeRowsToContents

void QTableView::resizeRowsToContents ( )

slot

Resizes all rows based on the size hints of the delegate used to render each item in the rows.

See also: resizeRowToContents(), sizeHintForRow(), QHeaderView::resizeContentsPrecision()

Definition at line 3321 of file qtableview.cpp.

◆ resizeRowToContents

void QTableView::resizeRowToContents ( int row )

slot

Resizes the given row based on the size hints of the delegate used to render each item in the row.

See also: resizeRowsToContents(), sizeHintForRow(), QHeaderView::resizeContentsPrecision()

Definition at line 3307 of file qtableview.cpp.

◆ rowAt()

int QTableView::rowAt ( int y ) const

Returns the row in which the given y-coordinate, y, in contents coordinates is located.

Note: This function returns -1 if the given coordinate is not valid (has no row).

See also: columnAt()

Definition at line 2591 of file qtableview.cpp.

◆ rowCountChanged

void QTableView::rowCountChanged	(	int	oldCount,
		int	newCount )

protectedslot

This slot is called whenever rows are added or deleted.

The previous number of rows is specified by oldCount, and the new number of rows is specified by newCount.

Definition at line 2249 of file qtableview.cpp.

◆ rowHeight()

int QTableView::rowHeight ( int row ) const

Returns the height of the given row.

See also: resizeRowToContents(), columnWidth()

Definition at line 2611 of file qtableview.cpp.

◆ rowMoved

void QTableView::rowMoved	(	int	row,
		int	oldIndex,
		int	newIndex )

protectedslot

This slot is called to change the index of the given row in the table view.

The old index is specified by oldIndex, and the new index by newIndex.

See also: columnMoved()

Definition at line 3182 of file qtableview.cpp.

◆ rowResized

void QTableView::rowResized	(	int	row,
		int	oldHeight,
		int	newHeight )

protectedslot

This slot is called to change the height of the given row.

The old height is specified by oldHeight, and the new height by newHeight.

See also: columnResized()

Definition at line 3023 of file qtableview.cpp.

◆ rowSpan()

int QTableView::rowSpan	(	int	row,
		int	column ) const

Returns the row span of the table element at (row, column).

The default is 1.

See also: setSpan(), columnSpan()

Definition at line 3433 of file qtableview.cpp.

◆ rowViewportPosition()

int QTableView::rowViewportPosition ( int row ) const

Returns the y-coordinate in contents coordinates of the given row.

Definition at line 2576 of file qtableview.cpp.

◆ scrollContentsBy()

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

overrideprotected

\reimp

Scroll the contents of the table view by (dx, dy).

Definition at line 1450 of file qtableview.cpp.

◆ scrollTo()

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

overridevirtual

\reimp

Makes sure that the given index is visible in the table view, scrolling if necessary.

Implements QAbstractItemView.

Definition at line 2896 of file qtableview.cpp.

◆ selectColumn

void QTableView::selectColumn ( int column )

slot

Selects the given column in the table view if the current SelectionMode and SelectionBehavior allows columns to be selected.

See also: selectRow()

Definition at line 3251 of file qtableview.cpp.

◆ selectedIndexes()

QModelIndexList QTableView::selectedIndexes ( ) const

overrideprotectedvirtual

\reimp

Reimplemented from QAbstractItemView.

Definition at line 2228 of file qtableview.cpp.

◆ selectionChanged()

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

overrideprotectedvirtual

\reimp

Reimplemented from QAbstractItemView.

Definition at line 3580 of file qtableview.cpp.

◆ selectRow

void QTableView::selectRow ( int row )

slot

Selects the given row in the table view if the current SelectionMode and SelectionBehavior allows rows to be selected.

See also: selectColumn()

Definition at line 3239 of file qtableview.cpp.

◆ setColumnHidden()

void QTableView::setColumnHidden	(	int	column,
		bool	hide )

If hide is true the given column will be hidden; otherwise it will be shown.

See also: setRowHidden()

Definition at line 2703 of file qtableview.cpp.

◆ setColumnWidth()

void QTableView::setColumnWidth	(	int	column,
		int	width )

Sets the width of the given column to be width.

Definition at line 2645 of file qtableview.cpp.

◆ setGridStyle()

void QTableView::setGridStyle ( Qt::PenStyle style )

Definition at line 2798 of file qtableview.cpp.

◆ setHorizontalHeader()

void QTableView::setHorizontalHeader ( QHeaderView * header )

Sets the widget to use for the horizontal header to header.

See also: horizontalHeader(), setVerticalHeader()

Definition at line 1368 of file qtableview.cpp.

◆ setModel()

void QTableView::setModel ( QAbstractItemModel * model )

overridevirtual

\reimp

Reimplemented from QAbstractItemView.

Reimplemented in QTableWidget.

Definition at line 1261 of file qtableview.cpp.

◆ setRootIndex()

void QTableView::setRootIndex ( const QModelIndex & index )

overridevirtual

\reimp

Reimplemented from QAbstractItemView.

Definition at line 1294 of file qtableview.cpp.

◆ setRowHeight()

void QTableView::setRowHeight	(	int	row,
		int	height )

Sets the height of the given row to be height.

Definition at line 2600 of file qtableview.cpp.

◆ setRowHidden()

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

If hide is true row will be hidden, otherwise it will be shown.

See also: setColumnHidden()

Definition at line 2678 of file qtableview.cpp.

◆ setSelection()

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

overrideprotectedvirtual

Selects the items within the given rect and in accordance with the specified selection flags.

Implements QAbstractItemView.

Definition at line 2004 of file qtableview.cpp.

◆ setSelectionModel()

void QTableView::setSelectionModel ( QItemSelectionModel * selectionModel )

overridevirtual

\reimp

Reimplemented from QAbstractItemView.

Definition at line 1320 of file qtableview.cpp.

◆ setShowGrid

void QTableView::setShowGrid ( bool show )

slot

Definition at line 2777 of file qtableview.cpp.

◆ setSortingEnabled()

void QTableView::setSortingEnabled ( bool enable )

If enable is true, enables sorting for the table and immediately trigger a call to sortByColumn() with the current sort section and order.

Definition at line 2731 of file qtableview.cpp.

◆ setSpan()

void QTableView::setSpan	(	int	row,
		int	column,
		int	rowSpanCount,
		int	columnSpanCount )

Sets the span of the table element at (row, column) to the number of rows and columns specified by (rowSpanCount, columnSpanCount).

See also: rowSpan(), columnSpan()

Definition at line 3418 of file qtableview.cpp.

◆ setVerticalHeader()

void QTableView::setVerticalHeader ( QHeaderView * header )

Sets the widget to use for the vertical header to header.

See also: verticalHeader(), setHorizontalHeader()

Definition at line 1408 of file qtableview.cpp.

◆ setWordWrap()

void QTableView::setWordWrap ( bool on )

Definition at line 2820 of file qtableview.cpp.

◆ showColumn

void QTableView::showColumn ( int column )

slot

Show the given column.

See also: hideColumn(), showRow()

Definition at line 3295 of file qtableview.cpp.

◆ showGrid()

bool QTableView::showGrid ( ) const

Definition at line 2771 of file qtableview.cpp.

◆ showRow

void QTableView::showRow ( int row )

slot

Show the given row.

See also: hideRow(), showColumn()

Definition at line 3284 of file qtableview.cpp.

◆ sizeHintForColumn()

int QTableView::sizeHintForColumn ( int column ) const

overrideprotectedvirtual

Returns the size hint for the given column's width or -1 if there is no model.

If you need to set the width of a given column to a fixed value, call QHeaderView::resizeSection() on the table's horizontal header.

If you reimplement this function in a subclass, note that the value you return will be used when resizeColumnToContents() or QHeaderView::resizeSections() is called. If a larger column width is required by either the horizontal header or the item delegate, the larger width will be used instead.

See also: QWidget::sizeHint, horizontalHeader(), QHeaderView::resizeContentsPrecision()

Reimplemented from QAbstractItemView.

Definition at line 2499 of file qtableview.cpp.

◆ sizeHintForRow()

int QTableView::sizeHintForRow ( int row ) const

overrideprotectedvirtual

Returns the size hint for the given row's height or -1 if there is no model.

If you need to set the height of a given row to a fixed value, call QHeaderView::resizeSection() on the table's vertical header.

If you reimplement this function in a subclass, note that the value you return is only used when resizeRowToContents() is called. In that case, if a larger row height is required by either the vertical header or the item delegate, that width will be used instead.

See also: QWidget::sizeHint, verticalHeader(), QHeaderView::resizeContentsPrecision()

Reimplemented from QAbstractItemView.

Definition at line 2410 of file qtableview.cpp.

◆ sortByColumn

void QTableView::sortByColumn	(	int	column,
		Qt::SortOrder	order )

slot

Sorts the model by the values in the given column and order.

column may be -1, in which case no sort indicator will be shown and the model will return to its natural, unsorted order. Note that not all models support this and may even crash in this case.

See also: sortingEnabled

Definition at line 3365 of file qtableview.cpp.

◆ timerEvent()

void QTableView::timerEvent ( QTimerEvent * event )

overrideprotected

\reimp

Definition at line 3049 of file qtableview.cpp.

◆ updateGeometries()

void QTableView::updateGeometries ( )

overrideprotectedvirtual

\reimp

Reimplemented from QAbstractItemView.

Definition at line 2278 of file qtableview.cpp.

◆ verticalHeader()

QHeaderView * QTableView::verticalHeader ( ) const

Returns the table view's vertical header.

See also: setVerticalHeader(), horizontalHeader(), QAbstractItemModel::headerData()

Definition at line 1357 of file qtableview.cpp.

◆ verticalOffset()

int QTableView::verticalOffset ( ) const

overrideprotectedvirtual

Returns the vertical offset of the items in the table view.

Note that the table view uses the vertical header section positions to determine the positions of rows in the view.

See also: horizontalOffset()

Implements QAbstractItemView.

Definition at line 1736 of file qtableview.cpp.

◆ verticalScrollbarAction()

void QTableView::verticalScrollbarAction ( int action )

overrideprotectedvirtual

Reimplemented from QAbstractItemView.

Definition at line 3381 of file qtableview.cpp.

◆ viewportSizeHint()

QSize QTableView::viewportSizeHint ( ) const

overrideprotected

\reimp

Definition at line 1250 of file qtableview.cpp.

◆ visualRect()

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

overridevirtual

\reimp

Returns the rectangle on the viewport occupied by the given index. If the index is hidden in the view it will return a null QRect.

Implements QAbstractItemView.

Definition at line 2867 of file qtableview.cpp.

◆ visualRegionForSelection()

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

overrideprotectedvirtual

\reimp

Returns the rectangle from the viewport of the items in the given selection.

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

Implements QAbstractItemView.

Definition at line 2134 of file qtableview.cpp.

◆ wordWrap()

bool QTableView::wordWrap ( ) const

Definition at line 2830 of file qtableview.cpp.

Friends And Related Symbol Documentation

◆ QAccessibleItemView

friend class QAccessibleItemView

friend

Definition at line 147 of file qtableview.h.

Property Documentation

◆ gridStyle

Qt::PenStyle QTableView::gridStyle

readwrite

the pen style used to draw the grid.

This property holds the style used when drawing the grid (see \l{showGrid}).

Definition at line 21 of file qtableview.h.

◆ showGrid

bool QTableView::showGrid

readwrite

whether the grid is shown

If this property is true a grid is drawn for the table; if the property is false, no grid is drawn. The default value is true.

Definition at line 20 of file qtableview.h.

◆ sortingEnabled

bool QTableView::sortingEnabled

readwrite

whether sorting is enabled

If this property is true, sorting is enabled for the table. If this property is false, sorting is not enabled. The default value is false.

Note: . Setting the property to true with setSortingEnabled() immediately triggers a call to sortByColumn() with the current sort section and order.

See also: sortByColumn()

Definition at line 22 of file qtableview.h.

◆ wordWrap

bool QTableView::wordWrap

readwrite

the item text word-wrapping policy

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 true by default.

Note that even of wrapping is enabled, the cell will not be expanded to fit all text. Ellipsis will be inserted according to the current \l{QAbstractItemView::}{textElideMode}.

Definition at line 23 of file qtableview.h.

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

qtbase/src/widgets/itemviews/qtableview.h (8e63cf282cb248ddd7fbc908766091659b3a0b22)
qtbase/src/widgets/itemviews/qtableview.cpp (10e0ce7f8251fb4449152ba9979076930424d011)

Public Slots

Public Member Functions

Protected Slots

Protected Member Functions

Properties

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QTableView() [1/2]

◆ ~QTableView()

◆ QTableView() [2/2]

Member Function Documentation

◆ clearSpans()

◆ columnAt()

◆ columnCountChanged

◆ columnMoved

◆ columnResized

◆ columnSpan()

◆ columnViewportPosition()

◆ columnWidth()

◆ currentChanged()

◆ doItemsLayout()

◆ gridStyle()

◆ hideColumn

◆ hideRow

◆ horizontalHeader()

◆ horizontalOffset()

◆ horizontalScrollbarAction()

◆ indexAt()

◆ initViewItemOption()

◆ isColumnHidden()

◆ isIndexHidden()

◆ isRowHidden()

◆ isSortingEnabled()

◆ moveCursor()

◆ paintEvent()

◆ resizeColumnsToContents

◆ resizeColumnToContents

◆ resizeRowsToContents

◆ resizeRowToContents

◆ rowAt()

◆ rowCountChanged

◆ rowHeight()

◆ rowMoved

◆ rowResized

◆ rowSpan()

◆ rowViewportPosition()

◆ scrollContentsBy()

◆ scrollTo()

◆ selectColumn

◆ selectedIndexes()

◆ selectionChanged()

◆ selectRow

◆ setColumnHidden()

◆ setColumnWidth()

◆ setGridStyle()

◆ setHorizontalHeader()

◆ setModel()

◆ setRootIndex()

◆ setRowHeight()

◆ setRowHidden()

◆ setSelection()

◆ setSelectionModel()

◆ setShowGrid

◆ setSortingEnabled()

◆ setSpan()

◆ setVerticalHeader()

◆ setWordWrap()

◆ showColumn

◆ showGrid()

◆ showRow

◆ sizeHintForColumn()

◆ sizeHintForRow()

◆ sortByColumn

◆ timerEvent()

◆ updateGeometries()

◆ verticalHeader()

◆ verticalOffset()

◆ verticalScrollbarAction()