/usr/share/qt5/doc/qtquick/qml-qtquick-keynavigation.html is in qtdeclarative5-doc-html 5.2.1-3ubuntu15.
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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.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" />
<!-- qquickitem.cpp -->
<title>KeyNavigation | QtQuick 5.2</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.2</li>
<li><a href="qtquick-index.html">Qt Quick</a></li>
<li><a href="qtquick-qmltypereference.html">QML Types</a></li>
<li>KeyNavigation</li>
<li id="buildversion">
Qt 5.2.1 Reference Documentation</li>
</ul>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<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="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">KeyNavigation</h1>
<span class="subtitle"></span>
<!-- $$$KeyNavigation-brief -->
<p>Supports key navigation by arrow keys <a href="#details">More...</a></p>
<!-- @@@KeyNavigation -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> </b><tt>import QtQuick 2.2</tt></td></tr></table><ul>
<li><a href="qml-qtquick-keynavigation-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-qtquick-keynavigation.html#backtab-prop">backtab</a></b></b> : Item</li>
<li class="fn"><b><b><a href="qml-qtquick-keynavigation.html#down-prop">down</a></b></b> : Item</li>
<li class="fn"><b><b><a href="qml-qtquick-keynavigation.html#left-prop">left</a></b></b> : Item</li>
<li class="fn"><b><b><a href="qml-qtquick-keynavigation.html#priority-prop">priority</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-qtquick-keynavigation.html#right-prop">right</a></b></b> : Item</li>
<li class="fn"><b><b><a href="qml-qtquick-keynavigation.html#tab-prop">tab</a></b></b> : Item</li>
<li class="fn"><b><b><a href="qml-qtquick-keynavigation.html#up-prop">up</a></b></b> : Item</li>
</ul>
<!-- $$$KeyNavigation-description -->
<a name="details"></a>
<h2>Detailed Description</h2>
<p>Key-based user interfaces commonly allow the use of arrow keys to navigate between focusable items. The KeyNavigation attached property enables this behavior by providing a convenient way to specify the item that should gain focus when an arrow or tab key is pressed.</p>
<p>The following example provides key navigation for a 2x2 grid of items:</p>
<pre class="qml">import QtQuick 2.0
<span class="type"><a href="qml-qtquick-grid.html">Grid</a></span> {
<span class="name">width</span>: <span class="number">100</span>; <span class="name">height</span>: <span class="number">100</span>
<span class="name">columns</span>: <span class="number">2</span>
<span class="type"><a href="qml-qtquick-rectangle.html">Rectangle</a></span> {
<span class="name">id</span>: <span class="name">topLeft</span>
<span class="name">width</span>: <span class="number">50</span>; <span class="name">height</span>: <span class="number">50</span>
<span class="name">color</span>: <span class="name">focus</span> ? <span class="string">"red"</span> : <span class="string">"lightgray"</span>
<span class="name">focus</span>: <span class="number">true</span>
<span class="name">KeyNavigation</span>.right: <span class="name">topRight</span>
<span class="name">KeyNavigation</span>.down: <span class="name">bottomLeft</span>
}
<span class="type"><a href="qml-qtquick-rectangle.html">Rectangle</a></span> {
<span class="name">id</span>: <span class="name">topRight</span>
<span class="name">width</span>: <span class="number">50</span>; <span class="name">height</span>: <span class="number">50</span>
<span class="name">color</span>: <span class="name">focus</span> ? <span class="string">"red"</span> : <span class="string">"lightgray"</span>
<span class="name">KeyNavigation</span>.left: <span class="name">topLeft</span>
<span class="name">KeyNavigation</span>.down: <span class="name">bottomRight</span>
}
<span class="type"><a href="qml-qtquick-rectangle.html">Rectangle</a></span> {
<span class="name">id</span>: <span class="name">bottomLeft</span>
<span class="name">width</span>: <span class="number">50</span>; <span class="name">height</span>: <span class="number">50</span>
<span class="name">color</span>: <span class="name">focus</span> ? <span class="string">"red"</span> : <span class="string">"lightgray"</span>
<span class="name">KeyNavigation</span>.right: <span class="name">bottomRight</span>
<span class="name">KeyNavigation</span>.up: <span class="name">topLeft</span>
}
<span class="type"><a href="qml-qtquick-rectangle.html">Rectangle</a></span> {
<span class="name">id</span>: <span class="name">bottomRight</span>
<span class="name">width</span>: <span class="number">50</span>; <span class="name">height</span>: <span class="number">50</span>
<span class="name">color</span>: <span class="name">focus</span> ? <span class="string">"red"</span> : <span class="string">"lightgray"</span>
<span class="name">KeyNavigation</span>.left: <span class="name">bottomLeft</span>
<span class="name">KeyNavigation</span>.up: <span class="name">topRight</span>
}
}</pre>
<p>The top-left item initially receives focus by setting <a href="qml-qtquick-item.html#focus-prop">focus</a> to <tt>true</tt>. When an arrow key is pressed, the focus will move to the appropriate item, as defined by the value that has been set for the KeyNavigation <a href="qml-qtquick-keynavigation.html#left-prop">left</a>, <a href="qml-qtquick-keynavigation.html#right-prop">right</a>, <a href="qml-qtquick-keynavigation.html#up-prop">up</a> or <a href="qml-qtquick-keynavigation.html#down-prop">down</a> properties.</p>
<p>Note that if a KeyNavigation attached property receives the key press and release events for a requested arrow or tab key, the event is accepted and does not propagate any further.</p>
<p>By default, KeyNavigation receives key events after the item to which it is attached. If the item accepts the key event, the KeyNavigation attached property will not receive an event for that key. Setting the <a href="qml-qtquick-keynavigation.html#priority-prop">priority</a> property to <tt>KeyNavigation.BeforeItem</tt> allows the event to be used for key navigation before the item, rather than after.</p>
<p>If item to which the focus is switching is not enabled or visible, an attempt will be made to skip this item and focus on the next. This is possible if there are a chain of items with the same KeyNavigation handler. If multiple items in a row are not enabled or visible, they will also be skipped.</p>
<p>KeyNavigation will implicitly set the other direction to return focus to this item. So if you set <a href="qml-qtquick-keynavigation.html#left-prop">left</a> to another item, <a href="qml-qtquick-keynavigation.html#right-prop">right</a> will be set on that item's KeyNavigation to set focus back to this item. However, if that item's KeyNavigation has had right explicitly set then no change will occur. This means that the above example could have been written, with the same behaviour, without specifying KeyNavigation.right or KeyNavigation.down for any of the items.</p>
<p><b>See also </b><a href="qml-qtquick-keys.html">Keys attached property</a>.</p>
<!-- @@@KeyNavigation -->
<h2>Property Documentation</h2>
<!-- $$$backtab -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="backtab-prop"></a><span class="name">backtab</span> : <span class="type"><a href="qml-qtquick-item.html">Item</a></span></p></td></tr></table></div><div class="qmldoc"><p>These properties hold the item to assign focus to when the Tab key or Shift+Tab key combination (Backtab) are pressed.</p>
</div></div><!-- @@@backtab -->
<br/>
<!-- $$$down -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="down-prop"></a><span class="name">down</span> : <span class="type"><a href="qml-qtquick-item.html">Item</a></span></p></td></tr></table></div><div class="qmldoc"><p>These properties hold the item to assign focus to when the left, right, up or down cursor keys are pressed.</p>
</div></div><!-- @@@down -->
<br/>
<!-- $$$left -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="left-prop"></a><span class="name">left</span> : <span class="type"><a href="qml-qtquick-item.html">Item</a></span></p></td></tr></table></div><div class="qmldoc"><p>These properties hold the item to assign focus to when the left, right, up or down cursor keys are pressed.</p>
</div></div><!-- @@@left -->
<br/>
<!-- $$$priority -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="priority-prop"></a><span class="name">priority</span> : <span class="type">enumeration</span></p></td></tr></table></div><div class="qmldoc"><p>This property determines whether the keys are processed before or after the attached item's own key handling.</p>
<ul>
<li><a href="qml-qtquick-keynavigation.html">KeyNavigation</a>.BeforeItem - process the key events before normal item key processing. If the event is used for key navigation, it will be accepted and will not be passed on to the item.</li>
<li><a href="qml-qtquick-keynavigation.html">KeyNavigation</a>.AfterItem (default) - process the key events after normal item key handling. If the item accepts the key event it will not be handled by the <a href="qml-qtquick-keynavigation.html">KeyNavigation</a> attached property handler.</li>
</ul>
</div></div><!-- @@@priority -->
<br/>
<!-- $$$right -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="right-prop"></a><span class="name">right</span> : <span class="type"><a href="qml-qtquick-item.html">Item</a></span></p></td></tr></table></div><div class="qmldoc"><p>These properties hold the item to assign focus to when the left, right, up or down cursor keys are pressed.</p>
</div></div><!-- @@@right -->
<br/>
<!-- $$$tab -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="tab-prop"></a><span class="name">tab</span> : <span class="type"><a href="qml-qtquick-item.html">Item</a></span></p></td></tr></table></div><div class="qmldoc"><p>These properties hold the item to assign focus to when the Tab key or Shift+Tab key combination (Backtab) are pressed.</p>
</div></div><!-- @@@tab -->
<br/>
<!-- $$$up -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="up-prop"></a><span class="name">up</span> : <span class="type"><a href="qml-qtquick-item.html">Item</a></span></p></td></tr></table></div><div class="qmldoc"><p>These properties hold the item to assign focus to when the left, right, up or down cursor keys are pressed.</p>
</div></div><!-- @@@up -->
<br/>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2013 Digia Plc and/or its
subsidiaries. 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> Digia, Qt and their respective logos are trademarks of Digia Plc in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
|