Класс QDockWidget

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

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

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

Свойства

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

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

Сигналы

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

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

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

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

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

Внешний вид

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

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

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

См. также QMainWindow и Пример виджетов-доков.

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

перечисление QDockWidget::DockWidgetFeatureфлаги QDockWidget::DockWidgetFeatures

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

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

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

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

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

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

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

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

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

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

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

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

Этот сигнал генерируется, когда виджет плавающей панели перемещается в другую область привязки 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)

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

Эта функция была добавлена в 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().