QDockWidget 类

成员函数文档

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

使用父窗口 parent 和窗口标志 flags 构建一个 QDockWidget。停靠小部件将被放置在左侧停靠小部件区域。

窗口标题设置为 title。当 QDockWidget 停靠和解除停靠时使用此标题。它还用于 QMainWindow 提供的上下文菜单中。

另请参阅setWindowTitle。

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

使用父窗口 parent 和窗口标志 flags 构建一个 QDockWidget。停靠小部件将被放置在左侧停靠小部件区域。

[virtual noexcept] QDockWidget::~QDockWidget()

销毁停靠小部件。

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

当停靠小部件被移动到另一个停靠 区域 或在当前停靠区域中的不同位置时，将发出此信号。这可能在停靠小部件被程序移动或由用户拖动到新位置时发生。

[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

如果此停靠小部件可以在给定的 区域 中放置，则返回 true；否则返回 false。

[覆盖虚保护] void QDockWidget::paintEvent(QPaintEvent *event)

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

void QDockWidget::setTitleBarWidget(QWidget *widget)

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

如果设置了标题栏 widget，当停靠窗口被浮动时，QDockWidget将不会使用本机窗口装饰。

下面是实现自定义标题栏的一些提示

• 未被标题栏 widget 显式处理的鼠标事件必须通过调用 QMouseEvent::ignore() 被忽略。这些事件随后传递到 QDockWidget 父窗口，并以常规方式处理，如当拖动标题栏时移动，双击时停靠或解除停靠等。
• 当在 QDockWidget 上设置 DockWidgetVerticalTitleBar 时，标题栏 widget 将相应地重新定位。在 resizeEvent() 中，标题栏应检查它应采用的什么方向

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

• 标题栏 widget 必须有有效的 QWidget::sizeHint() 和 QWidget::minimumSizeHint()。这些函数应考虑标题栏的当前方向。
• 无法从停靠窗口中移除标题栏。然而，可以通过设置默认构造的 QWidget 作为标题栏 widget 来实现类似的效果。

使用qobject_cast()，如上面所示，标题栏 widget 可以完全访问其父 QDockWidget。因此，它可以执行诸如在用户操作时进行停靠和隐藏等操作。

另请参阅titleBarWidget() 和 DockWidgetVerticalTitleBar.

void QDockWidget::setWidget(QWidget *widget)

将停靠窗口的 widget 设置为widget。

如果停靠窗口在使用widget时可见，您必须显式显示它。

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

另请参阅widget().

QWidget *QDockWidget::titleBarWidget() const

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

另请参阅setTitleBarWidget().

QAction *QDockWidget::toggleViewAction() const

返回一个可检查的操作，可以将它添加到菜单和工具栏中，以便用户显示或关闭此停靠窗口。

操作文本设置为停靠窗口的窗口标题。

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

[信号] void QDockWidget::topLevelChanged(bool topLevel)

当浮动属性变化时，会发出此信号。当停靠窗口现在为浮动时，topLevel 参数为 true；否则为 false。

另请参阅isWindow().

[信号] void QDockWidget::visibilityChanged(bool visible)

当停靠窗口变为可见（或不可见）时，会发出此信号。这发生在窗口被隐藏或显示时，以及当它作为标签停靠在标签停靠区中，并且其标签被选中或取消选中时。

QWidget *QDockWidget::widget() const

返回停靠窗口的窗口小部件。如果未设置窗口小部件，则此函数返回零。

另请参阅setWidget().