<!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.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Engauge Digitizer: Checklist/ChecklistGuide.cpp Source File</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="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">Engauge Digitizer
 <span id="projectnumber">2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_1206ffc2a5865d3b4d502237e11859d2.html">Checklist</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">ChecklistGuide.cpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/******************************************************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * (C) 2014 markummitchell@github.com. This file is part of Engauge Digitizer, which is released *</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * under GNU General Public License version 2 (GPLv2) or (at your option) any later version. See file *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * LICENSE or go to gnu.org/licenses for details. Distribution requires prior written permission. *</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> ******************************************************************************************************/</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include "ChecklistGuide.h"</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "ChecklistGuideBrowser.h"</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "CmdMediator.h"</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include "EngaugeAssert.h"</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include "Logger.h"</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <QTextBrowser></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> </div><div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="classChecklistGuide.html#a2285e443d1a4fe7591ce482f221af5d0"> 14</a></span> <a class="code" href="classChecklistGuide.html#a2285e443d1a4fe7591ce482f221af5d0">ChecklistGuide::ChecklistGuide</a> (QWidget *parent) :</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  QDockWidget (parent),</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  m_browser (0)</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> {</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  setVisible (<span class="keyword">false</span>);</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  setAllowedAreas (Qt::AllDockWidgetAreas);</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  setWindowTitle (tr (<span class="stringliteral">"Checklist Guide"</span>)); <span class="comment">// Appears in title bar when undocked</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  setStatusTip (tr (<span class="stringliteral">"Checklist Guide"</span>));</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  setWhatsThis (tr (<span class="stringliteral">"Checklist Guide\n\n"</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <span class="stringliteral">"This box contains a checklist of steps suggested by the Checklist Guide Wizard. Following "</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <span class="stringliteral">"these steps should produce a set of digitized points in an output file.\n\n"</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="stringliteral">"To run the Checklist Guide Wizard when an image file is imported, select the "</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="stringliteral">"Help / Checklist Wizard menu option."</span>));</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  m_browser = <span class="keyword">new</span> <a class="code" href="classChecklistGuideBrowser.html">ChecklistGuideBrowser</a>;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  setWidget (m_browser);</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> }</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="classChecklistGuide.html#a1f51642c02e15e9f6272c5e9799f1cbe"> 32</a></span> <span class="keywordtype">bool</span> <a class="code" href="classChecklistGuide.html#a1f51642c02e15e9f6272c5e9799f1cbe">ChecklistGuide::browserIsEmpty</a> ()<span class="keyword"> const</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword"></span>{</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keywordflow">return</span> m_browser->toPlainText().isEmpty();</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> }</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classChecklistGuide.html#adcb70e6619269ef366a1343f952b25df"> 37</a></span> <span class="keywordtype">void</span> <a class="code" href="classChecklistGuide.html#adcb70e6619269ef366a1343f952b25df">ChecklistGuide::closeEvent</a>(QCloseEvent * <span class="comment">/* event */</span>)</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> {</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  LOG4CPP_INFO_S ((*mainCat)) << <span class="stringliteral">"ChecklistGuide::closeEvent"</span>;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  emit <a class="code" href="classChecklistGuide.html#afb0db7b19ff273cfeefcd8b423c8442b">signalChecklistClosed</a>();</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> }</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classChecklistGuide.html#a743f1c176c5b4c22de336f54cc318c00"> 44</a></span> <span class="keywordtype">void</span> <a class="code" href="classChecklistGuide.html#a743f1c176c5b4c22de336f54cc318c00">ChecklistGuide::setTemplateHtml</a> (<span class="keyword">const</span> QString &html,</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">const</span> QStringList &curveNames)</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> {</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  LOG4CPP_INFO_S ((*mainCat)) << <span class="stringliteral">"ChecklistGuide::setTemplateHtml"</span>;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  m_browser-><a class="code" href="classChecklistGuideBrowser.html#a9729a89650df987790cbb0b63005ffcc">setTemplateHtml</a> (html,</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  curveNames);</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> }</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classChecklistGuide.html#a8d042a39a8d3663d08974b8d98aaa871"> 53</a></span> <span class="keywordtype">void</span> <a class="code" href="classChecklistGuide.html#a8d042a39a8d3663d08974b8d98aaa871">ChecklistGuide::update</a> (<span class="keyword">const</span> <a class="code" href="classCmdMediator.html">CmdMediator</a> &cmdMediator,</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">bool</span> documentIsExported)</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> {</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  LOG4CPP_INFO_S ((*mainCat)) << <span class="stringliteral">"ChecklistGuide::update"</span>;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  ENGAUGE_CHECK_PTR (m_browser);</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  m_browser-><a class="code" href="classChecklistGuideBrowser.html#a74a90d6507718824daab679645e122be">update</a> (cmdMediator,</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  documentIsExported);</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> }</div><div class="ttc" id="classChecklistGuideBrowser_html_a9729a89650df987790cbb0b63005ffcc"><div class="ttname"><a href="classChecklistGuideBrowser.html#a9729a89650df987790cbb0b63005ffcc">ChecklistGuideBrowser::setTemplateHtml</a></div><div class="ttdeci">virtual void setTemplateHtml(const QString &html, const QStringList &curveNames)</div><div class="ttdoc">Populate the browser with template html. The template html will be converted to real html...</div><div class="ttdef"><b>Definition:</b> <a href="ChecklistGuideBrowser_8cpp_source.html#l00249">ChecklistGuideBrowser.cpp:249</a></div></div>
<div class="ttc" id="classChecklistGuideBrowser_html_a74a90d6507718824daab679645e122be"><div class="ttname"><a href="classChecklistGuideBrowser.html#a74a90d6507718824daab679645e122be">ChecklistGuideBrowser::update</a></div><div class="ttdeci">void update(const CmdMediator &cmdMediator, bool documentIsExported)</div><div class="ttdoc">Update using current CmdMediator/Document state. </div><div class="ttdef"><b>Definition:</b> <a href="ChecklistGuideBrowser_8cpp_source.html#l00270">ChecklistGuideBrowser.cpp:270</a></div></div>
<div class="ttc" id="classChecklistGuide_html_afb0db7b19ff273cfeefcd8b423c8442b"><div class="ttname"><a href="classChecklistGuide.html#afb0db7b19ff273cfeefcd8b423c8442b">ChecklistGuide::signalChecklistClosed</a></div><div class="ttdeci">void signalChecklistClosed()</div><div class="ttdoc">Signal that this QDockWidget was just closed. </div></div>
<div class="ttc" id="classChecklistGuideBrowser_html"><div class="ttname"><a href="classChecklistGuideBrowser.html">ChecklistGuideBrowser</a></div><div class="ttdoc">Class that adds rudimentary tree collapse/expand functionality to QTextBrowser. </div><div class="ttdef"><b>Definition:</b> <a href="ChecklistGuideBrowser_8h_source.html#l00015">ChecklistGuideBrowser.h:15</a></div></div>
<div class="ttc" id="classChecklistGuide_html_adcb70e6619269ef366a1343f952b25df"><div class="ttname"><a href="classChecklistGuide.html#adcb70e6619269ef366a1343f952b25df">ChecklistGuide::closeEvent</a></div><div class="ttdeci">virtual void closeEvent(QCloseEvent *event)</div><div class="ttdoc">Catch close event so corresponding menu item in MainWindow can be updated accordingly. </div><div class="ttdef"><b>Definition:</b> <a href="ChecklistGuide_8cpp_source.html#l00037">ChecklistGuide.cpp:37</a></div></div>
<div class="ttc" id="classCmdMediator_html"><div class="ttname"><a href="classCmdMediator.html">CmdMediator</a></div><div class="ttdoc">Command queue stack. </div><div class="ttdef"><b>Definition:</b> <a href="CmdMediator_8h_source.html#l00023">CmdMediator.h:23</a></div></div>
<div class="ttc" id="classChecklistGuide_html_a2285e443d1a4fe7591ce482f221af5d0"><div class="ttname"><a href="classChecklistGuide.html#a2285e443d1a4fe7591ce482f221af5d0">ChecklistGuide::ChecklistGuide</a></div><div class="ttdeci">ChecklistGuide(QWidget *parent)</div><div class="ttdoc">Single constructor. Parent is needed or else this widget cannot be redocked after being undocked...</div><div class="ttdef"><b>Definition:</b> <a href="ChecklistGuide_8cpp_source.html#l00014">ChecklistGuide.cpp:14</a></div></div>
<div class="ttc" id="classChecklistGuide_html_a8d042a39a8d3663d08974b8d98aaa871"><div class="ttname"><a href="classChecklistGuide.html#a8d042a39a8d3663d08974b8d98aaa871">ChecklistGuide::update</a></div><div class="ttdeci">void update(const CmdMediator &cmdMediator, bool documentIsExported)</div><div class="ttdoc">Update using current CmdMediator/Document state. </div><div class="ttdef"><b>Definition:</b> <a href="ChecklistGuide_8cpp_source.html#l00053">ChecklistGuide.cpp:53</a></div></div>
<div class="ttc" id="classChecklistGuide_html_a1f51642c02e15e9f6272c5e9799f1cbe"><div class="ttname"><a href="classChecklistGuide.html#a1f51642c02e15e9f6272c5e9799f1cbe">ChecklistGuide::browserIsEmpty</a></div><div class="ttdeci">bool browserIsEmpty() const</div><div class="ttdoc">When browser is empty, it is pointless to show it. </div><div class="ttdef"><b>Definition:</b> <a href="ChecklistGuide_8cpp_source.html#l00032">ChecklistGuide.cpp:32</a></div></div>
<div class="ttc" id="classChecklistGuide_html_a743f1c176c5b4c22de336f54cc318c00"><div class="ttname"><a href="classChecklistGuide.html#a743f1c176c5b4c22de336f54cc318c00">ChecklistGuide::setTemplateHtml</a></div><div class="ttdeci">void setTemplateHtml(const QString &html, const QStringList &curveNames)</div><div class="ttdoc">Populate the browser with template html. </div><div class="ttdef"><b>Definition:</b> <a href="ChecklistGuide_8cpp_source.html#l00044">ChecklistGuide.cpp:44</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Dec 25 2016 20:54:08 for Engauge Digitizer by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.12
</small></address>
</body>
</html>
