QDockWidget Class

Documentation des fonctions membres

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

Crée un QDockWidget avec l’ parent comme parent et les indicateurs de fenêtre suivants : flags. Le widget d’ancrage sera placé dans la zone d’ancrage de gauche.

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

Crée un QDockWidget dont le parent est parent et dont les indicateurs de fenêtre sont flags. Le widget d'ancrage sera placé dans la zone d'ancrage de gauche.

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

Voir également setWindowTitle().

[virtual noexcept] QDockWidget::~QDockWidget()

Supprime le widget du dock.

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

Ce signal est émis lorsque la propriété « allowedAreas » change. 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 du dock est déplacé vers un autre dock area, ou lorsqu’il est déplacé vers un autre emplacement au sein de sa zone de dock actuelle. Cela se produit lorsque le widget du dock est déplacé par programmation ou lorsqu’il est glissé vers un nouvel emplacement par l’utilisateur.

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 » change. Le paramètre « features » indique la nouvelle valeur de la propriété.

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

Initialisez ` option ` avec les valeurs provenant de cette page : QDockWidget. Cette méthode est utile pour les sous-classes qui ont besoin d'un ` QStyleOptionDockWidget`, mais ne souhaitent pas renseigner elles-mêmes toutes les informations.

Voir également QStyleOption::initFrom().

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

Renvoie « true » si ce widget dock peut être placé à l'area indiquée ; 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)

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

Cette fonction a été introduite dans Qt 6.9.

Voir également dockLocation() et dockLocationChanged().

void QDockWidget::setTitleBarWidget(QWidget *widget)

Définit une chaîne de caractères arbitraire (` widget `) comme barre de titre du widget d'ancrage. Si ` widget ` est égal à ` nullptr`, tout widget de barre de titre personnalisé précédemment défini sur le widget d'ancrage est retiré (sans être supprimé), et la barre de titre par défaut est alors utilisée à la place.

Si un widget de barre de titre est défini, ` QDockWidget ` n'utilisera pas les décorations de fenêtre natives lorsqu'il sera en mode flottant.

Voici quelques conseils pour implémenter des 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 alors vers le parent ` QDockWidget `, qui les gère de la manière habituelle : déplacement lorsque la barre de titre est glissée, ancrage et désancrage lorsqu’on double-clique dessus, etc.
• Lorsque ` DockWidgetVerticalTitleBar ` est défini sur ` QDockWidget`, le widget de la barre de titre est repositionné en conséquence. Dans ` resizeEvent()` (), la barre de titre doit vérifier quelle orientation elle doit adopter :

  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 disposer de fonctions QWidget::sizeHint() et QWidget::minimumSizeHint() valides. Ces fonctions doivent prendre en compte l’orientation actuelle de la barre de titre.
• Il n’est pas possible de supprimer une barre de titre d’un widget d’ancrage. Cependant, un effet similaire peut être obtenu en définissant une QWidget construite par défaut comme widget de la barre de titre.

En utilisant qobject_cast() comme indiqué ci-dessus, le widget de barre de titre dispose d’un accès complet à son parent QDockWidget. Il peut ainsi 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 du dock sur « widget ».

Si le widget d'ancrage est visible lors de l'ajout de widget, vous devez l'show er () explicitement.

Notez que vous devez ajouter la mise en page de l'widget avant d'appeler cette fonction ; sinon, l'widget ne sera pas visible.

Voir également widget().

QWidget *QDockWidget::titleBarWidget() const

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

Voir également setTitleBarWidget().

QAction *QDockWidget::toggleViewAction() const

Renvoie une action « checkable » pouvant être ajoutée aux menus et aux barres d’outils afin que l’utilisateur puisse afficher ou fermer ce widget d’ancrage.

Le texte de l'action correspond au titre de la fenêtre du widget ancré.

L'objet ` QAction ` appartient à ` QDockWidget`. Il sera automatiquement supprimé lorsque ` QDockWidget ` sera détruit.

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

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

Ce signal est émis lorsque la propriété « floating » change. Le paramètre « topLevel » prend la valeur « true » si le widget d'ancrage est désormais flottant ; sinon, il prend la valeur « false ».

Voir aussi 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 masqué 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 correspondant au widget du dock. Cette fonction renvoie zéro si le widget n'a pas été défini.

Voir aussi setWidget().