/usr/share/qt5/doc/qtquickcontrols/qml-qtquick-controls-styles-menustyle.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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- MenuStyle.qml -->
<title>MenuStyle 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>MenuStyle 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="#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">MenuStyle QML Type</h1>
<span class="subtitle"></span>
<!-- $$$MenuStyle-brief -->
<p>Provides custom styling for Menu <a href="#details">More...</a></p>
<!-- @@@MenuStyle -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtQuick.Controls.Styles 1.4</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.3</td></tr></table></div><ul>
<li><a href="qml-qtquick-controls-styles-menustyle-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-styles-menustyle.html#font-prop">font</a></b></b> : font</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-styles-menustyle.html#frame-prop">frame</a></b></b> : Component</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-styles-menustyle.html#itemDelegate-prop">itemDelegate</a></b></b> : Object</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-styles-menustyle.html#scrollIndicator-prop">scrollIndicator</a></b></b> : Component</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-styles-menustyle.html#separator-prop">separator</a></b></b> : Component</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-styles-menustyle.html#submenuOverlap-prop">submenuOverlap</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-styles-menustyle.html#submenuPopupDelay-prop">submenuPopupDelay</a></b></b> : int</li>
</ul>
<a name="methods"></a>
<h2 id="methods">Methods</h2>
<ul>
<li class="fn">string <b><b><a href="qml-qtquick-controls-styles-menustyle.html#formatMnemonic-method">formatMnemonic</a></b></b>(string <i> text</i>, bool <i> underline</i>)</li>
</ul>
<!-- $$$MenuStyle-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<a name="styledata-properties"></a><p>The <b>styleData</b> object contains the following read-only properties:</p>
<div class="table"><table class="generic">
<tr valign="top" class="odd"><td ><b>styleData.index</b> : int</td><td >The index of the menu item in its menu.</td></tr>
<tr valign="top" class="even"><td ><b>styleData.type</b> : enumeration</td><td >The type of menu item. See below for possible values.</td></tr>
<tr valign="top" class="odd"><td ><b>styleData.selected</b> : bool</td><td ><code>true</code> if the menu item is selected.</td></tr>
<tr valign="top" class="even"><td ><b>styleData.pressed</b> : bool</td><td ><code>true</code> if the menu item is pressed. Available since 5.4.</td></tr>
<tr valign="top" class="odd"><td ><b>styleData.text</b> : string</td><td >The menu item's text, or title if it's a submenu.</td></tr>
<tr valign="top" class="even"><td ><b>styleData.underlineMnemonic</b> : bool</td><td >Whether the style should underline the menu item's label mnemonic.</td></tr>
<tr valign="top" class="odd"><td ><b>styleData.shortcut</b> : string</td><td >The text for the menu item's shortcut.</td></tr>
<tr valign="top" class="even"><td ><b>styleData.iconSource</b> : url</td><td >The source URL to the menu item's icon. Undefined if it has no icon.</td></tr>
<tr valign="top" class="odd"><td ><b>styleData.enabled</b> : bool</td><td ><code>true</code> if the menu item is enabled.</td></tr>
<tr valign="top" class="even"><td ><b>styleData.checkable</b> : bool</td><td ><code>true</code> if the menu item is checkable.</td></tr>
<tr valign="top" class="odd"><td ><b>styleData.exclusive</b> : bool</td><td ><code>true</code> if the menu item is checkable, and it's part of an <a href="qml-qtquick-controls-exclusivegroup.html">ExclusiveGroup</a>.</td></tr>
<tr valign="top" class="even"><td ><b>styleData.checked</b> : bool</td><td ><code>true</code> if the menu item is checkable and currently checked.</td></tr>
<tr valign="top" class="odd"><td ><b>styleData.scrollerDirection</b> : enumeration</td><td >If the menu item is a scroller, its pointing direction. Valid values are <code>Qt.UpArrow</code>, <code>Qt.DownArrow</code>, and <code>Qt.NoArrow</code>.</td></tr>
</table></div>
<p>The valid values for <b>styleData.type</b> are:</p>
<ul>
<li>MenuItemType.Item</li>
<li>MenuItemType.Menu</li>
<li>MenuItemType.Separator</li>
<li>MenuItemType.ScrollIndicator</li>
</ul>
<p><b>Note: </b>Styling menus may not be supported on platforms using native menus through their QPA plugin.</p><!-- @@@MenuStyle -->
<h2>Property Documentation</h2>
<!-- $$$font -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="font-prop"><td class="tblQmlPropNode"><p><a name="font-prop"></a><span class="name">font</span> : <span class="type"><a href="qml-qtquick-controls-styles-menustyle.html#font-prop">font</a></span></p></td></tr></table></div></div><div class="qmldoc"><p>The font of the control.</p>
<p>This QML property was introduced in QtQuick.Controls.Styles 1.3.</p>
</div></div><!-- @@@font -->
<br/>
<!-- $$$frame -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="frame-prop"><td class="tblQmlPropNode"><p><a name="frame-prop"></a><span class="name">frame</span> : <span class="type"><a href="../qtqml/qml-qtqml-component.html">Component</a></span></p></td></tr></table></div></div><div class="qmldoc"><p>The background frame for the menu popup.</p>
<p>The <a href="qml-qtquick-controls-menu.html">Menu</a> will resize the frame to its contents plus the padding.</p>
</div></div><!-- @@@frame -->
<br/>
<!-- $$$itemDelegate -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="itemDelegate-prop"><td class="tblQmlPropNode"><p><a name="itemDelegate-prop"></a><span class="name">itemDelegate</span> : <span class="type">Object</span></p></td></tr></table></div></div><div class="qmldoc"><p>The object containing the menu item subcontrol components. These subcontrols are used for normal menu items only, i.e. not for separators or scroll indicators.</p>
<p>The subcontrols are:</p>
<ul>
<li><b>itemDelegate.background</b> : Component<p>The menu item background component.</p>
<p>Its appearance generally changes with <a href="qml-qtquick-controls-styles-menustyle.html#styledata-properties">styleData.selected</a> and <a href="qml-qtquick-controls-styles-menustyle.html#styledata-properties">styleData.enabled</a>.</p>
<p>The default implementation shows only when the item is enabled and selected. It remains invisible otherwise.</p>
</li>
<li><b>itemDelegate.label</b> : Component<p>Component for the actual text label.</p>
<p>The text itself is fetched from <a href="qml-qtquick-controls-styles-menustyle.html#styledata-properties">styleData.text</a>, and its appearance should depend on <a href="qml-qtquick-controls-styles-menustyle.html#styledata-properties">styleData.enabled</a> and <a href="qml-qtquick-controls-styles-menustyle.html#styledata-properties">styleData.selected</a>.</p>
<p>If <a href="qml-qtquick-controls-styles-menustyle.html#styledata-properties">styleData.underlineMnemonic</a> is true, the label should underline its mnemonic character. <a href="qml-qtquick-controls-styles-menustyle.html#formatMnemonic-method">formatMnemonic</a> provides the default formatting.</p>
</li>
<li><b>itemDelegate.submenuIndicator</b> : Component<p>It indicates that the current menu item is a submenu.</p>
<p>Only used when <a href="qml-qtquick-controls-styles-menustyle.html#styledata-properties">styleData.type</a> equals <code>MenuItemType.Menu</code>.</p>
</li>
<li><b>itemDelegate.shortcut</b> : Component<p>Displays the shortcut attached to the menu item.</p>
<p>Only used when <a href="qml-qtquick-controls-styles-menustyle.html#styledata-properties">styleData.shortcut</a> is not empty.</p>
</li>
<li><b>itemDelegate.checkmarkIndicator</b> : Component<p>Will be used when <a href="qml-qtquick-controls-styles-menustyle.html#styledata-properties">styleData.checkable</a> is <code>true</code> and its appearance may depend on <a href="qml-qtquick-controls-styles-menustyle.html#styledata-properties">styleData.exclusive</a>, i.e., whether it will behave like a checkbox or a radio button. Use <a href="qml-qtquick-controls-styles-menustyle.html#styledata-properties">styleData.checked</a> for the checked state.</p>
</li>
</ul>
<p><b>Note: </b>This property cannot be overwritten although all of the subcontrol properties can.</p></div></div><!-- @@@itemDelegate -->
<br/>
<!-- $$$scrollIndicator -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="scrollIndicator-prop"><td class="tblQmlPropNode"><p><a name="scrollIndicator-prop"></a><span class="name">scrollIndicator</span> : <span class="type"><a href="../qtqml/qml-qtqml-component.html">Component</a></span></p></td></tr></table></div></div><div class="qmldoc"><p>Component for the scroll indicator menu item.</p>
<p>Will be used when <a href="qml-qtquick-controls-styles-menustyle.html#styledata-properties">styleData.type</a> equals <code>MenuItemType.ScrollIndicator</code>. Its appearance should follow <a href="qml-qtquick-controls-styles-menustyle.html#styledata-properties">styleData.scrollerDirection</a>.</p>
<p>This is the item added at the top and bottom of the menu popup when its contents won't fit the screen to indicate more content is available in the direction of the arrow.</p>
</div></div><!-- @@@scrollIndicator -->
<br/>
<!-- $$$separator -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="separator-prop"><td class="tblQmlPropNode"><p><a name="separator-prop"></a><span class="name">separator</span> : <span class="type"><a href="../qtqml/qml-qtqml-component.html">Component</a></span></p></td></tr></table></div></div><div class="qmldoc"><p>Component for the separator menu item.</p>
<p>Will be used when <a href="qml-qtquick-controls-styles-menustyle.html#styledata-properties">styleData.type</a> equals <code>MenuItemType.Separator</code>.</p>
</div></div><!-- @@@separator -->
<br/>
<!-- $$$submenuOverlap -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="submenuOverlap-prop"><td class="tblQmlPropNode"><p><a name="submenuOverlap-prop"></a><span class="name">submenuOverlap</span> : <span class="type">int</span></p></td></tr></table></div></div><div class="qmldoc"><p>The amount of pixels by which a submenu popup overlaps horizontally its parent menu.</p>
</div></div><!-- @@@submenuOverlap -->
<br/>
<!-- $$$submenuPopupDelay -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="submenuPopupDelay-prop"><td class="tblQmlPropNode"><p><a name="submenuPopupDelay-prop"></a><span class="name">submenuPopupDelay</span> : <span class="type">int</span></p></td></tr></table></div></div><div class="qmldoc"><p>The number of milliseconds to wait before opening a submenu.</p>
</div></div><!-- @@@submenuPopupDelay -->
<br/>
<h2>Method Documentation</h2>
<!-- $$$formatMnemonic -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="formatMnemonic-method"><td class="tblQmlFuncNode"><p><a name="formatMnemonic-method"></a><span class="type">string</span> <span class="name">formatMnemonic</span>(<span class="type">string</span><i> text</i>, <span class="type">bool</span><i> underline</i> = false)</p></td></tr></table></div></div><div class="qmldoc"><p>Returns a rich-text string to render mnemonics for a given menu item.</p>
<p>The mnemonic character is prefixed by an ampersand in the original string.</p>
<p>Passing <code>true</code> for <code>underline</code> will underline the mnemonic character (e.g., <code>formatMnemonic("&Open...", true)</code> will return <code>"<u>O</u>pen..."</code>). Passing <code>false</code> for <code>underline</code> will return the plain text form (e.g., <code>formatMnemonic("&Open...", false)</code> will return <code>"Open..."</code>).</p>
<p><b>See also </b><a href="qml-qtquick-controls-label.html">Label</a>.</p>
</div></div><!-- @@@formatMnemonic -->
<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>
|