
We bake cookies in your browser for a better experience. Using this site means that you consent.Read More
TheQAbstractItemView class provides the basic functionality for item view classes.More...
| Header: | #include <QAbstractItemView> |
| Inherits: | QAbstractScrollArea |
| Inherited By: |
| enum | DragDropMode { NoDragDrop, DragOnly, DropOnly, DragDrop, InternalMove } |
| enum | EditTrigger { NoEditTriggers, CurrentChanged, DoubleClicked, SelectedClicked, ..., AllEditTriggers } |
| flags | EditTriggers |
| enum | ScrollHint { EnsureVisible, PositionAtTop, PositionAtBottom, PositionAtCenter } |
| enum | ScrollMode { ScrollPerItem, ScrollPerPixel } |
| enum | SelectionBehavior { SelectItems, SelectRows, SelectColumns } |
| enum | SelectionMode { SingleSelection, ContiguousSelection, ExtendedSelection, MultiSelection, NoSelection } |
|
|
| QAbstractItemView(QWidget * parent = 0) | |
| ~QAbstractItemView() | |
| bool | alternatingRowColors() const |
| int | autoScrollMargin() const |
| void | closePersistentEditor(const QModelIndex & index) |
| QModelIndex | currentIndex() const |
| Qt::DropAction | defaultDropAction() const |
| DragDropMode | dragDropMode() const |
| bool | dragDropOverwriteMode() const |
| bool | dragEnabled() const |
| EditTriggers | editTriggers() const |
| bool | hasAutoScroll() const |
| ScrollMode | horizontalScrollMode() const |
| QSize | iconSize() const |
| virtual QModelIndex | indexAt(const QPoint & point) const = 0 |
| QWidget * | indexWidget(const QModelIndex & index) const |
| QAbstractItemDelegate * | itemDelegate() const |
| QAbstractItemDelegate * | itemDelegate(const QModelIndex & index) const |
| QAbstractItemDelegate * | itemDelegateForColumn(int column) const |
| QAbstractItemDelegate * | itemDelegateForRow(int row) const |
| virtual void | keyboardSearch(const QString & search) |
| QAbstractItemModel * | model() const |
| void | openPersistentEditor(const QModelIndex & index) |
| QModelIndex | rootIndex() const |
| virtual void | scrollTo(const QModelIndex & index, ScrollHint hint = EnsureVisible) = 0 |
| QAbstractItemView::SelectionBehavior | selectionBehavior() const |
| QAbstractItemView::SelectionMode | selectionMode() const |
| QItemSelectionModel * | selectionModel() const |
| void | setAlternatingRowColors(bool enable) |
| void | setAutoScroll(bool enable) |
| void | setAutoScrollMargin(int margin) |
| void | setDefaultDropAction(Qt::DropAction dropAction) |
| void | setDragDropMode(DragDropMode behavior) |
| void | setDragDropOverwriteMode(bool overwrite) |
| void | setDragEnabled(bool enable) |
| void | setDropIndicatorShown(bool enable) |
| void | setEditTriggers(EditTriggers triggers) |
| void | setHorizontalScrollMode(ScrollMode mode) |
| void | setIconSize(const QSize & size) |
| void | setIndexWidget(const QModelIndex & index, QWidget * widget) |
| void | setItemDelegate(QAbstractItemDelegate * delegate) |
| void | setItemDelegateForColumn(int column, QAbstractItemDelegate * delegate) |
| void | setItemDelegateForRow(int row, QAbstractItemDelegate * delegate) |
| virtual void | setModel(QAbstractItemModel * model) |
| void | setSelectionBehavior(QAbstractItemView::SelectionBehavior behavior) |
| void | setSelectionMode(QAbstractItemView::SelectionMode mode) |
| virtual void | setSelectionModel(QItemSelectionModel * selectionModel) |
| void | setTabKeyNavigation(bool enable) |
| void | setTextElideMode(Qt::TextElideMode mode) |
| void | setVerticalScrollMode(ScrollMode mode) |
| bool | showDropIndicator() const |
| virtual int | sizeHintForColumn(int column) const |
| QSize | sizeHintForIndex(const QModelIndex & index) const |
| virtual int | sizeHintForRow(int row) const |
| bool | tabKeyNavigation() const |
| Qt::TextElideMode | textElideMode() const |
| ScrollMode | verticalScrollMode() const |
| virtual QRect | visualRect(const QModelIndex & index) const = 0 |
| virtual QVariant | inputMethodQuery(Qt::InputMethodQuery query) const |
| void | clearSelection() |
| void | edit(const QModelIndex & index) |
| virtual void | reset() |
| void | scrollToBottom() |
| void | scrollToTop() |
| virtual void | selectAll() |
| void | setCurrentIndex(const QModelIndex & index) |
| virtual void | setRootIndex(const QModelIndex & index) |
| void | update(const QModelIndex & index) |
| void | activated(const QModelIndex & index) |
| void | clicked(const QModelIndex & index) |
| void | doubleClicked(const QModelIndex & index) |
| void | entered(const QModelIndex & index) |
| void | pressed(const QModelIndex & index) |
| void | viewportEntered() |
| enum | CursorAction { MoveUp, MoveDown, MoveLeft, MoveRight, ..., MovePrevious } |
| enum | DropIndicatorPosition { OnItem, AboveItem, BelowItem, OnViewport } |
| enum | State { NoState, DraggingState, DragSelectingState, EditingState, ..., AnimatingState } |
| QPoint | dirtyRegionOffset() const |
| DropIndicatorPosition | dropIndicatorPosition() const |
| virtual bool | edit(const QModelIndex & index, EditTrigger trigger, QEvent * event) |
| void | executeDelayedItemsLayout() |
| virtual int | horizontalOffset() const = 0 |
| virtual bool | isIndexHidden(const QModelIndex & index) const = 0 |
| virtual QModelIndex | moveCursor(CursorAction cursorAction, Qt::KeyboardModifiers modifiers) = 0 |
| void | scheduleDelayedItemsLayout() |
| void | scrollDirtyRegion(int dx, int dy) |
| virtual QModelIndexList | selectedIndexes() const |
| virtual QItemSelectionModel::SelectionFlags | selectionCommand(const QModelIndex & index, const QEvent * event = 0) const |
| void | setDirtyRegion(const QRegion & region) |
| virtual void | setSelection(const QRect & rect, QItemSelectionModel::SelectionFlags flags) = 0 |
| void | setState(State state) |
| virtual void | startDrag(Qt::DropActions supportedActions) |
| State | state() const |
| virtual int | verticalOffset() const = 0 |
| virtual QStyleOptionViewItem | viewOptions() const |
| virtual QRegion | visualRegionForSelection(const QItemSelection & selection) const = 0 |
| virtual void | dragEnterEvent(QDragEnterEvent * event) |
| virtual void | dragLeaveEvent(QDragLeaveEvent * event) |
| virtual void | dragMoveEvent(QDragMoveEvent * event) |
| virtual void | dropEvent(QDropEvent * event) |
| virtual bool | event(QEvent * event) |
| virtual void | focusInEvent(QFocusEvent * event) |
| virtual bool | focusNextPrevChild(bool next) |
| virtual void | focusOutEvent(QFocusEvent * event) |
| virtual void | inputMethodEvent(QInputMethodEvent * event) |
| virtual void | keyPressEvent(QKeyEvent * event) |
| virtual void | mouseDoubleClickEvent(QMouseEvent * event) |
| virtual void | mouseMoveEvent(QMouseEvent * event) |
| virtual void | mousePressEvent(QMouseEvent * event) |
| virtual void | mouseReleaseEvent(QMouseEvent * event) |
| virtual void | resizeEvent(QResizeEvent * event) |
| virtual void | timerEvent(QTimerEvent * event) |
| virtual bool | viewportEvent(QEvent * event) |
| virtual void | closeEditor(QWidget * editor, QAbstractItemDelegate::EndEditHint hint) |
| virtual void | commitData(QWidget * editor) |
| virtual void | currentChanged(const QModelIndex & current, const QModelIndex & previous) |
| virtual void | dataChanged(const QModelIndex & topLeft, const QModelIndex & bottomRight) |
| virtual void | editorDestroyed(QObject * editor) |
| virtual void | rowsAboutToBeRemoved(const QModelIndex & parent, int start, int end) |
| virtual void | rowsInserted(const QModelIndex & parent, int start, int end) |
| virtual void | selectionChanged(const QItemSelection & selected, const QItemSelection & deselected) |
| virtual void | updateGeometries() |
TheQAbstractItemView class provides the basic functionality for item view classes.
QAbstractItemView class is the base class for every standard view that uses aQAbstractItemModel.QAbstractItemView is an abstract class and cannot itself be instantiated. It provides a standard interface for interoperating with models through the signals and slots mechanism, enabling subclasses to be kept up-to-date with changes to their models. This class provides standard support for keyboard and mouse navigation, viewport scrolling, item editing, and selections. The keyboard navigation implements this functionality:
| Keys | Functionality |
|---|---|
| Arrow keys | Changes the current item and selects it. |
| Ctrl+Arrow keys | Changes the current item but does not select it. |
| Shift+Arrow keys | Changes the current item and selects it. The previously selected item(s) is not deselected. |
| Ctr+Space | Toggles selection of the current item. |
| Tab/Backtab | Changes the current item to the next/previous item. |
| Home/End | Selects the first/last item in the model. |
| Page up/Page down | Scrolls the rows shown up/down by the number of visible rows in the view. |
| Ctrl+A | Selects all items in the model. |
Note that the above table assumes that theselection mode allows the operations. For instance, you cannot select items if the selection mode isQAbstractItemView::NoSelection.
TheQAbstractItemView class is one of theModel/View Classes and is part of Qt'smodel/view framework.
The view classes that inheritQAbstractItemView only need to implement their own view-specific functionality, such as drawing items, returning the geometry of items, finding items, etc.
QAbstractItemView provides common slots such asedit() andsetCurrentIndex(). Many protected slots are also provided, includingdataChanged(),rowsInserted(),rowsAboutToBeRemoved(),selectionChanged(), andcurrentChanged().
The root item is returned byrootIndex(), and the current item bycurrentIndex(). To make sure that an item is visible usescrollTo().
Some ofQAbstractItemView's functions are concerned with scrolling, for examplesetHorizontalScrollMode() andsetVerticalScrollMode(). To set the range of the scroll bars, you can, for example, reimplement the view'sresizeEvent() function:
void MyView::resizeEvent(QResizeEvent*event) { horizontalScrollBar()->setRange(0, realWidth- width());...}
Note that the range is not updated until the widget is shown.
Several other functions are concerned with selection control; for examplesetSelectionMode(), andsetSelectionBehavior(). This class provides a default selection model to work with (selectionModel()), but this can be replaced by usingsetSelectionModel() with an instance ofQItemSelectionModel.
For complete control over the display and editing of items you can specify a delegate withsetItemDelegate().
QAbstractItemView provides a lot of protected functions. Some are concerned with editing, for example,edit(), andcommitData(), whilst others are keyboard and mouse event handlers.
Note:If you inheritQAbstractItemView and intend to update the contents of the viewport, you should use viewport->update() instead ofupdate() as all painting operations take place on the viewport.
See alsoView Classes,Model/View Programming,QAbstractItemModel, andChart Example.
This enum describes the different ways to navigate between items,
| Constant | Value | Description |
|---|---|---|
QAbstractItemView::MoveUp | 0 | Move to the item above the current item. |
QAbstractItemView::MoveDown | 1 | Move to the item below the current item. |
QAbstractItemView::MoveLeft | 2 | Move to the item left of the current item. |
QAbstractItemView::MoveRight | 3 | Move to the item right of the current item. |
QAbstractItemView::MoveHome | 4 | Move to the top-left corner item. |
QAbstractItemView::MoveEnd | 5 | Move to the bottom-right corner item. |
QAbstractItemView::MovePageUp | 6 | Move one page up above the current item. |
QAbstractItemView::MovePageDown | 7 | Move one page down below the current item. |
QAbstractItemView::MoveNext | 8 | Move to the item after the current item. |
QAbstractItemView::MovePrevious | 9 | Move to the item before the current item. |
See alsomoveCursor().
Describes the various drag and drop events the view can act upon. By default the view does not support dragging or dropping (NoDragDrop).
| Constant | Value | Description |
|---|---|---|
QAbstractItemView::NoDragDrop | 0 | Does not support dragging or dropping. |
QAbstractItemView::DragOnly | 1 | The view supports dragging of its own items |
QAbstractItemView::DropOnly | 2 | The view accepts drops |
QAbstractItemView::DragDrop | 3 | The view supports both dragging and dropping |
QAbstractItemView::InternalMove | 4 | The view accepts move (not copy) operations only from itself. |
Note that the model used needs to provide support for drag and drop operations.
This enum was introduced or modified in Qt 4.2.
See alsosetDragDropMode() andUsing drag and drop with item views.
This enum indicates the position of the drop indicator in relation to the index at the current mouse position:
| Constant | Value | Description |
|---|---|---|
QAbstractItemView::OnItem | 0 | The item will be dropped on the index. |
QAbstractItemView::AboveItem | 1 | The item will be dropped above the index. |
QAbstractItemView::BelowItem | 2 | The item will be dropped below the index. |
QAbstractItemView::OnViewport | 3 | The item will be dropped onto a region of the viewport with no items. The way each view handles items dropped onto the viewport depends on the behavior of the underlying model in use. |
This enum describes actions which will initiate item editing.
| Constant | Value | Description |
|---|---|---|
QAbstractItemView::NoEditTriggers | 0 | No editing possible. |
QAbstractItemView::CurrentChanged | 1 | Editing start whenever current item changes. |
QAbstractItemView::DoubleClicked | 2 | Editing starts when an item is double clicked. |
QAbstractItemView::SelectedClicked | 4 | Editing starts when clicking on an already selected item. |
QAbstractItemView::EditKeyPressed | 8 | Editing starts when the platform edit key has been pressed over an item. |
QAbstractItemView::AnyKeyPressed | 16 | Editing starts when any key is pressed over an item. |
QAbstractItemView::AllEditTriggers | 31 | Editing starts for all above actions. |
The EditTriggers type is a typedef forQFlags<EditTrigger>. It stores an OR combination of EditTrigger values.
| Constant | Value | Description |
|---|---|---|
QAbstractItemView::EnsureVisible | 0 | Scroll to ensure that the item is visible. |
QAbstractItemView::PositionAtTop | 1 | Scroll to position the item at the top of the viewport. |
QAbstractItemView::PositionAtBottom | 2 | Scroll to position the item at the bottom of the viewport. |
QAbstractItemView::PositionAtCenter | 3 | Scroll to position the item at the center of the viewport. |
| Constant | Value | Description |
|---|---|---|
QAbstractItemView::ScrollPerItem | 0 | The view will scroll the contents one item at a time. |
QAbstractItemView::ScrollPerPixel | 1 | The view will scroll the contents one pixel at a time. |
This enum was introduced or modified in Qt 4.2.
| Constant | Value | Description |
|---|---|---|
QAbstractItemView::SelectItems | 0 | Selecting single items. |
QAbstractItemView::SelectRows | 1 | Selecting only rows. |
QAbstractItemView::SelectColumns | 2 | Selecting only columns. |
This enum indicates how the view responds to user selections:
| Constant | Value | Description |
|---|---|---|
QAbstractItemView::SingleSelection | 1 | When the user selects an item, any already-selected item becomes unselected, and the user cannot unselect the selected item by clicking on it. |
QAbstractItemView::ContiguousSelection | 4 | When the user selects an item in the usual way, the selection is cleared and the new item selected. However, if the user presses the Shift key while clicking on an item, all items between the current item and the clicked item are selected or unselected, depending on the state of the clicked item. |
QAbstractItemView::ExtendedSelection | 3 | When the user selects an item in the usual way, the selection is cleared and the new item selected. However, if the user presses the Ctrl key when clicking on an item, the clicked item gets toggled and all other items are left untouched. If the user presses the Shift key while clicking on an item, all items between the current item and the clicked item are selected or unselected, depending on the state of the clicked item. Multiple items can be selected by dragging the mouse over them. |
QAbstractItemView::MultiSelection | 2 | When the user selects an item in the usual way, the selection status of that item is toggled and the other items are left alone. Multiple items can be toggled by dragging the mouse over them. |
QAbstractItemView::NoSelection | 0 | Items cannot be selected. |
The most commonly used modes are SingleSelection and ExtendedSelection.
Describes the different states the view can be in. This is usually only interesting when reimplementing your own view.
| Constant | Value | Description |
|---|---|---|
QAbstractItemView::NoState | 0 | The is the default state. |
QAbstractItemView::DraggingState | 1 | The user is dragging items. |
QAbstractItemView::DragSelectingState | 2 | The user is selecting items. |
QAbstractItemView::EditingState | 3 | The user is editing an item in a widget editor. |
QAbstractItemView::ExpandingState | 4 | The user is opening a branch of items. |
QAbstractItemView::CollapsingState | 5 | The user is closing a branch of items. |
QAbstractItemView::AnimatingState | 6 | The item view is performing an animation. |
This property holds whether to draw the background using alternating colors.
If this property is true, the item background will be drawn usingQPalette::Base andQPalette::AlternateBase; otherwise the background will be drawn using theQPalette::Base color.
By default, this property is false.
Access functions:
| bool | alternatingRowColors() const |
| void | setAlternatingRowColors(bool enable) |
This property holds whether autoscrolling in drag move events is enabled.
If this property is set to true (the default), theQAbstractItemView automatically scrolls the contents of the view if the user drags within 16 pixels of the viewport edge. If the current item changes, then the view will scroll automatically to ensure that the current item is fully visible.
This property only works if the viewport accepts drops. Autoscroll is switched off by setting this property to false.
Access functions:
| bool | hasAutoScroll() const |
| void | setAutoScroll(bool enable) |
This property holds the size of the area when auto scrolling is triggered.
This property controls the size of the area at the edge of the viewport that triggers autoscrolling. The default value is 16 pixels.
This property was introduced in Qt 4.4.
Access functions:
| int | autoScrollMargin() const |
| void | setAutoScrollMargin(int margin) |
This property holds the drop action that will be used by default in QAbstractItemView::drag().
If the property is not set, the drop action is CopyAction when the supported actions support CopyAction.
This property was introduced in Qt 4.6.
Access functions:
| Qt::DropAction | defaultDropAction() const |
| void | setDefaultDropAction(Qt::DropAction dropAction) |
See alsoshowDropIndicator anddragDropOverwriteMode.
This property holds the drag and drop event the view will act upon.
This property was introduced in Qt 4.2.
Access functions:
| DragDropMode | dragDropMode() const |
| void | setDragDropMode(DragDropMode behavior) |
See alsoshowDropIndicator anddragDropOverwriteMode.
This property holds the view's drag and drop behavior.
If its value istrue, the selected data will overwrite the existing item data when dropped, while moving the data will clear the item. If its value isfalse, the selected data will be inserted as a new item when the data is dropped. When the data is moved, the item is removed as well.
The default value isfalse, as in theQListView andQTreeView subclasses. In theQTableView subclass, on the other hand, the property has been set totrue.
Note: This is not intended to prevent overwriting of items. The model's implementation of flags() should do that by not returningQt::ItemIsDropEnabled.
This property was introduced in Qt 4.2.
Access functions:
| bool | dragDropOverwriteMode() const |
| void | setDragDropOverwriteMode(bool overwrite) |
See alsodragDropMode.
This property holds whether the view supports dragging of its own items.
Access functions:
| bool | dragEnabled() const |
| void | setDragEnabled(bool enable) |
See alsoshowDropIndicator,DragDropMode,dragDropOverwriteMode, andacceptDrops.
This property holds which actions will initiate item editing.
This property is a selection of flags defined byEditTrigger, combined using the OR operator. The view will only initiate the editing of an item if the action performed is set in this property.
Access functions:
| EditTriggers | editTriggers() const |
| void | setEditTriggers(EditTriggers triggers) |
This property holds how the view scrolls its contents in the horizontal direction.
This property controls how the view scroll its contents horizontally. Scrolling can be done either per pixel or per item.
This property was introduced in Qt 4.2.
Access functions:
| ScrollMode | horizontalScrollMode() const |
| void | setHorizontalScrollMode(ScrollMode mode) |
This property holds the size of items' icons.
Setting this property when the view is visible will cause the items to be laid out again.
Access functions:
| QSize | iconSize() const |
| void | setIconSize(const QSize & size) |
This property holds which selection behavior the view uses.
This property holds whether selections are done in terms of single items, rows or columns.
Access functions:
| QAbstractItemView::SelectionBehavior | selectionBehavior() const |
| void | setSelectionBehavior(QAbstractItemView::SelectionBehavior behavior) |
See alsoSelectionMode andSelectionBehavior.
This property holds which selection mode the view operates in.
This property controls whether the user can select one or many items and, in many-item selections, whether the selection must be a continuous range of items.
Access functions:
| QAbstractItemView::SelectionMode | selectionMode() const |
| void | setSelectionMode(QAbstractItemView::SelectionMode mode) |
See alsoSelectionMode andSelectionBehavior.
This property holds whether the drop indicator is shown when dragging items and dropping.
Access functions:
| bool | showDropIndicator() const |
| void | setDropIndicatorShown(bool enable) |
See alsodragEnabled,DragDropMode,dragDropOverwriteMode, andacceptDrops.
This property holds whether item navigation with tab and backtab is enabled.
Access functions:
| bool | tabKeyNavigation() const |
| void | setTabKeyNavigation(bool enable) |
This property holds the position of the "..." in elided text.
The default value for all item views isQt::ElideRight.
Access functions:
| Qt::TextElideMode | textElideMode() const |
| void | setTextElideMode(Qt::TextElideMode mode) |
This property holds how the view scrolls its contents in the vertical direction.
This property controls how the view scroll its contents vertically. Scrolling can be done either per pixel or per item.
This property was introduced in Qt 4.2.
Access functions:
| ScrollMode | verticalScrollMode() const |
| void | setVerticalScrollMode(ScrollMode mode) |
Constructs an abstract item view with the givenparent.
Destroys the view.
[signal]void QAbstractItemView::activated(constQModelIndex & index)This signal is emitted when the item specified byindex is activated by the user. How to activate items depends on the platform; e.g., by single- or double-clicking the item, or by pressing the Return or Enter key when the item is current.
See alsoclicked(),doubleClicked(),entered(), andpressed().
[slot]void QAbstractItemView::clearSelection()Deselects all selected items. The current index will not be changed.
See alsosetSelection() andselectAll().
[signal]void QAbstractItemView::clicked(constQModelIndex & index)This signal is emitted when a mouse button is clicked. The item the mouse was clicked on is specified byindex. The signal is only emitted when the index is valid.
See alsoactivated(),doubleClicked(),entered(), andpressed().
[virtual protected slot]void QAbstractItemView::closeEditor(QWidget * editor,QAbstractItemDelegate::EndEditHint hint)Closes the giveneditor, and releases it. Thehint is used to specify how the view should respond to the end of the editing operation. For example, the hint may indicate that the next item in the view should be opened for editing.
See alsoedit() andcommitData().
Closes the persistent editor for the item at the givenindex.
See alsoopenPersistentEditor().
[virtual protected slot]void QAbstractItemView::commitData(QWidget * editor)Commit the data in theeditor to the model.
See alsocloseEditor().
[virtual protected slot]void QAbstractItemView::currentChanged(constQModelIndex & current, constQModelIndex & previous)This slot is called when a new item becomes the current item. The previous current item is specified by theprevious index, and the new item by thecurrent index.
If you want to know about changes to items see thedataChanged() signal.
Returns the model index of the current item.
See alsosetCurrentIndex().
[virtual protected slot]void QAbstractItemView::dataChanged(constQModelIndex & topLeft, constQModelIndex & bottomRight)This slot is called when items are changed in the model. The changed items are those fromtopLeft tobottomRight inclusive. If just one item is changedtopLeft ==bottomRight.
[protected]QPoint QAbstractItemView::dirtyRegionOffset() constReturns the offset of the dirty regions in the view.
If you usescrollDirtyRegion() and implement apaintEvent() in a subclass ofQAbstractItemView, you should translate the area given by the paint event with the offset returned from this function.
See alsoscrollDirtyRegion() andsetDirtyRegion().
[signal]void QAbstractItemView::doubleClicked(constQModelIndex & index)This signal is emitted when a mouse button is double-clicked. The item the mouse was double-clicked on is specified byindex. The signal is only emitted when the index is valid.
See alsoclicked() andactivated().
[virtual protected]void QAbstractItemView::dragEnterEvent(QDragEnterEvent * event)Reimplemented fromQWidget::dragEnterEvent().
This function is called with the givenevent when a drag and drop operation enters the widget. If the drag is over a valid dropping place (e.g. over an item that accepts drops), the event is accepted; otherwise it is ignored.
See alsodropEvent() andstartDrag().
[virtual protected]void QAbstractItemView::dragLeaveEvent(QDragLeaveEvent * event)Reimplemented fromQWidget::dragLeaveEvent().
This function is called when the item being dragged leaves the view. Theevent describes the state of the drag and drop operation.
[virtual protected]void QAbstractItemView::dragMoveEvent(QDragMoveEvent * event)Reimplemented fromQWidget::dragMoveEvent().
This function is called continuously with the givenevent during a drag and drop operation over the widget. It can cause the view to scroll if, for example, the user drags a selection to view's right or bottom edge. In this case, the event will be accepted; otherwise it will be ignored.
See alsodropEvent() andstartDrag().
[virtual protected]void QAbstractItemView::dropEvent(QDropEvent * event)Reimplemented fromQWidget::dropEvent().
This function is called with the givenevent when a drop event occurs over the widget. If the model accepts the even position the drop event is accepted; otherwise it is ignored.
See alsostartDrag().
[protected]DropIndicatorPosition QAbstractItemView::dropIndicatorPosition() constReturns the position of the drop indicator in relation to the closest item.
This function was introduced in Qt 4.1.
[slot]void QAbstractItemView::edit(constQModelIndex & index)Starts editing the item corresponding to the givenindex if it is editable.
Note that this function does not change the current index. Since the current index defines the next and previous items to edit, users may find that keyboard navigation does not work as expected. To provide consistent navigation behavior, callsetCurrentIndex() before this function with the same model index.
See alsoQModelIndex::flags().
[virtual protected]bool QAbstractItemView::edit(constQModelIndex & index,EditTrigger trigger,QEvent * event)Starts editing the item atindex, creating an editor if necessary, and returns true if the view'sState is nowEditingState; otherwise returns false.
The action that caused the editing process is described bytrigger, and the associated event is specified byevent.
Editing can be forced by specifying thetrigger to beQAbstractItemView::AllEditTriggers.
See alsocloseEditor().
[virtual protected slot]void QAbstractItemView::editorDestroyed(QObject * editor)This function is called when the giveneditor has been destroyed.
See alsocloseEditor().
[signal]void QAbstractItemView::entered(constQModelIndex & index)This signal is emitted when the mouse cursor enters the item specified byindex. Mouse tracking needs to be enabled for this feature to work.
See alsoviewportEntered(),activated(),clicked(),doubleClicked(), andpressed().
[virtual protected]bool QAbstractItemView::event(QEvent * event)Reimplemented fromQObject::event().
[protected]void QAbstractItemView::executeDelayedItemsLayout()Executes the scheduled layouts without waiting for the event processing to begin.
See alsoscheduleDelayedItemsLayout().
[virtual protected]void QAbstractItemView::focusInEvent(QFocusEvent * event)Reimplemented fromQWidget::focusInEvent().
This function is called with the givenevent when the widget obtains the focus. By default, the event is ignored.
See alsosetFocus() andfocusOutEvent().
[virtual protected]bool QAbstractItemView::focusNextPrevChild(bool next)Reimplemented fromQWidget::focusNextPrevChild().
[virtual protected]void QAbstractItemView::focusOutEvent(QFocusEvent * event)Reimplemented fromQWidget::focusOutEvent().
This function is called with the givenevent when the widget looses the focus. By default, the event is ignored.
See alsoclearFocus() andfocusInEvent().
[pure virtual protected]int QAbstractItemView::horizontalOffset() constReturns the horizontal offset of the view.
In the base class this is a pure virtual function.
See alsoverticalOffset().
[pure virtual]QModelIndex QAbstractItemView::indexAt(constQPoint & point) constReturns the model index of the item at the viewport coordinatespoint.
In the base class this is a pure virtual function.
See alsovisualRect().
Returns the widget for the item at the givenindex.
This function was introduced in Qt 4.1.
See alsosetIndexWidget().
[virtual protected]void QAbstractItemView::inputMethodEvent(QInputMethodEvent * event)Reimplemented fromQWidget::inputMethodEvent().
[virtual]QVariant QAbstractItemView::inputMethodQuery(Qt::InputMethodQuery query) constReimplemented fromQWidget::inputMethodQuery().
[pure virtual protected]bool QAbstractItemView::isIndexHidden(constQModelIndex & index) constReturns true if the item referred to by the givenindex is hidden in the view, otherwise returns false.
Hiding is a view specific feature. For example in TableView a column can be marked as hidden or a row in the TreeView.
In the base class this is a pure virtual function.
Returns the item delegate used by this view and model. This is either one set withsetItemDelegate(), or the default one.
See alsosetItemDelegate().
Returns the item delegate used by this view and model for the givenindex.
Returns the item delegate used by this view and model for the givencolumn. You can callitemDelegate() to get a pointer to the current delegate for a given index.
This function was introduced in Qt 4.2.
See alsosetItemDelegateForColumn(),itemDelegateForRow(), anditemDelegate().
Returns the item delegate used by this view and model for the givenrow, or 0 if no delegate has been assigned. You can callitemDelegate() to get a pointer to the current delegate for a given index.
This function was introduced in Qt 4.2.
See alsosetItemDelegateForRow(),itemDelegateForColumn(), andsetItemDelegate().
[virtual protected]void QAbstractItemView::keyPressEvent(QKeyEvent * event)Reimplemented fromQWidget::keyPressEvent().
This function is called with the givenevent when a key event is sent to the widget. The default implementation handles basic cursor movement, e.g. Up, Down, Left, Right, Home, PageUp, and PageDown; theactivated() signal is emitted if the current index is valid and the activation key is pressed (e.g. Enter or Return, depending on the platform). This function is where editing is initiated by key press, e.g. if F2 is pressed.
See alsoedit(),moveCursor(),keyboardSearch(), andtabKeyNavigation.
[virtual]void QAbstractItemView::keyboardSearch(constQString & search)Moves to and selects the item best matching the stringsearch. If no item is found nothing happens.
In the default implementation, the search is reset ifsearch is empty, or the time interval since the last search has exceededQApplication::keyboardInputInterval().
Returns the model that this view is presenting.
See alsosetModel().
[virtual protected]void QAbstractItemView::mouseDoubleClickEvent(QMouseEvent * event)Reimplemented fromQWidget::mouseDoubleClickEvent().
This function is called with the givenevent when a mouse button is double clicked inside the widget. If the double-click is on a valid item it emits thedoubleClicked() signal and callsedit() on the item.
[virtual protected]void QAbstractItemView::mouseMoveEvent(QMouseEvent * event)Reimplemented fromQWidget::mouseMoveEvent().
This function is called with the givenevent when a mouse move event is sent to the widget. If a selection is in progress and new items are moved over the selection is extended; if a drag is in progress it is continued.
[virtual protected]void QAbstractItemView::mousePressEvent(QMouseEvent * event)Reimplemented fromQWidget::mousePressEvent().
This function is called with the givenevent when a mouse button is pressed while the cursor is inside the widget. If a valid item is pressed on it is made into the current item. This function emits thepressed() signal.
[virtual protected]void QAbstractItemView::mouseReleaseEvent(QMouseEvent * event)Reimplemented fromQWidget::mouseReleaseEvent().
This function is called with the givenevent when a mouse button is released, after a mouse press event on the widget. If a user presses the mouse inside your widget and then drags the mouse to another location before releasing the mouse button, your widget receives the release event. The function will emit theclicked() signal if an item was being pressed.
[pure virtual protected]QModelIndex QAbstractItemView::moveCursor(CursorAction cursorAction,Qt::KeyboardModifiers modifiers)Returns aQModelIndex object pointing to the next object in the view, based on the givencursorAction and keyboard modifiers specified bymodifiers.
In the base class this is a pure virtual function.
Opens a persistent editor on the item at the givenindex. If no editor exists, the delegate will create a new editor.
See alsoclosePersistentEditor().
[signal]void QAbstractItemView::pressed(constQModelIndex & index)This signal is emitted when a mouse button is pressed. The item the mouse was pressed on is specified byindex. The signal is only emitted when the index is valid.
Use theQApplication::mouseButtons() function to get the state of the mouse buttons.
See alsoactivated(),clicked(),doubleClicked(), andentered().
[virtual slot]void QAbstractItemView::reset()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.
[virtual protected]void QAbstractItemView::resizeEvent(QResizeEvent * event)Reimplemented fromQWidget::resizeEvent().
This function is called with the givenevent when a resize event is sent to the widget.
See alsoQWidget::resizeEvent().
Returns the model index of the model's root item. The root item is the parent item to the view's toplevel items. The root can be invalid.
See alsosetRootIndex().
[virtual protected slot]void QAbstractItemView::rowsAboutToBeRemoved(constQModelIndex & parent,int start,int end)This slot is called when rows are about to be removed. The deleted rows are those under the givenparent fromstart toend inclusive.
See alsorowsInserted().
[virtual protected slot]void QAbstractItemView::rowsInserted(constQModelIndex & parent,int start,int end)This slot is called when rows are inserted. The new rows are those under the givenparent fromstart toend inclusive. The base class implementation calls fetchMore() on the model to check for more data.
See alsorowsAboutToBeRemoved().
[protected]void QAbstractItemView::scheduleDelayedItemsLayout()Schedules a layout of the items in the view to be executed when the event processing starts.
Even if scheduleDelayedItemsLayout() is called multiple times before events are processed, the view will only do the layout once.
See alsoexecuteDelayedItemsLayout().
[protected]void QAbstractItemView::scrollDirtyRegion(int dx,int dy)Prepares the view for scrolling by (dx,dy) pixels by moving the dirty regions in the opposite direction. You only need to call this function if you are implementing a scrolling viewport in your view subclass.
If you implementscrollContentsBy() in a subclass ofQAbstractItemView, call this function before you callQWidget::scroll() on the viewport. Alternatively, just callupdate().
See alsoscrollContentsBy(),dirtyRegionOffset(), andsetDirtyRegion().
[pure virtual]void QAbstractItemView::scrollTo(constQModelIndex & index,ScrollHint hint = EnsureVisible)Scrolls the view if necessary to ensure that the item atindex is visible. The view will try to position the item according to the givenhint.
In the base class this is a pure virtual function.
[slot]void QAbstractItemView::scrollToBottom()Scrolls the view to the bottom.
This function was introduced in Qt 4.1.
See alsoscrollTo() andscrollToTop().
[slot]void QAbstractItemView::scrollToTop()Scrolls the view to the top.
This function was introduced in Qt 4.1.
See alsoscrollTo() andscrollToBottom().
[virtual slot]void QAbstractItemView::selectAll()Selects all items in the view. This function will use the selection behavior set on the view when selecting.
See alsosetSelection(),selectedIndexes(), andclearSelection().
[virtual protected]QModelIndexList QAbstractItemView::selectedIndexes() constThis convenience function returns a list of all selected and non-hidden item indexes in the view. The list contains no duplicates, and is not sorted.
See alsoQItemSelectionModel::selectedIndexes().
[virtual protected slot]void QAbstractItemView::selectionChanged(constQItemSelection & selected, constQItemSelection & deselected)This slot is called when the selection is changed. The previous selection (which may be empty), is specified bydeselected, and the new selection byselected.
See alsosetSelection().
[virtual protected]QItemSelectionModel::SelectionFlags QAbstractItemView::selectionCommand(constQModelIndex & index, constQEvent * event = 0) constReturns the SelectionFlags to be used when updating a selection with to include theindex specified. Theevent is a user input event, such as a mouse or keyboard event.
Reimplement this function to define your own selection behavior.
See alsosetSelection().
Returns the current selection model.
See alsosetSelectionModel() andselectedIndexes().
[slot]void QAbstractItemView::setCurrentIndex(constQModelIndex & index)Sets the current item to be the item atindex.
Unless the current selection mode isNoSelection, the item is also be selected. Note that this function also updates the starting position for any new selections the user performs.
To set an item as the current item without selecting it, call
selectionModel()->setCurrentIndex(index, QItemSelectionModel::NoUpdate);
See alsocurrentIndex(),currentChanged(), andselectionMode.
[protected]void QAbstractItemView::setDirtyRegion(constQRegion & region)Marks the givenregion as dirty and schedules it to be updated. You only need to call this function if you are implementing your own view subclass.
This function was introduced in Qt 4.1.
See alsoscrollDirtyRegion() anddirtyRegionOffset().
Sets the givenwidget on the item at the givenindex, passing the ownership of the widget to the viewport.
Ifindex is invalid (e.g., if you pass the root index), this function will do nothing.
The givenwidget'sautoFillBackground property must be set to true, otherwise the widget's background will be transparent, showing both the model data and the item at the givenindex.
If index widget A is replaced with index widget B, index widget A will be deleted. For example, in the code snippet below, theQLineEdit object will be deleted.
This function should only be used to display static content within the visible area corresponding to an item of data. If you want to display custom dynamic content or implement a custom editor widget, subclassQItemDelegate instead.
This function was introduced in Qt 4.1.
See alsoindexWidget() andDelegate Classes.
Sets the item delegate for this view and its model todelegate. This is useful if you want complete control over the editing and display of items.
Any existing delegate will be removed, but not deleted.QAbstractItemView does not take ownership ofdelegate.
Warning: You should not share the same instance of a delegate between views. Doing so can cause incorrect or unintuitive editing behavior since each view connected to a given delegate may receive thecloseEditor() signal, and attempt to access, modify or close an editor that has already been closed.
See alsoitemDelegate().
Sets the given itemdelegate used by this view and model for the givencolumn. All items oncolumn will be drawn and managed bydelegate instead of using the default delegate (i.e.,itemDelegate()).
Any existing column delegate forcolumn will be removed, but not deleted.QAbstractItemView does not take ownership ofdelegate.
Note:If a delegate has been assigned to both a row and a column, the row delegate will take precedence and manage the intersecting cell index.
Warning: You should not share the same instance of a delegate between views. Doing so can cause incorrect or unintuitive editing behavior since each view connected to a given delegate may receive thecloseEditor() signal, and attempt to access, modify or close an editor that has already been closed.
This function was introduced in Qt 4.2.
See alsoitemDelegateForColumn(),setItemDelegateForRow(), anditemDelegate().
Sets the given itemdelegate used by this view and model for the givenrow. All items onrow will be drawn and managed bydelegate instead of using the default delegate (i.e.,itemDelegate()).
Any existing row delegate forrow will be removed, but not deleted.QAbstractItemView does not take ownership ofdelegate.
Note:If a delegate has been assigned to both a row and a column, the row delegate (i.e., this delegate) will take precedence and manage the intersecting cell index.
Warning: You should not share the same instance of a delegate between views. Doing so can cause incorrect or unintuitive editing behavior since each view connected to a given delegate may receive thecloseEditor() signal, and attempt to access, modify or close an editor that has already been closed.
This function was introduced in Qt 4.2.
See alsoitemDelegateForRow(),setItemDelegateForColumn(), anditemDelegate().
[virtual]void QAbstractItemView::setModel(QAbstractItemModel * model)Sets themodel for the view to present.
This function will create and set a new selection model, replacing any model that was previously set withsetSelectionModel(). However, the old selection model will not be deleted as it may be shared between several views. We recommend that you delete the old selection model if it is no longer required. This is done with the following code:
QItemSelectionModel*m= view->selectionModel();view->setModel(new model);delete m;
If both the old model and the old selection model do not have parents, or if their parents are long-lived objects, it may be preferable to call theirdeleteLater() functions to explicitly delete them.
The viewdoes not take ownership of the model unless it is the model's parent object because the model may be shared between many different views.
See alsomodel(),selectionModel(), andsetSelectionModel().
[virtual slot]void QAbstractItemView::setRootIndex(constQModelIndex & index)Sets the root item to the item at the givenindex.
See alsorootIndex().
[pure virtual protected]void QAbstractItemView::setSelection(constQRect & rect,QItemSelectionModel::SelectionFlags flags)Applies the selectionflags to the items in or touched by the rectangle,rect.
When implementing your own itemview setSelection should callselectionModel()->select(selection, flags) where selection is either an emptyQModelIndex or aQItemSelection that contains all items that are contained inrect.
See alsoselectionCommand() andselectedIndexes().
[virtual]void QAbstractItemView::setSelectionModel(QItemSelectionModel * selectionModel)Sets the current selection model to the givenselectionModel.
Note that, if you callsetModel() after this function, the givenselectionModel will be replaced by one created by the view.
Note:It is up to the application to delete the old selection model if it is no longer needed; i.e., if it is not being used by other views. This will happen automatically when its parent object is deleted. However, if it does not have a parent, or if the parent is a long-lived object, it may be preferable to call itsdeleteLater() function to explicitly delete it.
See alsoselectionModel(),setModel(), andclearSelection().
[protected]void QAbstractItemView::setState(State state)Sets the item view's state to the givenstate.
See alsostate().
[virtual]int QAbstractItemView::sizeHintForColumn(int column) constReturns the width size hint for the specifiedcolumn or -1 if there is no model.
This function is used in views with a horizontal header to find the size hint for a header section based on the contents of the givencolumn.
See alsosizeHintForRow().
Returns the size hint for the item with the specifiedindex or an invalid size for invalid indexes.
See alsosizeHintForRow() andsizeHintForColumn().
[virtual]int QAbstractItemView::sizeHintForRow(int row) constReturns the height size hint for the specifiedrow or -1 if there is no model.
The returned height is calculated using the size hints of the givenrow's items, i.e. the returned value is the maximum height among the items. Note that to control the height of a row, you must reimplement theQAbstractItemDelegate::sizeHint() function.
This function is used in views with a vertical header to find the size hint for a header section based on the contents of the givenrow.
See alsosizeHintForColumn().
[virtual protected]void QAbstractItemView::startDrag(Qt::DropActions supportedActions)Starts a drag by calling drag->exec() using the givensupportedActions.
[protected]State QAbstractItemView::state() constReturns the item view's state.
See alsosetState().
[virtual protected]void QAbstractItemView::timerEvent(QTimerEvent * event)Reimplemented fromQObject::timerEvent().
This function is called with the givenevent when a timer event is sent to the widget.
See alsoQObject::timerEvent().
[slot]void QAbstractItemView::update(constQModelIndex & index)Updates the area occupied by the givenindex.
This function was introduced in Qt 4.3.
[virtual protected slot]void QAbstractItemView::updateGeometries()Updates the geometry of the child widgets of the view.
This function was introduced in Qt 4.4.
[pure virtual protected]int QAbstractItemView::verticalOffset() constReturns the vertical offset of the view.
In the base class this is a pure virtual function.
See alsohorizontalOffset().
[virtual protected]QStyleOptionViewItem QAbstractItemView::viewOptions() constReturns aQStyleOptionViewItem structure populated with the view's palette, font, state, alignments etc.
[signal]void QAbstractItemView::viewportEntered()This signal is emitted when the mouse cursor enters the viewport. Mouse tracking needs to be enabled for this feature to work.
See alsoentered().
[virtual protected]bool QAbstractItemView::viewportEvent(QEvent * event)Reimplemented fromQAbstractScrollArea::viewportEvent().
This function is used to handle tool tips, and What's This? mode, if the givenevent is aQEvent::ToolTip,or aQEvent::WhatsThis. It passes all other events on to its base class viewportEvent() handler.
[pure virtual]QRect QAbstractItemView::visualRect(constQModelIndex & index) constReturns the rectangle on the viewport occupied by the item atindex.
If your item is displayed in several areas then visualRect should return the primary area that contains index and not the complete area that index might encompasses, touch or cause drawing.
In the base class this is a pure virtual function.
See alsoindexAt() andvisualRegionForSelection().
[pure virtual protected]QRegion QAbstractItemView::visualRegionForSelection(constQItemSelection & selection) constReturns the region from the viewport of the items in the givenselection.
In the base class this is a pure virtual function.
See alsovisualRect() andselectedIndexes().
© 2016 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of theGNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.