<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qquicktextmetrics.cpp --> <title>TextMetrics QML Type | Qt Quick 5.12.6</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="qtquick-index.html">Qt Quick</a></td><td ><a href="qtquick-qmlmodule.html">QML Types</a></td><td >TextMetrics QML Type</td></tr></table><table class="buildversion"><tr> <td id="buildversion" width="100%" align="right"><a href="qtquick-index.html">Qt 5.12.6 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="#details">Detailed Description</a></li> </ul> </div> <div class="sidebar-content" id="sidebar-content"></div></div> <h1 class="title">TextMetrics QML Type</h1> <span class="subtitle"></span> <!-- $$$TextMetrics-brief --> <p>Provides metrics for a given font and text. <a href="#details">More...</a></p> <!-- @@@TextMetrics --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtQuick 2.12</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.4</td></tr></table></div><ul> <li><a href="qml-qtquick-textmetrics-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-textmetrics.html#advanceWidth-prop">advanceWidth</a></b></b> : real</li> <li class="fn"><b><b><a href="qml-qtquick-textmetrics.html#boundingRect-prop">boundingRect</a></b></b> : rect</li> <li class="fn"><b><b><a href="qml-qtquick-textmetrics.html#elide-prop">elide</a></b></b> : enumeration</li> <li class="fn"><b><b><a href="qml-qtquick-textmetrics.html#elideWidth-prop">elideWidth</a></b></b> : real</li> <li class="fn"><b><b><a href="qml-qtquick-textmetrics.html#elidedText-prop">elidedText</a></b></b> : string</li> <li class="fn"><b><b><a href="qml-qtquick-textmetrics.html#font-prop">font</a></b></b> : font</li> <li class="fn"><b><b><a href="qml-qtquick-textmetrics.html#height-prop">height</a></b></b> : real</li> <li class="fn"><b><b><a href="qml-qtquick-textmetrics.html#text-prop">text</a></b></b> : string</li> <li class="fn"><b><b><a href="qml-qtquick-textmetrics.html#tightBoundingRect-prop">tightBoundingRect</a></b></b> : rect</li> <li class="fn"><b><b><a href="qml-qtquick-textmetrics.html#width-prop">width</a></b></b> : real</li> </ul> <!-- $$$TextMetrics-description --> <a name="details"></a> <h2 id="details">Detailed Description</h2> <p><a href="qml-qtquick-textmetrics.html">TextMetrics</a> calculates various properties of a given string of text for a particular font.</p> <p>It provides a declarative API for the functions in QFontMetricsF which take arguments.</p> <pre class="cpp"> TextMetrics { id: textMetrics font<span class="operator">.</span>family: <span class="string">"Arial"</span> elide: Text<span class="operator">.</span>ElideMiddle elideWidth: <span class="number">100</span> text: <span class="string">"Hello World"</span> } MyItem { text: textMetrics<span class="operator">.</span>elidedText } </pre> <p><b>See also </b>QFontMetricsF and <a href="qml-qtquick-fontmetrics.html">FontMetrics</a>.</p> <!-- @@@TextMetrics --> <h2>Property Documentation</h2> <!-- $$$advanceWidth --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="advanceWidth-prop"> <td class="tblQmlPropNode"><p> <a name="advanceWidth-prop"></a><span class="name">advanceWidth</span> : <span class="type">real</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the advance in pixels of the characters in <a href="qml-qtquick-textmetrics.html#text-prop">text</a>. This is the distance from the position of the string to where the next string should be drawn.</p> <p><b>See also </b>QFontMetricsF::width().</p> </div></div><!-- @@@advanceWidth --> <br/> <!-- $$$boundingRect --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="boundingRect-prop"> <td class="tblQmlPropNode"><p> <a name="boundingRect-prop"></a><span class="name">boundingRect</span> : <span class="type">rect</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the bounding rectangle of the characters in the string specified by <a href="qml-qtquick-textmetrics.html#text-prop">text</a>.</p> <p><b>See also </b>QFontMetricsF::boundingRect() and <a href="qml-qtquick-textmetrics.html#tightBoundingRect-prop">tightBoundingRect</a>.</p> </div></div><!-- @@@boundingRect --> <br/> <!-- $$$elide --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="elide-prop"> <td class="tblQmlPropNode"><p> <a name="elide-prop"></a><span class="name">elide</span> : <span class="type">enumeration</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the elide mode of the text. This determines the position in which the string is elided. The possible values are:</p> <ul> <li><code>Qt::ElideNone</code> - No eliding; this is the default value.</li> <li><code>Qt::ElideLeft</code> - For example: "...World"</li> <li><code>Qt::ElideMiddle</code> - For example: "He...ld"</li> <li><code>Qt::ElideRight</code> - For example: "Hello..."</li> </ul> <p><b>See also </b><a href="qml-qtquick-textmetrics.html#elideWidth-prop">elideWidth</a> and QFontMetrics::elidedText.</p> </div></div><!-- @@@elide --> <br/> <!-- $$$elideWidth --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="elideWidth-prop"> <td class="tblQmlPropNode"><p> <a name="elideWidth-prop"></a><span class="name">elideWidth</span> : <span class="type">real</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the largest width the text can have (in pixels) before eliding will occur.</p> <p><b>See also </b><a href="qml-qtquick-textmetrics.html#elide-prop">elide</a> and QFontMetrics::elidedText.</p> </div></div><!-- @@@elideWidth --> <br/> <!-- $$$elidedText --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="elidedText-prop"> <td class="tblQmlPropNode"><p> <a name="elidedText-prop"></a><span class="name">elidedText</span> : <span class="type">string</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds an elided version of the string (i.e., a string with "..." in it) if the string <a href="qml-qtquick-textmetrics.html#text-prop">text</a> is wider than <a href="qml-qtquick-textmetrics.html#elideWidth-prop">elideWidth</a>. If the text is not wider than <a href="qml-qtquick-textmetrics.html#elideWidth-prop">elideWidth</a>, or <a href="qml-qtquick-textmetrics.html#elide-prop">elide</a> is set to <code>Qt::ElideNone</code>, this property will be equal to the original string.</p> <p><b>See also </b>QFontMetricsF::elidedText().</p> </div></div><!-- @@@elidedText --> <br/> <!-- $$$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-font.html">font</a></span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the font used for the metrics calculations.</p> </div></div><!-- @@@font --> <br/> <!-- $$$height --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="height-prop"> <td class="tblQmlPropNode"><p> <a name="height-prop"></a><span class="name">height</span> : <span class="type">real</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the height of the bounding rectangle of the characters in the string specified by <a href="qml-qtquick-textmetrics.html#text-prop">text</a>. It is equivalent to:</p> <pre class="cpp"> textMetrics<span class="operator">.</span>boundingRect<span class="operator">.</span>height </pre> <p><b>See also </b><a href="qml-qtquick-textmetrics.html#boundingRect-prop">boundingRect</a>.</p> </div></div><!-- @@@height --> <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>This property holds the text used for the metrics calculations.</p> </div></div><!-- @@@text --> <br/> <!-- $$$tightBoundingRect --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="tightBoundingRect-prop"> <td class="tblQmlPropNode"><p> <a name="tightBoundingRect-prop"></a><span class="name">tightBoundingRect</span> : <span class="type">rect</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds a tight bounding rectangle around the characters in the string specified by <a href="qml-qtquick-textmetrics.html#text-prop">text</a>.</p> <p><b>See also </b>QFontMetricsF::tightBoundingRect() and <a href="qml-qtquick-textmetrics.html#boundingRect-prop">boundingRect</a>.</p> </div></div><!-- @@@tightBoundingRect --> <br/> <!-- $$$width --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="width-prop"> <td class="tblQmlPropNode"><p> <a name="width-prop"></a><span class="name">width</span> : <span class="type">real</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the width of the bounding rectangle of the characters in the string specified by <a href="qml-qtquick-textmetrics.html#text-prop">text</a>. It is equivalent to:</p> <pre class="cpp"> textMetrics<span class="operator">.</span>boundingRect<span class="operator">.</span>width </pre> <p><b>See also </b><a href="qml-qtquick-textmetrics.html#boundingRect-prop">boundingRect</a>.</p> </div></div><!-- @@@width --> <br/> </div> </div> </div> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</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>