<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qquickfontloader.cpp -->
<title>FontLoader QML Type | Qt Quick 5.9</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.9</td><td ><a href="qtquick-index.html">Qt Quick</a></td><td ><a href="qtquick-qmlmodule.html">QML Types</a></td><td >FontLoader QML Type</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.4 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="#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">FontLoader QML Type</h1>
<span class="subtitle"></span>
<!-- $$$FontLoader-brief -->
<p>Allows fonts to be loaded by name or URL <a href="#details">More...</a></p>
<!-- @@@FontLoader -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtQuick 2.7</td></tr></table></div><ul>
<li><a href="qml-qtquick-fontloader-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-fontloader.html#name-prop">name</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtquick-fontloader.html#source-prop">source</a></b></b> : url</li>
<li class="fn"><b><b><a href="qml-qtquick-fontloader.html#status-prop">status</a></b></b> : enumeration</li>
</ul>
<!-- $$$FontLoader-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>The <a href="qml-qtquick-fontloader.html">FontLoader</a> type is used to load fonts by name or URL.</p>
<p>The <a href="qml-qtquick-fontloader.html#status-prop">status</a> indicates when the font has been loaded, which is useful for fonts loaded from remote sources.</p>
<p>For example:</p>
<pre class="qml">
import QtQuick 2.0
<span class="type"><a href="qml-qtquick-column.html">Column</a></span> {
<span class="type"><a href="qml-qtquick-fontloader.html">FontLoader</a></span> { <span class="name">id</span>: <span class="name">fixedFont</span>; <span class="name">name</span>: <span class="string">"Courier"</span> }
<span class="type"><a href="qml-qtquick-fontloader.html">FontLoader</a></span> { <span class="name">id</span>: <span class="name">webFont</span>; <span class="name">source</span>: <span class="string">"http://www.mysite.com/myfont.ttf"</span> }
<span class="type"><a href="qml-qtquick-text.html">Text</a></span> { <span class="name">text</span>: <span class="string">"Fixed-size font"</span>; <span class="name">font</span>.family: <span class="name">fixedFont</span>.<span class="name">name</span> }
<span class="type"><a href="qml-qtquick-text.html">Text</a></span> { <span class="name">text</span>: <span class="string">"Fancy font"</span>; <span class="name">font</span>.family: <span class="name">webFont</span>.<span class="name">name</span> }
}
</pre>
<p><b>See also </b><a href="qtquick-text-example.html#fonts">Qt Quick Examples - Text Fonts</a>.</p>
<!-- @@@FontLoader -->
<h2>Property Documentation</h2>
<!-- $$$name -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="name-prop">
<td class="tblQmlPropNode"><p>
<a name="name-prop"></a><span class="name">name</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the name of the font family. It is set automatically when a font is loaded using the <a href="qml-qtquick-fontloader.html#source-prop">source</a> property.</p>
<p>Use this to set the <code>font.family</code> property of a <code>Text</code> item.</p>
<p>Example:</p>
<pre class="qml">
<span class="type"><a href="qml-qtquick-item.html">Item</a></span> {
<span class="name">width</span>: <span class="number">200</span>; <span class="name">height</span>: <span class="number">50</span>
<span class="type"><a href="qml-qtquick-fontloader.html">FontLoader</a></span> {
<span class="name">id</span>: <span class="name">webFont</span>
<span class="name">source</span>: <span class="string">"http://www.mysite.com/myfont.ttf"</span>
}
<span class="type"><a href="qml-qtquick-text.html">Text</a></span> {
<span class="name">text</span>: <span class="string">"Fancy font"</span>
<span class="name">font</span>.family: <span class="name">webFont</span>.<span class="name">name</span>
}
}
</pre>
</div></div><!-- @@@name -->
<br/>
<!-- $$$source -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="source-prop">
<td class="tblQmlPropNode"><p>
<a name="source-prop"></a><span class="name">source</span> : <span class="type">url</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The URL of the font to load.</p>
</div></div><!-- @@@source -->
<br/>
<!-- $$$status -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="status-prop">
<td class="tblQmlPropNode"><p>
<a name="status-prop"></a><span class="name">status</span> : <span class="type">enumeration</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the status of font loading. It can be one of:</p>
<ul>
<li><a href="qml-qtquick-fontloader.html">FontLoader</a>.Null - no font has been set</li>
<li><a href="qml-qtquick-fontloader.html">FontLoader</a>.Ready - the font has been loaded</li>
<li><a href="qml-qtquick-fontloader.html">FontLoader</a>.Loading - the font is currently being loaded</li>
<li><a href="qml-qtquick-fontloader.html">FontLoader</a>.Error - an error occurred while loading the font</li>
</ul>
<p>Use this status to provide an update or respond to the status change in some way. For example, you could:</p>
<ul>
<li>Trigger a state change:<pre class="qml">
<span class="type"><a href="qml-qtquick-state.html">State</a></span> { <span class="name">name</span>: <span class="string">'loaded'</span>; <span class="name">when</span>: <span class="name">loader</span>.<span class="name">status</span> <span class="operator">==</span> <span class="name">FontLoader</span>.<span class="name">Ready</span> }
</pre>
</li>
<li>Implement an <code>onStatusChanged</code> signal handler:<pre class="qml">
<span class="type"><a href="qml-qtquick-fontloader.html">FontLoader</a></span> {
<span class="name">id</span>: <span class="name">loader</span>
<span class="name">onStatusChanged</span>: <span class="keyword">if</span> (<span class="name">loader</span>.<span class="name">status</span> <span class="operator">==</span> <span class="name">FontLoader</span>.<span class="name">Ready</span>) <span class="name">console</span>.<span class="name">log</span>(<span class="string">'Loaded'</span>)
}
</pre>
</li>
<li>Bind to the status value:<pre class="qml">
<span class="type"><a href="qml-qtquick-text.html">Text</a></span> { <span class="name">text</span>: <span class="name">loader</span>.<span class="name">status</span> <span class="operator">==</span> <span class="name">FontLoader</span>.<span class="name">Ready</span> ? <span class="string">'Loaded'</span> : <span class="string">'Not loaded'</span> }
</pre>
</li>
</ul>
</div></div><!-- @@@status -->
<br/>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2017 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>
