Класс QDockWidget

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

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

Открытые типы

Свойства

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

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

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

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

Сигналы

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

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

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

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

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

• 19 открытых слотов унаследовано от QWidget
• 1 открытый слот унаследовано от QObject
• 5 статических открытых членов унаследовано от QWidget
• 11 статических открытых членов унаследовано от QObject
• 1 защищённый слот унаследовано от QWidget

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

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

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

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

Внешний вид

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

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

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

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

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

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

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

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

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

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

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

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

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

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

QDockWidget::~QDockWidget()

Удаляет виджет дока.

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

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

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

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

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

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

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

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

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

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

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

Переопределено из QObject::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.

[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 (или invisible). Это происходит при скрытии или отображении виджета, а также при прикреплении его к области док-окна с вкладками, когда его вкладка выбирается или отменяется.

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

QWidget *QDockWidget::widget() const

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

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