File: qml-pincharea.html

package info (click to toggle)
qt4-x11 4%3A4.8.2%2Bdfsg-11
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 701,696 kB
  • sloc: cpp: 2,686,179; ansic: 375,485; python: 25,859; sh: 19,349; xml: 17,091; perl: 14,765; yacc: 5,383; asm: 5,038; makefile: 1,259; lex: 555; ruby: 526; objc: 347; cs: 112; pascal: 112; php: 54; sed: 34
file content (142 lines) | stat: -rw-r--r-- 11,318 bytes parent folder | download 
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
 
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qdeclarativepincharea.cpp -->
  <title>Qt 4.8: QML PinchArea Element</title>
  <link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="content"> 
    <a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
  </div>
  <div class="breadcrumb toolblock">
    <ul>
      <li class="first"><a href="index.html">Home</a></li>
      <!--  Breadcrumbs go here -->
<li><a href="qdeclarativeelements.html">QML Elements</a></li>
<li>QML PinchArea Element</li>
    </ul>
  </div>
</div>
<div class="content mainContent">
<p class="naviNextPrevious headerNavi">
</p><p/>
<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="#signal-handlers">Signal Handlers</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QML PinchArea Element</h1>
<span class="subtitle"></span>
<!-- $$$PinchArea-brief -->
<p>The PinchArea item enables simple pinch gesture handling. <a href="#details">More...</a></p>
<!-- @@@PinchArea -->
<p>Inherits <a href="qml-item.html">Item</a></p>
<ul>
<li><a href="qml-pincharea-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2>Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-pincharea.html#enabled-prop">enabled</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-pincharea.html#pinch.active-prop">pinch.active</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-pincharea.html#pinch.dragAxis-prop">pinch.dragAxis</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-pincharea.html#pinch.maximumRotation-prop">pinch.maximumRotation</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-pincharea.html#pinch.maximumScale-prop">pinch.maximumScale</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-pincharea.html#pinch.maximumX-prop">pinch.maximumX</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-pincharea.html#pinch.maximumY-prop">pinch.maximumY</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-pincharea.html#pinch.minimumRotation-prop">pinch.minimumRotation</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-pincharea.html#pinch.minimumScale-prop">pinch.minimumScale</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-pincharea.html#pinch.minimumX-prop">pinch.minimumX</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-pincharea.html#pinch.minimumY-prop">pinch.minimumY</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-pincharea.html#pinch.target-prop">pinch.target</a></b></b> : Item</li>
</ul>
<a name="signal-handlers"></a>
<h2>Signal Handlers</h2>
<ul>
<li class="fn"><b><b><a href="qml-pincharea.html#onPinchFinished-signal">onPinchFinished</a></b></b></li>
<li class="fn"><b><b><a href="qml-pincharea.html#onPinchStarted-signal">onPinchStarted</a></b></b></li>
<li class="fn"><b><b><a href="qml-pincharea.html#onPinchUpdated-signal">onPinchUpdated</a></b></b></li>
</ul>
<!-- $$$PinchArea-description -->
<a name="details"></a>
<h2>Detailed Description</h2>
<p><b>The PinchArea element was added in QtQuick 1.1</b></p>
<p>A PinchArea is an invisible item that is typically used in conjunction with a visible item in order to provide pinch gesture handling for that item.</p>
<p>The <a href="qml-pincharea.html#enabled-prop">enabled</a> property is used to enable and disable pinch handling for the proxied item. When disabled, the pinch area becomes transparent to mouse/touch events.</p>
<p>PinchArea can be used in two ways:</p>
<ul>
<li>setting a <tt>pinch.target</tt> to provide automatic interaction with an element</li>
<li>using the <a href="qml-pincharea.html#onPinchStarted-signal">onPinchStarted</a>, <a href="qml-pincharea.html#onPinchUpdated-signal">onPinchUpdated</a> and <a href="qml-pincharea.html#onPinchFinished-signal">onPinchFinished</a> handlers</li>
</ul>
<p><b>See also </b><a href="qml-pinchevent.html">PinchEvent</a>.</p>
<!-- @@@PinchArea -->
<h2>Property Documentation</h2>
<!-- $$$enabled -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="enabled-prop"></a><span class="name">enabled</span> : <span class="type"><a href="qml-bool.html">bool</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds whether the item accepts pinch gestures.</p>
<p>This property defaults to true.</p>
</div></div><!-- @@@enabled -->
<br/>
<!-- $$$pinch.target -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="pinch.target-prop"></a><span class="name">pinch.target</span> : <span class="type"><a href="qml-item.html">Item</a></span></p></td></tr><tr valign="top" class="even"><td class="tblQmlPropNode"><p><a name="pinch.active-prop"></a><span class="name">pinch.active</span> : <span class="type"><a href="qml-bool.html">bool</a></span></p></td></tr><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="pinch.minimumScale-prop"></a><span class="name">pinch.minimumScale</span> : <span class="type"><a href="qml-real.html">real</a></span></p></td></tr><tr valign="top" class="even"><td class="tblQmlPropNode"><p><a name="pinch.maximumScale-prop"></a><span class="name">pinch.maximumScale</span> : <span class="type"><a href="qml-real.html">real</a></span></p></td></tr><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="pinch.minimumRotation-prop"></a><span class="name">pinch.minimumRotation</span> : <span class="type"><a href="qml-real.html">real</a></span></p></td></tr><tr valign="top" class="even"><td class="tblQmlPropNode"><p><a name="pinch.maximumRotation-prop"></a><span class="name">pinch.maximumRotation</span> : <span class="type"><a href="qml-real.html">real</a></span></p></td></tr><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="pinch.dragAxis-prop"></a><span class="name">pinch.dragAxis</span> : <span class="type"><a href="qml-enumeration.html">enumeration</a></span></p></td></tr><tr valign="top" class="even"><td class="tblQmlPropNode"><p><a name="pinch.minimumX-prop"></a><span class="name">pinch.minimumX</span> : <span class="type"><a href="qml-real.html">real</a></span></p></td></tr><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="pinch.maximumX-prop"></a><span class="name">pinch.maximumX</span> : <span class="type"><a href="qml-real.html">real</a></span></p></td></tr><tr valign="top" class="even"><td class="tblQmlPropNode"><p><a name="pinch.minimumY-prop"></a><span class="name">pinch.minimumY</span> : <span class="type"><a href="qml-real.html">real</a></span></p></td></tr><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="pinch.maximumY-prop"></a><span class="name">pinch.maximumY</span> : <span class="type"><a href="qml-real.html">real</a></span></p></td></tr></table></div><div class="qmldoc"><p><tt>pinch</tt> provides a convenient way to make an item react to pinch gestures.</p>
<ul>
<li><tt>pinch.target</tt> specifies the id of the item to drag.</li>
<li><tt>pinch.active</tt> specifies if the target item is currently being dragged.</li>
<li><tt>pinch.minimumScale</tt> and <tt>pinch.maximumScale</tt> limit the range of the <a href="qml-item.html#scale-prop">Item::scale</a> property.</li>
<li><tt>pinch.minimumRotation</tt> and <tt>pinch.maximumRotation</tt> limit the range of the <a href="qml-item.html#rotation-prop">Item::rotation</a> property.</li>
<li><tt>pinch.dragAxis</tt> specifies whether dragging in not allowed (<tt>Pinch.NoDrag</tt>), can be done horizontally (<tt>Pinch.XAxis</tt>), vertically (<tt>Pinch.YAxis</tt>), or both (<tt>Pinch.XandYAxis</tt>)</li>
<li><tt>pinch.minimum</tt> and <tt>pinch.maximum</tt> limit how far the target can be dragged along the corresponding axes.</li>
</ul>
</div></div><!-- @@@pinch.target -->
<br/>
<h2>Signal Handler Documentation</h2>
<!-- $$$onPinchFinished -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="onPinchFinished-signal"></a>PinchArea::<span class="name">onPinchFinished</span> ()</p></td></tr></table></div><div class="qmldoc"><p>This handler is called when the pinch area detects that a pinch gesture has finished.</p>
<p>The <a href="qml-pinchevent.html">pinch</a> parameter provides information about the pinch gesture, including the scale, center and angle of the pinch.</p>
</div></div><!-- @@@onPinchFinished -->
<br/>
<!-- $$$onPinchStarted -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="onPinchStarted-signal"></a>PinchArea::<span class="name">onPinchStarted</span> ()</p></td></tr></table></div><div class="qmldoc"><p>This handler is called when the pinch area detects that a pinch gesture has started.</p>
<p>The <a href="qml-pinchevent.html">pinch</a> parameter provides information about the pinch gesture, including the scale, center and angle of the pinch.</p>
<p>To ignore this gesture set the <tt>pinch.accepted</tt> property to false. The gesture will be cancelled and no further events will be sent.</p>
</div></div><!-- @@@onPinchStarted -->
<br/>
<!-- $$$onPinchUpdated -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="onPinchUpdated-signal"></a>PinchArea::<span class="name">onPinchUpdated</span> ()</p></td></tr></table></div><div class="qmldoc"><p>This handler is called when the pinch area detects that a pinch gesture has changed.</p>
<p>The <a href="qml-pinchevent.html">pinch</a> parameter provides information about the pinch gesture, including the scale, center and angle of the pinch.</p>
</div></div><!-- @@@onPinchUpdated -->
<br/>
<p class="naviNextPrevious footerNavi">
</p>
  <div class="ft">
    <span></span>
  </div>
</div> 
<div class="footer">
    <p>
      <acronym title="Copyright">&copy;</acronym> 2012 Nokia Corporation and/or its
      subsidiaries. Documentation contributions included herein are the copyrights of
      their respective owners.</p>
    <br />
    <p>
      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.</p>
    <p>
      Documentation sources may be obtained from <a href="http://www.qt-project.org">
      www.qt-project.org</a>.</p>
    <br />
    <p>
      Nokia, Qt and their respective logos are trademarks of Nokia Corporation 
      in Finland and/or other countries worldwide. All other trademarks are property
      of their respective owners. <a title="Privacy Policy"
      href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
</body>
</html>