Sophie

Sophie

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

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" />
<!-- qwaylandwlshell.cpp -->
  <title>WlShellSurface 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 >WlShellSurface 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">WlShellSurface QML Type</h1>
<span class="subtitle"></span>
<!-- $$$WlShellSurface-brief -->
<p>Provides a <code>wl_shell_surface</code> that offers desktop-style compositor-specific features to a surface. <a href="#details">More...</a></p>
<!-- @@@WlShellSurface -->
<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></table></div><ul>
<li><a href="qml-qtwayland-compositor-wlshellsurface-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-wlshellsurface.html#className-prop">className</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtwayland-compositor-wlshellsurface.html#shell-prop">shell</a></b></b> : WlShell</li>
<li class="fn"><b><b><a href="qml-qtwayland-compositor-wlshellsurface.html#surface-prop">surface</a></b></b> : WaylandSurface</li>
<li class="fn"><b><b><a href="qml-qtwayland-compositor-wlshellsurface.html#title-prop">title</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtwayland-compositor-wlshellsurface.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-wlshellsurface.html#initialize-method">initialize</a></b></b>(WlShell <i>shell</i>,  WaylandSurface <i>surface</i>,  WaylandResource <i>resource</i>)</li>
<li class="fn">void <b><b><a href="qml-qtwayland-compositor-wlshellsurface.html#ping-method">ping</a></b></b>()</li>
<li class="fn">void <b><b><a href="qml-qtwayland-compositor-wlshellsurface.html#sendConfigure-method">sendConfigure</a></b></b>(size <i>s</i>,  enum <i>edges</i>)</li>
<li class="fn">void <b><b><a href="qml-qtwayland-compositor-wlshellsurface.html#sendPopupDone-method">sendPopupDone</a></b></b>()</li>
</ul>
<!-- $$$WlShellSurface-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>This type is part of the <a href="qml-qtwayland-compositor-wlshell.html">WlShell</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>wl_shell_surface</code>.</p>
<!-- @@@WlShellSurface -->
<h2>Property Documentation</h2>
<!-- $$$className -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="className-prop">
<td class="tblQmlPropNode"><p>
<a name="className-prop"></a><span class="name">className</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the class name of the <a href="qml-qtwayland-compositor-wlshellsurface.html">WlShellSurface</a>.</p>
</div></div><!-- @@@className -->
<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-wlshell.html">WlShell</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-wlshellsurface.html">WlShellSurface</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 <code>wl_surface</code> associated with this <a href="qml-qtwayland-compositor-wlshellsurface.html">WlShellSurface</a>.</p>
</div></div><!-- @@@surface -->
<br/>
<!-- $$$title -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="title-prop">
<td class="tblQmlPropNode"><p>
<a name="title-prop"></a><span class="name">title</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the title of the <a href="qml-qtwayland-compositor-wlshellsurface.html">WlShellSurface</a>.</p>
</div></div><!-- @@@title -->
<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-wlshellsurface.html">WlShellSurface</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"><a href="qml-qtwayland-compositor-wlshell.html">WlShell</a></span> <i>shell</i>,  <span class="type"><a href="qml-qtwayland-compositor-waylandsurface.html">WaylandSurface</a></span> <i>surface</i>,  <span class="type">WaylandResource</span> <i>resource</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Initializes the <a href="qml-qtwayland-compositor-wlshellsurface.html">WlShellSurface</a> and associates it with the given <i>shell</i>, <i>surface</i>, and <i>resource</i>.</p>
</div></div><!-- @@@initialize -->
<br/>
<!-- $$$ping -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="ping-method">
<td class="tblQmlFuncNode"><p>
<a name="ping-method"></a><span class="type">void</span> <span class="name">ping</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Sends a ping event to the client. If the client replies to the event the pong signal will be emitted.</p>
</div></div><!-- @@@ping -->
<br/>
<!-- $$$sendConfigure -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="sendConfigure-method">
<td class="tblQmlFuncNode"><p>
<a name="sendConfigure-method"></a><span class="type">void</span> <span class="name">sendConfigure</span>(<span class="type">size</span> <i>s</i>,  <span class="type">enum</span> <i>edges</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Sends a configure event to the client, suggesting that it resize its surface to the provided size <i>s</i>. The <i>edges</i> provide a hint about how the surface was resized.</p>
</div></div><!-- @@@sendConfigure -->
<br/>
<!-- $$$sendPopupDone -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="sendPopupDone-method">
<td class="tblQmlFuncNode"><p>
<a name="sendPopupDone-method"></a><span class="type">void</span> <span class="name">sendPopupDone</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Sends a popup_done event to the client to indicate that the user has clicked somewhere outside the client's surfaces.</p>
</div></div><!-- @@@sendPopupDone -->
<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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional