Files
gitea-pages/software/CSDataQuick/docs/qml-csdataquick-components-csimage.html
T
2025-07-08 08:18:09 +02:00

129 lines
6.3 KiB
HTML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- CSImage.qml -->
<title>CSImage QML Type | CSDataQuick Documentation 1.2</title>
<link rel="stylesheet" type="text/css" href="style/online.css" />
<script type="text/javascript">
(function (i, s, o, g, r, a, m) {
i['GoogleAnalyticsObject'] = r; i[r] = i[r] || function () {
(i[r].q = i[r].q || []).push(arguments)
}, i[r].l = 1 * new Date(); a = s.createElement(o),
m = s.getElementsByTagName(o)[0]; a.async = 1; a.src = g; m.parentNode.insertBefore(a, m)
})(window, document, 'script', '//www.google-analytics.com/analytics.js', 'ga');
ga('create', 'UA-24645639-4', 'qt.io');
ga('set', 'forceSSL', true);
ga('send', 'pageview');
</script>
</head>
<body>
<div class="header" id="header">
<header id="navbar" class="">
</header>
</div>
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<ul class="sub-navigation">
<li><a href="../../CSDataQuick.html">Home</a></li>
<li><a href="../docs.html" class="active">Documentation</a></li>
<li><a href="http://github.com/xiaoqiangwang/CSDataQuick/">Code</a></li>
<li><a href="https://github.com/xiaoqiangwang/CSDataQuick/issues/">Bug Reports</a></li>
</ul>
<div id="main_title_bar">
<h1>CSDataQuick Documentation</h1>
<div class="search_bar">
<script>
(function() {
var cx = '001693341472456439948:u9v0snkru3q';
var gcse = document.createElement('script');
gcse.type = 'text/javascript';
gcse.async = true;
gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') + '//www.google.com/cse/cse.js?cx=' + cx;
var s = document.getElementsByTagName('script')[0];
s.parentNode.insertBefore(gcse, s);
})();
</script>
<gcse:searchbox-only resultsUrl="search-results.html"></gcse:searchbox-only>
</div></div>
<ul>
<li><a href="index.html">CSDataQuick Documentation</a></li>
<li><a href="csdataquick-qmlmodules.html">QML Types</a></li>
<li>CSImage QML Type</li>
</ul>
</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-csdataquick-components-csimage.html#properties">Properties</a></li>
<li class="level1"><a href="qml-csdataquick-components-csimage.html#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<div class="context">
<h1 class="title">CSImage QML Type</h1>
<span class="subtitle"></span>
<!-- $$$CSImage-brief -->
<p>Show a static or dynamic image. <a href="qml-csdataquick-components-csimage.html#details">More...</a></p>
<!-- @@@CSImage -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import CSDataQuick.Components 1.0</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <p><a href="qml-csdataquick-components-csgraphics.html">CSGraphics</a></p>
</td></tr></table></div><ul>
<li><a href="qml-csdataquick-components-csimage-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-csdataquick-components-csimage.html#imageCalc-prop">imageCalc</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-csdataquick-components-csimage.html#source-prop">source</a></b></b> : url</li>
</ul>
<!-- $$$CSImage-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>The image can be any any image format supported by Qt, loaded from any URL scheme supported by Qt. The image is scaled to fit item size.</p>
<p>If the image file has multiple frames, the designer can choose to animate the images or to display a specified frame. The default is to animate if there is more than one frame. To display a specific frame, enter an expression for the <a href="qml-csdataquick-components-csimage.html#imageCalc-prop">imageCalc</a> that returns a frame number.</p>
<pre class="qml"><span class="type"><a href="qml-csdataquick-components-csimage.html">CSImage</a></span> {
<span class="name">source</span>: <span class="string">'LED.gif'</span>
<span class="name">dynamicAttribute</span>.channel: <span class="string">'catest'</span>
<span class="name">imageCalc</span>: <span class="string">'A*10'</span>
}</pre>
<!-- @@@CSImage -->
<h2>Property Documentation</h2>
<!-- $$$imageCalc -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="imageCalc-prop">
<td class="tblQmlPropNode"><p>
<a name="imageCalc-prop"></a><span class="name">imageCalc</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>For multiple-frame images, the frame to display is defined by this expression.</p>
<p>The syntax for the imageCalc expression is the same as that for the <a href="qml-csdataquick-components-dynamicattribute.html">DynamicAttribute</a>. The only difference is that the expression should return a frame number, not True or False. The Image will be black if the expression is invalid.</p>
<p>Frame numbers start with 0. The value will be rounded to the nearest integer. Frame numbers that are too high will use the last frame, and frame numbers that are too small will use the first frame.</p>
</div></div><!-- @@@imageCalc -->
<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"><a href="http://doc.qt.io/qt-5/qml-url.html">url</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the URL that refers to the source image.</p>
</div></div><!-- @@@source -->
<br/>
</div>
</div>
</div>
</div>
</div>
<div class="footer">Copyright (C) 2012-2021 Xiaoqiang Wang, Paul Scherrer Institute.</div>
</body>
</html>