aboutsummaryrefslogtreecommitdiffstats
path: root/examples/quick/mousearea/doc/src/mousearea.qdoc
blob: 520644907b58cb4e6986c6822672c35e91eee15f (plain)
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
// Copyright (C) 2017 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
    \title Qt Quick Examples - MouseArea
    \example mousearea
    \brief This is an example of the MouseArea type in QML.
    \image qml-mousearea-example.png
    \ingroup qtquickexamples

    \e MouseArea example shows how to respond to clicks and drags with a
    \l MouseArea. For more information, visit
    \l{Important Concepts In Qt Quick - User Input}.

    \include examples-run.qdocinc

    \section1 MouseArea Behavior

    When you click inside the red square, the \l Text type will list several
    properties of that click which are available to QML. The opacity of the
    red square will be reduced while the mouse is pressed and remains inside
    the MouseArea.

    Signals are emitted by the MouseArea when clicks or other discrete
    operations occur within it.
    \snippet mousearea/mousearea.qml clicks

    \l MouseArea can also be used to drag items around. By setting the
    parameters of the drag property, the target item will be dragged around if
    the user starts to drag within the mouse area boundary.
    \snippet mousearea/mousearea.qml drag
*/