内容

• 公共类型
• 特性
• 公共函数
• 公共槽
• 信号
• 详细描述

QWaylandSurface Class

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

头：	#include <QWaylandSurface>
qmake:	QT += waylandcompositor
Since:	Qt 5.8
继承：	QWaylandObject

• 所有成员列表，包括继承成员

公共类型

enum	Origin { OriginTopLeft, OriginBottomLeft }

特性

bufferScale : const int client : QWaylandClient * const contentOrientation : const Qt::ScreenOrientation cursorSurface : bool

hasContent : const bool origin : const QWaylandSurface::Origin size : const QSize

• 1 特性继承自 QObject

公共函数

	QWaylandSurface ()
	QWaylandSurface (QWaylandCompositor * compositor , QWaylandClient * client , uint id , int version )
virtual	~QWaylandSurface ()
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 )
Origin	origin () const
QWaylandView *	primaryView () const
QWaylandSurfaceRole *	role () const
void	sendFrameCallbacks ()
void	setPrimaryView (QWaylandView * view )
QSize	size () const
QList<QWaylandView *>	views () const

• 5 public functions inherited from QWaylandObject
• 32 公共函数继承自 QObject

公共槽

void	updateSelection ()

• 1 公共槽继承自 QObject

信号

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 ()

• 2 信号继承自 QObject

额外继承成员

• 11 静态公共成员继承自 QObject
• 9 保护函数继承自 QObject

详细描述

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.

访问函数：

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 .

[virtual] QWaylandSurface:: ~QWaylandSurface ()

销毁 QWaylandSurface .

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

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 .

[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.

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

初始化 QWaylandSurface 采用给定 compositor and client ，和采用给定 id and version .

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.

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 ()

QWaylandSurfaceRole *QWaylandSurface:: role () const

void QWaylandSurface:: sendFrameCallbacks ()

Sends pending frame callbacks.

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 ().

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

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

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

[signal] void QWaylandSurface:: surfaceDestroyed ()

[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 .