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 に移動したり、現在のドック領域内の別の場所に移動したときに発行されます。これは、ドックウィジェットがプログラムによって移動されたり、ユーザーによって新しい場所にドラッグされたときに発生します。

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

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::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()も参照してください 。