このページでは

QWaylandQuickItem Class

QWaylandQuickItem クラスは、Wayland クライアントのサーフェスを表す「Qt Quick 」アイテムを提供します。詳細...

ヘッダー: #include <QWaylandQuickItem>
CMake: find_package(Qt6 REQUIRED COMPONENTS WaylandCompositor)
target_link_libraries(mytarget PRIVATE Qt6::WaylandCompositor)
qmake: QT += waylandcompositor
QML内: WaylandQuickItem
継承元: QQuickItem
継承元:

QWaylandQuickShellSurfaceItem

プロパティ

パブリック関数

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

再実装されたパブリック関数

virtual QSGTextureProvider *textureProvider() const override

パブリックスロット

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

シグナル

詳細な説明

Qt Quick でQWaylandCompositor を作成する場合、このクラスを使用すると、クライアントのコンテンツを出力デバイスに表示し、ユーザー入力をクライアントに渡すことができます。

プロパティのドキュメント

allowDiscardFrontBuffer : bool

デフォルトでは、このアイテムは、新しいバッファが利用可能になり、updatePaintNode() が呼び出されるまで、現在のバッファをロックします。スロットリングビューがバッファを使用しなくなった際に、Qt が直ちにバッファを解放できるようにするには、このプロパティを true に設定してください。これは、更新間隔が長いアイテムの場合に役立ちます。

アクセス関数:

bool allowDiscardFrontBuffer() const
void setAllowDiscardFrontBuffer(bool discard)

Notifierシグナル:

void allowDiscardFrontBufferChanged()

bufferLocked : bool

このプロパティは、項目のバッファが現在ロックされているかどうかを示します。バッファがロックされている限り、バッファは解放されず、クライアントに返されません。

デフォルト値は false です。

アクセス関数:

bool isBufferLocked() const
void setBufferLocked(bool locked)

Notifierシグナル:

void bufferLockedChanged()

[read-only] compositor : QWaylandCompositor*

このプロパティには、このQWaylandQuickItem によってレンダリングされるサーフェスのコンポジターが格納されます。

アクセス関数:

QWaylandCompositor *compositor() const

通知シグナル:

void compositorChanged()

focusOnClick : bool

このプロパティは、QWaylandQuickItem がクリックまたはタップされた際にフォーカスを取得するかどうかを指定します。

デフォルトは `true` です。

アクセス関数:

bool focusOnClick() const
void setFocusOnClick(bool focus)

Notifierシグナル:

void focusOnClickChanged()

inputEventsEnabled : bool

このプロパティは、このアイテムに対して入力イベントが有効かどうかを示します。

true の場合、このアイテムはキーボードやマウスなどの入力イベントを処理および対応します。false の場合、入力イベントは無視されます。

アクセス関数:

bool inputEventsEnabled() const
void setInputEventsEnabled(bool enabled)

通知シグナル:

void inputEventsEnabledChanged()

[read-only] origin : QWaylandSurface::Origin

このプロパティは、サーフェスの現在のバッファの原点を表します。つまり、バッファのどの角が座標 (0, 0) に対応するかを示します。

アクセス関数:

QWaylandSurface::Origin origin() const

通知信号:

void originChanged()

関連項目: QWaylandSurface::origin 。

output : QWaylandOutput*

このプロパティには、この項目が表示される出力先が格納されます。

アクセス関数:

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

通知信号:

void outputChanged()

paintEnabled : bool

このプロパティを `false ` に設定すると、項目のレンダリングが停止します。visible を `false` に設定して項目を非表示にする場合とは異なり、マウスやキーボードからの入力が項目に届くのを妨げることはありません。

アクセス関数:

bool isPaintEnabled() const
void setPaintEnabled(bool paintEnabled)

Notifierシグナル:

void paintEnabledChanged()

subsurfaceHandler : QObject*

このプロパティを使用すると、デフォルトのサブサーフェスの挙動を上書きすることができます。

デフォルトでは、Qt XML はこのアイテムの子として新しい `QWaylandQuickItem ` を作成し、正しい位置を維持します。

デフォルトの挙動を上書きするには、このプロパティにハンドラオブジェクトを割り当てます。ハンドラは、handleSubsurfaceAdded(QWaylandSurface*) メソッドを実装している必要があります。

このプロパティのデフォルト値はnullptr です。

アクセス関数:

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

Notifier シグナル:

void subsurfaceHandlerChanged()

surface : QWaylandSurface*

このプロパティには、このQWaylandQuickItem によってレンダリングされたサーフェスが格納されます。

アクセス関数:

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

Notifierシグナル:

void surfaceChanged()

touchEventsEnabled : bool

このプロパティは、タッチイベントがクライアントサーフェスに転送される場合は `true `、そうでない場合は `false ` を返します。

アクセス関数:

bool touchEventsEnabled() const
void setTouchEventsEnabled(bool enabled)

Notifierシグナル:

void touchEventsEnabledChanged()

メンバ関数のドキュメント

QWaylandQuickItem::QWaylandQuickItem(QQuickItem *parent = nullptr)

指定されたparent を使用して、QWaylandQuickItemを生成します。

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

QWaylandQuickItem を破壊せよ。

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

この項目のサーフェスの入力領域に、localPosition で指定された位置が含まれている場合、true を返します。

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

Waylandサーフェスの座標系における指定されたpoint を、この項目の座標系内の対応する点にマッピングし、マッピングされた座標を返します。

注:この関数は 、メタオブジェクトシステムおよびQMLから呼び出すことができます。Q_INVOKABLE を参照してください。

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

この項目の座標系における指定されたpoint を、Waylandサーフェスの座標系内の対応する点にマッピングし、マッピングされた座標を返します。

注:この関数は 、メタオブジェクトシステムおよびQMLから呼び出すことができます。Q_INVOKABLE を参照してください。

[invokable] void QWaylandQuickItem::setPrimary()

QWaylandQuickItem のビューを、そのサーフェスのプライマリビューに設定します。

注:この関数は 、メタオブジェクトシステムおよびQMLから呼び出すことができます。Q_INVOKABLE を参照してください。

QWaylandSurface::primaryViewも参照してください 。

[signal] void QWaylandQuickItem::surfaceDestroyed()

このシグナルは、クライアントがQWaylandQuickItem に関連付けられたwl_surface を破棄したときに発せられます。このシグナルのハンドラは、QWaylandQuickItem を直ちに破棄するか、閉じるアニメーションを開始してからItemを破棄する必要があります。

アニメーションが開始された場合、アニメーションが終了するまでアイテムがコンテンツを保持し続けるよう、bufferLocked を設定する必要があります。

QWaylandQuickItem::bufferLockedも参照してください 。

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

この関数を呼び出すと、その項目が入力フィールド「device 」のフォーカスを取得します。

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

QQuickItem::textureProvider() const を再実装します。

この `QWaylandQuickItem` のテクスチャプロバイダを返します。

QWaylandView *QWaylandQuickItem::view() const

この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.