<?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>QWaylandQuickItem 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 >QWaylandQuickItem</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="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#reimplemented-public-functions">Reimplemented 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="#reimplemented-protected-functions">Reimplemented Protected Functions</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">QWaylandQuickItem Class</h1>
<!-- $$$QWaylandQuickItem-brief -->
<p>The <a href="qwaylandquickitem.html">QWaylandQuickItem</a> class provides a Qt Quick item representing a <a href="qwaylandview.html">QWaylandView</a>. <a href="#details">More...</a></p>
<!-- @@@QWaylandQuickItem -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QWaylandQuickItem></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"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="qwaylandquickshellsurfaceitem.html">QWaylandQuickShellSurfaceItem</a></p>
</td></tr></table></div><ul>
<li><a href="qwaylandquickitem-members.html">List of all members, including inherited members</a></li>
</ul>
<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="qwaylandquickitem.html#allowDiscardFrontBuffer-prop">allowDiscardFrontBuffer</a></b> : bool</li>
<li class="fn"><b><a href="qwaylandquickitem.html#bufferLocked-prop">bufferLocked</a></b> : bool</li>
<li class="fn"><b><a href="qwaylandquickitem.html#compositor-prop">compositor</a></b> : QWaylandCompositor* const</li>
<li class="fn"><b><a href="qwaylandquickitem.html#focusOnClick-prop">focusOnClick</a></b> : bool</li>
<li class="fn"><b><a href="qwaylandquickitem.html#inputEventsEnabled-prop">inputEventsEnabled</a></b> : bool</li>
<li class="fn"><b><a href="qwaylandquickitem.html#origin-prop">origin</a></b> : const QWaylandSurface::Origin</li>
</ul></td><td class="topAlign"><ul>
<li class="fn"><b><a href="qwaylandquickitem.html#output-prop">output</a></b> : QWaylandOutput*</li>
<li class="fn"><b><a href="qwaylandquickitem.html#paintEnabled-prop">paintEnabled</a></b> : bool</li>
<li class="fn"><b><a href="qwaylandquickitem.html#sizeFollowsSurface-prop">sizeFollowsSurface</a></b> : bool</li>
<li class="fn"><b><a href="qwaylandquickitem.html#subsurfaceHandler-prop">subsurfaceHandler</a></b> : QObject*</li>
<li class="fn"><b><a href="qwaylandquickitem.html#surface-prop">surface</a></b> : QWaylandSurface*</li>
<li class="fn"><b><a href="qwaylandquickitem.html#touchEventsEnabled-prop">touchEventsEnabled</a></b> : bool</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="qwaylandquickitem.html#QWaylandQuickItem">QWaylandQuickItem</a></b>(QQuickItem *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#dtor.QWaylandQuickItem">~QWaylandQuickItem</a></b>() override</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#allowDiscardFrontBuffer-prop">allowDiscardFrontBuffer</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QWaylandCompositor *</td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#compositor-prop">compositor</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#focusOnClick-prop">focusOnClick</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#inputEventsEnabled-prop">inputEventsEnabled</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVariant </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#inputMethodQuery-1">inputMethodQuery</a></b>(Qt::InputMethodQuery <i>query</i>, QVariant <i>argument</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#inputRegionContains">inputRegionContains</a></b>(const QPointF &<i>localPosition</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#inputRegionContains-1">inputRegionContains</a></b>(const QPointF &<i>localPosition</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#bufferLocked-prop">isBufferLocked</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPointF </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#mapToSurface">mapToSurface</a></b>(const QPointF &<i>point</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QWaylandSurface::Origin </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#origin-prop">origin</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QWaylandOutput *</td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#output-prop">output</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#paintEnabled">paintEnabled</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#allowDiscardFrontBuffer-prop">setAllowDiscardFrontBuffer</a></b>(bool <i>discard</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#bufferLocked-prop">setBufferLocked</a></b>(bool <i>locked</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#focusOnClick-prop">setFocusOnClick</a></b>(bool <i>focus</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#inputEventsEnabled-prop">setInputEventsEnabled</a></b>(bool <i>enabled</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#output-prop">setOutput</a></b>(QWaylandOutput *<i>output</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#setPrimary">setPrimary</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#sizeFollowsSurface-prop">setSizeFollowsSurface</a></b>(bool <i>sizeFollowsSurface</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#subsurfaceHandler-prop">setSubsurfaceHandler</a></b>(<i>QObject *</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#surface-prop">setSurface</a></b>(QWaylandSurface *<i>surface</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#touchEventsEnabled-prop">setTouchEventsEnabled</a></b>(bool <i>enabled</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#sizeFollowsSurface-prop">sizeFollowsSurface</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QObject *</td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#subsurfaceHandler-prop">subsurfaceHandler</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QWaylandSurface *</td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#surface-prop">surface</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#touchEventsEnabled-prop">touchEventsEnabled</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QWaylandView *</td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#view">view</a></b>() const</td></tr>
</table></div>
<a name="reimplemented-public-functions"></a>
<h2 id="reimplemented-public-functions">Reimplemented Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual QVariant </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#inputMethodQuery">inputMethodQuery</a></b>(Qt::InputMethodQuery <i>query</i>) const override</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#isTextureProvider">isTextureProvider</a></b>() const override</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QSGTextureProvider *</td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#textureProvider">textureProvider</a></b>() const override</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="qwaylandquickitem.html#lower">lower</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#raise">raise</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#sendMouseMoveEvent">sendMouseMoveEvent</a></b>(const QPointF &<i>position</i>, QWaylandSeat *<i>seat</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#paintEnabled-prop">setPaintEnabled</a></b>(bool <i>paintEnabled</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#takeFocus">takeFocus</a></b>(QWaylandSeat *<i>device</i> = nullptr)</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="qwaylandquickitem.html#allowDiscardFrontBuffer-prop">allowDiscardFrontBufferChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#bufferLocked-prop">bufferLockedChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#focusOnClick-prop">focusOnClickChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#inputEventsEnabled-prop">inputEventsEnabledChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#mouseMove">mouseMove</a></b>(const QPointF &<i>windowPosition</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#mouseRelease">mouseRelease</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#origin-prop">originChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#output-prop">outputChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#sizeFollowsSurface-prop">sizeFollowsSurfaceChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#subsurfaceHandler-prop">subsurfaceHandlerChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#surface-prop">surfaceChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#surfaceDestroyed">surfaceDestroyed</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#touchEventsEnabled-prop">touchEventsEnabledChanged</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"> const QMetaObject </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#staticMetaObject-var">staticMetaObject</a></b></td></tr>
</table></div>
<a name="reimplemented-protected-functions"></a>
<h2 id="reimplemented-protected-functions">Reimplemented Protected Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#touchUngrabEvent">touchUngrabEvent</a></b>() override</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QSGNode *</td><td class="memItemRight bottomAlign"><b><a href="qwaylandquickitem.html#updatePaintNode">updatePaintNode</a></b>(QSGNode *<i>oldNode</i>, QQuickItem::UpdatePaintNodeData *<i>data</i>) override</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QWaylandQuickItem-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qwaylandquickitem.html">QWaylandQuickItem</a> class provides a Qt Quick item representing a <a href="qwaylandview.html">QWaylandView</a>.</p>
<p>When writing a <a href="qwaylandcompositor.html">QWaylandCompositor</a> in Qt Quick, this class can be used to display a client's contents on an output device and will pass user input to the client.</p>
</div>
<!-- @@@QWaylandQuickItem -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$allowDiscardFrontBuffer-prop$$$allowDiscardFrontBuffer$$$setAllowDiscardFrontBufferbool$$$allowDiscardFrontBufferChanged -->
<h3 class="fn" id="allowDiscardFrontBuffer-prop"><a name="allowDiscardFrontBuffer-prop"></a><span class="name">allowDiscardFrontBuffer</span> : <span class="type">bool</span></h3>
<p>By default, the item locks the current buffer until a new buffer is available and <a href="qwaylandquickitem.html#updatePaintNode">updatePaintNode</a>() is called. Set this property to true to allow Qt to release the buffer immediately when the throttling view is no longer using it. This is useful for items that have slow update intervals.</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>allowDiscardFrontBuffer</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setAllowDiscardFrontBuffer</b></span>(bool <i>discard</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>allowDiscardFrontBufferChanged</b></span>()</td></tr>
</table></div>
<!-- @@@allowDiscardFrontBuffer -->
<!-- $$$bufferLocked-prop$$$isBufferLocked$$$setBufferLockedbool$$$bufferLockedChanged -->
<h3 class="fn" id="bufferLocked-prop"><a name="bufferLocked-prop"></a><span class="name">bufferLocked</span> : <span class="type">bool</span></h3>
<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>isBufferLocked</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setBufferLocked</b></span>(bool <i>locked</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>bufferLockedChanged</b></span>()</td></tr>
</table></div>
<!-- @@@bufferLocked -->
<!-- $$$compositor-prop$$$compositor -->
<h3 class="fn" id="compositor-prop"><a name="compositor-prop"></a><span class="name">compositor</span> : <span class="type"><a href="qwaylandcompositor.html">QWaylandCompositor</a></span>* const</h3>
<p>This property holds the compositor for the surface rendered by this <a href="qwaylandquickitem.html">QWaylandQuickItem</a>.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QWaylandCompositor *</td><td class="memItemRight bottomAlign"><span class="name"><b>compositor</b></span>() const</td></tr>
</table></div>
<!-- @@@compositor -->
<!-- $$$focusOnClick-prop$$$focusOnClick$$$setFocusOnClickbool$$$focusOnClickChanged -->
<h3 class="fn" id="focusOnClick-prop"><a name="focusOnClick-prop"></a><span class="name">focusOnClick</span> : <span class="type">bool</span></h3>
<p>This property specifies whether the <a href="qwaylandquickitem.html">QWaylandQuickItem</a> should take focus when it is clicked or touched.</p>
<p>The default is <code>true</code>.</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>focusOnClick</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setFocusOnClick</b></span>(bool <i>focus</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>focusOnClickChanged</b></span>()</td></tr>
</table></div>
<!-- @@@focusOnClick -->
<!-- $$$inputEventsEnabled-prop$$$inputEventsEnabled$$$setInputEventsEnabledbool$$$inputEventsEnabledChanged -->
<h3 class="fn" id="inputEventsEnabled-prop"><a name="inputEventsEnabled-prop"></a><span class="name">inputEventsEnabled</span> : <span class="type">bool</span></h3>
<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>inputEventsEnabled</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setInputEventsEnabled</b></span>(bool <i>enabled</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>inputEventsEnabledChanged</b></span>()</td></tr>
</table></div>
<!-- @@@inputEventsEnabled -->
<!-- $$$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="qwaylandquickitem.html">QWaylandQuickItem</a>.</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 -->
<!-- $$$output-prop$$$output$$$setOutputQWaylandOutput*$$$outputChanged -->
<h3 class="fn" id="output-prop"><a name="output-prop"></a><span class="name">output</span> : <span class="type"><a href="qwaylandoutput.html">QWaylandOutput</a></span>*</h3>
<p>This property holds the output on which this item is displayed.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QWaylandOutput *</td><td class="memItemRight bottomAlign"><span class="name"><b>output</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setOutput</b></span>(QWaylandOutput *<i>output</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>outputChanged</b></span>()</td></tr>
</table></div>
<!-- @@@output -->
<!-- $$$paintEnabled-prop$$$paintEnabled$$$setPaintEnabledbool -->
<h3 class="fn" id="paintEnabled-prop"><a name="paintEnabled-prop"></a><span class="name">paintEnabled</span> : <span class="type">bool</span></h3>
<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><a href="qwaylandquickitem.html#paintEnabled">paintEnabled</a></b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setPaintEnabled</b></span>(bool <i>paintEnabled</i>)</td></tr>
</table></div>
<!-- @@@paintEnabled -->
<!-- $$$sizeFollowsSurface-prop$$$sizeFollowsSurface$$$setSizeFollowsSurfacebool$$$sizeFollowsSurfaceChanged -->
<h3 class="fn" id="sizeFollowsSurface-prop"><a name="sizeFollowsSurface-prop"></a><span class="name">sizeFollowsSurface</span> : <span class="type">bool</span></h3>
<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>
<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>sizeFollowsSurface</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setSizeFollowsSurface</b></span>(bool <i>sizeFollowsSurface</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>sizeFollowsSurfaceChanged</b></span>()</td></tr>
</table></div>
<!-- @@@sizeFollowsSurface -->
<!-- $$$subsurfaceHandler-prop$$$subsurfaceHandler$$$setSubsurfaceHandlerQObject*$$$subsurfaceHandlerChanged -->
<h3 class="fn" id="subsurfaceHandler-prop"><a name="subsurfaceHandler-prop"></a><span class="name">subsurfaceHandler</span> : <span class="type">QObject</span>*</h3>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QObject *</td><td class="memItemRight bottomAlign"><span class="name"><b>subsurfaceHandler</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setSubsurfaceHandler</b></span>(<i>QObject *</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>subsurfaceHandlerChanged</b></span>()</td></tr>
</table></div>
<!-- @@@subsurfaceHandler -->
<!-- $$$surface-prop$$$surface$$$setSurfaceQWaylandSurface*$$$surfaceChanged -->
<h3 class="fn" id="surface-prop"><a name="surface-prop"></a><span class="name">surface</span> : <span class="type"><a href="qwaylandsurface.html">QWaylandSurface</a></span>*</h3>
<p>This property holds the surface rendered by this <a href="qwaylandquickitem.html">QWaylandQuickItem</a>.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QWaylandSurface *</td><td class="memItemRight bottomAlign"><span class="name"><b>surface</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setSurface</b></span>(QWaylandSurface *<i>surface</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>surfaceChanged</b></span>()</td></tr>
</table></div>
<!-- @@@surface -->
<!-- $$$touchEventsEnabled-prop$$$touchEventsEnabled$$$setTouchEventsEnabledbool$$$touchEventsEnabledChanged -->
<h3 class="fn" id="touchEventsEnabled-prop"><a name="touchEventsEnabled-prop"></a><span class="name">touchEventsEnabled</span> : <span class="type">bool</span></h3>
<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>touchEventsEnabled</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setTouchEventsEnabled</b></span>(bool <i>enabled</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>touchEventsEnabledChanged</b></span>()</td></tr>
</table></div>
<!-- @@@touchEventsEnabled -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QWaylandQuickItem[overload1]$$$QWaylandQuickItemQQuickItem* -->
<h3 class="fn" id="QWaylandQuickItem"><a name="QWaylandQuickItem"></a>QWaylandQuickItem::<span class="name">QWaylandQuickItem</span>(<span class="type">QQuickItem</span> *<i>parent</i> = nullptr)</h3>
<p>Constructs a <a href="qwaylandquickitem.html">QWaylandQuickItem</a> with the given <i>parent</i>.</p>
<!-- @@@QWaylandQuickItem -->
<!-- $$$~QWaylandQuickItem[overload1]$$$~QWaylandQuickItem -->
<h3 class="fn" id="dtor.QWaylandQuickItem"><a name="dtor.QWaylandQuickItem"></a><code>[override virtual] </code>QWaylandQuickItem::<span class="name">~QWaylandQuickItem</span>()</h3>
<p>Destroy the <a href="qwaylandquickitem.html">QWaylandQuickItem</a>.</p>
<!-- @@@~QWaylandQuickItem -->
<!-- $$$inputMethodQuery[overload1]$$$inputMethodQueryQt::InputMethodQuery -->
<h3 class="fn" id="inputMethodQuery"><a name="inputMethodQuery"></a><code>[override virtual] </code><span class="type">QVariant</span> QWaylandQuickItem::<span class="name">inputMethodQuery</span>(<span class="type">Qt::InputMethodQuery</span> <i>query</i>) const</h3>
<!-- @@@inputMethodQuery -->
<!-- $$$inputMethodQuery$$$inputMethodQueryQt::InputMethodQueryQVariant -->
<h3 class="fn" id="inputMethodQuery-1"><a name="inputMethodQuery-1"></a><span class="type">QVariant</span> QWaylandQuickItem::<span class="name">inputMethodQuery</span>(<span class="type">Qt::InputMethodQuery</span> <i>query</i>, <span class="type">QVariant</span> <i>argument</i>) const</h3>
<p><b>Note: </b>This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.</p>
<!-- @@@inputMethodQuery -->
<!-- $$$inputRegionContains[overload1]$$$inputRegionContainsconstQPointF& -->
<h3 class="fn" id="inputRegionContains"><a name="inputRegionContains"></a><span class="type">bool</span> QWaylandQuickItem::<span class="name">inputRegionContains</span>(const <span class="type">QPointF</span> &<i>localPosition</i>) const</h3>
<p>Returns <code>true</code> if the input region of this item's surface contains the position given by <i>localPosition</i>.</p>
<!-- @@@inputRegionContains -->
<!-- $$$inputRegionContains$$$inputRegionContainsconstQPointF& -->
<h3 class="fn" id="inputRegionContains-1"><a name="inputRegionContains-1"></a><span class="type">bool</span> QWaylandQuickItem::<span class="name">inputRegionContains</span>(const <span class="type">QPointF</span> &<i>localPosition</i>)</h3>
<p>Returns <code>true</code> if the input region of this item's surface contains the position given by <i>localPosition</i>.</p>
<!-- @@@inputRegionContains -->
<!-- $$$isTextureProvider[overload1]$$$isTextureProvider -->
<h3 class="fn" id="isTextureProvider"><a name="isTextureProvider"></a><code>[override virtual] </code><span class="type">bool</span> QWaylandQuickItem::<span class="name">isTextureProvider</span>() const</h3>
<!-- @@@isTextureProvider -->
<!-- $$$lower[overload1]$$$lower -->
<h3 class="fn" id="lower"><a name="lower"></a><code>[slot] </code><span class="type">void</span> QWaylandQuickItem::<span class="name">lower</span>()</h3>
<!-- @@@lower -->
<!-- $$$mapToSurface[overload1]$$$mapToSurfaceconstQPointF& -->
<h3 class="fn" id="mapToSurface"><a name="mapToSurface"></a><span class="type">QPointF</span> QWaylandQuickItem::<span class="name">mapToSurface</span>(const <span class="type">QPointF</span> &<i>point</i>) const</h3>
<p>Maps the given <i>point</i> in this item's coordinate system to the equivalent point within the Wayland surface's coordinate system, and returns the mapped coordinate.</p>
<p><b>Note: </b>This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.</p>
<!-- @@@mapToSurface -->
<!-- $$$mouseMove[overload1]$$$mouseMoveconstQPointF& -->
<h3 class="fn" id="mouseMove"><a name="mouseMove"></a><code>[signal] </code><span class="type">void</span> QWaylandQuickItem::<span class="name">mouseMove</span>(const <span class="type">QPointF</span> &<i>windowPosition</i>)</h3>
<!-- @@@mouseMove -->
<!-- $$$mouseRelease[overload1]$$$mouseRelease -->
<h3 class="fn" id="mouseRelease"><a name="mouseRelease"></a><code>[signal] </code><span class="type">void</span> QWaylandQuickItem::<span class="name">mouseRelease</span>()</h3>
<!-- @@@mouseRelease -->
<!-- $$$paintEnabled -->
<h3 class="fn" id="paintEnabled"><a name="paintEnabled"></a><span class="type">bool</span> QWaylandQuickItem::<span class="name">paintEnabled</span>() const</h3>
<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>
<p><b>Note:</b> Getter function for property <a href="qwaylandquickitem.html#paintEnabled-prop">paintEnabled</a>. </p><p><b>See also </b><a href="qwaylandquickitem.html#paintEnabled-prop">setPaintEnabled</a>().</p>
<!-- @@@paintEnabled -->
<!-- $$$raise[overload1]$$$raise -->
<h3 class="fn" id="raise"><a name="raise"></a><code>[slot] </code><span class="type">void</span> QWaylandQuickItem::<span class="name">raise</span>()</h3>
<!-- @@@raise -->
<!-- $$$sendMouseMoveEvent[overload1]$$$sendMouseMoveEventconstQPointF&QWaylandSeat* -->
<h3 class="fn" id="sendMouseMoveEvent"><a name="sendMouseMoveEvent"></a><code>[slot] </code><span class="type">void</span> QWaylandQuickItem::<span class="name">sendMouseMoveEvent</span>(const <span class="type">QPointF</span> &<i>position</i>, <span class="type"><a href="qwaylandseat.html">QWaylandSeat</a></span> *<i>seat</i> = nullptr)</h3>
<!-- @@@sendMouseMoveEvent -->
<!-- $$$setPrimary[overload1]$$$setPrimary -->
<h3 class="fn" id="setPrimary"><a name="setPrimary"></a><span class="type">void</span> QWaylandQuickItem::<span class="name">setPrimary</span>()</h3>
<p>Makes this <a href="qwaylandquickitem.html">QWaylandQuickItem</a>'s view the primary view for the surface.</p>
<p><b>Note: </b>This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.</p>
<p><b>See also </b><a href="qwaylandsurface.html#primaryView">QWaylandSurface::primaryView</a>.</p>
<!-- @@@setPrimary -->
<!-- $$$surfaceDestroyed[overload1]$$$surfaceDestroyed -->
<h3 class="fn" id="surfaceDestroyed"><a name="surfaceDestroyed"></a><code>[signal] </code><span class="type">void</span> QWaylandQuickItem::<span class="name">surfaceDestroyed</span>()</h3>
<p>This signal is emitted when the client has destroyed the <code>wl_surface</code> associated with the <a href="qwaylandquickitem.html">QWaylandQuickItem</a>. The handler for this signal is expected to either destroy the <a href="qwaylandquickitem.html">QWaylandQuickItem</a> immediately or start a close animation and then destroy the Item.</p>
<p>If an animation is started, <a href="qwaylandquickitem.html#bufferLocked-prop">bufferLocked</a> should be set to ensure the item keeps its content until the animation finishes</p>
<p><b>See also </b>QWaylandQuickkItem::bufferLocked.</p>
<!-- @@@surfaceDestroyed -->
<!-- $$$takeFocus[overload1]$$$takeFocusQWaylandSeat* -->
<h3 class="fn" id="takeFocus"><a name="takeFocus"></a><code>[virtual slot] </code><span class="type">void</span> QWaylandQuickItem::<span class="name">takeFocus</span>(<span class="type"><a href="qwaylandseat.html">QWaylandSeat</a></span> *<i>device</i> = nullptr)</h3>
<p>Calling this function causes the item to take the focus of the input <i>device</i>.</p>
<!-- @@@takeFocus -->
<!-- $$$textureProvider[overload1]$$$textureProvider -->
<h3 class="fn" id="textureProvider"><a name="textureProvider"></a><code>[override virtual] </code><span class="type">QSGTextureProvider</span> *QWaylandQuickItem::<span class="name">textureProvider</span>() const</h3>
<p>Returns the texture provider of this <a href="qwaylandquickitem.html">QWaylandQuickItem</a>.</p>
<!-- @@@textureProvider -->
<!-- $$$touchUngrabEvent[overload1]$$$touchUngrabEvent -->
<h3 class="fn" id="touchUngrabEvent"><a name="touchUngrabEvent"></a><code>[override virtual protected] </code><span class="type">void</span> QWaylandQuickItem::<span class="name">touchUngrabEvent</span>()</h3>
<!-- @@@touchUngrabEvent -->
<!-- $$$updatePaintNode[overload1]$$$updatePaintNodeQSGNode*QQuickItem::UpdatePaintNodeData* -->
<h3 class="fn" id="updatePaintNode"><a name="updatePaintNode"></a><code>[override virtual protected] </code><span class="type">QSGNode</span> *QWaylandQuickItem::<span class="name">updatePaintNode</span>(<span class="type">QSGNode</span> *<i>oldNode</i>, <span class="type">QQuickItem::UpdatePaintNodeData</span> *<i>data</i>)</h3>
<!-- @@@updatePaintNode -->
<!-- $$$view[overload1]$$$view -->
<h3 class="fn" id="view"><a name="view"></a><span class="type"><a href="qwaylandview.html">QWaylandView</a></span> *QWaylandQuickItem::<span class="name">view</span>() const</h3>
<p>Returns the view rendered by this <a href="qwaylandquickitem.html">QWaylandQuickItem</a>.</p>
<!-- @@@view -->
</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>
