<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qwaylandpointer.cpp -->
<title>QWaylandPointer 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 >QWaylandPointer</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">QWaylandPointer Class</h1>
<!-- $$$QWaylandPointer-brief -->
<p>The <a href="qwaylandpointer.html">QWaylandPointer</a> class represents a pointer device. <a href="#details">More...</a></p>
<!-- @@@QWaylandPointer -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QWaylandPointer></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><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> QWaylandObject</td></tr></table></div><ul>
<li><a href="qwaylandpointer-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="qwaylandpointer.html#isButtonPressed-prop">isButtonPressed</a></b> : const bool</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="qwaylandpointer.html#QWaylandPointer">QWaylandPointer</a></b>(QWaylandSeat *<i>seat</i>, QObject *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QWaylandCompositor *</td><td class="memItemRight bottomAlign"><b><a href="qwaylandpointer.html#compositor">compositor</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPointF </td><td class="memItemRight bottomAlign"><b><a href="qwaylandpointer.html#currentLocalPosition">currentLocalPosition</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPointF </td><td class="memItemRight bottomAlign"><b><a href="qwaylandpointer.html#currentSpacePosition">currentSpacePosition</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> wl_resource *</td><td class="memItemRight bottomAlign"><b><a href="qwaylandpointer.html#focusResource">focusResource</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qwaylandpointer.html#isButtonPressed">isButtonPressed</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QWaylandView *</td><td class="memItemRight bottomAlign"><b><a href="qwaylandpointer.html#mouseFocus">mouseFocus</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QWaylandOutput *</td><td class="memItemRight bottomAlign"><b><a href="qwaylandpointer.html#output">output</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QWaylandSeat *</td><td class="memItemRight bottomAlign"><b><a href="qwaylandpointer.html#seat">seat</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandpointer.html#sendMouseMoveEvent">sendMouseMoveEvent</a></b>(QWaylandView *<i>view</i>, const QPointF &<i>localPos</i>, const QPointF &<i>outputSpacePos</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual uint </td><td class="memItemRight bottomAlign"><b><a href="qwaylandpointer.html#sendMousePressEvent">sendMousePressEvent</a></b>(Qt::MouseButton <i>button</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual uint </td><td class="memItemRight bottomAlign"><b><a href="qwaylandpointer.html#sendMouseReleaseEvent">sendMouseReleaseEvent</a></b>(Qt::MouseButton <i>button</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandpointer.html#sendMouseWheelEvent">sendMouseWheelEvent</a></b>(Qt::Orientation <i>orientation</i>, int <i>delta</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandpointer.html#setOutput">setOutput</a></b>(QWaylandOutput *<i>output</i>)</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="qwaylandpointer.html#isButtonPressed-prop">buttonPressedChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandpointer.html#outputChanged">outputChanged</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"> const QMetaObject </td><td class="memItemRight bottomAlign"><b><a href="qwaylandpointer.html#staticMetaObject-var">staticMetaObject</a></b></td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QWaylandPointer-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qwaylandpointer.html">QWaylandPointer</a> class represents a pointer device.</p>
<p>This class provides access to the pointer device in a <a href="qwaylandseat.html">QWaylandSeat</a>. It corresponds to the Wayland interface wl_pointer.</p>
</div>
<!-- @@@QWaylandPointer -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$isButtonPressed-prop$$$isButtonPressed$$$buttonPressedChanged -->
<h3 class="fn" id="isButtonPressed-prop"><a name="isButtonPressed-prop"></a><span class="name">isButtonPressed</span> : const <span class="type">bool</span></h3>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qwaylandpointer.html#isButtonPressed">isButtonPressed</a></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>buttonPressedChanged</b></span>()</td></tr>
</table></div>
<!-- @@@isButtonPressed -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QWaylandPointer[overload1]$$$QWaylandPointerQWaylandSeat*QObject* -->
<h3 class="fn" id="QWaylandPointer"><a name="QWaylandPointer"></a>QWaylandPointer::<span class="name">QWaylandPointer</span>(<span class="type"><a href="qwaylandseat.html">QWaylandSeat</a></span> *<i>seat</i>, <span class="type">QObject</span> *<i>parent</i> = nullptr)</h3>
<p>Constructs a <a href="qwaylandpointer.html">QWaylandPointer</a> for the given <i>seat</i> and with the given <i>parent</i>.</p>
<!-- @@@QWaylandPointer -->
<!-- $$$compositor[overload1]$$$compositor -->
<h3 class="fn" id="compositor"><a name="compositor"></a><span class="type"><a href="qwaylandcompositor.html">QWaylandCompositor</a></span> *QWaylandPointer::<span class="name">compositor</span>() const</h3>
<p>Returns the compositor for this <a href="qwaylandpointer.html">QWaylandPointer</a>.</p>
<!-- @@@compositor -->
<!-- $$$currentLocalPosition[overload1]$$$currentLocalPosition -->
<h3 class="fn" id="currentLocalPosition"><a name="currentLocalPosition"></a><span class="type">QPointF</span> QWaylandPointer::<span class="name">currentLocalPosition</span>() const</h3>
<p>Returns the current local position of the <a href="qwaylandpointer.html">QWaylandPointer</a>.</p>
<!-- @@@currentLocalPosition -->
<!-- $$$currentSpacePosition[overload1]$$$currentSpacePosition -->
<h3 class="fn" id="currentSpacePosition"><a name="currentSpacePosition"></a><span class="type">QPointF</span> QWaylandPointer::<span class="name">currentSpacePosition</span>() const</h3>
<p>Returns the current output space position of the <a href="qwaylandpointer.html">QWaylandPointer</a>.</p>
<!-- @@@currentSpacePosition -->
<!-- $$$focusResource[overload1]$$$focusResource -->
<h3 class="fn" id="focusResource"><a name="focusResource"></a><span class="type">wl_resource</span> *QWaylandPointer::<span class="name">focusResource</span>() const</h3>
<p>Returns a Wayland resource for this <a href="qwaylandpointer.html">QWaylandPointer</a>.</p>
<p>This API doesn't actually make sense, since there may be many pointer resources per client It's here for compatibility reasons.</p>
<!-- @@@focusResource -->
<!-- $$$isButtonPressed -->
<h3 class="fn" id="isButtonPressed"><a name="isButtonPressed"></a><span class="type">bool</span> QWaylandPointer::<span class="name">isButtonPressed</span>() const</h3>
<p>Returns true if any button is currently pressed. Otherwise returns false.</p>
<p><b>Note:</b> Getter function for property <a href="qwaylandpointer.html#isButtonPressed-prop">isButtonPressed</a>. </p><!-- @@@isButtonPressed -->
<!-- $$$mouseFocus[overload1]$$$mouseFocus -->
<h3 class="fn" id="mouseFocus"><a name="mouseFocus"></a><span class="type"><a href="qwaylandview.html">QWaylandView</a></span> *QWaylandPointer::<span class="name">mouseFocus</span>() const</h3>
<p>Returns the view that currently holds mouse focus.</p>
<!-- @@@mouseFocus -->
<!-- $$$output[overload1]$$$output -->
<h3 class="fn" id="output"><a name="output"></a><span class="type"><a href="qwaylandoutput.html">QWaylandOutput</a></span> *QWaylandPointer::<span class="name">output</span>() const</h3>
<p>Returns the output for this <a href="qwaylandpointer.html">QWaylandPointer</a>.</p>
<p><b>See also </b><a href="qwaylandpointer.html#setOutput">setOutput</a>().</p>
<!-- @@@output -->
<!-- $$$outputChanged[overload1]$$$outputChanged -->
<h3 class="fn" id="outputChanged"><a name="outputChanged"></a><code>[signal] </code><span class="type">void</span> QWaylandPointer::<span class="name">outputChanged</span>()</h3>
<!-- @@@outputChanged -->
<!-- $$$seat[overload1]$$$seat -->
<h3 class="fn" id="seat"><a name="seat"></a><span class="type"><a href="qwaylandseat.html">QWaylandSeat</a></span> *QWaylandPointer::<span class="name">seat</span>() const</h3>
<p>Returns the input device for this <a href="qwaylandpointer.html">QWaylandPointer</a>.</p>
<!-- @@@seat -->
<!-- $$$sendMouseMoveEvent[overload1]$$$sendMouseMoveEventQWaylandView*constQPointF&constQPointF& -->
<h3 class="fn" id="sendMouseMoveEvent"><a name="sendMouseMoveEvent"></a><code>[virtual] </code><span class="type">void</span> QWaylandPointer::<span class="name">sendMouseMoveEvent</span>(<span class="type"><a href="qwaylandview.html">QWaylandView</a></span> *<i>view</i>, const <span class="type">QPointF</span> &<i>localPos</i>, const <span class="type">QPointF</span> &<i>outputSpacePos</i>)</h3>
<p>Sets the current mouse focus to <i>view</i> and sends a mouse move event to it with the local position <i>localPos</i> and output space position <i>outputSpacePos</i>.</p>
<!-- @@@sendMouseMoveEvent -->
<!-- $$$sendMousePressEvent[overload1]$$$sendMousePressEventQt::MouseButton -->
<h3 class="fn" id="sendMousePressEvent"><a name="sendMousePressEvent"></a><code>[virtual] </code><span class="type">uint</span> QWaylandPointer::<span class="name">sendMousePressEvent</span>(<span class="type">Qt::MouseButton</span> <i>button</i>)</h3>
<p>Sends a mouse press event for <i>button</i> to the view currently holding mouse focus.</p>
<p>Returns the serial number of the press event.</p>
<!-- @@@sendMousePressEvent -->
<!-- $$$sendMouseReleaseEvent[overload1]$$$sendMouseReleaseEventQt::MouseButton -->
<h3 class="fn" id="sendMouseReleaseEvent"><a name="sendMouseReleaseEvent"></a><code>[virtual] </code><span class="type">uint</span> QWaylandPointer::<span class="name">sendMouseReleaseEvent</span>(<span class="type">Qt::MouseButton</span> <i>button</i>)</h3>
<p>Sends a mouse release event for <i>button</i> to the view currently holding mouse focus.</p>
<p>Returns the serial number of the release event.</p>
<!-- @@@sendMouseReleaseEvent -->
<!-- $$$sendMouseWheelEvent[overload1]$$$sendMouseWheelEventQt::Orientationint -->
<h3 class="fn" id="sendMouseWheelEvent"><a name="sendMouseWheelEvent"></a><code>[virtual] </code><span class="type">void</span> QWaylandPointer::<span class="name">sendMouseWheelEvent</span>(<span class="type">Qt::Orientation</span> <i>orientation</i>, <span class="type">int</span> <i>delta</i>)</h3>
<p>Sends a mouse wheel event with the given <i>orientation</i> and <i>delta</i> to the view that currently holds mouse focus.</p>
<!-- @@@sendMouseWheelEvent -->
<!-- $$$setOutput[overload1]$$$setOutputQWaylandOutput* -->
<h3 class="fn" id="setOutput"><a name="setOutput"></a><span class="type">void</span> QWaylandPointer::<span class="name">setOutput</span>(<span class="type"><a href="qwaylandoutput.html">QWaylandOutput</a></span> *<i>output</i>)</h3>
<p>Sets the output for this <a href="qwaylandpointer.html">QWaylandPointer</a> to <i>output</i>.</p>
<p><b>See also </b><a href="qwaylandpointer.html#output">output</a>().</p>
<!-- @@@setOutput -->
</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>
