Skip to content
Snippets Groups Projects
qt3dinput-qaction.html 7.98 KiB
Newer Older
  • Learn to ignore specific revisions
  • <!DOCTYPE html>
    <html lang="en">
    <head>
      <meta charset="utf-8">
    <!-- qaction.cpp -->
      <title>QAction Class | Qt 3D 5.15.0</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">
            <ul>
    <li><a href="../qtdoc/index.html">Qt 5.15</a></li>
    <li><a href="qt3d-index.html">Qt 3D</a></li>
    <li><a href="qt3d-cpp.html">C++ Classes</a></li>
    <li>QAction</li>
    <li id="buildversion"><a href="qt3d-index.html">Qt 5.15.0 Reference Documentation</a></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="#public-functions">Public Functions</a></li>
    <li class="level1"><a href="#signals">Signals</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">QAction Class</h1>
    <span class="small-subtitle">class <a href="qt3dinput-module.html">Qt3DInput</a>::QAction</span>
    <!-- $$$QAction-brief -->
    <p>Links a set of <a href="qt3dinput-qabstractactioninput.html">QAbstractActionInput</a> that trigger the same event. <a href="#details">More...</a></p>
    <!-- @@@QAction -->
    <div class="table"><table class="alignedsummary">
    <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">  <span class="preprocessor">#include &lt;QAction&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.7</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiated By:</td><td class="memItemRight bottomAlign"> <a href="qml-qt3d-input-action.html">Action</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qt3dcore-qnode.html">Qt3DCore::QNode</a></td></tr></table></div><p>This class was introduced in Qt 5.7.</p>
    <ul>
    <li><a href="qt3dinput-qaction-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><a href="qt3dinput-qaction.html#active-prop">active</a></b> : const bool</li>
    </ul>
    <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-qaction.html#QAction">QAction</a></b>(Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr>
    <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qaction.html#addInput">addInput</a></b>(Qt3DInput::QAbstractActionInput *<i>input</i>)</td></tr>
    <tr><td class="memItemLeft rightAlign topAlign"> QVector&lt;Qt3DInput::QAbstractActionInput *&gt; </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qaction.html#inputs">inputs</a></b>() const</td></tr>
    <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qaction.html#active-prop">isActive</a></b>() const</td></tr>
    <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qaction.html#removeInput">removeInput</a></b>(Qt3DInput::QAbstractActionInput *<i>input</i>)</td></tr>
    </table></div>
    <a name="signals"></a>
    <h2 id="signals">Signals</h2>
    <div class="table"><table class="alignedsummary">
    <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qaction.html#active-prop">activeChanged</a></b>(bool <i>isActive</i>)</td></tr>
    </table></div>
    <a name="details"></a>
    <!-- $$$QAction-description -->
    <div class="descr">
    <h2 id="details">Detailed Description</h2>
    </div>
    <!-- @@@QAction -->
    <div class="prop">
    <h2>Property Documentation</h2>
    <!-- $$$active-prop$$$isActive$$$activeChangedbool -->
    <h3 class="fn" id="active-prop"><a name="active-prop"></a><span class="name">active</span> : const <span class="type">bool</span></h3>
    <p>Holds <code>true</code> if the action is active.</p>
    <p>Note this property is not updated when the action is disabled.</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>isActive</b></span>() const</td></tr>
    </table></div>
    <p><b>Notifier signal:</b></p>
    <div class="table"><table class="alignedsummary">
    <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>activeChanged</b></span>(bool <i>isActive</i>)</td></tr>
    </table></div>
    <!-- @@@active -->
    </div>
    <div class="func">
    <h2>Member Function Documentation</h2>
    <!-- $$$QAction[overload1]$$$QActionQt3DCore::QNode* -->
    <h3 class="fn" id="QAction"><a name="QAction"></a>QAction::<span class="name">QAction</span>(<span class="type"><a href="qt3dcore-qnode.html">Qt3DCore::QNode</a></span> *<i>parent</i> = nullptr)</h3>
    <p>Constructs a new QAction instance with parent <i>parent</i>.</p>
    <!-- @@@QAction -->
    <!-- $$$addInput[overload1]$$$addInputQt3DInput::QAbstractActionInput* -->
    <h3 class="fn" id="addInput"><a name="addInput"></a><span class="type">void</span> QAction::<span class="name">addInput</span>(<span class="type"><a href="qt3dinput-qabstractactioninput.html">Qt3DInput::QAbstractActionInput</a></span> *<i>input</i>)</h3>
    <p>Append <a href="qt3dinput-qabstractactioninput.html">QAbstractActionInput</a> <i>input</i> to the list of inputs that can trigger this action.</p>
    <!-- @@@addInput -->
    <!-- $$$inputs[overload1]$$$inputs -->
    <h3 class="fn" id="inputs"><a name="inputs"></a><span class="type"><a href="../qtcore/qvector.html">QVector</a></span>&lt;<span class="type"><a href="qt3dinput-qabstractactioninput.html">Qt3DInput::QAbstractActionInput</a></span> *&gt; QAction::<span class="name">inputs</span>() const</h3>
    <p>Returns the list of inputs that can trigger this action.</p>
    <!-- @@@inputs -->
    <!-- $$$removeInput[overload1]$$$removeInputQt3DInput::QAbstractActionInput* -->
    <h3 class="fn" id="removeInput"><a name="removeInput"></a><span class="type">void</span> QAction::<span class="name">removeInput</span>(<span class="type"><a href="qt3dinput-qabstractactioninput.html">Qt3DInput::QAbstractActionInput</a></span> *<i>input</i>)</h3>
    <p>Remove <a href="qt3dinput-qabstractactioninput.html">QAbstractActionInput</a> <i>input</i> to the list of inputs that can trigger this action.</p>
    <!-- @@@removeInput -->
    </div>
            </div>
           </div>
       </div>
       </div>
    </div>
    <div class="footer">
       <p>
       <acronym title="Copyright">&copy;</acronym> 2020 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>