QWaylandSurface Class

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

QWaylandSurface::QWaylandSurface()

初期化されていない QWaylandSurface を生成します。

QWaylandSurface::QWaylandSurface(QWaylandCompositor *compositor, QWaylandClient *client, uint id, int version)

指定されたcompositor およびclient に基づき、指定されたid およびversion を使用して、QWaylandSurfaceを構築し、初期化します。

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

QWaylandSurface を破棄します。

[signal] void QWaylandSurface::childAdded(QWaylandSurface *child)

このシグナルは、wl_subsurface（child ）がサーフェスに追加されたときに発火します。

QWaylandCompositor *QWaylandSurface::compositor() const

このQWaylandSurface のコンポジターを返します。

[invokable] void QWaylandSurface::destroy()

QWaylandSurface を破棄します。

[signal] void QWaylandSurface::dragStarted(QWaylandDrag *drag)

この信号は、drag がこの表面から発進した際に発信されます。

[invokable] void QWaylandSurface::frameStarted()

送信するためのすべてのフレームコールバックを準備します。

[static] QWaylandSurface *QWaylandSurface::fromResource(wl_resource *resource)

Waylandリソース「resource 」に対応するQWaylandSurface を返します。

[invokable] void QWaylandSurface::initialize(QWaylandCompositor *compositor, QWaylandClient *client, uint id, int version)

指定されたcompositor およびclient 、ならびに指定されたid およびversion を用いて、QWaylandSurface を初期化します。

bool QWaylandSurface::inputRegionContains(const QPoint &p) const

QWaylandSurface の入力領域に点p が含まれている場合、true を返します。それ以外の場合は、false を返します。

bool QWaylandSurface::inputRegionContains(const QPointF &position) const

QWaylandSurface の入力領域に点position が含まれている場合は、true を返します。そうでない場合は、false を返します。

[invokable] bool QWaylandSurface::isDestroyed() const

QWaylandSurface が破棄されている場合はtrueを返します。そうでない場合はfalseを返します。

bool QWaylandSurface::isInitialized() const

QWaylandSurface が初期化されている場合、trueを返します。

QWaylandView *QWaylandSurface::primaryView() const

このQWaylandSurface のプライマリビューを返します。

QWaylandView::advance() およびQWaylandSurface::setPrimaryView()も参照してください 。

struct wl_resource *QWaylandSurface::resource() const

この `QWaylandSurface` に対応する Wayland リソースを返します。

[invokable] void QWaylandSurface::sendFrameCallbacks()

保留中のフレームのコールバックを送信します。

void QWaylandSurface::setPrimaryView(QWaylandView *view)

このQWaylandSurface のプライマリビューをview に設定します（このサーフェスに複数のビューが存在する場合）。プライマリビューとは、クライアントのリフレッシュレートを制御するビューのことです。QWaylandView::advance()が呼び出された際に、バッファ参照の破棄を処理します。詳細については、QWaylandView::advance()のドキュメントを参照してください。

QWaylandWlShellIntegration や QWaylandXdgShellV5Integration などのシェルサーフェス統合では、クライアントからの最大化および全画面表示のリクエストは、その統合がサーフェスのプライマリビューである場合にのみ有効になります。

primaryView() およびQWaylandView::advance()も参照してください 。

bool QWaylandSurface::setRole(QWaylandSurfaceRole *role, wl_resource *errorResource, uint32_t errorCode)

サーフェスにrole を設定します。 roleは、サーフェスが画面上にどのようにマッピングされるかを定義します。roleが設定されていない場合、そのサーフェスは非表示とみなされます。サーフェスにroleが割り当てられると、それがそのサーフェスの恒久的なroleとなります。その後、異なるroleを指定してsetRole() を呼び出すと、errorResource に対してプロトコルエラーが発生し、クライアントにerrorCode が送信されます。この要件を強制することが、サーフェスのroleの主な目的です。

`role ` はポインタ値によって比較されます。名前にかかわらず、QWaylandSurfaceRole の 2 つのオブジェクトはすべて異なるロールと見なされます。

surface ロールは、例えばシェル拡張などで、特定の目的のためにサーフェスが採用される際に、プロトコル実装によって内部的に設定されます。この方法でサーフェスを使用する拡張機能を開発している場合を除き、この関数を呼び出してはなりません。

ロールの割り当てが可能であれば true を返し、そうでない場合は false を返します。

[signal] void QWaylandSurface::surfaceDestroyed()

このシグナルは、対応する wl_surface が破棄されたときに発生します。

[slot] void QWaylandSurface::updateSelection()

コンポジターがクリップボードに保持している選択範囲でサーフェスを更新します。サーフェスがキーボードフォーカスを受けると自動的にこの処理が行われますが、この関数は、キーボードフォーカスを持っていないクライアントを更新する際に役立ちます。

QList<QWaylandView *> QWaylandSurface::views() const

このQWaylandSurface のビューを返します。

wl_client *QWaylandSurface::waylandClient() const

このQWaylandSurface を使用して、wl_client を保持します。