Класс QScrollArea

Класс QScrollArea предоставляет прокручиваемый вид на другой виджет. Подробнее...

• Список всех членов, включая унаследованные

Свойства

• alignment : Qt::Alignment
• widgetResizable : bool

• 3 свойства унаследованы от QAbstractScrollArea
• 6 свойств унаследованы от QFrame
• 58 свойств унаследованы от QWidget
• 1 свойство унаследовано от QObject

Открытые функции

Переопределённые открытые функции

• 20 открытых функций унаследованы от QAbstractScrollArea
• 14 открытых функций унаследованы от QFrame
• 211 открытых функций унаследованы от QWidget
• 31 открытых функций унаследованы от QObject
• 14 открытых функций унаследованы от QPaintDevice

Переопределённые защищённые функции

• 20 защищённых функций унаследованы от QAbstractScrollArea
• 4 защищённых функций унаследованы от QFrame
• 35 защищённых функций унаследованы от QWidget
• 9 защищённых функций унаследованы от QObject
• 1 защищённая функция унаследована от QPaintDevice

Дополнительные унаследованные члены

• 19 открытых слотов унаследованы от QWidget
• 1 открытый слот унаследован от QObject
• 3 сигнала унаследованы от QWidget
• 2 сигнала унаследованы от QObject
• 5 статических открытых членов унаследованы от QWidget
• 11 статических открытых членов унаследованы от QObject
• 20 защищённых функций унаследованы от QAbstractScrollArea
• 4 защищённых функций унаследованы от QFrame
• 35 защищённых функций унаследованы от QWidget
• 9 защищённых функций унаследованы от QObject
• 1 защищённая функция унаследована от QPaintDevice
• 1 защищённый слот унаследован от QWidget

Подробное описание

Класс QScrollArea предоставляет прокручиваемый вид на другой виджет.

Область прокрутки используется для отображения содержимого дочернего виджета внутри рамки. Если виджет превышает размер рамки, просмотр может обеспечить полосы прокрутки, чтобы можно было увидеть всю область дочернего виджета. Дочерний виджет должен быть указан с помощью setWidget(). Например:

QLabel *imageLabel = new QLabel;
QImage image("happyguy.png");
imageLabel->setPixmap(QPixmap::fromImage(image));

scrollArea = new QScrollArea;
scrollArea->setBackgroundRole(QPalette::Dark);
scrollArea->setWidget(imageLabel);

Вышеприведённый код создаёт область прокрутки (отображаемую на изображениях ниже), содержащую метку изображения. При масштабировании изображения область прокрутки может обеспечить необходимые полосы прокрутки:

Внешний вид полос прокрутки зависит от текущих настроек политики полос прокрутки. Вы можете контролировать внешний вид полос прокрутки, используя унаследованные функции от QAbstractScrollArea.

Например, вы можете установить свойства QAbstractScrollArea::horizontalScrollBarPolicy и QAbstractScrollArea::verticalScrollBarPolicy. Или, если вы хотите, чтобы полосы прокрутки динамически подстраивались при изменении содержимого области прокрутки, вы можете использовать функции horizontalScrollBar() и verticalScrollBar() (которые позволяют получить доступ к полосам прокрутки) и устанавливать значения полос прокрутки всякий раз, когда содержимое области прокрутки изменяется, используя функцию QScrollBar::setValue().

Вы можете получить дочерний виджет, используя функцию widget(). Просмотр можно сделать масштабируемым с помощью функции setWidgetResizable(). Выравнивание виджета можно задать с помощью setAlignment().

Две вспомогательные функции ensureVisible() и ensureWidgetVisible() гарантируют, что определённый участок содержимого виден внутри области просмотра, прокручивая содержимое при необходимости.

Подсказки по размеру и макеты

При использовании области прокрутки для отображения содержимого пользовательского виджета важно убедиться, что подсказка о размере дочернего виджета установлена в подходящее значение. Если используется стандартный виджет QWidget для дочернего виджета, может потребоваться вызвать QWidget::setMinimumSize(), чтобы убедиться, что содержимое виджета отображается корректно в области прокрутки.

Если область прокрутки используется для отображения содержимого виджета, содержащего дочерние виджеты, организованные в макете, важно помнить, что политика размера макета также будет определять размер виджета. Это особенно полезно знать, если вы планируете динамически изменять содержимое макета. В таких случаях установка свойства ограничения размера макета на значение, которое обеспечивает ограничения минимального и/или максимального размера макета (например, QLayout::SetMinAndMaxSize), вызовет обновление размера области прокрутки всякий раз, когда изменяется содержимое макета.

Полный пример использования класса QScrollArea см. в примере Image Viewer. Пример демонстрирует, как комбинировать QLabel и QScrollArea для отображения изображения.

См. также QAbstractScrollArea, QScrollBar и Пример Image Viewer.

Документация по функциям-членам

QScrollArea::QScrollArea(QWidget *parent = Q_NULLPTR)

Конструирует пустую область прокрутки с заданным parent.

См. также setWidget().

QScrollArea::~QScrollArea()

Удаляет область прокрутки и ее дочерний виджет.

См. также setWidget().

void QScrollArea::ensureVisible(int x, int y, int xmargin = 50, int ymargin = 50)

Прокручивает содержимое области прокрутки так, чтобы точка (x, y) была видна в области просмотра с отступами, заданными в пикселях xmargin и ymargin. Если указанную точку нельзя достигнуть, содержимое прокручивается до ближайшей допустимой позиции. Значение по умолчанию для обоих отступов составляет 50 пикселей.

void QScrollArea::ensureWidgetVisible(QWidget *childWidget, int xmargin = 50, int ymargin = 50)

Прокручивает содержимое области прокрутки так, чтобы childWidget из QScrollArea::widget() был виден в области просмотра с отступами, заданными в пикселях xmargin и ymargin. Если указанную точку нельзя достигнуть, содержимое прокручивается до ближайшей допустимой позиции. Значение по умолчанию для обоих отступов составляет 50 пикселей.

Эта функция была добавлена в Qt 4.2.

[virtual protected] bool QScrollArea::event(QEvent *e)

Переопределено из QObject::event().

[virtual protected] bool QScrollArea::eventFilter(QObject *o, QEvent *e)

Переопределено из QObject::eventFilter().

[virtual] bool QScrollArea::focusNextPrevChild(bool next)

Переопределено из QWidget::focusNextPrevChild().

[virtual protected] void QScrollArea::resizeEvent(QResizeEvent *)

Переопределено из QWidget::resizeEvent().

[virtual protected] void QScrollArea::scrollContentsBy(int dx, int dy)

Переопределено из QAbstractScrollArea::scrollContentsBy().

void QScrollArea::setWidget(QWidget *widget)

Устанавливает widget области прокрутки.

widget становится дочерним элементом области прокрутки и будет удален при удалении области прокрутки или установке нового виджета.

Свойство autoFillBackground виджета будет установлено в true.

Если область прокрутки видна при добавлении widget, её необходимо явно отобразить с помощью show().

Обратите внимание: необходимо добавить макет widget перед вызовом этой функции; если вы добавите его позже, widget не будет виден — независимо от того, когда вы show() область прокрутки. В этом случае вы также не сможете show() widget позже.

См. также widget().

[virtual] QSize QScrollArea::sizeHint() const

Переопределено из QWidget::sizeHint().

QWidget *QScrollArea::takeWidget()

Удаляет виджет области прокрутки и передает владение им вызывающей стороне.

См. также widget().

[virtual protected] QSize QScrollArea::viewportSizeHint() const

Переопределено из QAbstractScrollArea::viewportSizeHint().

QWidget *QScrollArea::widget() const

Возвращает виджет области прокрутки или 0, если его нет.

См. также setWidget().