/usr/share/qt5/doc/qtquickcontrols/qml-qtquick-controls-action.html is in qtquickcontrols5-doc-html 5.5.1-1ubuntu1.
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 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qquickaction.cpp -->
<title>Action QML Type | Qt Quick Controls 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="qtquickcontrols-index.html">Qt Quick Controls</a></li>
<li><a href="qtquick-controls-qmlmodule.html">QML Types</a></li>
<li>Action 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="#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">Action QML Type</h1>
<span class="subtitle"></span>
<!-- $$$Action-brief -->
<p>Action provides an abstract user interface action that can be bound to items <a href="#details">More...</a></p>
<!-- @@@Action -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtQuick.Controls 1.4</td></tr></table></div><ul>
<li><a href="qml-qtquick-controls-action-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-qtquick-controls-action.html#checkable-prop">checkable</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-action.html#checked-prop">checked</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-action.html#enabled-prop">enabled</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-action.html#exclusiveGroup-prop">exclusiveGroup</a></b></b> : ExclusiveGroup</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-action.html#iconName-prop">iconName</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-action.html#iconSource-prop">iconSource</a></b></b> : url</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-action.html#shortcut-prop">shortcut</a></b></b> : keysequence</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-action.html#text-prop">text</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-action.html#tooltip-prop">tooltip</a></b></b> : string</li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtquick-controls-action.html#toggled-signal">toggled</a></b></b>(checked)</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-action.html#triggered-signal">triggered</a></b></b>(QObject * <i> source</i>)</li>
</ul>
<a name="methods"></a>
<h2 id="methods">Methods</h2>
<ul>
<li class="fn">void <b><b><a href="qml-qtquick-controls-action.html#trigger-method">trigger</a></b></b>(QObject * <i> source</i>)</li>
</ul>
<!-- $$$Action-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<p class="centerAlign"><img src="images/menubar-action.png" alt="" /></p><p>In applications many common commands can be invoked via menus, toolbar buttons, and keyboard shortcuts. Since the user expects each command to be performed in the same way, regardless of the user interface used, it is useful to represent each command as an <i>action</i>.</p>
<p>An action can be bound to a menu item and a toolbar button, and it will automatically keep them in sync. For example, in a word processor, if the user presses a Bold toolbar button, the Bold menu item will automatically be checked.</p>
<p><a href="../qtqml/qtquick-qmlmodule.html">QtQuick</a> Controls supports actions in <a href="qml-qtquick-controls-button.html">Button</a>, <a href="qml-qtquick-controls-toolbutton.html">ToolButton</a>, and <a href="qml-qtquick-controls-menuitem.html">MenuItem</a>.</p>
<pre class="qml"> ...
<span class="type"><a href="qml-qtquick-controls-action.html">Action</a></span> {
<span class="name">id</span>: <span class="name">copyAction</span>
<span class="name">text</span>: <span class="string">"&Copy"</span>
<span class="name">shortcut</span>: <span class="name">StandardKey</span>.<span class="name">Copy</span>
<span class="name">iconName</span>: <span class="string">"edit-copy"</span>
<span class="name">enabled</span>: (!!<span class="name">activeFocusItem</span> <span class="operator">&&</span> !!<span class="name">activeFocusItem</span>[<span class="string">"copy"</span>])
<span class="name">onTriggered</span>: <span class="name">activeFocusItem</span>.<span class="name">copy</span>()
}
<span class="type"><a href="qml-qtquick-controls-action.html">Action</a></span> {
<span class="name">id</span>: <span class="name">cutAction</span>
<span class="name">text</span>: <span class="string">"Cu&t"</span>
<span class="name">shortcut</span>: <span class="name">StandardKey</span>.<span class="name">Cut</span>
<span class="name">iconName</span>: <span class="string">"edit-cut"</span>
<span class="name">enabled</span>: (!!<span class="name">activeFocusItem</span> <span class="operator">&&</span> !!<span class="name">activeFocusItem</span>[<span class="string">"cut"</span>])
<span class="name">onTriggered</span>: <span class="name">activeFocusItem</span>.<span class="name">cut</span>()
}
<span class="type"><a href="qml-qtquick-controls-action.html">Action</a></span> {
<span class="name">id</span>: <span class="name">pasteAction</span>
<span class="name">text</span>: <span class="string">"&Paste"</span>
<span class="name">shortcut</span>: <span class="name">StandardKey</span>.<span class="name">Paste</span>
<span class="name">iconName</span>: <span class="string">"edit-paste"</span>
<span class="name">enabled</span>: (!!<span class="name">activeFocusItem</span> <span class="operator">&&</span> !!<span class="name">activeFocusItem</span>[<span class="string">"paste"</span>])
<span class="name">onTriggered</span>: <span class="name">activeFocusItem</span>.<span class="name">paste</span>()
}
<span class="name">toolBar</span>: <span class="name">ToolBar</span> {
<span class="type">RowLayout</span> {
<span class="name">anchors</span>.fill: <span class="name">parent</span>
<span class="name">anchors</span>.margins: <span class="name">spacing</span>
<span class="type"><a href="qml-qtquick-controls-label.html">Label</a></span> {
<span class="name">text</span>: <span class="name">UI</span>.<span class="name">label</span>
}
<span class="type"><a href="../qtquick/qml-qtquick-item.html">Item</a></span> { <span class="name">Layout</span>.fillWidth: <span class="number">true</span> }
<span class="type"><a href="qml-qtquick-controls-checkbox.html">CheckBox</a></span> {
<span class="name">id</span>: <span class="name">enabler</span>
<span class="name">text</span>: <span class="string">"Enabled"</span>
<span class="name">checked</span>: <span class="number">true</span>
}
}
}
<span class="name">menuBar</span>: <span class="name">MenuBar</span> {
<span class="type"><a href="qml-qtquick-controls-menu.html">Menu</a></span> {
<span class="name">title</span>: <span class="string">"&File"</span>
<span class="type"><a href="qml-qtquick-controls-menuitem.html">MenuItem</a></span> {
<span class="name">text</span>: <span class="string">"E&xit"</span>
<span class="name">shortcut</span>: <span class="name">StandardKey</span>.<span class="name">Quit</span>
<span class="name">onTriggered</span>: <span class="name">Qt</span>.<span class="name">quit</span>()
}
}
<span class="type"><a href="qml-qtquick-controls-menu.html">Menu</a></span> {
<span class="name">title</span>: <span class="string">"&Edit"</span>
<span class="name">visible</span>: <span class="name">tabView</span>.<span class="name">currentIndex</span> <span class="operator">==</span> <span class="number">2</span>
<span class="type"><a href="qml-qtquick-controls-menuitem.html">MenuItem</a></span> { <span class="name">action</span>: <span class="name">cutAction</span> }
<span class="type"><a href="qml-qtquick-controls-menuitem.html">MenuItem</a></span> { <span class="name">action</span>: <span class="name">copyAction</span> }
<span class="type"><a href="qml-qtquick-controls-menuitem.html">MenuItem</a></span> { <span class="name">action</span>: <span class="name">pasteAction</span> }
}
<span class="type"><a href="qml-qtquick-controls-menu.html">Menu</a></span> {
<span class="name">title</span>: <span class="string">"&Help"</span>
<span class="type"><a href="qml-qtquick-controls-menuitem.html">MenuItem</a></span> {
<span class="name">text</span>: <span class="string">"About..."</span>
<span class="name">onTriggered</span>: <span class="name">aboutDialog</span>.<span class="name">open</span>()
}
}
}
...</pre>
<!-- @@@Action -->
<h2>Property Documentation</h2>
<!-- $$$checkable -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="checkable-prop"><td class="tblQmlPropNode"><p><a name="checkable-prop"></a><span class="name">checkable</span> : <span class="type">bool</span></p></td></tr></table></div></div><div class="qmldoc"><p>Whether the menu item can be checked, or toggled. Defaults to <code>false</code>.</p>
<p><b>See also </b><a href="qml-qtquick-controls-action.html#checked-prop">checked</a> and <a href="qml-qtquick-controls-action.html#exclusiveGroup-prop">exclusiveGroup</a>.</p>
</div></div><!-- @@@checkable -->
<br/>
<!-- $$$checked -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="checked-prop"><td class="tblQmlPropNode"><p><a name="checked-prop"></a><span class="name">checked</span> : <span class="type">bool</span></p></td></tr></table></div></div><div class="qmldoc"><p>If the action is <a href="qml-qtquick-controls-action.html#checkable-prop">checkable</a>, this property reflects its checked state. Defaults to <code>false</code>. Its value is also false while <a href="qml-qtquick-controls-action.html#checkable-prop">checkable</a> is false.</p>
<p><b>See also </b><a href="qml-qtquick-controls-action.html#toggled-signal">toggled</a> and <a href="qml-qtquick-controls-action.html#exclusiveGroup-prop">exclusiveGroup</a>.</p>
</div></div><!-- @@@checked -->
<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>Whether the action is enabled, and can be triggered. Defaults to <code>true</code>.</p>
<p><b>See also </b><a href="qml-qtquick-controls-action.html#trigger-method">trigger()</a> and <a href="qml-qtquick-controls-action.html#triggered-signal">triggered</a>.</p>
</div></div><!-- @@@enabled -->
<br/>
<!-- $$$exclusiveGroup -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="exclusiveGroup-prop"><td class="tblQmlPropNode"><p><a name="exclusiveGroup-prop"></a><span class="name">exclusiveGroup</span> : <span class="type"><a href="qml-qtquick-controls-exclusivegroup.html">ExclusiveGroup</a></span></p></td></tr></table></div></div><div class="qmldoc"><p>If an action is checkable, an <a href="qml-qtquick-controls-exclusivegroup.html">ExclusiveGroup</a> can be attached to it. All the actions sharing the same exclusive group become mutually exclusive selectable, meaning that only the last checked action will actually be checked.</p>
<p>Defaults to <code>null</code>, meaning no exclusive behavior is to be expected.</p>
<p><b>See also </b><a href="qml-qtquick-controls-action.html#checkable-prop">checkable</a> and <a href="qml-qtquick-controls-action.html#checked-prop">checked</a>.</p>
</div></div><!-- @@@exclusiveGroup -->
<br/>
<!-- $$$iconName -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="iconName-prop"><td class="tblQmlPropNode"><p><a name="iconName-prop"></a><span class="name">iconName</span> : <span class="type">string</span></p></td></tr></table></div></div><div class="qmldoc"><p>Sets the icon name for the action. This will pick the icon with the given name from the current theme.</p>
<p>Defaults to the empty string.</p>
</div></div><!-- @@@iconName -->
<br/>
<!-- $$$iconSource -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="iconSource-prop"><td class="tblQmlPropNode"><p><a name="iconSource-prop"></a><span class="name">iconSource</span> : <span class="type"><a href="../qtqml/qml-url.html">url</a></span></p></td></tr></table></div></div><div class="qmldoc"><p>Sets the icon file or resource url for the action. Defaults to the empty URL.</p>
</div></div><!-- @@@iconSource -->
<br/>
<!-- $$$shortcut -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="shortcut-prop"><td class="tblQmlPropNode"><p><a name="shortcut-prop"></a><span class="name">shortcut</span> : <span class="type">keysequence</span></p></td></tr></table></div></div><div class="qmldoc"><p>Shortcut bound to the action. The keysequence can be a string or a <a href="../qtgui/qkeysequence.html#StandardKey-enum">standard key</a>.</p>
<p>Defaults to an empty string.</p>
<pre class="qml"><span class="type"><a href="qml-qtquick-controls-action.html">Action</a></span> {
<span class="name">id</span>: <span class="name">copyAction</span>
<span class="name">text</span>: <span class="name">qsTr</span>(<span class="string">"&Copy"</span>)
<span class="name">shortcut</span>: <span class="name">StandardKey</span>.<span class="name">Copy</span>
}</pre>
</div></div><!-- @@@shortcut -->
<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="name">text</span> : <span class="type">string</span></p></td></tr></table></div></div><div class="qmldoc"><p>Text for the action. This text will show as the button text, or as title in a menu item.</p>
<p>Mnemonics are supported by prefixing the shortcut letter with &. For instance, <code>"\&Open"</code> will bind the <code>Alt-O</code> shortcut to the <code>"Open"</code> menu item. Note that not all platforms support mnemonics.</p>
<p>Defaults to the empty string.</p>
</div></div><!-- @@@text -->
<br/>
<!-- $$$tooltip -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="tooltip-prop"><td class="tblQmlPropNode"><p><a name="tooltip-prop"></a><span class="name">tooltip</span> : <span class="type">string</span></p></td></tr></table></div></div><div class="qmldoc"><p>Tooltip to be shown when hovering the control bound to this action. Not all controls support tooltips on all platforms, especially <a href="qml-qtquick-controls-menuitem.html">MenuItem</a>.</p>
<p>Defaults to the empty string.</p>
</div></div><!-- @@@tooltip -->
<br/>
<h2>Signal Documentation</h2>
<!-- $$$toggled -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="toggled-signal"><td class="tblQmlFuncNode"><p><a name="toggled-signal"></a><span class="name">toggled</span>(<span class="type"><a href="qml-qtquick-controls-action.html#checked-prop">checked</a></span>)</p></td></tr></table></div></div><div class="qmldoc"><p>Emitted whenever a action's <a href="qml-qtquick-controls-action.html#checked-prop">checked</a> property changes. This usually happens at the same time as <a href="qml-qtquick-controls-action.html#triggered-signal">triggered</a>.</p>
<p>The corresponding handler is <code>onToggled</code>.</p>
</div></div><!-- @@@toggled -->
<br/>
<!-- $$$triggered -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="triggered-signal"><td class="tblQmlFuncNode"><p><a name="triggered-signal"></a><span class="name">triggered</span>(<span class="type"><a href="../qtcore/qobject.html">QObject</a></span> *<i> source</i>)</p></td></tr></table></div></div><div class="qmldoc"><p>Emitted when either the menu item or its bound action have been activated. Includes the object that triggered the event if relevant (e.g. a Button or <a href="qml-qtquick-controls-menuitem.html">MenuItem</a>). You shouldn't need to emit this signal, use <a href="qml-qtquick-controls-action.html#trigger-method">trigger()</a> instead.</p>
<p>The corresponding handler is <code>onTriggered</code>.</p>
</div></div><!-- @@@triggered -->
<br/>
<h2>Method Documentation</h2>
<!-- $$$trigger -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="trigger-method"><td class="tblQmlFuncNode"><p><a name="trigger-method"></a><span class="type">void</span> <span class="name">trigger</span>(<span class="type"><a href="../qtcore/qobject.html">QObject</a></span> *<i> source</i>)</p></td></tr></table></div></div><div class="qmldoc"><p>Will emit the <a href="qml-qtquick-controls-action.html#triggered-signal">triggered</a> signal if the action is enabled. You may provide a source object if the Action would benefit from knowing the origin of the triggering (e.g. for analytics). Will also emit the <a href="qml-qtquick-controls-action.html#toggled-signal">toggled</a> signal if it is checkable.</p>
</div></div><!-- @@@trigger -->
<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>
|