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

option を、QDockWidget の値を用いて初期化します。このメソッドは、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 へ伝播され、親ウィジェットが通常の方法で処理を行います。具体的には、タイトルバーがドラッグされた際の移動、ダブルクリック時のドッキングおよびドッキング解除などです。
• QDockWidget に対してDockWidgetVerticalTitleBar が設定されると、タイトルバーウィジェットはそれに応じて再配置されます。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

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

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