@@ -23,20 +23,12 @@
2323#include "Timer.h"
2424#include "ElapsedTimer.h"
2525
26−/*
27− Signals when the home key seems to be have been intentionally tapped.
28−
29− It only says the home key has been activated if it has been tapped in isolation,
30− that is, without being accompanied by touches on the screen. Home key taps that
31− happen along with (or immediately after, or immediately before) touches on the
32− screen are considered to have happened unintentionally and are thus ignored.
33−
34− Rationale being that it's easy to accidentally hit the home key while performing
35− a swipe from a screen edge, for instance. That's particularly the case when the
36− home key is a capacitive key.
37−
38− Additionally, this class monitors for generic touch events on the screen, to
39− help with hiding/revealing the mouse pointer.
26+/**
27+ * Monitors input events received by the window holding this item and the Home (Win aka Super_L)
28+ * key presses.
29+ *
30+ * Additionally, this class monitors for generic touch events on the screen, to
31+ * help with hiding/revealing the mouse pointer.
4032 */
4133class WindowInputMonitor : public QQuickItem
4234{
@@ -59,10 +51,29 @@ public:
5951 const qint64 msecsWithoutTouches = 150;
6052
6153Q_SIGNALS:
62− // Emitted when the home key has been intentionally tapped
54+ /**
55+ * Emitted when the home key has been intentionally tapped
56+ *
57+ * It only says the home key has been activated if it has been tapped in isolation,
58+ * that is, without being accompanied by touches on the screen. Home key taps that
59+ * happen along with (or immediately after, or immediately before) touches on the
60+ * screen are considered to have happened unintentionally and are thus ignored.
61+ *
62+ * Rationale being that it's easy to accidentally hit the home key while performing
63+ * a swipe from a screen edge, for instance. That's particularly the case when the
64+ * home key is a capacitive key.
65+ */
6366 void homeKeyActivated();
6467
68+ /**
69+ * Emitted when a touch begin event is detected
70+ */
6571 void touchBegun();
72+
73+ /**
74+ * Emitted when a touch end event is detected
75+ * @param pos the position in screen coordinates
76+ */
6677 void touchEnded(const QPointF &pos);
6778
6879private Q_SLOTS: