/usr/share/qt5/doc/qtlocation/qml-qtlocation-mapgesturearea.html is in qtlocation5-doc-html 5.5.1-3ubuntu1.
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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qdeclarativegeomapgesturearea.cpp -->
<title>MapGestureArea QML Type | Qt Location 5.5</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<ul>
<li>Qt 5.5</li>
<li><a href="qtlocation-index.html">Qt Location</a></li>
<li><a href="qtlocation-qmlmodule.html">QML Types</a></li>
<li>MapGestureArea QML Type</li>
<li id="buildversion">Qt 5.5.1 Reference Documentation</li>
</ul>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<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="#signals">Signals</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
<li class="level2"><a href="#performance">Performance</a></li>
<li class="level2"><a href="#example-usage">Example Usage</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">MapGestureArea QML Type</h1>
<span class="subtitle"></span>
<!-- $$$MapGestureArea-brief -->
<p>The <a href="qml-qtlocation-mapgesturearea.html">MapGestureArea</a> type provides Map gesture interaction. <a href="#details">More...</a></p>
<!-- @@@MapGestureArea -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtLocation 5.3</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt Location 5.0</td></tr></table></div><ul>
<li><a href="qml-qtlocation-mapgesturearea-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtlocation-mapgesturearea.html#activeGestures-prop">activeGestures</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-qtlocation-mapgesturearea.html#enabled-prop">enabled</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtlocation-mapgesturearea.html#flickDeceleration-prop">flickDeceleration</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtlocation-mapgesturearea.html#isPanActive-prop">isPanActive</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtlocation-mapgesturearea.html#isPinchActive-prop">isPinchActive</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtlocation-mapgesturearea.html#maximumZoomLevelChange-prop">maximumZoomLevelChange</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtlocation-mapgesturearea.html#panEnabled-prop">panEnabled</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtlocation-mapgesturearea.html#pinchEnabled-prop">pinchEnabled</a></b></b> : bool</li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtlocation-mapgesturearea.html#flickFinished-signal">flickFinished</a></b></b>()</li>
<li class="fn"><b><b><a href="qml-qtlocation-mapgesturearea.html#flickStarted-signal">flickStarted</a></b></b>()</li>
<li class="fn"><b><b><a href="qml-qtlocation-mapgesturearea.html#panFinished-signal">panFinished</a></b></b>()</li>
<li class="fn"><b><b><a href="qml-qtlocation-mapgesturearea.html#panStarted-signal">panStarted</a></b></b>()</li>
<li class="fn"><b><b><a href="qml-qtlocation-mapgesturearea.html#pinchFinished-signal">pinchFinished</a></b></b>(PinchEvent <i> event</i>)</li>
<li class="fn"><b><b><a href="qml-qtlocation-mapgesturearea.html#pinchStarted-signal">pinchStarted</a></b></b>(PinchEvent <i> event</i>)</li>
<li class="fn"><b><b><a href="qml-qtlocation-mapgesturearea.html#pinchUpdated-signal">pinchUpdated</a></b></b>(PinchEvent <i> event</i>)</li>
</ul>
<!-- $$$MapGestureArea-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<p><a href="qml-qtlocation-mapgesturearea.html">MapGestureArea</a> objects are used as part of a Map, to provide for panning, flicking and pinch-to-zoom gesture used on touch displays.</p>
<p>A <a href="qml-qtlocation-mapgesturearea.html">MapGestureArea</a> is automatically created with a new Map and available with the <a href="qml-qtlocation-map.html#gesture-prop">gesture</a> property. This is the only way to create a <a href="qml-qtlocation-mapgesturearea.html">MapGestureArea</a>, and once created this way cannot be destroyed without its parent Map.</p>
<p>The two most commonly used properties of the <a href="qml-qtlocation-mapgesturearea.html">MapGestureArea</a> are the <a href="qml-qtlocation-mapgesturearea.html#enabled-prop">enabled</a> and <a href="qml-qtlocation-mapgesturearea.html#activeGestures-prop">activeGestures</a> properties. Both of these must be set before a <a href="qml-qtlocation-mapgesturearea.html">MapGestureArea</a> will have any effect upon interaction with the Map. The <a href="qml-qtlocation-mapgesturearea.html#flickDeceleration-prop">flickDeceleration</a> property controls how quickly the map pan slows after contact is released while panning the map.</p>
<a name="performance"></a>
<h3 >Performance</h3>
<p>The <a href="qml-qtlocation-mapgesturearea.html">MapGestureArea</a>, when enabled, must process all incoming touch events in order to track the shape and size of the "pinch". The overhead added on touch events can be considered constant time.</p>
<a name="example-usage"></a>
<h3 >Example Usage</h3>
<p>The following example enables the zoom and pan gestures on the map, but not flicking. So the map scrolling will halt immediately on releasing the mouse button / touch.</p>
<pre class="cpp">Map {
gesture<span class="operator">.</span>enabled: <span class="keyword">true</span>
gesture<span class="operator">.</span>activeGestures: MapGestureArea<span class="operator">.</span>ZoomGesture <span class="operator">|</span> MapGestureArea<span class="operator">.</span>PanGesture
}</pre>
<!-- @@@MapGestureArea -->
<h2>Property Documentation</h2>
<!-- $$$activeGestures -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="activeGestures-prop"><td class="tblQmlPropNode"><p><a name="activeGestures-prop"></a><span class="name">activeGestures</span> : <span class="type">enumeration</span></p></td></tr></table></div></div><div class="qmldoc"><p>This property holds the gestures that will be active. By default the zoom, pan and flick gestures are enabled.</p>
<ul>
<li><a href="qml-qtlocation-mapgesturearea.html">MapGestureArea</a>.NoGesture - Don't support any additional gestures (value: 0x0000).</li>
<li><a href="qml-qtlocation-mapgesturearea.html">MapGestureArea</a>.ZoomGesture - Support the map zoom gesture (value: 0x0001).</li>
<li><a href="qml-qtlocation-mapgesturearea.html">MapGestureArea</a>.PanGesture - Support the map pan gesture (value: 0x0002).</li>
<li><a href="qml-qtlocation-mapgesturearea.html">MapGestureArea</a>.FlickGesture - Support the map flick gesture (value: 0x0004).</li>
</ul>
</div></div><!-- @@@activeGestures -->
<br/>
<!-- $$$enabled -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="enabled-prop"><td class="tblQmlPropNode"><p><a name="enabled-prop"></a><span class="name">enabled</span> : <span class="type">bool</span></p></td></tr></table></div></div><div class="qmldoc"><p>This property holds whether the gestures are enabled. Note: disabling gestures during an active gesture does not have effect on the potentially active current gesture.</p>
</div></div><!-- @@@enabled -->
<br/>
<!-- $$$flickDeceleration -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="flickDeceleration-prop"><td class="tblQmlPropNode"><p><a name="flickDeceleration-prop"></a><span class="name">flickDeceleration</span> : <span class="type">real</span></p></td></tr></table></div></div><div class="qmldoc"><p>This property holds the rate at which a flick will decelerate.</p>
<p>The default value is 2500.</p>
</div></div><!-- @@@flickDeceleration -->
<br/>
<!-- $$$isPanActive -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="isPanActive-prop"><td class="tblQmlPropNode"><p><a name="isPanActive-prop"></a><span class="name">isPanActive</span> : <span class="type">bool</span></p></td></tr></table></div></div><div class="qmldoc"><p>This read-only property holds whether any pan gesture (panning or flicking) is active.</p>
<p><b>Note: </b>Change notifications for this property were introduced in Qt 5.5.</p></div></div><!-- @@@isPanActive -->
<br/>
<!-- $$$isPinchActive -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="isPinchActive-prop"><td class="tblQmlPropNode"><p><a name="isPinchActive-prop"></a><span class="name">isPinchActive</span> : <span class="type">bool</span></p></td></tr></table></div></div><div class="qmldoc"><p>This read-only property holds whether any pinch gesture is active.</p>
</div></div><!-- @@@isPinchActive -->
<br/>
<!-- $$$maximumZoomLevelChange -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="maximumZoomLevelChange-prop"><td class="tblQmlPropNode"><p><a name="maximumZoomLevelChange-prop"></a><span class="name">maximumZoomLevelChange</span> : <span class="type">real</span></p></td></tr></table></div></div><div class="qmldoc"><p>This property holds the maximum zoom level change per pinch, essentially meant to be used for setting the zoom sensitivity.</p>
<p>It is an indicative measure calculated from the dimensions of the map area, roughly corresponding how much zoom level could change with maximum pinch zoom. Default value is 4.0, maximum value is 10.0</p>
</div></div><!-- @@@maximumZoomLevelChange -->
<br/>
<!-- $$$panEnabled -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="panEnabled-prop"><td class="tblQmlPropNode"><p><a name="panEnabled-prop"></a><span class="name">panEnabled</span> : <span class="type">bool</span></p></td></tr></table></div></div><div class="qmldoc"><p>This property holds whether the pan gestures are enabled. Note: disabling gestures during an active gesture does not have effect on the potentially active current gesture.</p>
</div></div><!-- @@@panEnabled -->
<br/>
<!-- $$$pinchEnabled -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="pinchEnabled-prop"><td class="tblQmlPropNode"><p><a name="pinchEnabled-prop"></a><span class="name">pinchEnabled</span> : <span class="type">bool</span></p></td></tr></table></div></div><div class="qmldoc"><p>This property holds whether the pinch gestures are enabled. Note: disabling gestures during an active gesture does not have effect on the potentially active current gesture.</p>
</div></div><!-- @@@pinchEnabled -->
<br/>
<h2>Signal Documentation</h2>
<!-- $$$flickFinished -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="flickFinished-signal"><td class="tblQmlFuncNode"><p><a name="flickFinished-signal"></a><span class="name">flickFinished</span>()</p></td></tr></table></div></div><div class="qmldoc"><p>This signal is emitted when the view stops moving due to a flick. The order of panFinished() and flickFinished() is not specified.</p>
<p>The corresponding handler is <code>onFlickFinished</code>.</p>
</div></div><!-- @@@flickFinished -->
<br/>
<!-- $$$flickStarted -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="flickStarted-signal"><td class="tblQmlFuncNode"><p><a name="flickStarted-signal"></a><span class="name">flickStarted</span>()</p></td></tr></table></div></div><div class="qmldoc"><p>This signal is emitted when the view is flicked. A flick starts from the point that the mouse or touch is released, while still in motion.</p>
<p>The corresponding handler is <code>onFlichStarted</code>.</p>
</div></div><!-- @@@flickStarted -->
<br/>
<!-- $$$panFinished -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="panFinished-signal"><td class="tblQmlFuncNode"><p><a name="panFinished-signal"></a><span class="name">panFinished</span>()</p></td></tr></table></div></div><div class="qmldoc"><p>This signal is emitted when the view stops moving due to user interaction. If a flick was generated, this signal is emitted when the flick stops. If a flick was not generated, this signal is emitted when the user stops dragging - that is a mouse or touch release.</p>
<p>The corresponding handler is <code>onPanFinished</code>.</p>
</div></div><!-- @@@panFinished -->
<br/>
<!-- $$$panStarted -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="panStarted-signal"><td class="tblQmlFuncNode"><p><a name="panStarted-signal"></a><span class="name">panStarted</span>()</p></td></tr></table></div></div><div class="qmldoc"><p>This signal is emitted when the view begins moving due to user interaction. Typically this means that the user is dragging a finger - or a mouse with one of more mouse buttons pressed - on the map.</p>
<p>The corresponding handler is <code>onPanStarted</code>.</p>
</div></div><!-- @@@panStarted -->
<br/>
<!-- $$$pinchFinished -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="pinchFinished-signal"><td class="tblQmlFuncNode"><p><a name="pinchFinished-signal"></a><span class="name">pinchFinished</span>(<span class="type">PinchEvent</span><i> event</i>)</p></td></tr></table></div></div><div class="qmldoc"><p>This signal is emitted at the end of a pinch gesture.</p>
<p>The corresponding handler is <code>onPinchFinished</code>.</p>
<p><b>See also </b><a href="qml-qtlocation-mapgesturearea.html#pinchStarted-signal">pinchStarted</a> and <a href="qml-qtlocation-mapgesturearea.html#pinchUpdated-signal">pinchUpdated</a>.</p>
</div></div><!-- @@@pinchFinished -->
<br/>
<!-- $$$pinchStarted -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="pinchStarted-signal"><td class="tblQmlFuncNode"><p><a name="pinchStarted-signal"></a><span class="name">pinchStarted</span>(<span class="type">PinchEvent</span><i> event</i>)</p></td></tr></table></div></div><div class="qmldoc"><p>This signal is emitted when a pinch gesture is started.</p>
<p>The corresponding handler is <code>onPinchStarted</code>.</p>
<p><b>See also </b><a href="qml-qtlocation-mapgesturearea.html#pinchUpdated-signal">pinchUpdated</a> and <a href="qml-qtlocation-mapgesturearea.html#pinchFinished-signal">pinchFinished</a>.</p>
</div></div><!-- @@@pinchStarted -->
<br/>
<!-- $$$pinchUpdated -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="pinchUpdated-signal"><td class="tblQmlFuncNode"><p><a name="pinchUpdated-signal"></a><span class="name">pinchUpdated</span>(<span class="type">PinchEvent</span><i> event</i>)</p></td></tr></table></div></div><div class="qmldoc"><p>This signal is emitted as the user's fingers move across the map, after the <a href="qml-qtlocation-mapgesturearea.html#pinchStarted-signal">pinchStarted</a> signal is emitted.</p>
<p>The corresponding handler is <code>onPinchUpdated</code>.</p>
<p><b>See also </b><a href="qml-qtlocation-mapgesturearea.html#pinchStarted-signal">pinchStarted</a> and <a href="qml-qtlocation-mapgesturearea.html#pinchFinished-signal">pinchFinished</a>.</p>
</div></div><!-- @@@pinchUpdated -->
<br/>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2015 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br> 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.<br> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
|