<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qwaylandquickitem.cpp -->
<title>WaylandQuickItem QML Type | 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="qtwayland-compositor-qmlmodule.html">QML Types</a></td><td >WaylandQuickItem QML Type</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="#properties">Properties</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#methods">Methods</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">WaylandQuickItem QML Type</h1>
<span class="subtitle"></span>
<!-- $$$WaylandQuickItem-brief -->
<p>Provides a Qt Quick item that represents a <a href="qml-qtwayland-compositor-waylandview.html">WaylandView</a>. <a href="#details">More...</a></p>
<!-- @@@WaylandQuickItem -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtWayland.Compositor 1.3</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"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="qml-qtwayland-compositor-shellsurfaceitem.html">ShellSurfaceItem</a></p>
</td></tr></table></div><ul>
<li><a href="qml-qtwayland-compositor-waylandquickitem-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtwayland-compositor-waylandquickitem.html#compositor-prop">compositor</a></b></b> : WaylandCompositor</li>
<li class="fn"><b><b><a href="qml-qtwayland-compositor-waylandquickitem.html#focusOnClick-prop">focusOnClick</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtwayland-compositor-waylandquickitem.html#origin-prop">origin</a></b></b> : enum</li>
<li class="fn"><b><b><a href="qml-qtwayland-compositor-waylandquickitem.html#paintEnabled-prop">paintEnabled</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtwayland-compositor-waylandquickitem.html#sizeFollowsSurface-prop">sizeFollowsSurface</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtwayland-compositor-waylandquickitem.html#subsurfaceHandler-prop">subsurfaceHandler</a></b></b> : object</li>
<li class="fn"><b><b><a href="qml-qtwayland-compositor-waylandquickitem.html#surface-prop">surface</a></b></b> : WaylandSurface</li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<ul>
<li class="fn">void <b><b><a href="qml-qtwayland-compositor-waylandquickitem.html#surfaceDestroyed-signal">surfaceDestroyed</a></b></b>()</li>
</ul>
<a name="methods"></a>
<h2 id="methods">Methods</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtwayland-compositor-waylandquickitem.html#setPrimary-method">setPrimary</a></b></b>()</li>
</ul>
<!-- $$$WaylandQuickItem-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>Qt Quick-based Wayland compositors can use this type to display a client's contents on an output device. It passes user input to the client.</p>
<!-- @@@WaylandQuickItem -->
<h2>Property Documentation</h2>
<!-- $$$compositor -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="compositor-prop">
<td class="tblQmlPropNode"><p>
<a name="compositor-prop"></a><span class="name">compositor</span> : <span class="type"><a href="qml-qtwayland-compositor-waylandcompositor.html">WaylandCompositor</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the compositor for the surface rendered by this <a href="qml-qtwayland-compositor-waylandquickitem.html">WaylandQuickItem</a>.</p>
</div></div><!-- @@@compositor -->
<br/>
<!-- $$$focusOnClick -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="focusOnClick-prop">
<td class="tblQmlPropNode"><p>
<a name="focusOnClick-prop"></a><span class="name">focusOnClick</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property specifies whether the <a href="qml-qtwayland-compositor-waylandquickitem.html">WaylandQuickItem</a> should take focus when it is clicked or touched.</p>
<p>The default is <code>true</code>.</p>
</div></div><!-- @@@focusOnClick -->
<br/>
<!-- $$$origin -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="origin-prop">
<td class="tblQmlPropNode"><p>
<a name="origin-prop"></a><span class="name">origin</span> : <span class="type">enum</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the origin of the <a href="qwaylandquickitem.html">QWaylandQuickItem</a>.</p>
</div></div><!-- @@@origin -->
<br/>
<!-- $$$paintEnabled -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="paintEnabled-prop">
<td class="tblQmlPropNode"><p>
<a name="paintEnabled-prop"></a><span class="name">paintEnabled</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Returns true if the item is hidden, though the texture is still updated. As opposed to hiding the item by setting visible to <code>false</code>, setting this property to <code>false</code> will not prevent mouse or keyboard input from reaching item.</p>
</div></div><!-- @@@paintEnabled -->
<br/>
<!-- $$$sizeFollowsSurface -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="sizeFollowsSurface-prop">
<td class="tblQmlPropNode"><p>
<a name="sizeFollowsSurface-prop"></a><span class="name">sizeFollowsSurface</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property specifies whether the size of the item should always match the size of its surface.</p>
<p>The default is <code>true</code>.</p>
</div></div><!-- @@@sizeFollowsSurface -->
<br/>
<!-- $$$subsurfaceHandler -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="subsurfaceHandler-prop">
<td class="tblQmlPropNode"><p>
<a name="subsurfaceHandler-prop"></a><span class="name">subsurfaceHandler</span> : <span class="type">object</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property provides a way to override the default subsurface behavior.</p>
<p>By default, Qt will create a new SurfaceItem as a child of this item, and maintain the correct position.</p>
<p>To override the default, assign a handler object to this property. The handler should implement a handleSubsurfaceAdded(<a href="qml-qtwayland-compositor-waylandsurface.html">WaylandSurface</a>) function.</p>
<pre class="cpp">
ShellSurfaceItem {
subsurfaceHandler: <span class="type">QtObject</span> {
function handleSubsurfaceAdded(child) {
<span class="comment">//create custom surface item, and connect the subsurfacePositionChanged signal</span>
}
}
</pre>
<p>The default value of this property is <code>null</code>.</p>
</div></div><!-- @@@subsurfaceHandler -->
<br/>
<!-- $$$surface -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="surface-prop">
<td class="tblQmlPropNode"><p>
<a name="surface-prop"></a><span class="name">surface</span> : <span class="type"><a href="qml-qtwayland-compositor-waylandsurface.html">WaylandSurface</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the surface rendered by this <a href="qml-qtwayland-compositor-waylandquickitem.html">WaylandQuickItem</a>.</p>
</div></div><!-- @@@surface -->
<br/>
<h2>Signal Documentation</h2>
<!-- $$$surfaceDestroyed -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="surfaceDestroyed-signal">
<td class="tblQmlFuncNode"><p>
<a name="surfaceDestroyed-signal"></a><span class="type">void</span> <span class="name">surfaceDestroyed</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when the client has destroyed the <code>wl_surface</code> associated with the <a href="qml-qtwayland-compositor-waylandquickitem.html">WaylandQuickItem</a>. The handler for this signal is expected to either destroy the <a href="qml-qtwayland-compositor-waylandquickitem.html">WaylandQuickItem</a> immediately or start a close animation and then destroy the Item.</p>
<p>If an animation is started, bufferLocked should be set to ensure the item keeps its content until the animation finishes</p>
<p><b>See also </b>isBufferLocked.</p>
</div></div><!-- @@@surfaceDestroyed -->
<br/>
<h2>Method Documentation</h2>
<!-- $$$setPrimary -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="setPrimary-method">
<td class="tblQmlFuncNode"><p>
<a name="setPrimary-method"></a><span class="name">setPrimary</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Makes this <a href="qml-qtwayland-compositor-waylandquickitem.html">WaylandQuickItem</a> the primary view for the surface.</p>
</div></div><!-- @@@setPrimary -->
<br/>
</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>
