QDockWidget Class

メンバ関数ドキュメント

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

親parent とウィンドウフラグflags を持つ QDockWidget を構築します。ドックウィジェットは左のドックウィジェットエリアに配置されます。

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

親parent とウィンドウフラグflags を持つ QDockWidget を構築します。ドックウィジェットは左のドックウィジェットエリアに配置されます。

ウィンドウタイトルはtitle に設定されます。このタイトルはQDockWidgetがドックされた時とドック解除された時に使用されます。また、QMainWindow によって提供されるコンテキストメニューでも使用されます。

setWindowTitle()も参照してください 。

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

このシグナルは、ドックウィジェットが別のドックarea に移動したとき、または現在のドック領域内の別の場所に移動したときに発行されます。これは、ドックウィジェットがプログラムによって移動されるか、ユーザによって新しい場所にドラッグされたときに発生します。

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

このドックウィジェットが与えられたarea に配置できる場合はtrue を返し、そうでない場合はfalse を返します。

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

再実装：QWidget::paintEvent(QPaintEvent *event)。

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

このドックウィジェットをarea に割り当てます。 別のドック位置にドッキングされている場合、area に移動します。 フローティングまたはフローティングタブの一部である場合、次にsetFloating(false) を呼び出すと、area にドッキングされます。

この関数は Qt 6.9 で導入されました。

dockLocation() とdockLocationChanged()も参照してください 。

void QDockWidget::setTitleBarWidget(QWidget *widget)

任意のwidget をドックウィジェットのタイトルバーとして設定します。widget がnullptr の場合、以前にドックウィジェットに設定されたカスタムタイトルバーウィジェットは削除されますが、削除はされず、代わりにデフォルトタイトルバーが使用されます。

タイトルバーウィジェットが設定されている場合、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 に完全にアクセスできます。したがって、ユーザーの操作に応じて、ドッキングや非表示などの操作を実行できます。

titleBarWidget() およびDockWidgetVerticalTitleBarも参照して ください。

void QDockWidget::setWidget(QWidget *widget)

ドックウィジェットのウィジェットをwidget に設定します。

widget が追加されたときにドック・ウィジェットが表示されている場合は、show() を明示的に追加する必要があります。

この関数を呼び出す前に、widget のレイアウトを追加する必要があることに注意してください。そうしないと、widget は表示されません。

widget()も参照してください 。

QWidget *QDockWidget::titleBarWidget() const

QDockWidgetカスタム・タイトル・バーが設定されていない場合はnullptr を返します。

setTitleBarWidget()も参照してください 。

QAction *QDockWidget::toggleViewAction() const

ユーザーがこのドックウィジェットを表示したり閉じたりできるように、メニューやツールバーに追加できるチェック可能なアクションを返します。

アクションのテキストは、ドックウィジェットのウィンドウタイトルに設定されます。

QAction オブジェクトはQDockWidget によって所有されます。QDockWidget が破棄されると、自動的に削除されます。

QAction::text およびQWidget::windowTitleも参照して ください。

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

このシグナルは、floating プロパティが変更されたときに発行される。ドックウィジェットがフローティングになった場合、topLevel パラメータは true になり、そうでない場合は false になります。

isWindow()も参照してください 。

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

このシグナルは、ドックウィジェットがvisible (または不可視) になったときに発せられます。これは、ウィジェットが非表示または表示されたときと、タブドックエリアにドッキングされ、そのタブが選択または非選択になったときに発生します。

QWidget *QDockWidget::widget() const

ドックウィジェットのウィジェットを返します。ウィジェットが設定されていない場合、この関数はゼロを返します。

setWidget()も参照してください 。