QDockWidget Class

成员函数 文档

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

构造一个 QDockWidget，其父级parent 和窗口标志flags 。停靠窗口小部件将放置在左侧停靠窗口小部件区域。

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

构造一个 QDockWidget，其父级parent 和窗口标志flags 。该停靠窗口小部件将被放置在左侧的停靠窗口小部件区域。

窗口标题被设置为title 。当 QDockWidget 被停靠或取消停靠时，该标题将被使用。它也会在QMainWindow 提供的上下文菜单中使用。

另请参阅 setWindowTitle() 。

[virtual noexcept] QDockWidget::~QDockWidget()

销毁 dock 部件。

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

当allowedAreas 属性发生变化时会发出该信号。allowedAreas 参数给出了属性的新值。

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

重实现：QWidget::changeEvent(QEvent *event).

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

重实现：QWidget::closeEvent(QCloseEvent *event).

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

当 dock 部件被移动到另一个 dockarea ，或者被移动到当前 dock 区域的不同位置时，就会发出这个信号。当用户以编程方式移动 dock 部件或将其拖动到新位置时，就会发生这种情况。

另请参阅 dockLocation() 和setDockLocation()。

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

重实现：QWidget::event(QEvent *event).

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

当features 属性发生变化时会发出该信号。features 参数给出了属性的新值。

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

使用此QDockWidget 中的值初始化option 。当子类需要QStyleOptionDockWidget ，但又不想自己填写所有信息时，该方法非常有用。

另请参阅 QStyleOption::initFrom()。

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

如果该 dock widget 可以放置在给定的area 中，则返回true ；否则返回false 。

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

重实现：QWidget::paintEvent(QPaintEvent *event).

[since 6.9] void QDockWidget::setDockLocation(Qt::DockWidgetArea area)

将此停靠 widget 指定到area 。如果停靠在其他停靠位置，它将移动到area 。如果是浮动或浮动标签的一部分，下一次调用setFloating(false) 将使它停靠在area 。

该函数在 Qt 6.9 中引入。

另请参阅 dockLocation() 和dockLocationChanged()。

void QDockWidget::setTitleBarWidget(QWidget *widget)

将任意widget 设置为 dock widget 的标题栏。如果widget 是nullptr ，之前在 dock widget 上设置的任何自定义标题栏 widget 都会被移除，但不会被删除，而将使用默认标题栏。

如果设置了标题栏部件，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() 函数。这些函数应考虑标题栏的当前方向。
• 从 dock widget 中移除标题栏是不可能的。不过，可以通过将默认构造的QWidget 设置为标题栏 widget 来达到类似的效果。

如上图所示，使用qobject_cast() 后，标题栏 widget 就可以完全访问其父QDockWidget 。因此，它可以根据用户操作执行停靠和隐藏等操作。

另请参阅 titleBarWidget() 和DockWidgetVerticalTitleBar 。

void QDockWidget::setWidget(QWidget *widget)

将 dock widget 设置为widget 。

如果在添加widget 时 dock 部件是可见的，则必须明确地show() 它。

请注意，必须在调用此函数前添加widget 的布局；否则，widget 将不可见。

另请参阅 widget() 。

QWidget *QDockWidget::titleBarWidget() const

返回在QDockWidget 上设置的自定义标题栏部件，如果没有设置自定义标题栏，则返回nullptr 。

另请参阅 setTitleBarWidget().

QAction *QDockWidget::toggleViewAction() const

返回一个可选中的操作，该操作可添加到菜单和工具栏中，以便用户显示或关闭该停靠窗口部件。

该操作的文本将设置为 dock 部件的窗口标题。

QAction 对象为QDockWidget 所有。当QDockWidget 被销毁时，该对象将被自动删除。

另请参阅 QAction::text 和QWidget::windowTitle 。

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

当floating 属性发生变化时会发出该信号。如果 dock 部件现在是浮动的，则topLevel 参数为 true；否则为 false。

另请参阅 isWindow().

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

当停靠 widget 变为visible （或不可见）时，就会发出该信号。当该 widget 被隐藏或显示时，以及当它停靠在标签式停靠区，其标签被选中或取消选中时，都会发生这种情况。

QWidget *QDockWidget::widget() const

返回 dock 部件的 widget。如果未设置 widget，则该函数返回 0。

另请参见 setWidget()。