Класс QDockWidget

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

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

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

Свойства

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

• 59 свойств унаследовано от QWidget
• 1 свойство унаследовано от QObject

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

• 214 публичных функций унаследовано от QWidget
• 34 публичных функций унаследовано от QObject
• 14 публичных функций унаследовано от QPaintDevice

Сигналы

• 3 сигнала унаследовано от QWidget
• 2 сигнала унаследовано от QObject

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

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

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

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

• 19 публичных слотов унаследовано от QWidget
• 1 публичный слот унаследовано от QObject
• 1 публичная переменная унаследовано от QObject
• 5 статических публичных членов унаследовано от QWidget
• 10 статических публичных членов унаследовано от QObject
• 1 защищённый слот унаследовано от QWidget
• 2 защищённых переменных унаследовано от QObject
• 1 защищённый тип унаследовано от QPaintDevice

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

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

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

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

Внешний вид

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

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

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

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

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

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

Тип DockWidgetFeatures является псевдонимом для QFlags<DockWidgetFeature>. Он хранит комбинацию значений DockWidgetFeature, полученную через операцию OR.

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

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

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

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

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

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

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

[virtual] QDockWidget::~QDockWidget()

Уничтожает виджет дока.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

[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().

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, или 0, если пользовательская панель заголовка не установлена.

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

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

QAction *QDockWidget::toggleViewAction() const

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

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

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

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

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

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

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

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

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

QWidget *QDockWidget::widget() const

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

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