aboutsummaryrefslogtreecommitdiffstats
path: root/examples/quick/mousearea/doc/src/mousearea.qdoc
blob: 827e5497ee88eb7bdc66fbc4ca5bd72f0de46aaf (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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
/****************************************************************************
**
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file.  Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: http://www.gnu.org/copyleft/fdl.html.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
    \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.

    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
*/