Sophie

Sophie

distrib > Mageia > 7 > i586 > media > core-updates > by-pkgid > f171b9b27b527f95603e88add5c7e1b6 > files > 66

qtwayland5-doc-5.12.6-1.mga7.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qwaylandxdgshell.cpp -->
  <title>XdgSurface 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 >XdgSurface 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="#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">XdgSurface QML Type</h1>
<span class="subtitle"></span>
<!-- $$$XdgSurface-brief -->
<p><a href="qml-qtwayland-compositor-xdgsurface.html">XdgSurface</a> provides desktop-style compositor-specific features to an xdg surface. <a href="#details">More...</a></p>
<!-- @@@XdgSurface -->
<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.12</td></tr></table></div><ul>
<li><a href="qml-qtwayland-compositor-xdgsurface-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-xdgsurface.html#popup-prop">popup</a></b></b> : XdgPopup</li>
<li class="fn"><b><b><a href="qml-qtwayland-compositor-xdgsurface.html#shell-prop">shell</a></b></b> : XdgShell</li>
<li class="fn"><b><b><a href="qml-qtwayland-compositor-xdgsurface.html#surface-prop">surface</a></b></b> : WaylandSurface</li>
<li class="fn"><b><b><a href="qml-qtwayland-compositor-xdgsurface.html#toplevel-prop">toplevel</a></b></b> : XdgToplevel</li>
<li class="fn"><b><b><a href="qml-qtwayland-compositor-xdgsurface.html#windowGeometry-prop">windowGeometry</a></b></b> : rect</li>
<li class="fn"><b><b><a href="qml-qtwayland-compositor-xdgsurface.html#windowType-prop">windowType</a></b></b> : enum</li>
</ul>
<a name="methods"></a>
<h2 id="methods">Methods</h2>
<ul>
<li class="fn">void <b><b><a href="qml-qtwayland-compositor-xdgsurface.html#initialize-method">initialize</a></b></b>(object <i>xdgShell</i>,  object <i>surface</i>,  object <i>client</i>,  int <i>id</i>)</li>
</ul>
<!-- $$$XdgSurface-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>This type is part of the <a href="qml-qtwayland-compositor-xdgshell.html">XdgShell</a> extension and provides a way to extend the functionality of an existing <a href="qml-qtwayland-compositor-waylandsurface.html">WaylandSurface</a> with features specific to desktop-style compositors, such as resizing and moving the surface.</p>
<p>It corresponds to the Wayland interface <code>xdg_surface</code>.</p>
<!-- @@@XdgSurface -->
<h2>Property Documentation</h2>
<!-- $$$popup -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="popup-prop">
<td class="tblQmlPropNode"><p>
<a name="popup-prop"></a><span class="name">popup</span> : <span class="type"><a href="qml-qtwayland-compositor-xdgpopup.html">XdgPopup</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the properties and methods that are specific to the popup <a href="qml-qtwayland-compositor-xdgsurface.html">XdgSurface</a>.</p>
<p><b>See also </b><a href="qml-qtwayland-compositor-xdgsurface.html#toplevel-prop">toplevel</a> and <a href="qml-qtwayland-compositor-xdgshell.html#popupCreated-signal">XdgShell::popupCreated</a>.</p>
</div></div><!-- @@@popup -->
<br/>
<!-- $$$shell -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="shell-prop">
<td class="tblQmlPropNode"><p>
<a name="shell-prop"></a><span class="name">shell</span> : <span class="type"><a href="qml-qtwayland-compositor-xdgshell.html">XdgShell</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the shell associated with this <a href="qml-qtwayland-compositor-xdgsurface.html">XdgSurface</a>.</p>
</div></div><!-- @@@shell -->
<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 associated with this <a href="qml-qtwayland-compositor-xdgsurface.html">XdgSurface</a>.</p>
</div></div><!-- @@@surface -->
<br/>
<!-- $$$toplevel -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="toplevel-prop">
<td class="tblQmlPropNode"><p>
<a name="toplevel-prop"></a><span class="name">toplevel</span> : <span class="type"><a href="qml-qtwayland-compositor-xdgtoplevel.html">XdgToplevel</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the properties and methods that are specific to the toplevel <a href="qml-qtwayland-compositor-xdgsurface.html">XdgSurface</a>.</p>
<p><b>See also </b><a href="qml-qtwayland-compositor-xdgsurface.html#popup-prop">popup</a> and <a href="qml-qtwayland-compositor-xdgshell.html#toplevelCreated-signal">XdgShell::toplevelCreated</a>.</p>
</div></div><!-- @@@toplevel -->
<br/>
<!-- $$$windowGeometry -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="windowGeometry-prop">
<td class="tblQmlPropNode"><p>
<a name="windowGeometry-prop"></a><span class="name">windowGeometry</span> : <span class="type">rect</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the window geometry of the <a href="qwaylandxdgsurface.html">QWaylandXdgSurface</a>. The window geometry describes the window's visible bounds from the user's perspective. The geometry includes title bars and borders if drawn by the client, but excludes drop shadows. It is meant to be used for aligning and tiling windows.</p>
</div></div><!-- @@@windowGeometry -->
<br/>
<!-- $$$windowType -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="windowType-prop">
<td class="tblQmlPropNode"><p>
<a name="windowType-prop"></a><span class="name">windowType</span> : <span class="type">enum</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the window type of the <a href="qml-qtwayland-compositor-xdgsurface.html">XdgSurface</a>.</p>
</div></div><!-- @@@windowType -->
<br/>
<h2>Method Documentation</h2>
<!-- $$$initialize -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="initialize-method">
<td class="tblQmlFuncNode"><p>
<a name="initialize-method"></a><span class="type">void</span> <span class="name">initialize</span>(<span class="type">object</span> <i>xdgShell</i>,  <span class="type">object</span> <i>surface</i>,  <span class="type">object</span> <i>client</i>,  <span class="type">int</span> <i>id</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Initializes the <a href="qml-qtwayland-compositor-xdgsurface.html">XdgSurface</a>, associating it with the given <i>xdgShell</i>, <i>surface</i>, <i>client</i>, and <i>id</i>.</p>
</div></div><!-- @@@initialize -->
<br/>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</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>