内容

• 公共类型
• 特性
• 公共函数
• 重实现公共函数
• 公共槽
• 信号
• 静态公共成员
• 详细描述

QWaylandWlShellSurface Class

The QWaylandWlShellSurface class provides desktop-style compositor-specific features to a surface. 更多...

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

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

公共类型

enum	FullScreenMethod { DefaultFullScreen, ScaleFullScreen, DriverFullScreen, FillFullScreen }
enum	ResizeEdge { NoneEdge, TopEdge, BottomEdge, LeftEdge, ..., BottomRightEdge }

特性

• className : const QString
• shell : QWaylandWlShell* const
• surface : QWaylandSurface* const
• title : const QString

• 1 特性继承自 QWaylandShellSurface
• 1 特性继承自 QObject

公共函数

	QWaylandWlShellSurface ()
	QWaylandWlShellSurface (QWaylandWlShell * shell , QWaylandSurface * surface , const QWaylandResource & res )
virtual	~QWaylandWlShellSurface () override
QString	className () const
QQmlListProperty<QObject>	data ()
void	initialize (QWaylandWlShell * shell , QWaylandSurface * surface , const QWaylandResource & resource )
void	sendConfigure (const QSize & size , QWaylandWlShellSurface::ResizeEdge edges )
void	sendPopupDone ()
QWaylandWlShell *	shell () const
QSize	sizeForResize (const QSizeF & size , const QPointF & delta , QWaylandWlShellSurface::ResizeEdge edges )
QWaylandSurface *	surface () const
QString	title () const

重实现公共函数

virtual QWaylandQuickShellIntegration *	createIntegration (QWaylandQuickShellSurfaceItem * item ) override
virtual Qt::WindowType	windowType () const override

• 2 公共函数继承自 QWaylandShellSurface
• 31 公共函数继承自 QObject

公共槽

void

ping ()

• 1 公共槽继承自 QObject

信号

void	classNameChanged ()
void	pong ()
void	setDefaultToplevel ()
void	setFullScreen (QWaylandWlShellSurface::FullScreenMethod method , uint framerate , QWaylandOutput * output )
void	setMaximized (QWaylandOutput * output )
void	setPopup (QWaylandSeat * seat , QWaylandSurface * parentSurface , const QPoint & relativeToParent )
void	setTransient (QWaylandSurface * parentSurface , const QPoint & relativeToParent , bool inactive )
void	shellChanged ()
void	startMove (QWaylandSeat * seat )
void	startResize (QWaylandSeat * seat , QWaylandWlShellSurface::ResizeEdge edges )
void	surfaceChanged ()
void	titleChanged ()

• 1 信号继承自 QWaylandShellSurface
• 2 信号继承自 QObject

静态公共成员

void	appendFunction (QQmlListProperty<QObject> * list , QObject * object )
QObject *	atFunction (QQmlListProperty<QObject> * list , int index )
void	clearFunction (QQmlListProperty<QObject> * list )
int	countFunction (QQmlListProperty<QObject> * list )
QWaylandWlShellSurface *	fromResource (wl_resource * resource )
const struct wl_interface *	interface ()
QWaylandSurfaceRole *	role ()
const QMetaObject	staticMetaObject

• 9 静态公共成员继承自 QObject

额外继承成员

• 9 保护函数继承自 QObject

详细描述

The QWaylandWlShellSurface class provides desktop-style compositor-specific features to a surface.

此类属于 QWaylandWlShell extension and provides a way to extend the functionality of an existing QWaylandSurface with features specific to desktop-style compositors, such as resizing and moving the surface.

It corresponds to the Wayland interface wl_shell_surface .

成员类型文档编制

enum QWaylandWlShellSurface:: FullScreenMethod

enum QWaylandWlShellSurface:: ResizeEdge

This enum type provides a way to specify an edge or corner of the surface.

常量	值	描述
QWaylandWlShellSurface::NoneEdge	0	No edge.
QWaylandWlShellSurface::TopEdge	1	The top edge.
QWaylandWlShellSurface::BottomEdge	2	The bottom edge.
QWaylandWlShellSurface::LeftEdge	4	The left edge.
QWaylandWlShellSurface::TopLeftEdge	5	The top left corner.
QWaylandWlShellSurface::BottomLeftEdge	6	The bottom left corner.
QWaylandWlShellSurface::RightEdge	8	The right edge.
QWaylandWlShellSurface::TopRightEdge	9	The top right corner.
QWaylandWlShellSurface::BottomRightEdge	10	The bottom right corner.

特性文档编制

className : const QString

This property holds the class name of the QWaylandWlShellSurface .

访问函数：

QString

className () const

通知程序信号：

void	classNameChanged ()

shell : QWaylandWlShell * const

This property holds the shell associated with this QWaylandWlShellSurface .

访问函数：

QWaylandWlShell *

shell () const

通知程序信号：

void	shellChanged ()

surface : QWaylandSurface * const

This property holds the surface associated with this QWaylandWlShellSurface .

访问函数：

QWaylandSurface *

surface () const

通知程序信号：

void	surfaceChanged ()

title : const QString

This property holds the title of the QWaylandWlShellSurface .

访问函数：

QString

title () const

通知程序信号：

void	titleChanged ()

成员函数文档编制

QWaylandWlShellSurface:: QWaylandWlShellSurface ()

构造 QWaylandWlShellSurface .

QWaylandWlShellSurface:: QWaylandWlShellSurface ( QWaylandWlShell * shell , QWaylandSurface * surface , const QWaylandResource & res )

构造 QWaylandWlShellSurface for surface and initializes it with the given shell and resource res .

[override virtual] QWaylandWlShellSurface:: ~QWaylandWlShellSurface ()

Destroys the instance of QWaylandWlShellSurface. The destructor is virtual.

[static] void QWaylandWlShellSurface:: appendFunction ( QQmlListProperty < QObject > * list , QObject * object )

[static] QObject *QWaylandWlShellSurface:: atFunction ( QQmlListProperty < QObject > * list , int index )

[static] void QWaylandWlShellSurface:: clearFunction ( QQmlListProperty < QObject > * list )

[static] int QWaylandWlShellSurface:: countFunction ( QQmlListProperty < QObject > * list )

[override virtual] QWaylandQuickShellIntegration *QWaylandWlShellSurface:: createIntegration ( QWaylandQuickShellSurfaceItem * item )

QQmlListProperty < QObject > QWaylandWlShellSurface:: data ()

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

返回 QWaylandWlShellSurface object associated with the given resource , or null if no such object exists.

void QWaylandWlShellSurface:: initialize ( QWaylandWlShell * shell , QWaylandSurface * surface , const QWaylandResource & resource )

初始化 QWaylandWlShellSurface and associates it with the given shell , surface ，和 resource .

注意： 此函数可以被援引，通过元对象系统和从 QML。见 Q_INVOKABLE .

[static] const struct wl_interface *QWaylandWlShellSurface:: interface ()

[slot] void QWaylandWlShellSurface:: ping ()

Sends a ping event to the client. If the client replies to the event the pong signal will be emitted.

[signal] void QWaylandWlShellSurface:: pong ()

[static] QWaylandSurfaceRole *QWaylandWlShellSurface:: role ()

void QWaylandWlShellSurface:: sendConfigure (const QSize & size , QWaylandWlShellSurface::ResizeEdge edges )

Sends a configure event to the client, suggesting that it resize its surface to the provided size 。 edges provide a hint about how the surface was resized.

注意： 此函数可以被援引，通过元对象系统和从 QML。见 Q_INVOKABLE .

void QWaylandWlShellSurface:: sendPopupDone ()

Sends a popup_done event to the client to indicate that the user has clicked somewhere outside the client's surfaces.

注意： 此函数可以被援引，通过元对象系统和从 QML。见 Q_INVOKABLE .

[signal] void QWaylandWlShellSurface:: setDefaultToplevel ()

[signal] void QWaylandWlShellSurface:: setFullScreen ( QWaylandWlShellSurface::FullScreenMethod method , uint framerate , QWaylandOutput * output )

[signal] void QWaylandWlShellSurface:: setMaximized ( QWaylandOutput * output )

[signal] void QWaylandWlShellSurface:: setPopup ( QWaylandSeat * seat , QWaylandSurface * parentSurface , const QPoint & relativeToParent )

[signal] void QWaylandWlShellSurface:: setTransient ( QWaylandSurface * parentSurface , const QPoint & relativeToParent , bool inactive )

QSize QWaylandWlShellSurface:: sizeForResize (const QSizeF & size , const QPointF & delta , QWaylandWlShellSurface::ResizeEdge edges )

注意： 此函数可以被援引，通过元对象系统和从 QML。见 Q_INVOKABLE .

[signal] void QWaylandWlShellSurface:: startMove ( QWaylandSeat * seat )

[signal] void QWaylandWlShellSurface:: startResize ( QWaylandSeat * seat , QWaylandWlShellSurface::ResizeEdge edges )

[override virtual] Qt::WindowType QWaylandWlShellSurface:: windowType () const