Sur cette page

QWaylandQuickItem Class

La classe `QWaylandQuickItem` fournit un élément « Qt Quick » qui représente la surface d'un client Wayland. En savoir plus...

En-tête : #include <QWaylandQuickItem>
CMake : find_package(Qt6 REQUIRED COMPONENTS WaylandCompositor)
target_link_libraries(mytarget PRIVATE Qt6::WaylandCompositor)
qmake : QT += waylandcompositor
En QML : WaylandQuickItem
Hérite de : QQuickItem
Hérité par :

QWaylandQuickShellSurfaceItem

Propriétés

Fonctions publiques

QWaylandQuickItem(QQuickItem *parent = nullptr)
virtual ~QWaylandQuickItem() override
bool allowDiscardFrontBuffer() const
QWaylandCompositor *compositor() const
bool focusOnClick() const
bool inputEventsEnabled() const
bool inputRegionContains(const QPointF &localPosition) const
bool isBufferLocked() const
bool isPaintEnabled() const
QPointF mapFromSurface(const QPointF &point) const
QPointF mapToSurface(const QPointF &point) const
QWaylandSurface::Origin origin() const
QWaylandOutput *output() const
void setAllowDiscardFrontBuffer(bool discard)
void setBufferLocked(bool locked)
void setFocusOnClick(bool focus)
void setInputEventsEnabled(bool enabled)
void setOutput(QWaylandOutput *output)
void setPrimary()
void setSubsurfaceHandler(QObject *)
void setSurface(QWaylandSurface *surface)
void setTouchEventsEnabled(bool enabled)
QObject *subsurfaceHandler() const
QWaylandSurface *surface() const
bool touchEventsEnabled() const
QWaylandView *view() const

Fonctions publiques réimplémentées

virtual QSGTextureProvider *textureProvider() const override

Slots publics

void setPaintEnabled(bool paintEnabled)
virtual void takeFocus(QWaylandSeat *device = nullptr)

Signaux

Description détaillée

Lors de la création d’un programme « QWaylandCompositor » dans « Qt Quick », cette classe peut être utilisée pour afficher le contenu d’un client sur un périphérique de sortie et transmettra les entrées de l’utilisateur au client.

Documentation des propriétés

allowDiscardFrontBuffer : bool

Par défaut, l'élément verrouille le tampon actuel jusqu'à ce qu'un nouveau tampon soit disponible et que la fonction ` updatePaintNode()` soit appelée. Définissez cette propriété sur `true` pour permettre à Qt de libérer immédiatement le tampon dès que la vue de régulation ne l'utilise plus. Cela s'avère utile pour les éléments dont les intervalles de mise à jour sont longs.

Fonctions d'accès :

bool allowDiscardFrontBuffer() const
void setAllowDiscardFrontBuffer(bool discard)

Signal de notification :

void allowDiscardFrontBufferChanged()

bufferLocked : bool

Cette propriété indique si le tampon de l'élément est actuellement verrouillé. Tant que le tampon est verrouillé, il ne sera pas libéré ni renvoyé au client.

La valeur par défaut est false.

Fonctions d'accès :

bool isBufferLocked() const
void setBufferLocked(bool locked)

Signal de notification :

void bufferLockedChanged()

[read-only] compositor : QWaylandCompositor*

Cette propriété contient le compositeur de la surface rendue par cet QWaylandQuickItem.

Fonctions d'accès :

QWaylandCompositor *compositor() const

Signal de notification :

void compositorChanged()

focusOnClick : bool

Cette propriété permet de définir si l'élément « QWaylandQuickItem » doit recevoir le focus lorsqu'on clique dessus ou qu'on le touche.

La valeur par défaut est « true ».

Fonctions d'accès :

bool focusOnClick() const
void setFocusOnClick(bool focus)

Signal de notification :

void focusOnClickChanged()

inputEventsEnabled : bool

Cette propriété indique si les événements de saisie sont activés pour cet élément.

Lorsque la valeur est « true », l'élément traite et gère les événements d'entrée tels que les événements clavier et souris ; lorsque la valeur est « false », les événements d'entrée sont ignorés.

Fonctions d'accès :

bool inputEventsEnabled() const
void setInputEventsEnabled(bool enabled)

Signal de notification :

void inputEventsEnabledChanged()

[read-only] origin : QWaylandSurface::Origin

Cette propriété indique l'origine du tampon actuel de la surface, c'est-à-dire quel coin du tampon correspond à la coordonnée (0, 0).

Fonctions d'accès :

QWaylandSurface::Origin origin() const

Signal de notification :

void originChanged()

Voir aussi QWaylandSurface::origin.

output : QWaylandOutput*

Cette propriété contient l'élément de sortie sur lequel cet élément est affiché.

Fonctions d'accès :

QWaylandOutput *output() const
void setOutput(QWaylandOutput *output)

Signal de notification :

void outputChanged()

paintEnabled : bool

Si vous définissez cette propriété sur « false », l'affichage de l'élément sera interrompu. Contrairement au masquage de l'élément obtenu en définissant la propriété « visible » sur « false », cela n'empêchera pas les entrées de la souris ou du clavier d'atteindre l'élément.

Fonctions d'accès :

bool isPaintEnabled() const
void setPaintEnabled(bool paintEnabled)

Signal de notification :

void paintEnabledChanged()

subsurfaceHandler : QObject*

Cette propriété permet de modifier le comportement par défaut de la sous-surface.

Par défaut, Qt créera un nouvel objet « QWaylandQuickItem » en tant qu'enfant de cet élément et conservera la position correcte.

Pour remplacer le comportement par défaut, attribuez un objet gestionnaire à cette propriété. Le gestionnaire doit implémenter une méthode ` handleSubsurfaceAdded(QWaylandSurface*) `.

La valeur par défaut de cette propriété est ` nullptr`.

Fonctions d’accès :

QObject *subsurfaceHandler() const
void setSubsurfaceHandler(QObject *)

Signal de notificateur :

void subsurfaceHandlerChanged()

surface : QWaylandSurface*

Cette propriété contient la surface générée par cette QWaylandQuickItem.

Fonctions d'accès :

QWaylandSurface *surface() const
void setSurface(QWaylandSurface *surface)

Signal de notification :

void surfaceChanged()

touchEventsEnabled : bool

Cette propriété prend la valeur « true » si les événements tactiles sont transmis à la surface cliente, et « false » dans le cas contraire.

Fonctions d'accès :

bool touchEventsEnabled() const
void setTouchEventsEnabled(bool enabled)

Signal de notification :

void touchEventsEnabledChanged()

Documentation des fonctions membres

QWaylandQuickItem::QWaylandQuickItem(QQuickItem *parent = nullptr)

Crée un objet `QWaylandQuickItem` à partir de l'parent` fournie.

[override virtual noexcept] QWaylandQuickItem::~QWaylandQuickItem()

Détruisez l'QWaylandQuickItem.

bool QWaylandQuickItem::inputRegionContains(const QPointF &localPosition) const

Renvoie ` true ` si la région d'entrée de la surface de cet élément contient la position indiquée par ` localPosition`.

[invokable] QPointF QWaylandQuickItem::mapFromSurface(const QPointF &point) const

Mappe l'point e donnée dans le système de coordonnées des surfaces Wayland vers le point équivalent dans le système de coordonnées de cet élément, puis renvoie la coordonnée mappée.

Remarque : cette fonction peut être appelée via le système de méta-objets et depuis QML. Voir Q_INVOKABLE.

[invokable] QPointF QWaylandQuickItem::mapToSurface(const QPointF &point) const

Mappe l'point e donnée dans le système de coordonnées de cet élément vers le point équivalent dans le système de coordonnées de la surface Wayland, puis renvoie la coordonnée mappée.

Remarque : cette fonction peut être appelée via le système de méta-objets et depuis QML. Voir ` Q_INVOKABLE`.

[invokable] void QWaylandQuickItem::setPrimary()

Définit la vue de QWaylandQuickItem comme vue principale de la surface.

Remarque : cette fonction peut être appelée via le système de méta-objets et depuis QML. Voir Q_INVOKABLE.

Voir également QWaylandSurface::primaryView.

[signal] void QWaylandQuickItem::surfaceDestroyed()

Ce signal est émis lorsque le client a détruit l'wl_surface associé à l'QWaylandQuickItem. Le gestionnaire de ce signal doit soit détruire immédiatement l'QWaylandQuickItem, soit lancer une animation de fermeture, puis détruire l'Item.

Si une animation est lancée, bufferLocked doit être défini de manière à ce que l'élément conserve son contenu jusqu'à la fin de l'animation

Voir également QWaylandQuickItem::bufferLocked.

[virtual slot] void QWaylandQuickItem::takeFocus(QWaylandSeat *device = nullptr)

L'appel de cette fonction permet à l'élément de prendre le focus de l'device.

[override virtual] QSGTextureProvider *QWaylandQuickItem::textureProvider() const

Réimplémente : ` QQuickItem::textureProvider()` const.

Renvoie le fournisseur de textures de cet objet ` QWaylandQuickItem`.

QWaylandView *QWaylandQuickItem::view() const

Renvoie la vue générée par cette QWaylandQuickItem.

© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.