<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qwaylandsurface.cpp -->
<title>QWaylandSurface Class | Qt Wayland Compositor 5.12.6</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.12</td><td ><a href="qtwaylandcompositor-index.html">Qt Wayland Compositor</a></td><td ><a href="qtwaylandcompositor-module.html">C++ Classes</a></td><td >QWaylandSurface</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qtwaylandcompositor-index.html">Qt 5.12.6 Reference Documentation</a></td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#public-slots">Public Slots</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QWaylandSurface Class</h1>
<!-- $$$QWaylandSurface-brief -->
<p>The <a href="qwaylandsurface.html">QWaylandSurface</a> class represents a rectangular area on an output device. <a href="#details">More...</a></p>
<!-- @@@QWaylandSurface -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QWaylandSurface></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += waylandcompositor</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.8</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> QWaylandObject</td></tr></table></div><ul>
<li><a href="qwaylandsurface-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2 id="public-types">Public Types</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#Origin-enum">Origin</a></b> { OriginTopLeft, OriginBottomLeft }</td></tr>
</table></div>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<div class="table"><table class="propsummary">
<tr><td class="topAlign"><ul>
<li class="fn"><b><a href="qwaylandsurface.html#bufferScale-prop">bufferScale</a></b> : const int</li>
<li class="fn"><b><a href="qwaylandsurface.html#client-prop">client</a></b> : QWaylandClient* const</li>
<li class="fn"><b><a href="qwaylandsurface.html#contentOrientation-prop">contentOrientation</a></b> : const Qt::ScreenOrientation</li>
<li class="fn"><b><a href="qwaylandsurface.html#cursorSurface-prop">cursorSurface</a></b> : bool</li>
</ul></td><td class="topAlign"><ul>
<li class="fn"><b><a href="qwaylandsurface.html#hasContent-prop">hasContent</a></b> : const bool</li>
<li class="fn"><b><a href="qwaylandsurface.html#origin-prop">origin</a></b> : const QWaylandSurface::Origin</li>
<li class="fn"><b><a href="qwaylandsurface.html#size-prop">size</a></b> : const QSize</li>
</ul>
</td></tr>
</table></div>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#QWaylandSurface">QWaylandSurface</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#QWaylandSurface-1">QWaylandSurface</a></b>(QWaylandCompositor *<i>compositor</i>, QWaylandClient *<i>client</i>, uint <i>id</i>, int <i>version</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#dtor.QWaylandSurface">~QWaylandSurface</a></b>() override</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#bufferScale-prop">bufferScale</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QWaylandClient *</td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#client-prop">client</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QWaylandCompositor *</td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#compositor">compositor</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt::ScreenOrientation </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#contentOrientation-prop">contentOrientation</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#destroy">destroy</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#frameStarted">frameStarted</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#hasContent-prop">hasContent</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#initialize">initialize</a></b>(QWaylandCompositor *<i>compositor</i>, QWaylandClient *<i>client</i>, uint <i>id</i>, int <i>version</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QWaylandInputMethodControl *</td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#inputMethodControl">inputMethodControl</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#inputRegionContains">inputRegionContains</a></b>(const QPoint &<i>p</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#cursorSurface-prop">isCursorSurface</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#isDestroyed">isDestroyed</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#isInitialized">isInitialized</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#cursorSurface-prop">markAsCursorSurface</a></b>(bool <i>cursorSurface</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QWaylandSurface::Origin </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#origin-prop">origin</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QWaylandView *</td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#primaryView">primaryView</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> struct wl_resource *</td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#resource">resource</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QWaylandSurfaceRole *</td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#role">role</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#sendFrameCallbacks">sendFrameCallbacks</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#setPrimaryView">setPrimaryView</a></b>(QWaylandView *<i>view</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#setRole">setRole</a></b>(QWaylandSurfaceRole *<i>role</i>, wl_resource *<i>errorResource</i>, uint32_t <i>errorCode</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QSize </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#size-prop">size</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QWaylandView *> </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#views">views</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> ::wl_client *</td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#waylandClient">waylandClient</a></b>() const</td></tr>
</table></div>
<a name="public-slots"></a>
<h2 id="public-slots">Public Slots</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#updateSelection">updateSelection</a></b>()</td></tr>
</table></div>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#bufferScale-prop">bufferScaleChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#childAdded">childAdded</a></b>(QWaylandSurface *<i>child</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#configure">configure</a></b>(bool <i>hasBuffer</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#contentOrientation-prop">contentOrientationChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#cursorSurface-prop">cursorSurfaceChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#damaged">damaged</a></b>(const QRegion &<i>rect</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#dragStarted">dragStarted</a></b>(QWaylandDrag *<i>drag</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#hasContent-prop">hasContentChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#offsetForNextFrame">offsetForNextFrame</a></b>(const QPoint &<i>offset</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#origin-prop">originChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#parentChanged">parentChanged</a></b>(QWaylandSurface *<i>newParent</i>, QWaylandSurface *<i>oldParent</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#redraw">redraw</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#size-prop">sizeChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#subsurfacePlaceAbove">subsurfacePlaceAbove</a></b>(QWaylandSurface *<i>sibling</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#subsurfacePlaceBelow">subsurfacePlaceBelow</a></b>(QWaylandSurface *<i>sibling</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#subsurfacePositionChanged">subsurfacePositionChanged</a></b>(const QPoint &<i>position</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#surfaceDestroyed">surfaceDestroyed</a></b>()</td></tr>
</table></div>
<a name="static-public-members"></a>
<h2 id="static-public-members">Static Public Members</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> QWaylandSurface *</td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#fromResource">fromResource</a></b>(::wl_resource *<i>res</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QMetaObject </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurface.html#staticMetaObject-var">staticMetaObject</a></b></td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QWaylandSurface-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qwaylandsurface.html">QWaylandSurface</a> class represents a rectangular area on an output device.</p>
<p>This class encapsulates a rectangular area of pixels that is displayed on an output device. It corresponds to the interface <code>wl_surface</code> in the Wayland protocol.</p>
</div>
<!-- @@@QWaylandSurface -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$Origin$$$OriginTopLeft$$$OriginBottomLeft -->
<h3 class="fn" id="Origin-enum"><a name="Origin-enum"></a>enum QWaylandSurface::<span class="name">Origin</span></h3>
<p>This enum type is used to specify the origin of a <a href="qwaylandsurface.html">QWaylandSurface</a>'s buffer.</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>QWaylandSurface::OriginTopLeft</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">The origin is the top left corner of the buffer.</td></tr>
<tr><td class="topAlign"><code>QWaylandSurface::OriginBottomLeft</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">The origin is the bottom left corner of the buffer.</td></tr>
</table></div>
<!-- @@@Origin -->
</div>
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$bufferScale-prop$$$bufferScale$$$bufferScaleChanged -->
<h3 class="fn" id="bufferScale-prop"><a name="bufferScale-prop"></a><span class="name">bufferScale</span> : const <span class="type">int</span></h3>
<p>This property holds the <a href="qwaylandsurface.html">QWaylandSurface</a>'s buffer scale. The buffer scale lets a client supply higher resolution buffer data for use on high resolution outputs.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>bufferScale</b></span>() const</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>bufferScaleChanged</b></span>()</td></tr>
</table></div>
<!-- @@@bufferScale -->
<!-- $$$client-prop$$$client -->
<h3 class="fn" id="client-prop"><a name="client-prop"></a><span class="name">client</span> : <span class="type"><a href="qwaylandclient.html">QWaylandClient</a></span>* const</h3>
<p>This property holds the client using this <a href="qwaylandsurface.html">QWaylandSurface</a>.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QWaylandClient *</td><td class="memItemRight bottomAlign"><span class="name"><b>client</b></span>() const</td></tr>
</table></div>
<!-- @@@client -->
<!-- $$$contentOrientation-prop$$$contentOrientation$$$contentOrientationChanged -->
<h3 class="fn" id="contentOrientation-prop"><a name="contentOrientation-prop"></a><span class="name">contentOrientation</span> : const <span class="type">Qt::ScreenOrientation</span></h3>
<p>This property holds the orientation of the <a href="qwaylandsurface.html">QWaylandSurface</a>'s contents.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> Qt::ScreenOrientation </td><td class="memItemRight bottomAlign"><span class="name"><b>contentOrientation</b></span>() const</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>contentOrientationChanged</b></span>()</td></tr>
</table></div>
<p><b>See also </b><a href="qwaylandoutput.html#transform-prop">QWaylandOutput::transform</a>.</p>
<!-- @@@contentOrientation -->
<!-- $$$cursorSurface-prop$$$isCursorSurface$$$markAsCursorSurfacebool$$$cursorSurfaceChanged -->
<h3 class="fn" id="cursorSurface-prop"><a name="cursorSurface-prop"></a><span class="name">cursorSurface</span> : <span class="type">bool</span></h3>
<p>This property holds whether the <a href="qwaylandsurface.html">QWaylandSurface</a> is a cursor surface.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>isCursorSurface</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>markAsCursorSurface</b></span>(bool <i>cursorSurface</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>cursorSurfaceChanged</b></span>()</td></tr>
</table></div>
<!-- @@@cursorSurface -->
<!-- $$$hasContent-prop$$$hasContent$$$hasContentChanged -->
<h3 class="fn" id="hasContent-prop"><a name="hasContent-prop"></a><span class="name">hasContent</span> : const <span class="type">bool</span></h3>
<p>This property holds whether the <a href="qwaylandsurface.html">QWaylandSurface</a> has content.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>hasContent</b></span>() const</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>hasContentChanged</b></span>()</td></tr>
</table></div>
<!-- @@@hasContent -->
<!-- $$$origin-prop$$$origin$$$originChanged -->
<h3 class="fn" id="origin-prop"><a name="origin-prop"></a><span class="name">origin</span> : const <span class="type"><a href="qwaylandsurface.html#Origin-enum">QWaylandSurface::Origin</a></span></h3>
<p>This property holds the origin of the <a href="qwaylandsurface.html">QWaylandSurface</a>'s buffer, or <a href="qwaylandsurface.html#Origin-enum">QWaylandSurface::OriginTopLeft</a> if the surface has no buffer.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QWaylandSurface::Origin </td><td class="memItemRight bottomAlign"><span class="name"><b>origin</b></span>() const</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>originChanged</b></span>()</td></tr>
</table></div>
<!-- @@@origin -->
<!-- $$$size-prop$$$size$$$sizeChanged -->
<h3 class="fn" id="size-prop"><a name="size-prop"></a><span class="name">size</span> : const <span class="type">QSize</span></h3>
<p>This property holds the <a href="qwaylandsurface.html">QWaylandSurface</a>'s size in pixels.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QSize </td><td class="memItemRight bottomAlign"><span class="name"><b>size</b></span>() const</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>sizeChanged</b></span>()</td></tr>
</table></div>
<!-- @@@size -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QWaylandSurface[overload1]$$$QWaylandSurface -->
<h3 class="fn" id="QWaylandSurface"><a name="QWaylandSurface"></a>QWaylandSurface::<span class="name">QWaylandSurface</span>()</h3>
<p>Constructs a an uninitialized <a href="qwaylandsurface.html">QWaylandSurface</a>.</p>
<!-- @@@QWaylandSurface -->
<!-- $$$QWaylandSurface$$$QWaylandSurfaceQWaylandCompositor*QWaylandClient*uintint -->
<h3 class="fn" id="QWaylandSurface-1"><a name="QWaylandSurface-1"></a>QWaylandSurface::<span class="name">QWaylandSurface</span>(<span class="type"><a href="qwaylandcompositor.html">QWaylandCompositor</a></span> *<i>compositor</i>, <span class="type"><a href="qwaylandclient.html">QWaylandClient</a></span> *<i>client</i>, <span class="type">uint</span> <i>id</i>, <span class="type">int</span> <i>version</i>)</h3>
<p>Constructs and initializes a <a href="qwaylandsurface.html">QWaylandSurface</a> for the given <i>compositor</i> and <i>client</i>, and with the given <i>id</i> and <i>version</i>.</p>
<!-- @@@QWaylandSurface -->
<!-- $$$~QWaylandSurface[overload1]$$$~QWaylandSurface -->
<h3 class="fn" id="dtor.QWaylandSurface"><a name="dtor.QWaylandSurface"></a><code>[override virtual] </code>QWaylandSurface::<span class="name">~QWaylandSurface</span>()</h3>
<p>Destroys the <a href="qwaylandsurface.html">QWaylandSurface</a>.</p>
<!-- @@@~QWaylandSurface -->
<!-- $$$childAdded[overload1]$$$childAddedQWaylandSurface* -->
<h3 class="fn" id="childAdded"><a name="childAdded"></a><code>[signal] </code><span class="type">void</span> QWaylandSurface::<span class="name">childAdded</span>(<span class="type"><a href="qwaylandsurface.html#QWaylandSurface">QWaylandSurface</a></span> *<i>child</i>)</h3>
<p>This signal is emitted when a wl_subsurface, <i>child</i>, has been added to the surface.</p>
<!-- @@@childAdded -->
<!-- $$$compositor[overload1]$$$compositor -->
<h3 class="fn" id="compositor"><a name="compositor"></a><span class="type"><a href="qwaylandcompositor.html">QWaylandCompositor</a></span> *QWaylandSurface::<span class="name">compositor</span>() const</h3>
<p>Returns the compositor for this <a href="qwaylandsurface.html">QWaylandSurface</a>.</p>
<!-- @@@compositor -->
<!-- $$$configure[overload1]$$$configurebool -->
<h3 class="fn" id="configure"><a name="configure"></a><code>[signal] </code><span class="type">void</span> QWaylandSurface::<span class="name">configure</span>(<span class="type">bool</span> <i>hasBuffer</i>)</h3>
<!-- @@@configure -->
<!-- $$$damaged[overload1]$$$damagedconstQRegion& -->
<h3 class="fn" id="damaged"><a name="damaged"></a><code>[signal] </code><span class="type">void</span> QWaylandSurface::<span class="name">damaged</span>(const <span class="type">QRegion</span> &<i>rect</i>)</h3>
<!-- @@@damaged -->
<!-- $$$destroy[overload1]$$$destroy -->
<h3 class="fn" id="destroy"><a name="destroy"></a><span class="type">void</span> QWaylandSurface::<span class="name">destroy</span>()</h3>
<p>Destroys the <a href="qwaylandsurface.html">QWaylandSurface</a>.</p>
<p><b>Note: </b>This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.</p>
<!-- @@@destroy -->
<!-- $$$dragStarted[overload1]$$$dragStartedQWaylandDrag* -->
<h3 class="fn" id="dragStarted"><a name="dragStarted"></a><code>[signal] </code><span class="type">void</span> QWaylandSurface::<span class="name">dragStarted</span>(<span class="type">QWaylandDrag</span> *<i>drag</i>)</h3>
<p>This signal is emitted when a <i>drag</i> has started from this surface.</p>
<!-- @@@dragStarted -->
<!-- $$$frameStarted[overload1]$$$frameStarted -->
<h3 class="fn" id="frameStarted"><a name="frameStarted"></a><span class="type">void</span> QWaylandSurface::<span class="name">frameStarted</span>()</h3>
<p>Prepares all frame callbacks for sending.</p>
<p><b>Note: </b>This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.</p>
<!-- @@@frameStarted -->
<!-- $$$fromResource[overload1]$$$fromResource::wl_resource* -->
<h3 class="fn" id="fromResource"><a name="fromResource"></a><code>[static] </code><span class="type"><a href="qwaylandsurface.html#QWaylandSurface">QWaylandSurface</a></span> *QWaylandSurface::<span class="name">fromResource</span>(<span class="type">::wl_resource</span> *<i>res</i>)</h3>
<p>Returns the <a href="qwaylandsurface.html">QWaylandSurface</a> corresponding to the Wayland resource <i>res</i>.</p>
<!-- @@@fromResource -->
<!-- $$$initialize[overload1]$$$initializeQWaylandCompositor*QWaylandClient*uintint -->
<h3 class="fn" id="initialize"><a name="initialize"></a><span class="type">void</span> QWaylandSurface::<span class="name">initialize</span>(<span class="type"><a href="qwaylandcompositor.html">QWaylandCompositor</a></span> *<i>compositor</i>, <span class="type"><a href="qwaylandclient.html">QWaylandClient</a></span> *<i>client</i>, <span class="type">uint</span> <i>id</i>, <span class="type">int</span> <i>version</i>)</h3>
<p>Initializes the <a href="qwaylandsurface.html">QWaylandSurface</a> with the given <i>compositor</i> and <i>client</i>, and with the given <i>id</i> and <i>version</i>.</p>
<p><b>Note: </b>This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.</p>
<!-- @@@initialize -->
<!-- $$$inputMethodControl[overload1]$$$inputMethodControl -->
<h3 class="fn" id="inputMethodControl"><a name="inputMethodControl"></a><span class="type">QWaylandInputMethodControl</span> *QWaylandSurface::<span class="name">inputMethodControl</span>() const</h3>
<!-- @@@inputMethodControl -->
<!-- $$$inputRegionContains[overload1]$$$inputRegionContainsconstQPoint& -->
<h3 class="fn" id="inputRegionContains"><a name="inputRegionContains"></a><span class="type">bool</span> QWaylandSurface::<span class="name">inputRegionContains</span>(const <span class="type">QPoint</span> &<i>p</i>) const</h3>
<p>Returns <code>true</code> if the <a href="qwaylandsurface.html">QWaylandSurface</a>'s input region contains the point <i>p</i>. Otherwise returns <code>false</code>.</p>
<!-- @@@inputRegionContains -->
<!-- $$$isDestroyed[overload1]$$$isDestroyed -->
<h3 class="fn" id="isDestroyed"><a name="isDestroyed"></a><span class="type">bool</span> QWaylandSurface::<span class="name">isDestroyed</span>() const</h3>
<p>Returns true if the <a href="qwaylandsurface.html">QWaylandSurface</a> has been destroyed. Otherwise returns false.</p>
<p><b>Note: </b>This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.</p>
<!-- @@@isDestroyed -->
<!-- $$$isInitialized[overload1]$$$isInitialized -->
<h3 class="fn" id="isInitialized"><a name="isInitialized"></a><span class="type">bool</span> QWaylandSurface::<span class="name">isInitialized</span>() const</h3>
<p>Returns true if the <a href="qwaylandsurface.html">QWaylandSurface</a> has been initialized.</p>
<!-- @@@isInitialized -->
<!-- $$$offsetForNextFrame[overload1]$$$offsetForNextFrameconstQPoint& -->
<h3 class="fn" id="offsetForNextFrame"><a name="offsetForNextFrame"></a><code>[signal] </code><span class="type">void</span> QWaylandSurface::<span class="name">offsetForNextFrame</span>(const <span class="type">QPoint</span> &<i>offset</i>)</h3>
<!-- @@@offsetForNextFrame -->
<!-- $$$parentChanged[overload1]$$$parentChangedQWaylandSurface*QWaylandSurface* -->
<h3 class="fn" id="parentChanged"><a name="parentChanged"></a><code>[signal] </code><span class="type">void</span> QWaylandSurface::<span class="name">parentChanged</span>(<span class="type"><a href="qwaylandsurface.html#QWaylandSurface">QWaylandSurface</a></span> *<i>newParent</i>, <span class="type"><a href="qwaylandsurface.html#QWaylandSurface">QWaylandSurface</a></span> *<i>oldParent</i>)</h3>
<!-- @@@parentChanged -->
<!-- $$$primaryView[overload1]$$$primaryView -->
<h3 class="fn" id="primaryView"><a name="primaryView"></a><span class="type"><a href="qwaylandview.html">QWaylandView</a></span> *QWaylandSurface::<span class="name">primaryView</span>() const</h3>
<p>Returns this <a href="qwaylandsurface.html">QWaylandSurface</a>'s primary view.</p>
<p><b>See also </b><a href="qwaylandview.html#advance">QWaylandView::advance</a>() and <a href="qwaylandsurface.html#setPrimaryView">QWaylandSurface::setPrimaryView</a>().</p>
<!-- @@@primaryView -->
<!-- $$$redraw[overload1]$$$redraw -->
<h3 class="fn" id="redraw"><a name="redraw"></a><code>[signal] </code><span class="type">void</span> QWaylandSurface::<span class="name">redraw</span>()</h3>
<!-- @@@redraw -->
<!-- $$$resource[overload1]$$$resource -->
<h3 class="fn" id="resource"><a name="resource"></a><span class="type">struct</span> <span class="type">wl_resource</span> *QWaylandSurface::<span class="name">resource</span>() const</h3>
<p>Returns the Wayland resource corresponding to this <a href="qwaylandsurface.html">QWaylandSurface</a>.</p>
<!-- @@@resource -->
<!-- $$$role[overload1]$$$role -->
<h3 class="fn" id="role"><a name="role"></a><span class="type">QWaylandSurfaceRole</span> *QWaylandSurface::<span class="name">role</span>() const</h3>
<p><b>See also </b><a href="qwaylandsurface.html#setRole">setRole</a>().</p>
<!-- @@@role -->
<!-- $$$sendFrameCallbacks[overload1]$$$sendFrameCallbacks -->
<h3 class="fn" id="sendFrameCallbacks"><a name="sendFrameCallbacks"></a><span class="type">void</span> QWaylandSurface::<span class="name">sendFrameCallbacks</span>()</h3>
<p>Sends pending frame callbacks.</p>
<p><b>Note: </b>This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.</p>
<!-- @@@sendFrameCallbacks -->
<!-- $$$setPrimaryView[overload1]$$$setPrimaryViewQWaylandView* -->
<h3 class="fn" id="setPrimaryView"><a name="setPrimaryView"></a><span class="type">void</span> QWaylandSurface::<span class="name">setPrimaryView</span>(<span class="type"><a href="qwaylandview.html">QWaylandView</a></span> *<i>view</i>)</h3>
<p>Sets this <a href="qwaylandsurface.html">QWaylandSurface</a>'s primary view to <i>view</i>, 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 <a href="qwaylandview.html#advance">QWaylandView::advance</a>() is called. See the documentation for <a href="qwaylandview.html#advance">QWaylandView::advance</a>() for more details.</p>
<p>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.</p>
<p><b>See also </b><a href="qwaylandsurface.html#primaryView">primaryView</a>() and <a href="qwaylandview.html#advance">QWaylandView::advance</a>().</p>
<!-- @@@setPrimaryView -->
<!-- $$$setRole[overload1]$$$setRoleQWaylandSurfaceRole*wl_resource*uint32_t -->
<h3 class="fn" id="setRole"><a name="setRole"></a><span class="type">bool</span> QWaylandSurface::<span class="name">setRole</span>(<span class="type">QWaylandSurfaceRole</span> *<i>role</i>, <span class="type">wl_resource</span> *<i>errorResource</i>, <span class="type">uint32_t</span> <i>errorCode</i>)</h3>
<p>Sets a <i>role</i> 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 <i>errorResource</i> and send an <i>errorCode</i> to the client.</p>
<p><b>See also </b><a href="qwaylandsurface.html#role">role</a>().</p>
<!-- @@@setRole -->
<!-- $$$subsurfacePlaceAbove[overload1]$$$subsurfacePlaceAboveQWaylandSurface* -->
<h3 class="fn" id="subsurfacePlaceAbove"><a name="subsurfacePlaceAbove"></a><code>[signal] </code><span class="type">void</span> QWaylandSurface::<span class="name">subsurfacePlaceAbove</span>(<span class="type"><a href="qwaylandsurface.html#QWaylandSurface">QWaylandSurface</a></span> *<i>sibling</i>)</h3>
<!-- @@@subsurfacePlaceAbove -->
<!-- $$$subsurfacePlaceBelow[overload1]$$$subsurfacePlaceBelowQWaylandSurface* -->
<h3 class="fn" id="subsurfacePlaceBelow"><a name="subsurfacePlaceBelow"></a><code>[signal] </code><span class="type">void</span> QWaylandSurface::<span class="name">subsurfacePlaceBelow</span>(<span class="type"><a href="qwaylandsurface.html#QWaylandSurface">QWaylandSurface</a></span> *<i>sibling</i>)</h3>
<!-- @@@subsurfacePlaceBelow -->
<!-- $$$subsurfacePositionChanged[overload1]$$$subsurfacePositionChangedconstQPoint& -->
<h3 class="fn" id="subsurfacePositionChanged"><a name="subsurfacePositionChanged"></a><code>[signal] </code><span class="type">void</span> QWaylandSurface::<span class="name">subsurfacePositionChanged</span>(const <span class="type">QPoint</span> &<i>position</i>)</h3>
<!-- @@@subsurfacePositionChanged -->
<!-- $$$surfaceDestroyed[overload1]$$$surfaceDestroyed -->
<h3 class="fn" id="surfaceDestroyed"><a name="surfaceDestroyed"></a><code>[signal] </code><span class="type">void</span> QWaylandSurface::<span class="name">surfaceDestroyed</span>()</h3>
<p>This signal is emitted when the corresponing wl_surface is destroyed.</p>
<!-- @@@surfaceDestroyed -->
<!-- $$$updateSelection[overload1]$$$updateSelection -->
<h3 class="fn" id="updateSelection"><a name="updateSelection"></a><code>[slot] </code><span class="type">void</span> QWaylandSurface::<span class="name">updateSelection</span>()</h3>
<p>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.</p>
<!-- @@@updateSelection -->
<!-- $$$views[overload1]$$$views -->
<h3 class="fn" id="views"><a name="views"></a><span class="type">QList</span><<span class="type"><a href="qwaylandview.html">QWaylandView</a></span> *> QWaylandSurface::<span class="name">views</span>() const</h3>
<p>Returns the views for this <a href="qwaylandsurface.html">QWaylandSurface</a>.</p>
<!-- @@@views -->
<!-- $$$waylandClient[overload1]$$$waylandClient -->
<h3 class="fn" id="waylandClient"><a name="waylandClient"></a><span class="type">::wl_client</span> *QWaylandSurface::<span class="name">waylandClient</span>() const</h3>
<!-- @@@waylandClient -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2019 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br/> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br/> 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. </p>
</div>
</body>
</html>
distrib
>
Mageia
>
7
>
i586
>
media
>
core-updates
>
by-pkgid
>
f171b9b27b527f95603e88add5c7e1b6
>
files
>
172
