QDockWidget Class

Fonction membre Documentation

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

Construit un QDockWidget avec le parent parent et les drapeaux de fenêtre flags. Le widget dock sera placé dans la zone gauche du widget dock.

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

Construit un QDockWidget avec le parent parent et les drapeaux de fenêtre flags. Le widget d'ancrage sera placé dans la zone gauche du widget d'ancrage.

Le titre de la fenêtre est défini sur title. Ce titre est utilisé lorsque le QDockWidget est ancré et désancré. Il est également utilisé dans le menu contextuel fourni par QMainWindow.

Voir également setWindowTitle().

[virtual noexcept] QDockWidget::~QDockWidget()

Détruit le widget du dock.

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

Ce signal est émis lorsque la propriété allowedAreas est modifiée. Le paramètre allowedAreas indique la nouvelle valeur de la propriété.

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

Réimplémente : QWidget::changeEvent(QEvent *event).

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

Réimplémente : QWidget::closeEvent(QCloseEvent *event).

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

Ce signal est émis lorsque le widget de dock est déplacé vers un autre dock area, ou est déplacé vers un emplacement différent dans sa zone de dock actuelle. Cela se produit lorsque le widget dock est déplacé par programme ou lorsque l'utilisateur le fait glisser vers un nouvel emplacement.

Voir également dockLocation() et setDockLocation().

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

Réimplémente : QWidget::event(QEvent *event).

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

Ce signal est émis lorsque la propriété features est modifiée. Le paramètre features indique la nouvelle valeur de la propriété.

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

Initialiser option avec les valeurs de QDockWidget. Cette méthode est utile pour les sous-classes qui ont besoin d'un QStyleOptionDockWidget, mais qui ne veulent pas remplir toutes les informations elles-mêmes.

Voir aussi QStyleOption::initFrom().

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

Renvoie true si ce widget dock peut être placé dans l'emplacement donné area; sinon, renvoie false.

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

Réimplémente : QWidget::paintEvent(QPaintEvent *event).

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

Affecte ce widget d'ancrage à area. S'il est ancré à un autre emplacement d'ancrage, il se déplacera à area. S'il est flottant ou fait partie d'onglets flottants, le prochain appel de setFloating(false) l'ancrera à area.

Cette fonction a été introduite dans Qt 6.9.

Voir aussi dockLocation() et dockLocationChanged().

void QDockWidget::setTitleBarWidget(QWidget *widget)

Définit une adresse arbitraire widget comme barre de titre du widget dock. Si widget est nullptr, tout widget de barre de titre personnalisé précédemment défini sur le widget dock est supprimé, mais pas effacé, et la barre de titre par défaut sera utilisée à la place.

Si un widget de barre de titre est défini, QDockWidget n'utilisera pas les décorations natives de la fenêtre lorsqu'elle est flottante.

Voici quelques conseils pour la mise en œuvre de barres de titre personnalisées :

• Les événements de souris qui ne sont pas explicitement gérés par le widget de barre de titre doivent être ignorés en appelant QMouseEvent::ignore(). Ces événements se propagent ensuite au parent QDockWidget, qui les gère de la manière habituelle : déplacement lorsque la barre de titre est tirée, ancrage et désancrage lorsqu'elle est double-cliquée, etc.
• Lorsque DockWidgetVerticalTitleBar est placé sur QDockWidget, le widget de la barre de titre est repositionné en conséquence. Dans resizeEvent(), la barre de titre doit vérifier l'orientation qu'elle doit prendre :

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

• Le widget de la barre de titre doit avoir une fonction valide QWidget::sizeHint() et QWidget::minimumSizeHint(). Ces fonctions doivent tenir compte de l'orientation actuelle de la barre de titre.
• Il n'est pas possible de supprimer une barre de titre d'un widget dock. Toutefois, il est possible d'obtenir un effet similaire en définissant une construction par défaut QWidget comme widget de barre de titre.

En utilisant qobject_cast() comme indiqué ci-dessus, le widget de la barre de titre a un accès complet à son parent QDockWidget. Il peut donc effectuer des opérations telles que l'ancrage et le masquage en réponse aux actions de l'utilisateur.

Voir également titleBarWidget() et DockWidgetVerticalTitleBar.

void QDockWidget::setWidget(QWidget *widget)

Définit le widget pour le widget dock à widget.

Si le widget de la station d'accueil est visible lorsque widget est ajouté, vous devez show() l'ajouter explicitement.

Notez que vous devez ajouter la disposition de widget avant d'appeler cette fonction, sinon widget ne sera pas visible.

Voir également widget().

QWidget *QDockWidget::titleBarWidget() const

Renvoie le widget de barre de titre personnalisé défini sur le site QDockWidget, ou nullptr si aucune barre de titre personnalisée n'a été définie.

Voir aussi setTitleBarWidget().

QAction *QDockWidget::toggleViewAction() const

Renvoie une action vérifiable qui peut être ajoutée aux menus et aux barres d'outils afin que l'utilisateur puisse afficher ou fermer ce widget dock.

Le texte de l'action est défini comme le titre de la fenêtre du widget dock.

L'objet QAction appartient à l'objet QDockWidget et sera automatiquement supprimé lors de la destruction de l'objet QDockWidget.

Voir également QAction::text et QWidget::windowTitle.

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

Ce signal est émis lorsque la propriété floating est modifiée. Le paramètre topLevel est vrai si le widget dock est maintenant flottant, sinon il est faux.

Voir également isWindow().

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

Ce signal est émis lorsque le widget d'ancrage devient visible (ou invisible). Cela se produit lorsque le widget est caché ou affiché, ainsi que lorsqu'il est ancré dans une zone d'ancrage à onglets et que son onglet est sélectionné ou désélectionné.

QWidget *QDockWidget::widget() const

Renvoie le widget du widget dock. Cette fonction renvoie zéro si le widget n'a pas été défini.

Voir également setWidget().