qtquick-templates2-qmlmodule.html 14.8 KB
Newer Older
xuebingbing's avatar
xuebingbing committed
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
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qtquicktemplates2-qmltypes.qdoc -->
  <title>Qt Quick Templates 2 QML Types | Qt Quick Controls 2 5.11</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 ><a href="../qtdoc/index.html">Qt 5.11</a></td><td ><a href="qtquickcontrols2-index.html">Qt Quick Controls 2</a></td><td >Qt Quick Templates 2 QML Types</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.11.2 Reference Documentation</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="#qml-types">QML Types</a></li>
<li class="level1"><a href="#related-information">Related Information</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Qt Quick Templates 2 QML Types</h1>
<span class="subtitle"></span>
<!-- $$$QtQuick.Templates-description -->
<div class="descr"> <a name="details"></a>
<p>The <a href="qtquicktemplates2-index.html">Qt Quick Templates 2</a> module provides a set of non-visual templates that can be used to build user interface controls in QML using <a href="../qtquick/qtquick-index.html">Qt Quick</a>.</p>
<p>The QML types can be imported using the following import statement in your <code>.qml</code> file:</p>
<pre class="cpp plain">

  import QtQuick.Templates 2.4 as T

</pre>
<p>For the sake of clarity, there is a one-to-one mapping between the types provided by the <code>QtQuick.Templates</code> and <code>QtQuick.Controls</code> imports. For every type available in the <code>QtQuick.Controls</code> import, a non-visual template type by the same name exists in the <code>QtQuick.Templates</code> import.</p>
<p><b>Note: </b>It is recommended to use a namespace for the templates import to avoid overlap with the types provided by the <code>QtQuick.Controls</code> import.</p><a name="qml-types"></a>
<h2 id="qml-types">QML Types</h2>
<div class="table"><table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-abstractbutton.html">AbstractButton</a></p></td><td class="tblDescr"><p>Abstract base type providing functionality common to buttons</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-action.html">Action</a></p></td><td class="tblDescr"><p>Abstract user interface action</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-actiongroup.html">ActionGroup</a></p></td><td class="tblDescr"><p>Groups actions together</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-applicationwindow.html">ApplicationWindow</a></p></td><td class="tblDescr"><p>Styled top-level window with support for a header and footer</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-busyindicator.html">BusyIndicator</a></p></td><td class="tblDescr"><p>Indicates background activity, for example, while content is being loaded</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-button.html">Button</a></p></td><td class="tblDescr"><p>Push-button that can be clicked to perform a command or answer a question</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-buttongroup.html">ButtonGroup</a></p></td><td class="tblDescr"><p>Mutually-exclusive group of checkable buttons</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-checkbox.html">CheckBox</a></p></td><td class="tblDescr"><p>Check button that can be toggled on or off</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-checkdelegate.html">CheckDelegate</a></p></td><td class="tblDescr"><p>Item delegate with a check indicator that can be toggled on or off</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-combobox.html">ComboBox</a></p></td><td class="tblDescr"><p>Combined button and popup list for selecting options</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-container.html">Container</a></p></td><td class="tblDescr"><p>Abstract base type providing functionality common to containers</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-control.html">Control</a></p></td><td class="tblDescr"><p>Abstract base type providing functionality common to all controls</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-delaybutton.html">DelayButton</a></p></td><td class="tblDescr"><p>Check button that triggers when held down long enough</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-dial.html">Dial</a></p></td><td class="tblDescr"><p>Circular dial that is rotated to set a value</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-dialog.html">Dialog</a></p></td><td class="tblDescr"><p>Popup dialog with standard buttons and a title, used for short-term interaction with the user</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-dialogbuttonbox.html">DialogButtonBox</a></p></td><td class="tblDescr"><p>A button box used in dialogs</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-drawer.html">Drawer</a></p></td><td class="tblDescr"><p>Side panel that can be opened and closed using a swipe gesture</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-frame.html">Frame</a></p></td><td class="tblDescr"><p>Visual frame for a logical group of controls</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-groupbox.html">GroupBox</a></p></td><td class="tblDescr"><p>Visual frame and title for a logical group of controls</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-itemdelegate.html">ItemDelegate</a></p></td><td class="tblDescr"><p>Basic item delegate that can be used in various views and controls</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-label.html">Label</a></p></td><td class="tblDescr"><p>Styled text label with inherited font</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-menu.html">Menu</a></p></td><td class="tblDescr"><p>Popup that can be used as a context menu or popup menu</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-menubar.html">MenuBar</a></p></td><td class="tblDescr"><p>Provides a window menu bar</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-menubaritem.html">MenuBarItem</a></p></td><td class="tblDescr"><p>Presents a drop-down menu within a MenuBar</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-menuitem.html">MenuItem</a></p></td><td class="tblDescr"><p>Presents an item within a Menu</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-menuseparator.html">MenuSeparator</a></p></td><td class="tblDescr"><p>Separates a group of items in a menu from adjacent items</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-overlay.html">Overlay</a></p></td><td class="tblDescr"><p>A window overlay for popups</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-page.html">Page</a></p></td><td class="tblDescr"><p>Styled page control with support for a header and footer</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-pageindicator.html">PageIndicator</a></p></td><td class="tblDescr"><p>Indicates the currently active page</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-pane.html">Pane</a></p></td><td class="tblDescr"><p>Provides a background matching with the application style and theme</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-popup.html">Popup</a></p></td><td class="tblDescr"><p>Base type of popup-like user interface controls</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-progressbar.html">ProgressBar</a></p></td><td class="tblDescr"><p>Indicates the progress of an operation</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-radiobutton.html">RadioButton</a></p></td><td class="tblDescr"><p>Exclusive radio button that can be toggled on or off</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-radiodelegate.html">RadioDelegate</a></p></td><td class="tblDescr"><p>Exclusive item delegate with a radio indicator that can be toggled on or off</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-rangeslider.html">RangeSlider</a></p></td><td class="tblDescr"><p>Used to select a range of values by sliding two handles along a track</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-roundbutton.html">RoundButton</a></p></td><td class="tblDescr"><p>A push-button control with rounded corners that can be clicked by the user</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-scrollbar.html">ScrollBar</a></p></td><td class="tblDescr"><p>Vertical or horizontal interactive scroll bar</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-scrollindicator.html">ScrollIndicator</a></p></td><td class="tblDescr"><p>Vertical or horizontal non-interactive scroll indicator</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-scrollview.html">ScrollView</a></p></td><td class="tblDescr"><p>Scrollable view</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-slider.html">Slider</a></p></td><td class="tblDescr"><p>Used to select a value by sliding a handle along a track</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-spinbox.html">SpinBox</a></p></td><td class="tblDescr"><p>Allows the user to select from a set of preset values</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-stackview.html">StackView</a></p></td><td class="tblDescr"><p>Provides a stack-based navigation model</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-swipedelegate.html">SwipeDelegate</a></p></td><td class="tblDescr"><p>Swipable item delegate</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-swipeview.html">SwipeView</a></p></td><td class="tblDescr"><p>Enables the user to navigate pages by swiping sideways</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-switch.html">Switch</a></p></td><td class="tblDescr"><p>Button that can be toggled on or off</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-switchdelegate.html">SwitchDelegate</a></p></td><td class="tblDescr"><p>Item delegate with a switch indicator that can be toggled on or off</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-tabbar.html">TabBar</a></p></td><td class="tblDescr"><p>Allows the user to switch between different views or subtasks</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-tabbutton.html">TabButton</a></p></td><td class="tblDescr"><p>Button with a look suitable for a TabBar</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-textarea.html">TextArea</a></p></td><td class="tblDescr"><p>Multi-line text input area</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-textfield.html">TextField</a></p></td><td class="tblDescr"><p>Single-line text input field</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-toolbar.html">ToolBar</a></p></td><td class="tblDescr"><p>Container for context-sensitive controls</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-toolbutton.html">ToolButton</a></p></td><td class="tblDescr"><p>Button with a look suitable for a ToolBar</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-toolseparator.html">ToolSeparator</a></p></td><td class="tblDescr"><p>Separates a group of items in a toolbar from adjacent items</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-tooltip.html">ToolTip</a></p></td><td class="tblDescr"><p>Provides tool tips for any control</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtquick-controls2-tumbler.html">Tumbler</a></p></td><td class="tblDescr"><p>Spinnable wheel of items that can be selected</p></td></tr>
</table></div>
<a name="related-information"></a>
<h2 id="related-information">Related Information</h2>
<ul>
<li><a href="qtquick-controls2-qmlmodule.html">Qt Quick Controls 2 QML Types</a></li>
</ul>
</div>
<!-- @@@QtQuick.Templates -->
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2018 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>