<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qwaylandquickshellsurfaceitem.cpp -->
<title>ShellSurfaceItem 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 >ShellSurfaceItem 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="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">ShellSurfaceItem QML Type</h1>
<span class="subtitle"></span>
<!-- $$$ShellSurfaceItem-brief -->
<p>A Qt Quick item type for displaying and interacting with a <a href="qml-qtwayland-compositor-shellsurface.html">ShellSurface</a>. <a href="#details">More...</a></p>
<!-- @@@ShellSurfaceItem -->
<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"> Inherits:</td><td class="memItemRight bottomAlign"> <p><a href="qml-qtwayland-compositor-waylandquickitem.html">WaylandQuickItem</a></p>
</td></tr></table></div><ul>
<li><a href="qml-qtwayland-compositor-shellsurfaceitem-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-shellsurfaceitem.html#autoCreatePopupItems-prop">autoCreatePopupItems</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtwayland-compositor-shellsurfaceitem.html#moveItem-prop">moveItem</a></b></b> : Item</li>
<li class="fn"><b><b><a href="qml-qtwayland-compositor-shellsurfaceitem.html#shellSurface-prop">shellSurface</a></b></b> : ShellSurface</li>
</ul>
<!-- $$$ShellSurfaceItem-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>This type is used to render <code>wl_shell</code>, <code>xdg_shell</code> or <code>ivi_application</code> surfaces as part of a Qt Quick scene. It handles moving and resizing triggered by clicking on the window decorations.</p>
<p><b>See also </b><a href="qml-qtwayland-compositor-waylandquickitem.html">WaylandQuickItem</a>, <a href="qml-qtwayland-compositor-wlshellsurface.html">WlShellSurface</a>, <a href="qml-qtwayland-compositor-xdgsurfacev5.html">XdgSurfaceV5</a>, and <a href="qml-qtwayland-compositor-ivisurface.html">IviSurface</a>.</p>
<!-- @@@ShellSurfaceItem -->
<h2>Property Documentation</h2>
<!-- $$$autoCreatePopupItems -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="autoCreatePopupItems-prop">
<td class="tblQmlPropNode"><p>
<a name="autoCreatePopupItems-prop"></a><span class="name">autoCreatePopupItems</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds whether ShellSurfaceItems for popups parented to the shell surface managed by this item should automatically be created.</p>
</div></div><!-- @@@autoCreatePopupItems -->
<br/>
<!-- $$$moveItem -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="moveItem-prop">
<td class="tblQmlPropNode"><p>
<a name="moveItem-prop"></a><span class="name">moveItem</span> : <span class="type">Item</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the move item for this <a href="qml-qtwayland-compositor-shellsurfaceitem.html">ShellSurfaceItem</a>. This is the item that will be moved when the clients request the <a href="qml-qtwayland-compositor-shellsurface.html">ShellSurface</a> to be moved, maximized, resized etc. This property is useful when implementing server-side decorations.</p>
</div></div><!-- @@@moveItem -->
<br/>
<!-- $$$shellSurface -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="shellSurface-prop">
<td class="tblQmlPropNode"><p>
<a name="shellSurface-prop"></a><span class="name">shellSurface</span> : <span class="type"><a href="qml-qtwayland-compositor-shellsurface.html">ShellSurface</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the <a href="qml-qtwayland-compositor-shellsurface.html">ShellSurface</a> rendered by this <a href="qml-qtwayland-compositor-shellsurfaceitem.html">ShellSurfaceItem</a>. It may either be an XdgSurfaceV5, <a href="qml-qtwayland-compositor-wlshellsurface.html">WlShellSurface</a> or <a href="qml-qtwayland-compositor-ivisurface.html">IviSurface</a> depending on which shell protocol is in use.</p>
</div></div><!-- @@@shellSurface -->
<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>
