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

230 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: QwtPickerMachine 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_picker_machine.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-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_qwt_picker_machine-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">QwtPickerMachine Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>A state machine for <a class="el" href="class_qwt_picker.html" title="QwtPicker provides selections on a widget. ">QwtPicker</a> selections.
<a href="class_qwt_picker_machine.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="qwt__picker__machine_8h_source.html">qwt_picker_machine.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for QwtPickerMachine:</div>
<div class="dyncontent">
<div class="center"><img src="class_qwt_picker_machine__inherit__graph.png" border="0" usemap="#_qwt_picker_machine_inherit__map" alt="Inheritance graph"/></div>
<map name="_qwt_picker_machine_inherit__map" id="_qwt_picker_machine_inherit__map">
<area shape="rect" id="node2" href="class_qwt_picker_click_point_machine.html" title="A state machine for point selections. " alt="" coords="188,5,383,32"/>
<area shape="rect" id="node3" href="class_qwt_picker_click_rect_machine.html" title="A state machine for rectangle selections. " alt="" coords="190,56,381,83"/>
<area shape="rect" id="node4" href="class_qwt_picker_drag_line_machine.html" title="A state machine for line selections. " alt="" coords="191,107,380,133"/>
<area shape="rect" id="node5" href="class_qwt_picker_drag_point_machine.html" title="A state machine for point selections. " alt="" coords="188,157,383,184"/>
<area shape="rect" id="node6" href="class_qwt_picker_drag_rect_machine.html" title="A state machine for rectangle selections. " alt="" coords="190,208,381,235"/>
<area shape="rect" id="node7" href="class_qwt_picker_polygon_machine.html" title="A state machine for polygon selections. " alt="" coords="193,259,377,285"/>
<area shape="rect" id="node8" href="class_qwt_picker_tracker_machine.html" title="A state machine for indicating mouse movements. " alt="" coords="194,309,377,336"/>
</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:a24a9faf12cfa5746eee839a2c0bb937d"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_picker_machine.html#a24a9faf12cfa5746eee839a2c0bb937d">SelectionType</a> { <a class="el" href="class_qwt_picker_machine.html#a24a9faf12cfa5746eee839a2c0bb937da326bcc03f7a99aa5970d875f3db46888">NoSelection</a> = -1,
<a class="el" href="class_qwt_picker_machine.html#a24a9faf12cfa5746eee839a2c0bb937dae65a34cc1ca5d818eb65c05b2484d855">PointSelection</a>,
<a class="el" href="class_qwt_picker_machine.html#a24a9faf12cfa5746eee839a2c0bb937da9f540e78958e8e238240584120e8af1d">RectSelection</a>,
<a class="el" href="class_qwt_picker_machine.html#a24a9faf12cfa5746eee839a2c0bb937dac74671ee5ba5d6fd0410f71db1aa3b97">PolygonSelection</a>
}</td></tr>
<tr class="separator:a24a9faf12cfa5746eee839a2c0bb937d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a8d3d4c107ce5f8351e4cbdd38c43f7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3a8d3d4c107ce5f8351e4cbdd38c43f7"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_picker_machine.html#a3a8d3d4c107ce5f8351e4cbdd38c43f7">Command</a> { <br />
&#160;&#160;<b>Begin</b>,
<b>Append</b>,
<b>Move</b>,
<b>Remove</b>,
<br />
&#160;&#160;<b>End</b>
<br />
}<tr class="memdesc:a3a8d3d4c107ce5f8351e4cbdd38c43f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Commands - the output of a state machine. <br /></td></tr>
</td></tr>
<tr class="separator:a3a8d3d4c107ce5f8351e4cbdd38c43f7"><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:ab27bc3f70d48aa145db9ebbfdba34e15"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab27bc3f70d48aa145db9ebbfdba34e15"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_picker_machine.html#ab27bc3f70d48aa145db9ebbfdba34e15">QwtPickerMachine</a> (<a class="el" href="class_qwt_picker_machine.html#a24a9faf12cfa5746eee839a2c0bb937d">SelectionType</a>)</td></tr>
<tr class="memdesc:ab27bc3f70d48aa145db9ebbfdba34e15"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:ab27bc3f70d48aa145db9ebbfdba34e15"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1164dfb8ae6ac62fb3b6cb19efcb3e5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa1164dfb8ae6ac62fb3b6cb19efcb3e5"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_picker_machine.html#aa1164dfb8ae6ac62fb3b6cb19efcb3e5">~QwtPickerMachine</a> ()</td></tr>
<tr class="memdesc:aa1164dfb8ae6ac62fb3b6cb19efcb3e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:aa1164dfb8ae6ac62fb3b6cb19efcb3e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf7b57003bec437ce1ecf83e6d544968"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acf7b57003bec437ce1ecf83e6d544968"></a>
virtual QList&lt; <a class="el" href="class_qwt_picker_machine.html#a3a8d3d4c107ce5f8351e4cbdd38c43f7">Command</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_picker_machine.html#acf7b57003bec437ce1ecf83e6d544968">transition</a> (const <a class="el" href="class_qwt_event_pattern.html">QwtEventPattern</a> &amp;, const QEvent *)=0</td></tr>
<tr class="memdesc:acf7b57003bec437ce1ecf83e6d544968"><td class="mdescLeft">&#160;</td><td class="mdescRight">Transition. <br /></td></tr>
<tr class="separator:acf7b57003bec437ce1ecf83e6d544968"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace6daa55324a8daab3839cf8ba677a93"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ace6daa55324a8daab3839cf8ba677a93"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_picker_machine.html#ace6daa55324a8daab3839cf8ba677a93">reset</a> ()</td></tr>
<tr class="memdesc:ace6daa55324a8daab3839cf8ba677a93"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the current state to 0. <br /></td></tr>
<tr class="separator:ace6daa55324a8daab3839cf8ba677a93"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9060b1036ef5125968fc7030681d73c0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9060b1036ef5125968fc7030681d73c0"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_picker_machine.html#a9060b1036ef5125968fc7030681d73c0">state</a> () const </td></tr>
<tr class="memdesc:a9060b1036ef5125968fc7030681d73c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the current state. <br /></td></tr>
<tr class="separator:a9060b1036ef5125968fc7030681d73c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a569c426543e4a6aa15c221eb7c4910f0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a569c426543e4a6aa15c221eb7c4910f0"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_picker_machine.html#a569c426543e4a6aa15c221eb7c4910f0">setState</a> (int)</td></tr>
<tr class="memdesc:a569c426543e4a6aa15c221eb7c4910f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Change the current state. <br /></td></tr>
<tr class="separator:a569c426543e4a6aa15c221eb7c4910f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ccd6ccb3fa0e2a73730e69a8658c316"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ccd6ccb3fa0e2a73730e69a8658c316"></a>
<a class="el" href="class_qwt_picker_machine.html#a24a9faf12cfa5746eee839a2c0bb937d">SelectionType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_picker_machine.html#a9ccd6ccb3fa0e2a73730e69a8658c316">selectionType</a> () const </td></tr>
<tr class="memdesc:a9ccd6ccb3fa0e2a73730e69a8658c316"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the selection type. <br /></td></tr>
<tr class="separator:a9ccd6ccb3fa0e2a73730e69a8658c316"><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 state machine for <a class="el" href="class_qwt_picker.html" title="QwtPicker provides selections on a widget. ">QwtPicker</a> selections. </p>
<p><a class="el" href="class_qwt_picker_machine.html" title="A state machine for QwtPicker selections. ">QwtPickerMachine</a> accepts key and mouse events and translates them into selection commands.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_qwt_event_pattern.html#af48dc808ac5e125eeed41a4c0285d1ea" title="Symbolic mouse input codes. ">QwtEventPattern::MousePatternCode</a>, <a class="el" href="class_qwt_event_pattern.html#a8fb57ceb9982d5583a1bf568e37d3007" title="Symbolic keyboard input codes. ">QwtEventPattern::KeyPatternCode</a> </dd></dl>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="a24a9faf12cfa5746eee839a2c0bb937d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="class_qwt_picker_machine.html#a24a9faf12cfa5746eee839a2c0bb937d">QwtPickerMachine::SelectionType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type of a selection. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="class_qwt_picker_machine.html#a9ccd6ccb3fa0e2a73730e69a8658c316" title="Return the selection type. ">selectionType()</a> </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="a24a9faf12cfa5746eee839a2c0bb937da326bcc03f7a99aa5970d875f3db46888"></a>NoSelection&#160;</td><td class="fielddoc">
<p>The state machine not usable for any type of selection. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a24a9faf12cfa5746eee839a2c0bb937dae65a34cc1ca5d818eb65c05b2484d855"></a>PointSelection&#160;</td><td class="fielddoc">
<p>The state machine is for selecting a single point. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a24a9faf12cfa5746eee839a2c0bb937da9f540e78958e8e238240584120e8af1d"></a>RectSelection&#160;</td><td class="fielddoc">
<p>The state machine is for selecting a rectangle (2 points). </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a24a9faf12cfa5746eee839a2c0bb937dac74671ee5ba5d6fd0410f71db1aa3b97"></a>PolygonSelection&#160;</td><td class="fielddoc">
<p>The state machine is for selecting a polygon (many points). </p>
</td></tr>
</table>
</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_picker_machine.html">QwtPickerMachine</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>