Sophie

Sophie

distrib > Mageia > 7 > armv7hl > media > core-release > by-pkgid > c936229ef0138f42857f36beadbeda30 > files > 255

qt3d5-doc-5.12.2-2.mga7.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qkeyevent.cpp -->
  <title>KeyEvent QML Type | Qt 3D 5.12.2</title>
  <link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
  <script type="text/javascript">
    document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
    // loading style sheet breaks anchors that were jumped to before
    // so force jumping to anchor again
    setTimeout(function() {
        var anchor = location.hash;
        // need to jump to different anchor first (e.g. none)
        location.hash = "#";
        setTimeout(function() {
            location.hash = anchor;
        }, 0);
    }, 0);
  </script>
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="main">
    <div class="main-rounded">
      <div class="navigationbar">
        <table><tr>
<td >Qt 5.12</td><td ><a href="qt3d-index.html">Qt 3D</a></td><td ><a href="qt3d-qml.html">QML Types</a></td><td >KeyEvent QML Type</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qt3d-index.html">Qt 5.12.2 Reference Documentation</a></td>
        </tr></table>
      </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="#methods">Methods</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">KeyEvent QML Type</h1>
<span class="subtitle"></span>
<!-- $$$KeyEvent-brief -->
<p>QML frontend for QKeyEvent C++ class. <a href="#details">More...</a></p>
<!-- @@@KeyEvent -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import Qt3D.Input 2.12</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign">  Qt 5.5</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiates:</td><td class="memItemRight bottomAlign"> <a href="qml-qt3d-input-keyevent.html"><a href="qt3dinput-qkeyevent.html">QKeyEvent</a></td></tr></table></div><ul>
<li><a href="qml-qt3d-input-keyevent-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-qt3d-input-keyevent.html#accepted-prop">accepted</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qt3d-input-keyevent.html#count-prop">count</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qt3d-input-keyevent.html#isAutoRepeat-prop">isAutoRepeat</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qt3d-input-keyevent.html#key-prop">key</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qt3d-input-keyevent.html#modifiers-prop">modifiers</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qt3d-input-keyevent.html#nativeScanCode-prop">nativeScanCode</a></b></b> : quint32</li>
<li class="fn"><b><b><a href="qml-qt3d-input-keyevent.html#text-prop">text</a></b></b> : string</li>
</ul>
<a name="methods"></a>
<h2 id="methods">Methods</h2>
<ul>
<li class="fn">bool <b><b><a href="qml-qt3d-input-keyevent.html#matches-method">matches</a></b></b>(StandardKey <i>key</i>)</li>
</ul>
<!-- $$$KeyEvent-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>The <a href="qml-qt3d-input-keyevent.html">KeyEvent</a> QML type cannot be directly created. Objects of this type are used as signal parameters in <a href="qml-qt3d-input-keyboardhandler.html">KeyboardHandler</a>.</p>
<!-- @@@KeyEvent -->
<h2>Property Documentation</h2>
<!-- $$$accepted -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="accepted-prop">
<td class="tblQmlPropNode"><p>
<a name="accepted-prop"></a><span class="name">accepted</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Setting <i>accepted</i> to <code>true</code> prevents the key event from being propagated to the item's parent.</p>
<p>Generally, if the item acts on the key event then it should be accepted so that ancestor items do not also respond to the same event.</p>
</div></div><!-- @@@accepted -->
<br/>
<!-- $$$count -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="count-prop">
<td class="tblQmlPropNode"><p>
<a name="count-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">count</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Holds the number of keys involved in this event. If <a href="qml-qt3d-input-keyevent.html#text-prop">text</a> is not empty, this is simply the length of the string.</p>
</div></div><!-- @@@count -->
<br/>
<!-- $$$isAutoRepeat -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="isAutoRepeat-prop">
<td class="tblQmlPropNode"><p>
<a name="isAutoRepeat-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">isAutoRepeat</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Holds whether this event comes from an auto-repeating key.</p>
</div></div><!-- @@@isAutoRepeat -->
<br/>
<!-- $$$key -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="key-prop">
<td class="tblQmlPropNode"><p>
<a name="key-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">key</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the code of the key that was pressed or released.</p>
<p>See Qt.Key for the list of keyboard codes.</p>
<p><b>See also </b>KeyEvent.key.</p>
</div></div><!-- @@@key -->
<br/>
<!-- $$$modifiers -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="modifiers-prop">
<td class="tblQmlPropNode"><p>
<a name="modifiers-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">modifiers</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the keyboard modifier flags that existed immediately before the event occurred.</p>
<p><b>See also </b>KeyEvent.modifiers.</p>
</div></div><!-- @@@modifiers -->
<br/>
<!-- $$$nativeScanCode -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="nativeScanCode-prop">
<td class="tblQmlPropNode"><p>
<a name="nativeScanCode-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">nativeScanCode</span> : <span class="type">quint32</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property contains the native scan code of the key that was pressed. It is passed through from QKeyEvent unchanged.</p>
<p><b>See also </b>QKeyEvent::nativeScanCode().</p>
</div></div><!-- @@@nativeScanCode -->
<br/>
<!-- $$$text -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="text-prop">
<td class="tblQmlPropNode"><p>
<a name="text-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">text</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the Unicode text that the key generated. The text returned can be an empty string in cases where modifier keys, such as Shift, Control, Alt, and Meta, are being pressed or released. In such cases <a href="qml-qt3d-input-keyevent.html#key-prop">key</a> will contain a valid value.</p>
</div></div><!-- @@@text -->
<br/>
<h2>Method Documentation</h2>
<!-- $$$matches -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="matches-method">
<td class="tblQmlFuncNode"><p>
<a name="matches-method"></a><span class="type">bool</span> <span class="name">matches</span>(<span class="type">StandardKey</span> <i>key</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Returns <code>true</code> if the key event matches the given standard key; otherwise returns <code>false</code>.</p>
<p><b>See also </b>QKeySequence::StandardKey.</p>
</div></div><!-- @@@matches -->
<br/>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2019 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>