<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qtwaylandcompositor-cpp.qdoc -->
<title>Qt Wayland Compositor C++ Classes | 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 >Qt Wayland Compositor C++ Classes</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="#classes">Classes</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">Qt Wayland Compositor C++ Classes</h1>
<span class="subtitle"></span>
<!-- $$$QtWaylandCompositor-brief -->
<p>Provides C++ classes for writing custom Wayland display servers. <a href="#details">More...</a></p>
<!-- @@@QtWaylandCompositor -->
<a name="classes"></a>
<h2 id="classes">Classes</h2>
<div class="table"><table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="qwaylandbufferref.html">QWaylandBufferRef</a></p></td><td class="tblDescr"><p>Holds the reference to a surface buffer</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qwaylandclient.html">QWaylandClient</a></p></td><td class="tblDescr"><p>Represents a client connecting to the QWaylandCompositor</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qwaylandcompositor.html">QWaylandCompositor</a></p></td><td class="tblDescr"><p>Manages the Wayland display server</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qwaylandiviapplication.html">QWaylandIviApplication</a></p></td><td class="tblDescr"><p>Extension for embedded-style user interfaces</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qwaylandivisurface.html">QWaylandIviSurface</a></p></td><td class="tblDescr"><p>Simple way to identify and resize a surface</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qwaylandkeyboard.html">QWaylandKeyboard</a></p></td><td class="tblDescr"><p>Represents a keyboard device</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qwaylandoutput.html">QWaylandOutput</a></p></td><td class="tblDescr"><p>Represents a displayable area managed by the compositor</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qwaylandoutputmode.html">QWaylandOutputMode</a></p></td><td class="tblDescr"><p>Holds the resolution and refresh rate of an output</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qwaylandpointer.html">QWaylandPointer</a></p></td><td class="tblDescr"><p>Represents a pointer device</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qwaylandquickitem.html">QWaylandQuickItem</a></p></td><td class="tblDescr"><p>Qt Quick item representing a QWaylandView</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qwaylandquickshellsurfaceitem.html">QWaylandQuickShellSurfaceItem</a></p></td><td class="tblDescr"><p>Qt Quick item that represents a QWaylandShellSurface</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qwaylandseat.html">QWaylandSeat</a></p></td><td class="tblDescr"><p>Access to keyboard, mouse, and touch input</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qwaylandshellsurface.html">QWaylandShellSurface</a></p></td><td class="tblDescr"><p>Common interface for surface roles specified by shell extensions</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qwaylandsurface.html">QWaylandSurface</a></p></td><td class="tblDescr"><p>Represents a rectangular area on an output device</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qwaylandsurfacegrabber.html">QWaylandSurfaceGrabber</a></p></td><td class="tblDescr"><p>Allows to read the content of a QWaylandSurface</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qwaylandtouch.html">QWaylandTouch</a></p></td><td class="tblDescr"><p>Access to a touch device</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qwaylandview.html">QWaylandView</a></p></td><td class="tblDescr"><p>Represents a view of a surface on an output</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qwaylandwlshell.html">QWaylandWlShell</a></p></td><td class="tblDescr"><p>Extension for desktop-style user interfaces</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qwaylandwlshellsurface.html">QWaylandWlShellSurface</a></p></td><td class="tblDescr"><p>Desktop-style compositor-specific features to a surface</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qwaylandxdgdecorationmanagerv1.html">QWaylandXdgDecorationManagerV1</a></p></td><td class="tblDescr"><p>Provides an extension for negotiation of server-side and client-side window decorations</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qwaylandxdgpopup.html">QWaylandXdgPopup</a></p></td><td class="tblDescr"><p>Represents the popup specific parts of an xdg surface</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qwaylandxdgpopupv6.html">QWaylandXdgPopupV6</a></p></td><td class="tblDescr"><p>Represents the popup specific parts of an xdg surface</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qwaylandxdgshell.html">QWaylandXdgShell</a></p></td><td class="tblDescr"><p>Extension for desktop-style user interfaces</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qwaylandxdgshellv6.html">QWaylandXdgShellV6</a></p></td><td class="tblDescr"><p>Extension for desktop-style user interfaces</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qwaylandxdgsurface.html">QWaylandXdgSurface</a></p></td><td class="tblDescr"><p>Desktop-style compositor-specific features to an xdg surface</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qwaylandxdgsurfacev6.html">QWaylandXdgSurfaceV6</a></p></td><td class="tblDescr"><p>Desktop-style compositor-specific features to an xdg surface</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qwaylandxdgtoplevel.html">QWaylandXdgToplevel</a></p></td><td class="tblDescr"><p>Represents the toplevel window specific parts of an xdg surface</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qwaylandxdgtoplevelv6.html">QWaylandXdgToplevelV6</a></p></td><td class="tblDescr"><p>Represents the toplevel window specific parts of an xdg surface</p></td></tr>
</table></div>
<!-- $$$QtWaylandCompositor-description -->
<a name="details"></a>
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>To include the definitions of the module's classes, use the following directive:</p>
<pre class="cpp">
<span class="preprocessor">#include <QtWaylandCompositor></span>
</pre>
<p>To link against the module, add this line to your qmake <code>.pro</code> file:</p>
<pre class="cpp">
QT <span class="operator">+</span><span class="operator">=</span> waylandcompositor
</pre>
<p>For more information about using these classes in your application, see the <a href="qtwaylandcompositor-index.html">Qt Wayland Compositor</a> documentation.</p>
</div>
<!-- @@@QtWaylandCompositor -->
</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>
