Files
ResInsight/ThirdParty/Qwt/doc/html/class_qwt_compass_magnet_needle.html
Magne Sjaastad ecf5a67074 System : Upgrade to Qwt 6.1.4
Avoid use of deprecated Qt functions like QString::null
2019-09-13 10:07:49 +02:00

254 lines
16 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Qwt User&#39;s Guide: QwtCompassMagnetNeedle 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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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.1.4</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<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');
/* @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_compass_magnet_needle.html','');});
/* @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-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="class_qwt_compass_magnet_needle-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">QwtCompassMagnetNeedle Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A magnet needle for compass widgets.
<a href="class_qwt_compass_magnet_needle.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="qwt__dial__needle_8h_source.html">qwt_dial_needle.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for QwtCompassMagnetNeedle:</div>
<div class="dyncontent">
<div class="center"><img src="class_qwt_compass_magnet_needle__inherit__graph.png" border="0" usemap="#_qwt_compass_magnet_needle_inherit__map" alt="Inheritance graph"/></div>
<map name="_qwt_compass_magnet_needle_inherit__map" id="_qwt_compass_magnet_needle_inherit__map">
<area shape="rect" id="node2" href="class_qwt_dial_needle.html" title="Base class for needles that can be used in a QwtDial. " alt="" coords="45,5,158,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:aee1d882c6ec8b680b94b59b5710a92a5"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_compass_magnet_needle.html#aee1d882c6ec8b680b94b59b5710a92a5">Style</a> { <a class="el" href="class_qwt_compass_magnet_needle.html#aee1d882c6ec8b680b94b59b5710a92a5ad2ba960c4dae88e36da39f6b62798f3b">TriangleStyle</a>,
<a class="el" href="class_qwt_compass_magnet_needle.html#aee1d882c6ec8b680b94b59b5710a92a5ab63a2dd26ef14c2aaf9763bc24a8bdac">ThinStyle</a>
}</td></tr>
<tr class="memdesc:aee1d882c6ec8b680b94b59b5710a92a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Style of the needle. <a href="class_qwt_compass_magnet_needle.html#aee1d882c6ec8b680b94b59b5710a92a5">More...</a><br /></td></tr>
<tr class="separator:aee1d882c6ec8b680b94b59b5710a92a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a3422e6490d44c527289bafdcceecd741"><td class="memItemLeft" align="right" valign="top"><a id="a3422e6490d44c527289bafdcceecd741"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_compass_magnet_needle.html#a3422e6490d44c527289bafdcceecd741">QwtCompassMagnetNeedle</a> (<a class="el" href="class_qwt_compass_magnet_needle.html#aee1d882c6ec8b680b94b59b5710a92a5">Style</a>=<a class="el" href="class_qwt_compass_magnet_needle.html#aee1d882c6ec8b680b94b59b5710a92a5ad2ba960c4dae88e36da39f6b62798f3b">TriangleStyle</a>, const QColor &amp;light=Qt::white, const QColor &amp;dark=Qt::red)</td></tr>
<tr class="memdesc:a3422e6490d44c527289bafdcceecd741"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:a3422e6490d44c527289bafdcceecd741"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_qwt_dial_needle"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_qwt_dial_needle')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_qwt_dial_needle.html">QwtDialNeedle</a></td></tr>
<tr class="memitem:aef3af79632ce784bc4d7332f6e269a1f inherit pub_methods_class_qwt_dial_needle"><td class="memItemLeft" align="right" valign="top"><a id="aef3af79632ce784bc4d7332f6e269a1f"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_dial_needle.html#aef3af79632ce784bc4d7332f6e269a1f">QwtDialNeedle</a> ()</td></tr>
<tr class="memdesc:aef3af79632ce784bc4d7332f6e269a1f inherit pub_methods_class_qwt_dial_needle"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:aef3af79632ce784bc4d7332f6e269a1f inherit pub_methods_class_qwt_dial_needle"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac23b2af4af50042967c8cea87b474247 inherit pub_methods_class_qwt_dial_needle"><td class="memItemLeft" align="right" valign="top"><a id="ac23b2af4af50042967c8cea87b474247"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_dial_needle.html#ac23b2af4af50042967c8cea87b474247">~QwtDialNeedle</a> ()</td></tr>
<tr class="memdesc:ac23b2af4af50042967c8cea87b474247 inherit pub_methods_class_qwt_dial_needle"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:ac23b2af4af50042967c8cea87b474247 inherit pub_methods_class_qwt_dial_needle"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae850883a64501136bca64d6ea2d084b9 inherit pub_methods_class_qwt_dial_needle"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_dial_needle.html#ae850883a64501136bca64d6ea2d084b9">setPalette</a> (const QPalette &amp;)</td></tr>
<tr class="separator:ae850883a64501136bca64d6ea2d084b9 inherit pub_methods_class_qwt_dial_needle"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4c32d58f2b8e77fd66e0dfc66b7c37a inherit pub_methods_class_qwt_dial_needle"><td class="memItemLeft" align="right" valign="top">const QPalette &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_dial_needle.html#ad4c32d58f2b8e77fd66e0dfc66b7c37a">palette</a> () const</td></tr>
<tr class="separator:ad4c32d58f2b8e77fd66e0dfc66b7c37a inherit pub_methods_class_qwt_dial_needle"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b437180b9f4085485a6003d211f6efa inherit pub_methods_class_qwt_dial_needle"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_dial_needle.html#a3b437180b9f4085485a6003d211f6efa">draw</a> (QPainter *painter, const QPointF &amp;center, double length, double direction, QPalette::ColorGroup=QPalette::Active) const</td></tr>
<tr class="separator:a3b437180b9f4085485a6003d211f6efa inherit pub_methods_class_qwt_dial_needle"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a3e9787b5d4fa1264e3e05ccdf049ffa9"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_compass_magnet_needle.html#a3e9787b5d4fa1264e3e05ccdf049ffa9">drawNeedle</a> (QPainter *, double length, QPalette::ColorGroup) const</td></tr>
<tr class="separator:a3e9787b5d4fa1264e3e05ccdf049ffa9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_class_qwt_dial_needle"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_qwt_dial_needle')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="class_qwt_dial_needle.html">QwtDialNeedle</a></td></tr>
<tr class="memitem:a769a895b3fefd851b44021ca118f2422 inherit pro_methods_class_qwt_dial_needle"><td class="memItemLeft" align="right" valign="top"><a id="a769a895b3fefd851b44021ca118f2422"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_dial_needle.html#a769a895b3fefd851b44021ca118f2422">drawKnob</a> (QPainter *, double width, const QBrush &amp;, bool sunken) const</td></tr>
<tr class="memdesc:a769a895b3fefd851b44021ca118f2422 inherit pro_methods_class_qwt_dial_needle"><td class="mdescLeft">&#160;</td><td class="mdescRight">Draw the knob. <br /></td></tr>
<tr class="separator:a769a895b3fefd851b44021ca118f2422 inherit pro_methods_class_qwt_dial_needle"><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 magnet needle for compass widgets. </p>
<p>A magnet needle points to two opposite directions indicating north and south.</p>
<p>The following colors are used:</p><ul>
<li>QPalette::Light<br />
Used for pointing south</li>
<li>QPalette::Dark<br />
Used for pointing north</li>
<li>QPalette::Base<br />
Knob (ThinStyle only)</li>
</ul>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_qwt_dial.html" title="QwtDial class provides a rounded range control. ">QwtDial</a>, <a class="el" href="class_qwt_compass.html" title="A Compass Widget. ">QwtCompass</a> </dd></dl>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="aee1d882c6ec8b680b94b59b5710a92a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee1d882c6ec8b680b94b59b5710a92a5">&#9670;&nbsp;</a></span>Style</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="class_qwt_compass_magnet_needle.html#aee1d882c6ec8b680b94b59b5710a92a5">QwtCompassMagnetNeedle::Style</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Style of the needle. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aee1d882c6ec8b680b94b59b5710a92a5ad2ba960c4dae88e36da39f6b62798f3b"></a>TriangleStyle&#160;</td><td class="fielddoc"><p>A needle with a triangular shape. </p>
</td></tr>
<tr><td class="fieldname"><a id="aee1d882c6ec8b680b94b59b5710a92a5ab63a2dd26ef14c2aaf9763bc24a8bdac"></a>ThinStyle&#160;</td><td class="fielddoc"><p>A thin needle. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a3e9787b5d4fa1264e3e05ccdf049ffa9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e9787b5d4fa1264e3e05ccdf049ffa9">&#9670;&nbsp;</a></span>drawNeedle()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void QwtCompassMagnetNeedle::drawNeedle </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">double&#160;</td>
<td class="paramname"><em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QPalette::ColorGroup&#160;</td>
<td class="paramname"><em>colorGroup</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">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Draw the needle</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">length</td><td>Length of the needle </td></tr>
<tr><td class="paramname">colorGroup</td><td>Color group, used for painting </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="class_qwt_dial_needle.html#a1e4fee366fec1838edc18890d9957f2b">QwtDialNeedle</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_compass_magnet_needle.html">QwtCompassMagnetNeedle</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
</div>
</body>
</html>