Files
qwt/doc/html/class_qwt_rich_text_engine.html
2023-10-31 09:22:42 +01:00

444 lines
21 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Qwt User&#39;s Guide: QwtRichTextEngine Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Qwt User&#39;s Guide
&#160;<span id="projectnumber">6.2.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_qwt_rich_text_engine.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_qwt_rich_text_engine-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">QwtRichTextEngine Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A text engine for Qt rich texts.
<a href="class_qwt_rich_text_engine.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="qwt__text__engine_8h_source.html">qwt_text_engine.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for QwtRichTextEngine:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="class_qwt_rich_text_engine__inherit__graph.svg" width="150" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa4c1d5a1ee88d7406ba1d6453005b46a"><td class="memItemLeft" align="right" valign="top"><a id="aa4c1d5a1ee88d7406ba1d6453005b46a"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_rich_text_engine.html#aa4c1d5a1ee88d7406ba1d6453005b46a">QwtRichTextEngine</a> ()</td></tr>
<tr class="memdesc:aa4c1d5a1ee88d7406ba1d6453005b46a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:aa4c1d5a1ee88d7406ba1d6453005b46a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6f771bfd843aa0b73054b9614d581cd0"><td class="memItemLeft" align="right" valign="top">virtual double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_rich_text_engine.html#a6f771bfd843aa0b73054b9614d581cd0">heightForWidth</a> (const QFont &amp;font, int flags, const QString &amp;text, double width) const override</td></tr>
<tr class="separator:a6f771bfd843aa0b73054b9614d581cd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d1f78b85935ecbff2bf5ea8cb84ba14"><td class="memItemLeft" align="right" valign="top">virtual QSizeF&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_rich_text_engine.html#a0d1f78b85935ecbff2bf5ea8cb84ba14">textSize</a> (const QFont &amp;font, int flags, const QString &amp;text) const override</td></tr>
<tr class="separator:a0d1f78b85935ecbff2bf5ea8cb84ba14"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abdcff7491057afe90c168c49c339b01d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_rich_text_engine.html#abdcff7491057afe90c168c49c339b01d">draw</a> (QPainter *, const QRectF &amp;rect, int flags, const QString &amp;text) const override</td></tr>
<tr class="separator:abdcff7491057afe90c168c49c339b01d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a548d48e5e5a2202e83c51e7b61ae7328"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_rich_text_engine.html#a548d48e5e5a2202e83c51e7b61ae7328">mightRender</a> (const QString &amp;) const override</td></tr>
<tr class="separator:a548d48e5e5a2202e83c51e7b61ae7328"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2790acb2618c446ed6707a07d1a4c811"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_rich_text_engine.html#a2790acb2618c446ed6707a07d1a4c811">textMargins</a> (const QFont &amp;, const QString &amp;, double &amp;left, double &amp;right, double &amp;top, double &amp;bottom) const override</td></tr>
<tr class="separator:a2790acb2618c446ed6707a07d1a4c811"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_qwt_text_engine"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_qwt_text_engine')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_qwt_text_engine.html">QwtTextEngine</a></td></tr>
<tr class="memitem:adda9e23494429c54b3cc3452940fb2bc inherit pub_methods_class_qwt_text_engine"><td class="memItemLeft" align="right" valign="top"><a id="adda9e23494429c54b3cc3452940fb2bc"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_text_engine.html#adda9e23494429c54b3cc3452940fb2bc">~QwtTextEngine</a> ()</td></tr>
<tr class="memdesc:adda9e23494429c54b3cc3452940fb2bc inherit pub_methods_class_qwt_text_engine"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:adda9e23494429c54b3cc3452940fb2bc inherit pub_methods_class_qwt_text_engine"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_class_qwt_text_engine"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_qwt_text_engine')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="class_qwt_text_engine.html">QwtTextEngine</a></td></tr>
<tr class="memitem:a97c5ef76ee920ab0f19e178e85017d9d inherit pro_methods_class_qwt_text_engine"><td class="memItemLeft" align="right" valign="top"><a id="a97c5ef76ee920ab0f19e178e85017d9d"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_text_engine.html#a97c5ef76ee920ab0f19e178e85017d9d">QwtTextEngine</a> ()</td></tr>
<tr class="memdesc:a97c5ef76ee920ab0f19e178e85017d9d inherit pro_methods_class_qwt_text_engine"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:a97c5ef76ee920ab0f19e178e85017d9d inherit pro_methods_class_qwt_text_engine"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A text engine for Qt rich texts. </p>
<p><a class="el" href="class_qwt_rich_text_engine.html" title="A text engine for Qt rich texts.">QwtRichTextEngine</a> renders Qt rich texts using the classes of the Scribe framework of Qt. </p>
<p class="definition">Definition at line <a class="el" href="qwt__text__engine_8h_source.html#l00147">147</a> of file <a class="el" href="qwt__text__engine_8h_source.html">qwt_text_engine.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="abdcff7491057afe90c168c49c339b01d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abdcff7491057afe90c168c49c339b01d">&#9670;&nbsp;</a></span>draw()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void QwtRichTextEngine::draw </td>
<td>(</td>
<td class="paramtype">QPainter *&#160;</td>
<td class="paramname"><em>painter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QRectF &amp;&#160;</td>
<td class="paramname"><em>rect</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QString &amp;&#160;</td>
<td class="paramname"><em>text</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Draw the text in a clipping rectangle</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">painter</td><td>Painter </td></tr>
<tr><td class="paramname">rect</td><td>Clipping rectangle </td></tr>
<tr><td class="paramname">flags</td><td>Bitwise OR of the flags like in for QPainter::drawText() </td></tr>
<tr><td class="paramname">text</td><td>Text to be rendered </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="class_qwt_text_engine.html#ad727f58f9eebfec86369e7f2e5bf6a59">QwtTextEngine</a>.</p>
<p class="definition">Definition at line <a class="el" href="qwt__text__engine_8cpp_source.html#l00305">305</a> of file <a class="el" href="qwt__text__engine_8cpp_source.html">qwt_text_engine.cpp</a>.</p>
</div>
</div>
<a id="a6f771bfd843aa0b73054b9614d581cd0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6f771bfd843aa0b73054b9614d581cd0">&#9670;&nbsp;</a></span>heightForWidth()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double QwtRichTextEngine::heightForWidth </td>
<td>(</td>
<td class="paramtype">const QFont &amp;&#160;</td>
<td class="paramname"><em>font</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QString &amp;&#160;</td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>width</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Find the height for a given width</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">font</td><td>Font of the text </td></tr>
<tr><td class="paramname">flags</td><td>Bitwise OR of the flags used like in QPainter::drawText() </td></tr>
<tr><td class="paramname">text</td><td>Text to be rendered </td></tr>
<tr><td class="paramname">width</td><td>Width</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Calculated height </dd></dl>
<p>Implements <a class="el" href="class_qwt_text_engine.html#aee891b14d90c817b8c73d551f623cc17">QwtTextEngine</a>.</p>
<p class="definition">Definition at line <a class="el" href="qwt__text__engine_8cpp_source.html#l00262">262</a> of file <a class="el" href="qwt__text__engine_8cpp_source.html">qwt_text_engine.cpp</a>.</p>
</div>
</div>
<a id="a548d48e5e5a2202e83c51e7b61ae7328"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a548d48e5e5a2202e83c51e7b61ae7328">&#9670;&nbsp;</a></span>mightRender()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool QwtRichTextEngine::mightRender </td>
<td>(</td>
<td class="paramtype">const QString &amp;&#160;</td>
<td class="paramname"><em>text</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Test if a string can be rendered by this text engine</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">text</td><td>Text to be tested </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Qt::mightBeRichText(text); </dd></dl>
<p>Implements <a class="el" href="class_qwt_text_engine.html#a98316f2f6f4f50216ceffbe9babe2901">QwtTextEngine</a>.</p>
<p class="definition">Definition at line <a class="el" href="qwt__text__engine_8cpp_source.html#l00331">331</a> of file <a class="el" href="qwt__text__engine_8cpp_source.html">qwt_text_engine.cpp</a>.</p>
</div>
</div>
<a id="a2790acb2618c446ed6707a07d1a4c811"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2790acb2618c446ed6707a07d1a4c811">&#9670;&nbsp;</a></span>textMargins()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void QwtRichTextEngine::textMargins </td>
<td>(</td>
<td class="paramtype">const QFont &amp;&#160;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QString &amp;&#160;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double &amp;&#160;</td>
<td class="paramname"><em>left</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double &amp;&#160;</td>
<td class="paramname"><em>right</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double &amp;&#160;</td>
<td class="paramname"><em>top</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double &amp;&#160;</td>
<td class="paramname"><em>bottom</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return margins around the texts</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">left</td><td>Return 0 </td></tr>
<tr><td class="paramname">right</td><td>Return 0 </td></tr>
<tr><td class="paramname">top</td><td>Return 0 </td></tr>
<tr><td class="paramname">bottom</td><td>Return 0 </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="class_qwt_text_engine.html#a83c8d3dc590b9914e9216c01e78e0838">QwtTextEngine</a>.</p>
<p class="definition">Definition at line <a class="el" href="qwt__text__engine_8cpp_source.html#l00344">344</a> of file <a class="el" href="qwt__text__engine_8cpp_source.html">qwt_text_engine.cpp</a>.</p>
</div>
</div>
<a id="a0d1f78b85935ecbff2bf5ea8cb84ba14"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d1f78b85935ecbff2bf5ea8cb84ba14">&#9670;&nbsp;</a></span>textSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QSizeF QwtRichTextEngine::textSize </td>
<td>(</td>
<td class="paramtype">const QFont &amp;&#160;</td>
<td class="paramname"><em>font</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QString &amp;&#160;</td>
<td class="paramname"><em>text</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the size, that is needed to render text</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">font</td><td>Font of the text </td></tr>
<tr><td class="paramname">flags</td><td>Bitwise OR of the flags used like in QPainter::drawText() </td></tr>
<tr><td class="paramname">text</td><td>Text to be rendered</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Calculated size </dd></dl>
<p>Implements <a class="el" href="class_qwt_text_engine.html#ad9382cc8ff22c6b3e448fce566a76178">QwtTextEngine</a>.</p>
<p class="definition">Definition at line <a class="el" href="qwt__text__engine_8cpp_source.html#l00281">281</a> of file <a class="el" href="qwt__text__engine_8cpp_source.html">qwt_text_engine.cpp</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="class_qwt_rich_text_engine.html">QwtRichTextEngine</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>