qwt-cmake/doc/html/class_qwt_dial_needle.html
2018-08-02 11:01:31 -04:00

340 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.11"/>
<title>Qwt User&#39;s Guide: QwtDialNeedle 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">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</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">
$(document).ready(function(){initNavTree('class_qwt_dial_needle.html','');});
</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="#pro-methods">Protected Member Functions</a> &#124;
<a href="class_qwt_dial_needle-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">QwtDialNeedle Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Base class for needles that can be used in a <a class="el" href="class_qwt_dial.html" title="QwtDial class provides a rounded range control. ">QwtDial</a>.
<a href="class_qwt_dial_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 QwtDialNeedle:</div>
<div class="dyncontent">
<div class="center"><img src="class_qwt_dial_needle__inherit__graph.png" border="0" usemap="#_qwt_dial_needle_inherit__map" alt="Inheritance graph"/></div>
<map name="_qwt_dial_needle_inherit__map" id="_qwt_dial_needle_inherit__map">
<area shape="rect" id="node2" href="class_qwt_compass_magnet_needle.html" title="A magnet needle for compass widgets. " alt="" coords="5,80,197,107"/>
<area shape="rect" id="node3" href="class_qwt_compass_wind_arrow.html" title="An indicator for the wind direction. " alt="" coords="222,80,391,107"/>
<area shape="rect" id="node4" href="class_qwt_dial_simple_needle.html" title="A needle for dial widgets. " alt="" coords="416,80,571,107"/>
</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-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aef3af79632ce784bc4d7332f6e269a1f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" 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"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:aef3af79632ce784bc4d7332f6e269a1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac23b2af4af50042967c8cea87b474247"><td class="memItemLeft" align="right" valign="top"><a class="anchor" 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"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:ac23b2af4af50042967c8cea87b474247"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae850883a64501136bca64d6ea2d084b9"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b3c915032389261e07cc983b433166c"><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#a8b3c915032389261e07cc983b433166c">palette</a> () const </td></tr>
<tr class="separator:a8b3c915032389261e07cc983b433166c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a425085086c4a8c7baff10b161616ee42"><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#a425085086c4a8c7baff10b161616ee42">draw</a> (QPainter *painter, const QPointF &amp;center, double length, double direction, QPalette::ColorGroup=QPalette::Active) const </td></tr>
<tr class="separator:a425085086c4a8c7baff10b161616ee42"><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:a3893ef0232ba0e000d3d33a0cb541dd1"><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#a3893ef0232ba0e000d3d33a0cb541dd1">drawNeedle</a> (QPainter *painter, double length, QPalette::ColorGroup colorGroup) const =0</td></tr>
<tr class="memdesc:a3893ef0232ba0e000d3d33a0cb541dd1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Draw the needle. <a href="#a3893ef0232ba0e000d3d33a0cb541dd1">More...</a><br /></td></tr>
<tr class="separator:a3893ef0232ba0e000d3d33a0cb541dd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaca9572717a1db10b1b6609571024688"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaca9572717a1db10b1b6609571024688"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_dial_needle.html#aaca9572717a1db10b1b6609571024688">drawKnob</a> (QPainter *, double width, const QBrush &amp;, bool sunken) const </td></tr>
<tr class="memdesc:aaca9572717a1db10b1b6609571024688"><td class="mdescLeft">&#160;</td><td class="mdescRight">Draw the knob. <br /></td></tr>
<tr class="separator:aaca9572717a1db10b1b6609571024688"><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>Base class for needles that can be used in a <a class="el" href="class_qwt_dial.html" title="QwtDial class provides a rounded range control. ">QwtDial</a>. </p>
<p><a class="el" href="class_qwt_dial_needle.html" title="Base class for needles that can be used in a QwtDial. ">QwtDialNeedle</a> is a pointer that indicates a value by pointing to a specific direction.</p>
<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 Function Documentation</h2>
<a class="anchor" id="a425085086c4a8c7baff10b161616ee42"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void QwtDialNeedle::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 QPointF &amp;&#160;</td>
<td class="paramname"><em>center</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">double&#160;</td>
<td class="paramname"><em>direction</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QPalette::ColorGroup&#160;</td>
<td class="paramname"><em>colorGroup</em> = <code>QPalette::Active</code>&#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">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">center</td><td>Center of the dial, start position for the needle </td></tr>
<tr><td class="paramname">length</td><td>Length of the needle </td></tr>
<tr><td class="paramname">direction</td><td>Direction of the needle, in degrees counter clockwise </td></tr>
<tr><td class="paramname">colorGroup</td><td>Color group, used for painting </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3893ef0232ba0e000d3d33a0cb541dd1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void QwtDialNeedle::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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Draw the needle. </p>
<p>The origin of the needle is at position (0.0, 0.0 ) pointing in direction 0.0 ( = east ).</p>
<p>The painter is already initialized with translation and rotation.</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>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_qwt_dial_needle.html#ae850883a64501136bca64d6ea2d084b9">setPalette()</a>, <a class="el" href="class_qwt_dial_needle.html#a8b3c915032389261e07cc983b433166c">palette()</a> </dd></dl>
<p>Implemented in <a class="el" href="class_qwt_compass_wind_arrow.html#a4e3b612f2de83ff416e34f62c1f0fd6c">QwtCompassWindArrow</a>, <a class="el" href="class_qwt_compass_magnet_needle.html#aa052d929a09bfc6d487a973b2221d44d">QwtCompassMagnetNeedle</a>, and <a class="el" href="class_qwt_dial_simple_needle.html#a0eff8832707ff968d17eddf478d6a771">QwtDialSimpleNeedle</a>.</p>
</div>
</div>
<a class="anchor" id="a8b3c915032389261e07cc983b433166c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const QPalette &amp; QwtDialNeedle::palette </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the palette of the needle. </dd></dl>
</div>
</div>
<a class="anchor" id="ae850883a64501136bca64d6ea2d084b9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void QwtDialNeedle::setPalette </td>
<td>(</td>
<td class="paramtype">const QPalette &amp;&#160;</td>
<td class="paramname"><em>palette</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the palette for the needle.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">palette</td><td>New Palette </td></tr>
</table>
</dd>
</dl>
</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_dial_needle.html">QwtDialNeedle</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.11 </li>
</ul>
</div>
</body>
</html>