/usr/include/KF5/KWayland/Client/pointergestures.h is in libkf5wayland-dev 4:5.44.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 | /****************************************************************************
Copyright 2016 Martin Gräßlin <mgraesslin@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) version 3, or any
later version accepted by the membership of KDE e.V. (or its
successor approved by the membership of KDE e.V.), which shall
act as a proxy defined in Section 6 of version 3 of the license.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library. If not, see <http://www.gnu.org/licenses/>.
****************************************************************************/
#ifndef KWAYLAND_CLIENT_POINTERGESTURES_H
#define KWAYLAND_CLIENT_POINTERGESTURES_H
#include <QObject>
#include <QPointer>
#include <KWayland/Client/kwaylandclient_export.h>
struct zwp_pointer_gestures_v1;
struct zwp_pointer_gesture_swipe_v1;
struct zwp_pointer_gesture_pinch_v1;
class QSizeF;
namespace KWayland
{
namespace Client
{
class EventQueue;
class PointerPinchGesture;
class Pointer;
class Surface;
class PointerSwipeGesture;
/**
* @short Wrapper for the zwp_pointer_gestures_v1 interface.
*
* This class provides a convenient wrapper for the zwp_pointer_gestures_v1 interface.
*
* To use this class one needs to interact with the Registry. There are two
* possible ways to create the PointerGestures interface:
* @code
* PointerGestures *c = registry->createPointerGestures(name, version);
* @endcode
*
* This creates the PointerGestures and sets it up directly. As an alternative this
* can also be done in a more low level way:
* @code
* PointerGestures *c = new PointerGestures;
* c->setup(registry->bindPointerGestures(name, version));
* @endcode
*
* The PointerGestures can be used as a drop-in replacement for any zwp_pointer_gestures_v1
* pointer as it provides matching cast operators.
*
* @see Registry
* @see PointerSwipeGesture
* @see PointerPinchGesture
* @since 5.29
**/
class KWAYLANDCLIENT_EXPORT PointerGestures : public QObject
{
Q_OBJECT
public:
/**
* Creates a new PointerGestures.
* Note: after constructing the PointerGestures it is not yet valid and one needs
* to call setup. In order to get a ready to use PointerGestures prefer using
* Registry::createPointerGestures.
**/
explicit PointerGestures(QObject *parent = nullptr);
virtual ~PointerGestures();
/**
* Setup this PointerGestures to manage the @p pointergestures.
* When using Registry::createPointerGestures there is no need to call this
* method.
**/
void setup(zwp_pointer_gestures_v1 *pointergestures);
/**
* @returns @c true if managing a zwp_pointer_gestures_v1.
**/
bool isValid() const;
/**
* Releases the zwp_pointer_gestures_v1 interface.
* After the interface has been released the PointerGestures instance is no
* longer valid and can be setup with another zwp_pointer_gestures_v1 interface.
**/
void release();
/**
* Destroys the data held by this PointerGestures.
* This method is supposed to be used when the connection to the Wayland
* server goes away. If the connection is not valid anymore, it's not
* possible to call release anymore as that calls into the Wayland
* connection and the call would fail. This method cleans up the data, so
* that the instance can be deleted or set up to a new zwp_pointer_gestures_v1 interface
* once there is a new connection available.
*
* This method is automatically invoked when the Registry which created this
* PointerGestures gets destroyed.
* @endcode
*
* @see release
**/
void destroy();
/**
* Sets the @p queue to use for creating objects with this PointerGestures.
**/
void setEventQueue(EventQueue *queue);
/**
* @returns The event queue to use for creating objects with this PointerGestures.
**/
EventQueue *eventQueue();
/**
* Creates a PointerSwipeGesture for the given @p pointer with the @p parent.
**/
PointerSwipeGesture *createSwipeGesture(Pointer *pointer, QObject *parent = nullptr);
/**
* Creates a PointerPinchGesture for the given @p pointer with the @p parent.
**/
PointerPinchGesture *createPinchGesture(Pointer *pointer, QObject *parent = nullptr);
operator zwp_pointer_gestures_v1*();
operator zwp_pointer_gestures_v1*() const;
Q_SIGNALS:
/**
* The corresponding global for this interface on the Registry got removed.
*
* This signal gets only emitted if the PointerGestures got created by
* Registry::createPointerGestures
**/
void removed();
private:
class Private;
QScopedPointer<Private> d;
};
/**
* This class is a wrapper for the zwp_pointer_gesture_swipe_v1 protocol.
*
* A PointerSwipeGesture object notifies a client about a multi-finger swipe
* gesture detected on an indirect input device such as a touchpad.
* The gesture is usually initiated by multiple fingers moving in the
* same direction but once initiated the direction may change.
* The precise conditions of when such a gesture is detected are
* implementation-dependent.
*
* A gesture consists of three stages: begin, update (optional) and end.
* There cannot be multiple simultaneous pinch or swipe gestures on the
* same pointer/seat, how compositors prevent these situations is
* implementation-dependent.
*
* A gesture may be cancelled by the compositor or the hardware.
* Clients should not consider performing permanent or irreversible
* actions until the end of a gesture has been received.
*
* @see PointerGestures
* @see PointerPinchGesture
* @since 5.29
**/
class KWAYLANDCLIENT_EXPORT PointerSwipeGesture : public QObject
{
Q_OBJECT
public:
virtual ~PointerSwipeGesture();
/**
* Setup this PointerSwipeGesture to manage the @p pointerswipegesture.
* When using PointerGestures::createPointerSwipeGesture there is no need to call this
* method.
**/
void setup(zwp_pointer_gesture_swipe_v1 *pointerswipegesture);
/**
* @returns @c true if managing a zwp_pointer_gesture_swipe_v1.
**/
bool isValid() const;
/**
* Releases the zwp_pointer_gesture_swipe_v1 interface.
* After the interface has been released the PointerSwipeGesture instance is no
* longer valid and can be setup with another zwp_pointer_gesture_swipe_v1 interface.
**/
void release();
/**
* Destroys the data held by this PointerSwipeGesture.
* This method is supposed to be used when the connection to the Wayland
* server goes away. If the connection is not valid anymore, it's not
* possible to call release anymore as that calls into the Wayland
* connection and the call would fail. This method cleans up the data, so
* that the instance can be deleted or set up to a new zwp_pointer_gesture_swipe_v1 interface
* once there is a new connection available.
*
* It is suggested to connect this method to ConnectionThread::connectionDied:
* @code
* connect(connection, &ConnectionThread::connectionDied, pointerswipegesture, &PointerSwipeGesture::destroy);
* @endcode
*
* @see release
**/
void destroy();
/**
* The number of fingers taking part in this gesture.
* If no gesture is in progress @c 0 is returned.
**/
quint32 fingerCount() const;
/**
* The Surface on which this gesture is performed.
* If no gesture is in progress the returned pointer is null.
**/
QPointer<Surface> surface() const;
operator zwp_pointer_gesture_swipe_v1*();
operator zwp_pointer_gesture_swipe_v1*() const;
Q_SIGNALS:
/**
* A gesture got started.
* @param serial Unique serial for this start gesture event.
* @param time Timestamp in milliseconds granularity
* @see updated
* @see ended
* @see cancelled
**/
void started(quint32 serial, quint32 time);
/**
* A gesture got updated.
* @param delta relative coordinates of the logical center of the gesture compared to the previous event
* @param time Timestamp in milliseconds granularity
* @see started
* @see ended
* @see cancelled
**/
void updated(const QSizeF &delta, quint32 time);
/**
* A gesture ended.
*
* @param serial Unique serial for this end gesture event.
* @param time Timestamp in milliseconds granularity
* @see started
* @see updated
* @see cancelled
**/
void ended(quint32 serial, quint32 time);
/**
* A gesture got cancelled by the Wayland compositor.
*
* @param serial Unique serial for this cancel gesture event.
* @param time Timestamp in milliseconds granularity
* @see started
* @see updated
* @see ended
**/
void cancelled(quint32 serial, quint32 time);
private:
friend class PointerGestures;
explicit PointerSwipeGesture(QObject *parent = nullptr);
class Private;
QScopedPointer<Private> d;
};
/**
* This class is a wrapper for the zwp_pointer_gesture_pinch_v1 protocol.
*
* A PointerPinchGesture object notifies a client about a multi-finger pinch
* gesture detected on an indirect input device such as a touchpad.
* The gesture is usually initiated by multiple fingers moving towards
* each other or away from each other, or by two or more fingers rotating
* around a logical center of gravity. The precise conditions of when
* such a gesture is detected are implementation-dependent.
*
* A gesture consists of three stages: begin, update (optional) and end.
* There cannot be multiple simultaneous pinch or swipe gestures on the
* same pointer/seat, how compositors prevent these situations is
* implementation-dependent.
*
* A gesture may be cancelled by the compositor or the hardware.
* Clients should not consider performing permanent or irreversible
* actions until the end of a gesture has been received.
*
* @see PointerGestures
* @see PointerSwipeGesture
* @since 5.29
**/
class KWAYLANDCLIENT_EXPORT PointerPinchGesture : public QObject
{
Q_OBJECT
public:
virtual ~PointerPinchGesture();
/**
* Setup this PointerPinchGesture to manage the @p pointerpinchgesture.
* When using PointerGestures::createPointerPinchGesture there is no need to call this
* method.
**/
void setup(zwp_pointer_gesture_pinch_v1 *pointerpinchgesture);
/**
* @returns @c true if managing a zwp_pointer_gesture_pinch_v1.
**/
bool isValid() const;
/**
* Releases the zwp_pointer_gesture_pinch_v1 interface.
* After the interface has been released the PointerPinchGesture instance is no
* longer valid and can be setup with another zwp_pointer_gesture_pinch_v1 interface.
**/
void release();
/**
* Destroys the data held by this PointerPinchGesture.
* This method is supposed to be used when the connection to the Wayland
* server goes away. If the connection is not valid anymore, it's not
* possible to call release anymore as that calls into the Wayland
* connection and the call would fail. This method cleans up the data, so
* that the instance can be deleted or set up to a new zwp_pointer_gesture_pinch_v1 interface
* once there is a new connection available.
*
* It is suggested to connect this method to ConnectionThread::connectionDied:
* @code
* connect(connection, &ConnectionThread::connectionDied, pointerpinchgesture, &PointerPinchGesture::destroy);
* @endcode
*
* @see release
**/
void destroy();
/**
* The number of fingers taking part in this gesture.
* If no gesture is in progress @c 0 is returned.
**/
quint32 fingerCount() const;
/**
* The Surface on which this gesture is performed.
* If no gesture is in progress the returned pointer is null.
**/
QPointer<Surface> surface() const;
operator zwp_pointer_gesture_pinch_v1*();
operator zwp_pointer_gesture_pinch_v1*() const;
Q_SIGNALS:
/**
* A gesture got started.
* @param serial Unique serial for this start gesture event.
* @param time Timestamp in milliseconds granularity
* @see updated
* @see ended
* @see cancelled
**/
void started(quint32 serial, quint32 time);
/**
* A gesture got updated.
* @param delta relative coordinates of the logical center of the gesture compared to the previous event
* @param scale an absolute scale compared to the start
* @param rotation relative angle in degrees clockwise compared to the previous start or update event.
* @param time Timestamp in milliseconds granularity
* @see started
* @see ended
* @see cancelled
**/
void updated(const QSizeF &delta, qreal scale, qreal rotation, quint32 time);
/**
* A gesture ended.
*
* @param serial Unique serial for this end gesture event.
* @param time Timestamp in milliseconds granularity
* @see started
* @see updated
* @see cancelled
**/
void ended(quint32 serial, quint32 time);
/**
* A gesture got cancelled by the Wayland compositor.
*
* @param serial Unique serial for this cancel gesture event.
* @param time Timestamp in milliseconds granularity
* @see started
* @see updated
* @see ended
**/
void cancelled(quint32 serial, quint32 time);
private:
friend class PointerGestures;
explicit PointerPinchGesture(QObject *parent = nullptr);
class Private;
QScopedPointer<Private> d;
};
}
}
#endif
|