b15f/docs/html/view_8h_source.html
2019-12-03 07:43:29 +01:00

100 lines
18 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.8.16"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>B15F: ui/view.h 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">B15F
</div>
<div id="projectbrief">Board 15 Famulus Edition</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<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>
<!-- 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_1788f8309b1a812dcb800a185471cf6c.html">ui</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">view.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef VIEW_H</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define VIEW_H</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160; </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &lt;iostream&gt;</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &lt;cmath&gt;</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include &lt;functional&gt;</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &lt;ncurses.h&gt;</span> <span class="comment">// sudo apt-get install libncurses5-dev</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &lt;sys/ioctl.h&gt;</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &lt;unistd.h&gt;</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &lt;signal.h&gt;</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &quot;../drv/b15f.h&quot;</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; </div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="keyword">extern</span> std::string ERR_MSG;</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="keyword">typedef</span> std::function&lt;void(<span class="keywordtype">int</span>)&gt; call_t;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; </div><div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="classView.html"> 19</a></span>&#160;<span class="keyword">class </span><a class="code" href="classView.html">View</a></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;{</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <a class="code" href="classView.html#a0a9be6e5fb588412aab31cacf5e43b04">View</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keyword">virtual</span> <a class="code" href="classView.html#a450dfab3f21a52edc03db4310593412f">~View</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classView.html#a990aa2223befde031dfcce54a740c558">setWinContext</a>(WINDOW* <a class="code" href="classView.html#a5ddee2bf0b26dbcfa7780be17ff33dd7">win</a>);</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keyword">static</span> WINDOW* <a class="code" href="classView.html#a0710c6ba06e3795e7ddf369361308b79">getWinContext</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keyword">static</span> std::vector&lt;std::string&gt; <a class="code" href="classView.html#a52c2e2a7bc56388e7d9bfa398ad52668">str_split</a>(<span class="keyword">const</span> std::string&amp; str, <span class="keyword">const</span> std::string delim);</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classView.html#a6c725e4d83fd7474635a7e64200c7a08">setTitle</a>(std::string <a class="code" href="classView.html#a80441aa81b52e04677a2aa2bd9c47753">title</a>);</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classView.html#aa7b1f1179e3c4f06bef1e99355d0d592">repaint</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; </div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classView.html#a092a269bf53569af7fca4d710dd5b980">draw</a>(<span class="keywordtype">void</span>) = 0;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keyword">virtual</span> call_t <a class="code" href="classView.html#a60f77156dc4786bb6227d58a3061d2f6">keypress</a>(<span class="keywordtype">int</span>&amp; key) = 0;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;<span class="keyword">protected</span>:</div><div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="classView.html#ae039aa744b085db819ae149705b2c32b"> 79</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="classView.html#ae039aa744b085db819ae149705b2c32b">width</a>; </div><div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="classView.html#a6e3e5c18893617490f02166641356746"> 80</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="classView.html#a6e3e5c18893617490f02166641356746">height</a>; </div><div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="classView.html#a9fc9f3b0c876d063e6f57dee320a43fe"> 81</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="classView.html#a9fc9f3b0c876d063e6f57dee320a43fe">start_x</a> = 0; </div><div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="classView.html#ac424db4c13776c3ce9d33f9074dfcfaa"> 82</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="classView.html#ac424db4c13776c3ce9d33f9074dfcfaa">start_y</a> = 0; </div><div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="classView.html#a80441aa81b52e04677a2aa2bd9c47753"> 83</a></span>&#160; std::string <a class="code" href="classView.html#a80441aa81b52e04677a2aa2bd9c47753">title</a>; </div><div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="classView.html#a610367214a727e2f7da72ac5bdb60fa3"> 84</a></span>&#160; std::vector&lt;call_t&gt; <a class="code" href="classView.html#a610367214a727e2f7da72ac5bdb60fa3">calls</a>; </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; </div><div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="classView.html#a5ddee2bf0b26dbcfa7780be17ff33dd7"> 86</a></span>&#160; <span class="keyword">static</span> WINDOW* <a class="code" href="classView.html#a5ddee2bf0b26dbcfa7780be17ff33dd7">win</a>; </div><div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="classView.html#a3554cf8689cad24c643665aa3d182134"> 87</a></span>&#160; constexpr <span class="keyword">static</span> <span class="keywordtype">int</span> <a class="code" href="classView.html#a3554cf8689cad24c643665aa3d182134">KEY_ENT</a> = 10; </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;};</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; </div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;<span class="preprocessor">#endif // VIEW_H</span></div></div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclassView_html_a6e3e5c18893617490f02166641356746"><div class="ttname"><a href="classView.html#a6e3e5c18893617490f02166641356746">View::height</a></div><div class="ttdeci">int height</div><div class="ttdoc">height of view in terminal characters</div><div class="ttdef"><b>Definition:</b> <a href="view_8h_source.html#l00080">view.h:80</a></div></div>
<div class="ttc" id="aclassView_html_ae039aa744b085db819ae149705b2c32b"><div class="ttname"><a href="classView.html#ae039aa744b085db819ae149705b2c32b">View::width</a></div><div class="ttdeci">int width</div><div class="ttdoc">width of view in terminal characters</div><div class="ttdef"><b>Definition:</b> <a href="view_8h_source.html#l00079">view.h:79</a></div></div>
<div class="ttc" id="aclassView_html_a80441aa81b52e04677a2aa2bd9c47753"><div class="ttname"><a href="classView.html#a80441aa81b52e04677a2aa2bd9c47753">View::title</a></div><div class="ttdeci">std::string title</div><div class="ttdoc">title of the view</div><div class="ttdef"><b>Definition:</b> <a href="view_8h_source.html#l00083">view.h:83</a></div></div>
<div class="ttc" id="aclassView_html_a450dfab3f21a52edc03db4310593412f"><div class="ttname"><a href="classView.html#a450dfab3f21a52edc03db4310593412f">View::~View</a></div><div class="ttdeci">virtual ~View(void)</div><div class="ttdef"><b>Definition:</b> <a href="view_8cpp_source.html#l00015">view.cpp:15</a></div></div>
<div class="ttc" id="aclassView_html_a0710c6ba06e3795e7ddf369361308b79"><div class="ttname"><a href="classView.html#a0710c6ba06e3795e7ddf369361308b79">View::getWinContext</a></div><div class="ttdeci">static WINDOW * getWinContext(void)</div><div class="ttdef"><b>Definition:</b> <a href="view_8cpp_source.html#l00024">view.cpp:24</a></div></div>
<div class="ttc" id="aclassView_html"><div class="ttname"><a href="classView.html">View</a></div><div class="ttdef"><b>Definition:</b> <a href="view_8h_source.html#l00019">view.h:19</a></div></div>
<div class="ttc" id="aclassView_html_a610367214a727e2f7da72ac5bdb60fa3"><div class="ttname"><a href="classView.html#a610367214a727e2f7da72ac5bdb60fa3">View::calls</a></div><div class="ttdeci">std::vector&lt; call_t &gt; calls</div><div class="ttdoc">calls (function pointers) for different button actions in the view (if any)</div><div class="ttdef"><b>Definition:</b> <a href="view_8h_source.html#l00084">view.h:84</a></div></div>
<div class="ttc" id="aclassView_html_a5ddee2bf0b26dbcfa7780be17ff33dd7"><div class="ttname"><a href="classView.html#a5ddee2bf0b26dbcfa7780be17ff33dd7">View::win</a></div><div class="ttdeci">static WINDOW * win</div><div class="ttdoc">static window contexts for all views</div><div class="ttdef"><b>Definition:</b> <a href="view_8h_source.html#l00086">view.h:86</a></div></div>
<div class="ttc" id="aclassView_html_a990aa2223befde031dfcce54a740c558"><div class="ttname"><a href="classView.html#a990aa2223befde031dfcce54a740c558">View::setWinContext</a></div><div class="ttdeci">static void setWinContext(WINDOW *win)</div><div class="ttdef"><b>Definition:</b> <a href="view_8cpp_source.html#l00019">view.cpp:19</a></div></div>
<div class="ttc" id="aclassView_html_a52c2e2a7bc56388e7d9bfa398ad52668"><div class="ttname"><a href="classView.html#a52c2e2a7bc56388e7d9bfa398ad52668">View::str_split</a></div><div class="ttdeci">static std::vector&lt; std::string &gt; str_split(const std::string &amp;str, const std::string delim)</div><div class="ttdef"><b>Definition:</b> <a href="view_8cpp_source.html#l00030">view.cpp:30</a></div></div>
<div class="ttc" id="aclassView_html_aa7b1f1179e3c4f06bef1e99355d0d592"><div class="ttname"><a href="classView.html#aa7b1f1179e3c4f06bef1e99355d0d592">View::repaint</a></div><div class="ttdeci">virtual void repaint(void)</div><div class="ttdef"><b>Definition:</b> <a href="view_8cpp_source.html#l00052">view.cpp:52</a></div></div>
<div class="ttc" id="aclassView_html_a60f77156dc4786bb6227d58a3061d2f6"><div class="ttname"><a href="classView.html#a60f77156dc4786bb6227d58a3061d2f6">View::keypress</a></div><div class="ttdeci">virtual call_t keypress(int &amp;key)=0</div></div>
<div class="ttc" id="aclassView_html_a9fc9f3b0c876d063e6f57dee320a43fe"><div class="ttname"><a href="classView.html#a9fc9f3b0c876d063e6f57dee320a43fe">View::start_x</a></div><div class="ttdeci">int start_x</div><div class="ttdoc">x offset (characters) in the terminal, used to center the window on repaint()</div><div class="ttdef"><b>Definition:</b> <a href="view_8h_source.html#l00081">view.h:81</a></div></div>
<div class="ttc" id="aclassView_html_a0a9be6e5fb588412aab31cacf5e43b04"><div class="ttname"><a href="classView.html#a0a9be6e5fb588412aab31cacf5e43b04">View::View</a></div><div class="ttdeci">View(void)</div><div class="ttdef"><b>Definition:</b> <a href="view_8cpp_source.html#l00005">view.cpp:5</a></div></div>
<div class="ttc" id="aclassView_html_a6c725e4d83fd7474635a7e64200c7a08"><div class="ttname"><a href="classView.html#a6c725e4d83fd7474635a7e64200c7a08">View::setTitle</a></div><div class="ttdeci">virtual void setTitle(std::string title)</div><div class="ttdef"><b>Definition:</b> <a href="view_8cpp_source.html#l00047">view.cpp:47</a></div></div>
<div class="ttc" id="aclassView_html_ac424db4c13776c3ce9d33f9074dfcfaa"><div class="ttname"><a href="classView.html#ac424db4c13776c3ce9d33f9074dfcfaa">View::start_y</a></div><div class="ttdeci">int start_y</div><div class="ttdoc">y offset (characters) in the terminal, used to center the window on repaint()</div><div class="ttdef"><b>Definition:</b> <a href="view_8h_source.html#l00082">view.h:82</a></div></div>
<div class="ttc" id="aclassView_html_a092a269bf53569af7fca4d710dd5b980"><div class="ttname"><a href="classView.html#a092a269bf53569af7fca4d710dd5b980">View::draw</a></div><div class="ttdeci">virtual void draw(void)=0</div></div>
<div class="ttc" id="aclassView_html_a3554cf8689cad24c643665aa3d182134"><div class="ttname"><a href="classView.html#a3554cf8689cad24c643665aa3d182134">View::KEY_ENT</a></div><div class="ttdeci">constexpr static int KEY_ENT</div><div class="ttdoc">Key value for the Enter key.</div><div class="ttdef"><b>Definition:</b> <a href="view_8h_source.html#l00087">view.h:87</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Dec 3 2019 07:42:51 for B15F by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.16
</small></address>
</body>
</html>