Sophie

Sophie

distrib > Mageia > 7 > i586 > by-pkgid > c936229ef0138f42857f36beadbeda30 > files > 887

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>QKeyEvent Class | 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-cpp.html">C++ Classes</a></td><td >QKeyEvent</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="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#related-non-members">Related Non-Members</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">QKeyEvent Class</h1>
<span class="small-subtitle">(<a href="qt3dinput-qkeyevent.html">Qt3DInput::QKeyEvent</a>)<br/></span>
<!-- $$$QKeyEvent-brief -->
<p><a href="qt3dinput-qkeyevent.html">QKeyEvent</a> event type send by KeyBoardHandler. <a href="#details">More...</a></p>
<!-- @@@QKeyEvent -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">   <span class="preprocessor">#include &lt;QKeyEvent&gt;</span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += 3dinput</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"> Instantiated By:</td><td class="memItemRight bottomAlign"> <a href="qml-qt3d-input-keyevent.html">KeyEvent</a></td></tr></table></div><ul>
<li><a href="qt3dinput-qkeyevent-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<div class="table"><table class="propsummary">
<tr><td class="topAlign"><ul>
<li class="fn"><b><a href="qt3dinput-qkeyevent.html#accepted-prop">accepted</a></b> : bool</li>
<li class="fn"><b><a href="qt3dinput-qkeyevent.html#count-prop">count</a></b> : const int</li>
<li class="fn"><b><a href="qt3dinput-qkeyevent.html#isAutoRepeat-prop">isAutoRepeat</a></b> : const bool</li>
<li class="fn"><b><a href="qt3dinput-qkeyevent.html#key-prop">key</a></b> : const int</li>
</ul></td><td class="topAlign"><ul>
<li class="fn"><b><a href="qt3dinput-qkeyevent.html#modifiers-prop">modifiers</a></b> : const int</li>
<li class="fn"><b><a href="qt3dinput-qkeyevent.html#nativeScanCode-prop">nativeScanCode</a></b> : const quint32</li>
<li class="fn"><b><a href="qt3dinput-qkeyevent.html#text-prop">text</a></b> : const QString</li>
</ul>
</td></tr>
</table></div>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qkeyevent.html#QKeyEvent">QKeyEvent</a></b>(QEvent::Type <i>type</i>, int <i>key</i>, Qt::KeyboardModifiers <i>modifiers</i>, const QString &amp;<i>text</i> = QString(), bool <i>autorep</i> = false, ushort <i>count</i> = 1)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qkeyevent.html#QKeyEvent-1">QKeyEvent</a></b>(const ::QKeyEvent &amp;<i>ke</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qkeyevent.html#count-prop">count</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qkeyevent.html#accepted-prop">isAccepted</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qkeyevent.html#isAutoRepeat-prop">isAutoRepeat</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qkeyevent.html#key-prop">key</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qkeyevent.html#matches">matches</a></b>(QKeySequence::StandardKey <i>key_</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qkeyevent.html#modifiers-prop">modifiers</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> quint32 </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qkeyevent.html#nativeScanCode-prop">nativeScanCode</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qkeyevent.html#accepted-prop">setAccepted</a></b>(bool <i>accepted</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qkeyevent.html#text-prop">text</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QEvent::Type </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qkeyevent.html#type">type</a></b>() const</td></tr>
</table></div>
<a name="static-public-members"></a>
<h2 id="static-public-members">Static Public Members</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> const QMetaObject </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qkeyevent.html#staticMetaObject-var">staticMetaObject</a></b></td></tr>
</table></div>
<a name="related-non-members"></a>
<h2 id="related-non-members">Related Non-Members</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> typedef </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qkeyevent.html#QKeyEventPtr-typedef">QKeyEventPtr</a></b></td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QKeyEvent-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p><a href="qt3dinput-qkeyevent.html">QKeyEvent</a> event type send by KeyBoardHandler.</p>
<p>Contains parameters that describe a key event</p>
</div>
<!-- @@@QKeyEvent -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$accepted-prop$$$isAccepted$$$setAcceptedbool -->
<h3 class="fn" id="accepted-prop"><a name="accepted-prop"></a><span class="name">accepted</span> : <span class="type">bool</span></h3>
<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>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>isAccepted</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setAccepted</b></span>(bool <i>accepted</i>)</td></tr>
</table></div>
<!-- @@@accepted -->
<!-- $$$count-prop$$$count -->
<h3 class="fn" id="count-prop"><a name="count-prop"></a><span class="name">count</span> : const <span class="type">int</span></h3>
<p>Holds the number of keys involved in this event. If <a href="qt3dinput-qkeyevent.html#text-prop">text</a> is not empty, this is simply the length of the string.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>count</b></span>() const</td></tr>
</table></div>
<!-- @@@count -->
<!-- $$$isAutoRepeat-prop$$$isAutoRepeat -->
<h3 class="fn" id="isAutoRepeat-prop"><a name="isAutoRepeat-prop"></a><span class="name">isAutoRepeat</span> : const <span class="type">bool</span></h3>
<p>Holds whether this event comes from an auto-repeating key.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>isAutoRepeat</b></span>() const</td></tr>
</table></div>
<!-- @@@isAutoRepeat -->
<!-- $$$key-prop$$$key -->
<h3 class="fn" id="key-prop"><a name="key-prop"></a><span class="name">key</span> : const <span class="type">int</span></h3>
<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>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>key</b></span>() const</td></tr>
</table></div>
<p><b>See also </b>QKeyEvent::key.</p>
<!-- @@@key -->
<!-- $$$modifiers-prop$$$modifiers -->
<h3 class="fn" id="modifiers-prop"><a name="modifiers-prop"></a><span class="name">modifiers</span> : const <span class="type">int</span></h3>
<p>This property holds the keyboard modifier flags that existed immediately before the event occurred.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>modifiers</b></span>() const</td></tr>
</table></div>
<p><b>See also </b>QKeyEvent::modifiers.</p>
<!-- @@@modifiers -->
<!-- $$$nativeScanCode-prop$$$nativeScanCode -->
<h3 class="fn" id="nativeScanCode-prop"><a name="nativeScanCode-prop"></a><span class="name">nativeScanCode</span> : const <span class="type">quint32</span></h3>
<p>This property contains the native scan code of the key that was pressed. It is passed through from <a href="qt3dinput-qkeyevent.html">QKeyEvent</a> unchanged.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> quint32 </td><td class="memItemRight bottomAlign"><span class="name"><b>nativeScanCode</b></span>() const</td></tr>
</table></div>
<!-- @@@nativeScanCode -->
<!-- $$$text-prop$$$text -->
<h3 class="fn" id="text-prop"><a name="text-prop"></a><span class="name">text</span> : const <span class="type">QString</span></h3>
<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="qt3dinput-qkeyevent.html#key-prop">key</a> will contain a valid value.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QString </td><td class="memItemRight bottomAlign"><span class="name"><b>text</b></span>() const</td></tr>
</table></div>
<!-- @@@text -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QKeyEvent[overload1]$$$QKeyEventQEvent::TypeintQt::KeyboardModifiersconstQString&boolushort -->
<h3 class="fn" id="QKeyEvent"><a name="QKeyEvent"></a>QKeyEvent::<span class="name">QKeyEvent</span>(<span class="type">QEvent::Type</span> <i>type</i>, <span class="type">int</span> <i>key</i>, <span class="type">Qt::KeyboardModifiers</span> <i>modifiers</i>, const <span class="type">QString</span> &amp;<i>text</i> = QString(), <span class="type">bool</span> <i>autorep</i> = false, <span class="type">ushort</span> <i>count</i> = 1)</h3>
<p>Default constructs an instance of QKeyEvent.</p><!-- @@@QKeyEvent -->
<!-- $$$QKeyEvent$$$QKeyEventconst::QKeyEvent& -->
<h3 class="fn" id="QKeyEvent-1"><a name="QKeyEvent-1"></a>QKeyEvent::<span class="name">QKeyEvent</span>(const <span class="type">::QKeyEvent</span> &amp;<i>ke</i>)</h3>
<p>Default constructs an instance of QKeyEvent.</p><!-- @@@QKeyEvent -->
<!-- $$$matches[overload1]$$$matchesQKeySequence::StandardKey -->
<h3 class="fn" id="matches"><a name="matches"></a><span class="type">bool</span> QKeyEvent::<span class="name">matches</span>(<span class="type">QKeySequence::StandardKey</span> <i>key_</i>) const</h3>
<p><b>Note: </b>This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.</p>
<!-- @@@matches -->
<!-- $$$type[overload1]$$$type -->
<h3 class="fn" id="type"><a name="type"></a><span class="type">QEvent::Type</span> QKeyEvent::<span class="name">type</span>() const</h3>
<!-- @@@type -->
</div>
<div class="relnonmem">
<h2>Related Non-Members</h2>
<!-- $$$QKeyEventPtr -->
<h3 class="fn" id="QKeyEventPtr-typedef"><a name="QKeyEventPtr-typedef"></a>typedef Qt3DInput::<span class="name">QKeyEventPtr</span></h3>
<p>A shared pointer for <a href="qt3dinput-qkeyevent.html">QKeyEvent</a>.</p>
<!-- @@@QKeyEventPtr -->
</div>
        </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>