QWaylandSurface Class

The QWaylandSurface class represents a rectangular area on an output device. 更多...

頭: #include <QWaylandSurface>
qmake: QT += waylandcompositor
Since: Qt 5.8
繼承: QWaylandObject

公共類型

enum Origin { OriginTopLeft, OriginBottomLeft }

特性

公共函數

QWaylandSurface ()
QWaylandSurface (QWaylandCompositor * compositor , QWaylandClient * client , uint id , int version )
virtual ~QWaylandSurface () override
int bufferScale () const
QWaylandClient * client () const
QWaylandCompositor * compositor () const
Qt::ScreenOrientation contentOrientation () const
void destroy ()
void frameStarted ()
bool hasContent () const
void initialize (QWaylandCompositor * compositor , QWaylandClient * client , uint id , int version )
QWaylandInputMethodControl * inputMethodControl () const
bool inputRegionContains (const QPoint & p ) const
bool isCursorSurface () const
bool isDestroyed () const
bool isInitialized () const
void markAsCursorSurface (bool cursorSurface )
QWaylandSurface::Origin origin () const
QWaylandView * primaryView () const
struct wl_resource * resource () const
QWaylandSurfaceRole * role () const
void sendFrameCallbacks ()
void setPrimaryView (QWaylandView * view )
bool setRole (QWaylandSurfaceRole * role , wl_resource * errorResource , uint32_t errorCode )
QSize size () const
QList<QWaylandView *> views () const
::wl_client * waylandClient () const

公共槽

void updateSelection ()

信號

void bufferScaleChanged ()
void childAdded (QWaylandSurface * child )
void configure (bool hasBuffer )
void contentOrientationChanged ()
void cursorSurfaceChanged ()
void damaged (const QRegion & rect )
void dragStarted (QWaylandDrag * drag )
void hasContentChanged ()
void offsetForNextFrame (const QPoint & offset )
void originChanged ()
void parentChanged (QWaylandSurface * newParent , QWaylandSurface * oldParent )
void redraw ()
void sizeChanged ()
void subsurfacePlaceAbove (QWaylandSurface * sibling )
void subsurfacePlaceBelow (QWaylandSurface * sibling )
void subsurfacePositionChanged (const QPoint & position )
void surfaceDestroyed ()

靜態公共成員

QWaylandSurface * fromResource (::wl_resource * res )
const QMetaObject staticMetaObject

額外繼承成員

詳細描述

The QWaylandSurface class represents a rectangular area on an output device.

This class encapsulates a rectangular area of pixels that is displayed on an output device. It corresponds to the interface wl_surface in the Wayland protocol.

成員類型文檔編製

enum QWaylandSurface:: Origin

This enum type is used to specify the origin of a QWaylandSurface 's buffer.

常量 描述
QWaylandSurface::OriginTopLeft 0 The origin is the top left corner of the buffer.
QWaylandSurface::OriginBottomLeft 1 The origin is the bottom left corner of the buffer.

特性文檔編製

bufferScale : const int

此特性保持 QWaylandSurface 's buffer scale. The buffer scale lets a client supply higher resolution buffer data for use on high resolution outputs.

訪問函數:

int bufferScale () const

通知程序信號:

void bufferScaleChanged ()

client : QWaylandClient * const

This property holds the client using this QWaylandSurface .

訪問函數:

QWaylandClient * client () const

contentOrientation : const Qt::ScreenOrientation

This property holds the orientation of the QWaylandSurface 's contents.

訪問函數:

Qt::ScreenOrientation contentOrientation () const

通知程序信號:

void contentOrientationChanged ()

另請參閱 QWaylandOutput::transform .

cursorSurface : bool

This property holds whether the QWaylandSurface is a cursor surface.

訪問函數:

bool isCursorSurface () const
void markAsCursorSurface (bool cursorSurface )

通知程序信號:

void cursorSurfaceChanged ()

hasContent : const bool

This property holds whether the QWaylandSurface has content.

訪問函數:

bool hasContent () const

通知程序信號:

void hasContentChanged ()

origin : const QWaylandSurface::Origin

This property holds the origin of the QWaylandSurface 's buffer, or QWaylandSurface::OriginTopLeft if the surface has no buffer.

訪問函數:

QWaylandSurface::Origin origin () const

通知程序信號:

void originChanged ()

size : const QSize

此特性保持 QWaylandSurface 's size in pixels.

訪問函數:

QSize size () const

通知程序信號:

void sizeChanged ()

成員函數文檔編製

QWaylandSurface:: QWaylandSurface ()

Constructs a an uninitialized QWaylandSurface .

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

Constructs and initializes a QWaylandSurface 為給定 compositor and client ,和采用給定 id and version .

[override virtual] QWaylandSurface:: ~QWaylandSurface ()

銷毀 QWaylandSurface .

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

This signal is emitted when a wl_subsurface, child , has been added to the surface.

QWaylandCompositor *QWaylandSurface:: compositor () const

Returns the compositor for this QWaylandSurface .

[signal] void QWaylandSurface:: configure ( bool hasBuffer )

[signal] void QWaylandSurface:: damaged (const QRegion & rect )

void QWaylandSurface:: destroy ()

銷毀 QWaylandSurface .

注意: 此函數可以被援引,通過元對象係統和從 QML。見 Q_INVOKABLE .

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

This signal is emitted when a drag has started from this surface.

void QWaylandSurface:: frameStarted ()

Prepares all frame callbacks for sending.

注意: 此函數可以被援引,通過元對象係統和從 QML。見 Q_INVOKABLE .

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

返迴 QWaylandSurface corresponding to the Wayland resource res .

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

初始化 QWaylandSurface 采用給定 compositor and client ,和采用給定 id and version .

注意: 此函數可以被援引,通過元對象係統和從 QML。見 Q_INVOKABLE .

QWaylandInputMethodControl *QWaylandSurface:: inputMethodControl () const

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

返迴 true QWaylandSurface 's input region contains the point p . Otherwise returns false .

bool QWaylandSurface:: isDestroyed () const

返迴 true 若 QWaylandSurface has been destroyed. Otherwise returns false.

注意: 此函數可以被援引,通過元對象係統和從 QML。見 Q_INVOKABLE .

bool QWaylandSurface:: isInitialized () const

返迴 true 若 QWaylandSurface has been initialized.

[signal] void QWaylandSurface:: offsetForNextFrame (const QPoint & offset )

[signal] void QWaylandSurface:: parentChanged ( QWaylandSurface * newParent , QWaylandSurface * oldParent )

QWaylandView *QWaylandSurface:: primaryView () const

Returns this QWaylandSurface 's primary view.

另請參閱 QWaylandView::advance () 和 QWaylandSurface::setPrimaryView ().

[signal] void QWaylandSurface:: redraw ()

struct wl_resource *QWaylandSurface:: resource () const

Returns the Wayland resource corresponding to this QWaylandSurface .

QWaylandSurfaceRole *QWaylandSurface:: role () const

另請參閱 setRole ().

void QWaylandSurface:: sendFrameCallbacks ()

Sends pending frame callbacks.

注意: 此函數可以被援引,通過元對象係統和從 QML。見 Q_INVOKABLE .

void QWaylandSurface:: setPrimaryView ( QWaylandView * view )

設置此 QWaylandSurface 's primary view to view , in case there are multiple views of this surface. The primary view is the view that governs the client's refresh rate. It takes care of discarding buffer references when QWaylandView::advance () is called. See the documentation for QWaylandView::advance () 瞭解更多細節。

In shell surface integrations, such as QWaylandWlShellIntegration and QWaylandXdgShellV5Integration, maximize and fullscreen requests from the client will only have an effect if the integration has the primary view of the surface.

另請參閱 primaryView () 和 QWaylandView::advance ().

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

設置 role on the surface. A role defines how a surface will be mapped on screen, without a role a surface is supposed to be hidden. Only one role at all times can be set on a surface. Although setting the same role many times is allowed, attempting to change the role of a surface will trigger a protocol error to the errorResource and send an errorCode to the client.

另請參閱 role ().

[signal] void QWaylandSurface:: subsurfacePlaceAbove ( QWaylandSurface * sibling )

[signal] void QWaylandSurface:: subsurfacePlaceBelow ( QWaylandSurface * sibling )

[signal] void QWaylandSurface:: subsurfacePositionChanged (const QPoint & position )

[signal] void QWaylandSurface:: surfaceDestroyed ()

This signal is emitted when the corresponing wl_surface is destroyed.

[slot] void QWaylandSurface:: updateSelection ()

Updates the surface with the compositor's retained clipboard selection. Although this is done automatically when the surface receives keyboard focus, this function is useful for updating clients which do not have keyboard focus.

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

Returns the views for this QWaylandSurface .

::wl_client *QWaylandSurface:: waylandClient () const