Класс QDockWidget

Класс QDockWidget предоставляет виджет, который может быть прикреплён внутри QMainWindow или отображён как независимое окно на рабочем столе. Подробнее...

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

Типы публичного интерфейса

Свойства

• allowedAreas : Qt::DockWidgetAreas
• features : DockWidgetFeatures
• floating : bool
• windowTitle : QString

Публичные функции

Сигналы

Защищённые функции

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

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

QDockWidget предоставляет концепцию прикреплённых виджетов, также известных как панели инструментов или служебные окна. Окна прикрепления — это вспомогательные окна, расположенные в области прикрепления вокруг центрального виджета центрального виджета в QMainWindow.

Окна прикрепления могут перемещаться в рамках своей области, перемещаться в новые области и открепляться (например, отвязываться) пользователем. API QDockWidget позволяет программисту ограничить возможности перемещения, открепления и закрытия виджетов прикрепления, а также области, в которых они могут быть размещены.

Внешний вид

QDockWidget состоит из строки заголовка и области содержимого. Строка заголовка отображает заголовок окна виджета заголовок окна, кнопку «открепить» и кнопку «закрыть». В зависимости от состояния QDockWidget, кнопки «открепить» и «закрыть» могут быть либо отключены, либо вообще не отображаться.

Визуальный вид строки заголовка и кнопок зависит от используемого стиля стиля.

QDockWidget действует как оболочка для его дочернего виджета, установленного с помощью setWidget(). Собственные подсказки размера, минимальные и максимальные размеры и политики размера должны быть реализованы в дочернем виджете. QDockWidget будет учитывать их, изменяя свои собственные ограничения для включения рамки и строки заголовка. Ограничения размера не должны устанавливаться для самого QDockWidget, потому что они меняются в зависимости от того, прикреплен ли он; прикреплённый QDockWidget не имеет рамки и имеет более маленькую строку заголовка.

См. также QMainWindow и Пример виджетов прикрепления.

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

enum QDockWidget::DockWidgetFeatureflags QDockWidget::DockWidgetFeatures

Тип DockWidgetFeatures — это псевдоним для QFlags<DockWidgetFeature>. Он хранит результат логического ИЛИ комбинации значений DockWidgetFeature.

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

QDockWidget::QDockWidget(QWidget *parent = nullptr, Qt::WindowFlags flags = Qt::WindowFlags())

Создаёт плавающий виджет с родителем parent и флагами окна flags. Плавающий виджет будет размещён в левой области.

QDockWidget::QDockWidget(const QString &title, QWidget *parent = nullptr, Qt::WindowFlags flags = Qt::WindowFlags())

Создаёт плавающий виджет с родителем parent и флагами окна flags. Плавающий виджет будет размещён в левой области.

Заголовок окна устанавливается в title. Этот заголовок используется, когда плавающий виджет прикреплён и откреплён. Он также используется в контекстном меню, предоставляемом QMainWindow.

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

[signal] void QDockWidget::allowedAreasChanged(Qt::DockWidgetAreas allowedAreas)

Этот сигнал излучается при изменении свойства allowedAreas. Параметр allowedAreas содержит новое значение свойства.

Примечание: Сигнал уведомления для свойства allowedAreas.

[signal] void QDockWidget::dockLocationChanged(Qt::DockWidgetArea area)

Этот сигнал излучается, когда плавающий виджет перемещается в другую область расположения, или перемещается в другое место в текущей области расположения. Это происходит при программном перемещении плавающего виджета или при перетаскивании пользователем в новое место.

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

[signal] void QDockWidget::featuresChanged(QDockWidget::DockWidgetFeatures features)

Этот сигнал излучается при изменении свойства features. Параметр features содержит новое значение свойства.

Примечание: Сигнал уведомления для свойства features.

[signal] void QDockWidget::topLevelChanged(bool topLevel)

Этот сигнал излучается при изменении свойства floating. Параметр topLevel имеет значение true, если плавающий виджет теперь откреплён; в противном случае — false.

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

[signal] void QDockWidget::visibilityChanged(bool visible)

Этот сигнал излучается, когда плавающий виджет становится visible (или невидимым). Это происходит при скрытии или показе виджета, а также когда он прикреплён в области плавающего виджета с вкладками и его вкладка становится выбранной или невыбранной.

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

[virtual] QDockWidget::~QDockWidget()

Уничтожает плавающий виджет.

[override virtual protected] void QDockWidget::changeEvent(QEvent *event)

Переопределяет: QWidget::changeEvent(QEvent *event).

[override virtual protected] void QDockWidget::closeEvent(QCloseEvent *event)

Переопределяет: QWidget::closeEvent(QCloseEvent *event).

[override virtual protected] bool QDockWidget::event(QEvent *event)

Переопределяет: QWidget::event(QEvent *event).

[protected] void QDockWidget::initStyleOption(QStyleOptionDockWidget *option) const

Инициализирует option значениями из этого QDockWidget. Этот метод полезен для подклассов, когда им нужен QStyleOptionDockWidget, но они не хотят заполнять всю информацию самостоятельно.

См. также QStyleOption::initFrom().

bool QDockWidget::isAreaAllowed(Qt::DockWidgetArea area) const

Возвращает true если этот плавающий виджет может быть размещён в заданной области area; в противном случае возвращает false.

[override virtual protected] void QDockWidget::paintEvent(QPaintEvent *event)

Переопределяет: QWidget::paintEvent(QPaintEvent *event).

void QDockWidget::setTitleBarWidget(QWidget *widget)

Устанавливает произвольный widget в качестве панели заголовка плавающего виджета. Если widget равен 0, любой пользовательский виджет панели заголовка, ранее установленный на плавающий виджет, удаляется (но не удаляется), и вместо него используется стандартная панель заголовка.

Если установлено панель заголовка виджета, QDockWidget не будет использовать собственные декорации окна при его откреплении.

Вот несколько советов по реализации пользовательских панелей заголовка:

• События мыши, которые явно не обрабатываются виджетом панели заголовка, должны игнорироваться, вызывая QMouseEvent::ignore(). Эти события затем распространяются на родительский QDockWidget, который обрабатывает их стандартным образом, перемещая его при перетаскивании панели заголовка, прикрепляя и открепляя при двойном щелчке и т. д.
• Когда DockWidgetVerticalTitleBar задан для QDockWidget, виджет панели заголовка перепозиционируется соответствующим образом. В resizeEvent() виджет панели заголовка должен проверять, какую ориентацию ему следует принять:

  QDockWidget *dockWidget = qobject_cast<QDockWidget*>(parentWidget());
  if (dockWidget->features() & QDockWidget::DockWidgetVerticalTitleBar) {
      // I need to be vertical
  } else {
      // I need to be horizontal
  }

• Виджет панели заголовка должен иметь допустимые QWidget::sizeHint() и QWidget::minimumSizeHint(). Эти функции должны учитывать текущую ориентацию панели заголовка.
• Невозможно удалить панель заголовка из виджета привязки. Однако аналогичный эффект можно достичь, установив виджет QWidget по умолчанию в качестве виджета панели заголовка.

Используя qobject_cast(), как показано выше, виджет панели заголовка имеет полный доступ к своему родительскому QDockWidget. Следовательно, он может выполнять такие операции, как прикрепление и скрытие в ответ на действия пользователя.

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

См. также titleBarWidget() и DockWidgetVerticalTitleBar.

void QDockWidget::setWidget(QWidget *widget)

Устанавливает виджет для виджета привязки в widget.

Если виджет привязки виден, когда widget добавляется, необходимо явно вызвать show().

Обратите внимание, что вы должны добавить макет widget перед вызовом этой функции; в противном случае widget не будет виден.

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

QWidget *QDockWidget::titleBarWidget() const

Возвращает настраиваемый виджет панели заголовка, установленный на QDockWidget, или nullptr если настраиваемая панель заголовка не была установлена.

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

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

QAction *QDockWidget::toggleViewAction() const

Возвращает действие с флажком, которое можно использовать для отображения или закрытия этого виджета привязки.

Текст действия устанавливается в заголовок окна виджета привязки.

См. также QAction::text и QWidget::windowTitle.

QWidget *QDockWidget::widget() const

Возвращает виджет для виджета привязки. Эта функция возвращает ноль, если виджет не был установлен.

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