<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qwaylandivisurface.cpp -->
<title>QWaylandIviSurface 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 >QWaylandIviSurface</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="#signals">Signals</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</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">QWaylandIviSurface Class</h1>
<!-- $$$QWaylandIviSurface-brief -->
<p>The <a href="qwaylandivisurface.html">QWaylandIviSurface</a> class provides a simple way to identify and resize a surface. <a href="#details">More...</a></p>
<!-- @@@QWaylandIviSurface -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QWaylandIviSurface></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></table></div><ul>
<li><a href="qwaylandivisurface-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><a href="qwaylandivisurface.html#iviId-prop">iviId</a></b> : const uint</li>
<li class="fn"><b><a href="qwaylandivisurface.html#surface-prop">surface</a></b> : QWaylandSurface* const</li>
</ul>
<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="qwaylandivisurface.html#QWaylandIviSurface">QWaylandIviSurface</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qwaylandivisurface.html#QWaylandIviSurface-1">QWaylandIviSurface</a></b>(QWaylandIviApplication *<i>application</i>, QWaylandSurface *<i>surface</i>, uint <i>iviId</i>, const QWaylandResource &<i>resource</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QWaylandQuickShellIntegration *</td><td class="memItemRight bottomAlign"><b><a href="qwaylandivisurface.html#createIntegration">createIntegration</a></b>(QWaylandQuickShellSurfaceItem *<i>item</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QQmlListProperty<QObject> </td><td class="memItemRight bottomAlign"><b><a href="qwaylandivisurface.html#data">data</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandivisurface.html#initialize">initialize</a></b>(QWaylandIviApplication *<i>iviApplication</i>, QWaylandSurface *<i>surface</i>, uint <i>iviId</i>, const QWaylandResource &<i>resource</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> uint </td><td class="memItemRight bottomAlign"><b><a href="qwaylandivisurface.html#iviId-prop">iviId</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandivisurface.html#sendConfigure">sendConfigure</a></b>(const QSize &<i>size</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QWaylandSurface *</td><td class="memItemRight bottomAlign"><b><a href="qwaylandivisurface.html#surface-prop">surface</a></b>() const</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="qwaylandivisurface.html#iviId-prop">iviIdChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandivisurface.html#surface-prop">surfaceChanged</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"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandivisurface.html#appendFunction">appendFunction</a></b>(QQmlListProperty<QObject> *<i>list</i>, QObject *<i>object</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QObject *</td><td class="memItemRight bottomAlign"><b><a href="qwaylandivisurface.html#atFunction">atFunction</a></b>(QQmlListProperty<QObject> *<i>list</i>, int <i>index</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandivisurface.html#clearFunction">clearFunction</a></b>(QQmlListProperty<QObject> *<i>list</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qwaylandivisurface.html#countFunction">countFunction</a></b>(QQmlListProperty<QObject> *<i>list</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QWaylandIviSurface *</td><td class="memItemRight bottomAlign"><b><a href="qwaylandivisurface.html#fromResource">fromResource</a></b>(::wl_resource *<i>resource</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const struct wl_interface *</td><td class="memItemRight bottomAlign"><b><a href="qwaylandivisurface.html#interface">interface</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QByteArray </td><td class="memItemRight bottomAlign"><b><a href="qwaylandivisurface.html#interfaceName">interfaceName</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QWaylandSurfaceRole *</td><td class="memItemRight bottomAlign"><b><a href="qwaylandivisurface.html#role">role</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QMetaObject </td><td class="memItemRight bottomAlign"><b><a href="qwaylandivisurface.html#staticMetaObject-var">staticMetaObject</a></b></td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QWaylandIviSurface-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qwaylandivisurface.html">QWaylandIviSurface</a> class provides a simple way to identify and resize a surface.</p>
<p>This class is part of the <a href="qwaylandiviapplication.html">QWaylandIviApplication</a> extension and provides a way to extend the functionality of an existing <a href="qwaylandsurface.html">QWaylandSurface</a> with a way to resize and identify it.</p>
<p>It corresponds to the Wayland <code>ivi_surface</code> interface.</p>
</div>
<!-- @@@QWaylandIviSurface -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$iviId-prop$$$iviId$$$iviIdChanged -->
<h3 class="fn" id="iviId-prop"><a name="iviId-prop"></a><span class="name">iviId</span> : const <span class="type">uint</span></h3>
<p>This property holds the ivi id of this <a href="qwaylandivisurface.html">QWaylandIviSurface</a>.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> uint </td><td class="memItemRight bottomAlign"><span class="name"><b>iviId</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>iviIdChanged</b></span>()</td></tr>
</table></div>
<!-- @@@iviId -->
<!-- $$$surface-prop$$$surface$$$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>* const</h3>
<p>This property holds the surface associated with this <a href="qwaylandivisurface.html">QWaylandIviSurface</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>
</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 -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QWaylandIviSurface[overload1]$$$QWaylandIviSurface -->
<h3 class="fn" id="QWaylandIviSurface"><a name="QWaylandIviSurface"></a>QWaylandIviSurface::<span class="name">QWaylandIviSurface</span>()</h3>
<p>Constructs a <a href="qwaylandivisurface.html">QWaylandIviSurface</a>.</p>
<!-- @@@QWaylandIviSurface -->
<!-- $$$QWaylandIviSurface$$$QWaylandIviSurfaceQWaylandIviApplication*QWaylandSurface*uintconstQWaylandResource& -->
<h3 class="fn" id="QWaylandIviSurface-1"><a name="QWaylandIviSurface-1"></a>QWaylandIviSurface::<span class="name">QWaylandIviSurface</span>(<span class="type"><a href="qwaylandiviapplication.html">QWaylandIviApplication</a></span> *<i>application</i>, <span class="type"><a href="qwaylandsurface.html">QWaylandSurface</a></span> *<i>surface</i>, <span class="type">uint</span> <i>iviId</i>, const <span class="type">QWaylandResource</span> &<i>resource</i>)</h3>
<p>Constructs a <a href="qwaylandivisurface.html">QWaylandIviSurface</a> for <i>surface</i> and initializes it with the given <i>application</i>, <i>surface</i>, <i>iviId</i>, and <i>resource</i>.</p>
<!-- @@@QWaylandIviSurface -->
<!-- $$$appendFunction[overload1]$$$appendFunctionQQmlListProperty<QObject>*QObject* -->
<h3 class="fn" id="appendFunction"><a name="appendFunction"></a><code>[static] </code><span class="type">void</span> QWaylandIviSurface::<span class="name">appendFunction</span>(<span class="type">QQmlListProperty</span><<span class="type">QObject</span>> *<i>list</i>, <span class="type">QObject</span> *<i>object</i>)</h3>
<!-- @@@appendFunction -->
<!-- $$$atFunction[overload1]$$$atFunctionQQmlListProperty<QObject>*int -->
<h3 class="fn" id="atFunction"><a name="atFunction"></a><code>[static] </code><span class="type">QObject</span> *QWaylandIviSurface::<span class="name">atFunction</span>(<span class="type">QQmlListProperty</span><<span class="type">QObject</span>> *<i>list</i>, <span class="type">int</span> <i>index</i>)</h3>
<!-- @@@atFunction -->
<!-- $$$clearFunction[overload1]$$$clearFunctionQQmlListProperty<QObject>* -->
<h3 class="fn" id="clearFunction"><a name="clearFunction"></a><code>[static] </code><span class="type">void</span> QWaylandIviSurface::<span class="name">clearFunction</span>(<span class="type">QQmlListProperty</span><<span class="type">QObject</span>> *<i>list</i>)</h3>
<!-- @@@clearFunction -->
<!-- $$$countFunction[overload1]$$$countFunctionQQmlListProperty<QObject>* -->
<h3 class="fn" id="countFunction"><a name="countFunction"></a><code>[static] </code><span class="type">int</span> QWaylandIviSurface::<span class="name">countFunction</span>(<span class="type">QQmlListProperty</span><<span class="type">QObject</span>> *<i>list</i>)</h3>
<!-- @@@countFunction -->
<!-- $$$createIntegration[overload1]$$$createIntegrationQWaylandQuickShellSurfaceItem* -->
<h3 class="fn" id="createIntegration"><a name="createIntegration"></a><span class="type">QWaylandQuickShellIntegration</span> *QWaylandIviSurface::<span class="name">createIntegration</span>(<span class="type"><a href="qwaylandquickshellsurfaceitem.html">QWaylandQuickShellSurfaceItem</a></span> *<i>item</i>)</h3>
<!-- @@@createIntegration -->
<!-- $$$data[overload1]$$$data -->
<h3 class="fn" id="data"><a name="data"></a><span class="type">QQmlListProperty</span><<span class="type">QObject</span>> QWaylandIviSurface::<span class="name">data</span>()</h3>
<!-- @@@data -->
<!-- $$$fromResource[overload1]$$$fromResource::wl_resource* -->
<h3 class="fn" id="fromResource"><a name="fromResource"></a><code>[static] </code><span class="type"><a href="qwaylandivisurface.html#QWaylandIviSurface">QWaylandIviSurface</a></span> *QWaylandIviSurface::<span class="name">fromResource</span>(<span class="type">::wl_resource</span> *<i>resource</i>)</h3>
<p>Returns the <a href="qwaylandivisurface.html">QWaylandIviSurface</a> corresponding to the <i>resource</i>.</p>
<!-- @@@fromResource -->
<!-- $$$initialize[overload1]$$$initializeQWaylandIviApplication*QWaylandSurface*uintconstQWaylandResource& -->
<h3 class="fn" id="initialize"><a name="initialize"></a><span class="type">void</span> QWaylandIviSurface::<span class="name">initialize</span>(<span class="type"><a href="qwaylandiviapplication.html">QWaylandIviApplication</a></span> *<i>iviApplication</i>, <span class="type"><a href="qwaylandsurface.html">QWaylandSurface</a></span> *<i>surface</i>, <span class="type">uint</span> <i>iviId</i>, const <span class="type">QWaylandResource</span> &<i>resource</i>)</h3>
<p>Initializes the <a href="qwaylandivisurface.html">QWaylandIviSurface</a>, associating it with the given <i>iviApplication</i>, <i>surface</i>, <i>iviId</i>, and <i>resource</i>.</p>
<p><b>Note: </b>This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.</p>
<!-- @@@initialize -->
<!-- $$$interface[overload1]$$$interface -->
<h3 class="fn" id="interface"><a name="interface"></a><code>[static] </code>const <span class="type">struct</span> <span class="type">wl_interface</span> *QWaylandIviSurface::<span class="name">interface</span>()</h3>
<p>Returns the Wayland interface for the <a href="qwaylandivisurface.html">QWaylandIviSurface</a>.</p>
<!-- @@@interface -->
<!-- $$$interfaceName[overload1]$$$interfaceName -->
<h3 class="fn" id="interfaceName"><a name="interfaceName"></a><code>[static] </code><span class="type">QByteArray</span> QWaylandIviSurface::<span class="name">interfaceName</span>()</h3>
<!-- @@@interfaceName -->
<!-- $$$role[overload1]$$$role -->
<h3 class="fn" id="role"><a name="role"></a><code>[static] </code><span class="type">QWaylandSurfaceRole</span> *QWaylandIviSurface::<span class="name">role</span>()</h3>
<p>Returns the surface role for the <a href="qwaylandivisurface.html">QWaylandIviSurface</a>.</p>
<!-- @@@role -->
<!-- $$$sendConfigure[overload1]$$$sendConfigureconstQSize& -->
<h3 class="fn" id="sendConfigure"><a name="sendConfigure"></a><span class="type">void</span> QWaylandIviSurface::<span class="name">sendConfigure</span>(const <span class="type">QSize</span> &<i>size</i>)</h3>
<p>Sends a configure event to the client, telling it to resize the surface to the given <i>size</i>.</p>
<p><b>Note: </b>This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.</p>
<!-- @@@sendConfigure -->
</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>
distrib
>
Mageia
>
7
>
i586
>
media
>
core-updates
>
by-pkgid
>
f171b9b27b527f95603e88add5c7e1b6
>
files
>
154
