Constructs a viewport. The parent argument is sent to the QWidget constructor.

Destroys the viewport.

Adds widget as a scroll bar widget in the location specified by alignment.

Scroll bar widgets are shown next to the horizontal or vertical scroll bar, and can be placed on either side of it. If you want the scroll bar widgets to be always visible, set the scrollBarPolicy for the corresponding scroll bar to AlwaysOn.

alignment must be one of Qt::Alignleft and Qt::AlignRight, which maps to the horizontal scroll bar, or Qt::AlignTop and Qt::AlignBottom, which maps to the vertical scroll bar.

A scroll bar widget can be removed by either re-parenting the widget or deleting it. It is also possible to hide a widget with QWidget::hide()

The scroll bar widget will be resized to fit the scroll bar geometry for the current style. The following describes the case for scroll bar widgets on the horizontal scroll bar:

The height of the widget will be set to match the height of the scroll bar. To control the width of the widget, use QWidget::setMinimumWidth and QWidget::setMaximumWidth, or implement QWidget::sizeHint() and set a horizontal size policy. If you want a square widget, call QStyle::pixelMetric(QStyle::PM_ScrollBarExtent) and set the width to this value.

See also

scrollBarWidgets()

This event handler can be reimplemented in a subclass to receive context menu events for the viewport() widget. The event is passed in event.

See also

QWidget::contextMenuEvent()

Reimplemented from QWidget::contextMenuEvent()

Reimplemented in QTextEdit::contextMenuEvent(), QPlainTextEdit::contextMenuEvent()

Returns the widget in the corner between the two scroll bars. By default, no corner widget is present.

See also

setCornerWidget()

This event handler can be reimplemented in a subclass to receive drag events for the viewport() widget. The event is passed in event.

See also

QWidget::dragEnterEvent()

Reimplemented from QWidget::dragEnterEvent()

Reimplemented in QTextEdit::dragEnterEvent(), QPlainTextEdit::dragEnterEvent()

This event handler can be reimplemented in a subclass to receive drag leave events for the viewport() widget. The event is passed in event.

See also

QWidget::dragLeaveEvent()

Reimplemented from QWidget::dragLeaveEvent()

Reimplemented in QTextEdit::dragLeaveEvent(), QPlainTextEdit::dragLeaveEvent()

This event handler can be reimplemented in a subclass to receive drag move events or the viewport() widget. The event is passed in event.

See also

QWidget::dragMoveEvent()

Reimplemented from QWidget::dragMoveEvent()

Reimplemented in QTextEdit::dragMoveEvent(), QPlainTextEdit::dragMoveEvent()

This event handler can be reimplemented in a subclass to receive drop events for the viewport() widget. The event is passed in event.

See also

QWidget::dropEvent()

Reimplemented from QWidget::dropEvent()

Reimplemented in QTextEdit::dropEvent(), QPlainTextEdit::dropEvent()

This is the main event handler for the QAbstractScrollArea widget, not the scrolling area viewport(). The specified event is a general event object that may need to be cast to the appropriate class depending on its type.

See also

QEvent::type()

Returns the horizontal scroll bar.

See also

setHorizontalScrollBar(), horizontalScrollBarPolicy, verticalScrollBar()

Returns the value of the property.

Called with key event when a key press occurs. Handles PageUp, PageDown, Up, Down, Left, and Right, and ignores all other key presses.

Reimplemented from QWidget::keyPressEvent()

Reimplemented in QTextEdit::keyPressEvent(), QPlainTextEdit::keyPressEvent(), QTextBrowser::keyPressEvent()

Returns the size of the viewport as if the scroll bars had no valid scrolling range.

Reimplemented from QWidget::minimumSizeHint()

Reimplemented in QMdiArea::minimumSizeHint()

This event handler can be reimplemented in a subclass to receive mouse double click events for the viewport() widget. The event is passed in event.

See also

QWidget::mouseDoubleClickEvent()

Reimplemented from QWidget::mouseDoubleClickEvent()

Reimplemented in QTextEdit::mouseDoubleClickEvent(), QPlainTextEdit::mouseDoubleClickEvent()

This event handler can be reimplemented in a subclass to receive mouse move events for the viewport() widget. The event is passed in event.

See also

QWidget::mouseMoveEvent()

Reimplemented from QWidget::mouseMoveEvent()

Reimplemented in QTextEdit::mouseMoveEvent(), QPlainTextEdit::mouseMoveEvent(), QTextBrowser::mouseMoveEvent()

This event handler can be reimplemented in a subclass to receive mouse press events for the viewport() widget. The event is passed in event.

See also

QWidget::mousePressEvent()

Reimplemented from QWidget::mousePressEvent()

Reimplemented in QTextEdit::mousePressEvent(), QPlainTextEdit::mousePressEvent(), QTextBrowser::mousePressEvent()

This event handler can be reimplemented in a subclass to receive mouse release events for the viewport() widget. The event is passed in event.

See also

QWidget::mouseReleaseEvent()

Reimplemented from QWidget::mouseReleaseEvent()

Reimplemented in QTextEdit::mouseReleaseEvent(), QPlainTextEdit::mouseReleaseEvent(), QTextBrowser::mouseReleaseEvent()

This event handler can be reimplemented in a subclass to receive paint events for the viewport() widget. The event is passed in event.

If you open a painter, make sure to open it on the viewport().

See also

QWidget::paintEvent()

Reimplemented from QWidget::paintEvent()

Reimplemented in QMdiArea::paintEvent(), QTextEdit::paintEvent(), QPlainTextEdit::paintEvent(), QTextBrowser::paintEvent()

This event handler can be reimplemented in a subclass to receive resize events for the viewport() widget. The event is passed in event.

When resizeEvent() is called, the viewport already has its new geometry: Its new size is accessible through the QResizeEvent::size() function, and the old size through QResizeEvent::oldSize().

See also

QWidget::resizeEvent()

Reimplemented from QWidget::resizeEvent()

Reimplemented in QMdiArea::resizeEvent(), QTextEdit::resizeEvent(), QPlainTextEdit::resizeEvent(), QScrollArea::resizeEvent()

Returns a list of the currently set scroll bar widgets. The alignment can be any combination of the four location flags.

See also

addScrollBarWidget()

This virtual handler is called when the scroll bars are moved by dx, dy, and consequently the viewport's contents should be scrolled accordingly.

The default implementation simply calls update() on the entire viewport(). Subclasses can reimplement this handler for optimization purposes, or as with QScrollArea to move a contents widget. The parameters dx and dy are there for convenience, so that the class knows how much should be scrolled. You may ignore these values and scroll directly to the position the scroll bars indicate.

Calling this method in order to scroll programmatically is an error, use the scroll bars instead (e.g. by calling QScrollBar::setValue() directly).

Reimplemented in QTextEdit::scrollContentsBy(), QPlainTextEdit::scrollContentsBy(), QGraphicsView::scrollContentsBy(), QHeaderView::scrollContentsBy(), QListView::scrollContentsBy(), QTreeView::scrollContentsBy(), QMdiArea::scrollContentsBy(), QTableView::scrollContentsBy(), QColumnView::scrollContentsBy(), QScrollArea::scrollContentsBy()

Sets the widget in the corner between the two scroll bars to be widget. You will probably also want to set at least one of the scroll bar modes to AlwaysOn. Passing nullptr shows no widget in the corner. Any previous corner widget will be hidden.

All widgets passed to this method will be deleted by the scroll area when it is destroyed, unless you separately reparent the widget after setting some other corner widget. Any new widgets should have no current parent.

By default no corner widget is present.

See also

cornerWidget(), horizontalScrollBarPolicy, horizontalScrollBarPolicy

Replaces the existing horizontal scroll bar with scrollBar, and sets all the former scroll bar's slider properties on the new scroll bar. The former scroll bar is then deleted.

QAbstractScrollArea already provides horizontal and vertical scroll bars by default. You can call this function to replace the default horizontal scroll bar with your own custom scroll bar.

See also

horizontalScrollBar(), setVerticalScrollBar()

Sets the value of the property to policy.

Sets the value of the property to policy.

This slot is called by QAbstractScrollArea after setViewport(viewport) has been called. Reimplement this function in a subclass of QAbstractScrollArea to initialize the new viewport before it is used.

See also

setViewport()

Replaces the existing vertical scroll bar with scrollBar, and sets all the former scroll bar's slider properties on the new scroll bar. The former scroll bar is then deleted.

QAbstractScrollArea already provides vertical and horizontal scroll bars by default. You can call this method to replace the default vertical scroll bar with your own custom scroll bar.

See also

verticalScrollBar(), setHorizontalScrollBar()

Sets the value of the property to policy.

Sets the viewport to be the given widget. The QAbstractScrollArea will take ownership of the given widget. If widget is a nullptr QAbstractScrollArea will assign a new QWidget instance for the viewport.

See also

viewport()

Sets margins around the scrolling area. This is useful for applications such as spreadsheets with "locked" rows and columns. The margin space is left blank to provide an area for widgets. By default all margins are zero.

Sets the margins around the scrolling area to left, top, right, and bottom. This is useful for applications such as spreadsheets with "locked" rows and columns. The margin space is left blank to provide an area for widgets. By default all margins are zero.

This method is called by QTreeView and QTableView and must be implemented in any class which inherits from QAbstractScrollArea.

Returns the value of the property.

Reimplemented from QWidget::sizeHint()

Reimplemented in QMdiArea::sizeHint(), QScrollArea::sizeHint()

Returns the vertical scroll bar.

See also

setVerticalScrollBar(), verticalScrollBarPolicy, horizontalScrollBar()

Returns the value of the property.

Returns the viewport widget. Use the QScrollArea::widget() method to retrieve the contents of the viewport widget.

See also

setViewport(), QScrollArea::widget()

The main event handler for the scrolling area the viewport() widget. It handles the event specified, and can be called by subclasses to provide reasonable default behavior. Returns true to indicate to the event system that the event has been handled, and needs no further processing, otherwise returns false to indicate that the event should be propagated further.

You can reimplement this method in a subclass, but we recommend using one of the specialized event handlers instead.

Specialized handlers for viewport events are: paintEvent(), mousePressEvent(), mouseReleaseEvent(), mouseDoubleClickEvent(), mouseMoveEvent(), wheelEvent(), dragEnterEvent(), dragMoveEvent(), dragLeaveEvent(), dropEvent(), contextMenuEvent(), and resizeEvent().

Reimplemented in QAbstractItemView::viewportEvent(), QGraphicsView::viewportEvent(), QHeaderView::viewportEvent(), QTreeView::viewportEvent(), QMdiArea::viewportEvent()

Returns the value of the property.

Returns the value of the property.

Reimplemented in QAbstractItemView::viewportSizeHint(), QListView::viewportSizeHint(), QTreeView::viewportSizeHint(), QTableView::viewportSizeHint(), QScrollArea::viewportSizeHint()

This event handler can be reimplemented in a subclass to receive wheel events for the viewport() widget. The event is passed in event.

See also

QWidget::wheelEvent()

Reimplemented from QWidget::wheelEvent()

Reimplemented in QTextEdit::wheelEvent(), QPlainTextEdit::wheelEvent()

This property holds the policy for the horizontal scroll bar. The default policy is Qt::ScrollBarAsNeeded.

See also

verticalScrollBarPolicy

This property holds the policy for the vertical scroll bar. The default policy is Qt::ScrollBarAsNeeded.

See also

horizontalScrollBarPolicy