lauchmelder/b15f
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

comments for ui/view.h

Browse source
This commit is contained in:
Tristan Krause 2019-07-31 11:59:24 +02:00
parent 9640bb00c8
commit 3b71364edf
112 changed files with 1746 additions and 437 deletions
Download patch file Download diff file Expand all files Collapse all files

85
docs/html/classViewMonitor.html
View file

@ -88,8 +88,7 @@ $(function() {
<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:a2224002fe45655df87130fe07a161693"><td class="memItemLeft" align="right" valign="top"><a id="a2224002fe45655df87130fe07a161693"></a>
virtual call_t&#160;</td><td class="memItemRight" valign="bottom"><b>keypress</b> (int &amp;key) override</td></tr>
<tr class="memitem:a2224002fe45655df87130fe07a161693"><td class="memItemLeft" align="right" valign="top">virtual call_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classViewMonitor.html#a2224002fe45655df87130fe07a161693">keypress</a> (int &amp;key) override</td></tr>
<tr class="separator:a2224002fe45655df87130fe07a161693"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classViewInfo"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classViewInfo')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classViewInfo.html">ViewInfo</a></td></tr>
<tr class="memitem:abc93067b319df17e19f013a86d762f81 inherit pub_methods_classViewInfo"><td class="memItemLeft" align="right" valign="top"><a id="abc93067b319df17e19f013a86d762f81"></a>
@ -101,15 +100,16 @@ virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>setLabelClose
<tr class="memitem:a45fd0b8b96d15fd92824ce63fb6814ca inherit pub_methods_classViewInfo"><td class="memItemLeft" align="right" valign="top"><a id="a45fd0b8b96d15fd92824ce63fb6814ca"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>setCall</b> (call_t call)</td></tr>
<tr class="separator:a45fd0b8b96d15fd92824ce63fb6814ca inherit pub_methods_classViewInfo"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7f9ea145f8cf26dbd27e29982cda206 inherit pub_methods_classViewInfo"><td class="memItemLeft" align="right" valign="top"><a id="ab7f9ea145f8cf26dbd27e29982cda206"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>draw</b> (void) override</td></tr>
<tr class="memitem:ab7f9ea145f8cf26dbd27e29982cda206 inherit pub_methods_classViewInfo"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classViewInfo.html#ab7f9ea145f8cf26dbd27e29982cda206">draw</a> (void) override</td></tr>
<tr class="separator:ab7f9ea145f8cf26dbd27e29982cda206 inherit pub_methods_classViewInfo"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classView"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classView')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classView.html">View</a></td></tr>
<tr class="memitem:a6c725e4d83fd7474635a7e64200c7a08 inherit pub_methods_classView"><td class="memItemLeft" align="right" valign="top"><a id="a6c725e4d83fd7474635a7e64200c7a08"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>setTitle</b> (std::string title)</td></tr>
<tr class="memitem:a0a9be6e5fb588412aab31cacf5e43b04 inherit pub_methods_classView"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classView.html#a0a9be6e5fb588412aab31cacf5e43b04">View</a> (void)</td></tr>
<tr class="separator:a0a9be6e5fb588412aab31cacf5e43b04 inherit pub_methods_classView"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a450dfab3f21a52edc03db4310593412f inherit pub_methods_classView"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classView.html#a450dfab3f21a52edc03db4310593412f">~View</a> (void)</td></tr>
<tr class="separator:a450dfab3f21a52edc03db4310593412f inherit pub_methods_classView"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c725e4d83fd7474635a7e64200c7a08 inherit pub_methods_classView"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classView.html#a6c725e4d83fd7474635a7e64200c7a08">setTitle</a> (std::string <a class="el" href="classView.html#a80441aa81b52e04677a2aa2bd9c47753">title</a>)</td></tr>
<tr class="separator:a6c725e4d83fd7474635a7e64200c7a08 inherit pub_methods_classView"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7b1f1179e3c4f06bef1e99355d0d592 inherit pub_methods_classView"><td class="memItemLeft" align="right" valign="top"><a id="aa7b1f1179e3c4f06bef1e99355d0d592"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>repaint</b> (void)</td></tr>
<tr class="memitem:aa7b1f1179e3c4f06bef1e99355d0d592 inherit pub_methods_classView"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classView.html#aa7b1f1179e3c4f06bef1e99355d0d592">repaint</a> (void)</td></tr>
<tr class="separator:aa7b1f1179e3c4f06bef1e99355d0d592 inherit pub_methods_classView"><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>
@ -141,35 +141,38 @@ int&#160;</td><td class="memItemRight" valign="bottom"><b>close_offset_y</b> = 0
<tr class="separator:a5954adf853cb44d4655ede731faf1a28 inherit pro_attribs_classViewInfo"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_classView"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classView')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classView.html">View</a></td></tr>
<tr class="memitem:ae039aa744b085db819ae149705b2c32b inherit pro_attribs_classView"><td class="memItemLeft" align="right" valign="top"><a id="ae039aa744b085db819ae149705b2c32b"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>width</b></td></tr>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classView.html#ae039aa744b085db819ae149705b2c32b">width</a></td></tr>
<tr class="memdesc:ae039aa744b085db819ae149705b2c32b inherit pro_attribs_classView"><td class="mdescLeft">&#160;</td><td class="mdescRight">width of view in terminal characters <br /></td></tr>
<tr class="separator:ae039aa744b085db819ae149705b2c32b inherit pro_attribs_classView"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6e3e5c18893617490f02166641356746 inherit pro_attribs_classView"><td class="memItemLeft" align="right" valign="top"><a id="a6e3e5c18893617490f02166641356746"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>height</b></td></tr>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classView.html#a6e3e5c18893617490f02166641356746">height</a></td></tr>
<tr class="memdesc:a6e3e5c18893617490f02166641356746 inherit pro_attribs_classView"><td class="mdescLeft">&#160;</td><td class="mdescRight">height of view in terminal characters <br /></td></tr>
<tr class="separator:a6e3e5c18893617490f02166641356746 inherit pro_attribs_classView"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9fc9f3b0c876d063e6f57dee320a43fe inherit pro_attribs_classView"><td class="memItemLeft" align="right" valign="top"><a id="a9fc9f3b0c876d063e6f57dee320a43fe"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>start_x</b> = 0</td></tr>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classView.html#a9fc9f3b0c876d063e6f57dee320a43fe">start_x</a> = 0</td></tr>
<tr class="memdesc:a9fc9f3b0c876d063e6f57dee320a43fe inherit pro_attribs_classView"><td class="mdescLeft">&#160;</td><td class="mdescRight">x offset (characters) in the terminal, used to center the window on <a class="el" href="classView.html#aa7b1f1179e3c4f06bef1e99355d0d592">repaint()</a> <br /></td></tr>
<tr class="separator:a9fc9f3b0c876d063e6f57dee320a43fe inherit pro_attribs_classView"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac424db4c13776c3ce9d33f9074dfcfaa inherit pro_attribs_classView"><td class="memItemLeft" align="right" valign="top"><a id="ac424db4c13776c3ce9d33f9074dfcfaa"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>start_y</b> = 0</td></tr>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classView.html#ac424db4c13776c3ce9d33f9074dfcfaa">start_y</a> = 0</td></tr>
<tr class="memdesc:ac424db4c13776c3ce9d33f9074dfcfaa inherit pro_attribs_classView"><td class="mdescLeft">&#160;</td><td class="mdescRight">y offset (characters) in the terminal, used to center the window on <a class="el" href="classView.html#aa7b1f1179e3c4f06bef1e99355d0d592">repaint()</a> <br /></td></tr>
<tr class="separator:ac424db4c13776c3ce9d33f9074dfcfaa inherit pro_attribs_classView"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80441aa81b52e04677a2aa2bd9c47753 inherit pro_attribs_classView"><td class="memItemLeft" align="right" valign="top"><a id="a80441aa81b52e04677a2aa2bd9c47753"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>title</b></td></tr>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classView.html#a80441aa81b52e04677a2aa2bd9c47753">title</a></td></tr>
<tr class="memdesc:a80441aa81b52e04677a2aa2bd9c47753 inherit pro_attribs_classView"><td class="mdescLeft">&#160;</td><td class="mdescRight">title of the view <br /></td></tr>
<tr class="separator:a80441aa81b52e04677a2aa2bd9c47753 inherit pro_attribs_classView"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a610367214a727e2f7da72ac5bdb60fa3 inherit pro_attribs_classView"><td class="memItemLeft" align="right" valign="top"><a id="a610367214a727e2f7da72ac5bdb60fa3"></a>
std::vector&lt; call_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>calls</b></td></tr>
std::vector&lt; call_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classView.html#a610367214a727e2f7da72ac5bdb60fa3">calls</a></td></tr>
<tr class="memdesc:a610367214a727e2f7da72ac5bdb60fa3 inherit pro_attribs_classView"><td class="mdescLeft">&#160;</td><td class="mdescRight">calls (function pointers) for different button actions in the view (if any) <br /></td></tr>
<tr class="separator:a610367214a727e2f7da72ac5bdb60fa3 inherit pro_attribs_classView"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_static_methods_classView"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classView')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="classView.html">View</a></td></tr>
<tr class="memitem:a990aa2223befde031dfcce54a740c558 inherit pub_static_methods_classView"><td class="memItemLeft" align="right" valign="top"><a id="a990aa2223befde031dfcce54a740c558"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><b>setWinContext</b> (WINDOW *win)</td></tr>
<tr class="memitem:a990aa2223befde031dfcce54a740c558 inherit pub_static_methods_classView"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classView.html#a990aa2223befde031dfcce54a740c558">setWinContext</a> (WINDOW *<a class="el" href="classView.html#a5ddee2bf0b26dbcfa7780be17ff33dd7">win</a>)</td></tr>
<tr class="separator:a990aa2223befde031dfcce54a740c558 inherit pub_static_methods_classView"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0710c6ba06e3795e7ddf369361308b79 inherit pub_static_methods_classView"><td class="memItemLeft" align="right" valign="top"><a id="a0710c6ba06e3795e7ddf369361308b79"></a>
static WINDOW *&#160;</td><td class="memItemRight" valign="bottom"><b>getWinContext</b> (void)</td></tr>
<tr class="memitem:a0710c6ba06e3795e7ddf369361308b79 inherit pub_static_methods_classView"><td class="memItemLeft" align="right" valign="top">static WINDOW *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classView.html#a0710c6ba06e3795e7ddf369361308b79">getWinContext</a> (void)</td></tr>
<tr class="separator:a0710c6ba06e3795e7ddf369361308b79 inherit pub_static_methods_classView"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52c2e2a7bc56388e7d9bfa398ad52668 inherit pub_static_methods_classView"><td class="memItemLeft" align="right" valign="top"><a id="a52c2e2a7bc56388e7d9bfa398ad52668"></a>
static std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>str_split</b> (const std::string &amp;str, const std::string delim)</td></tr>
<tr class="memitem:a52c2e2a7bc56388e7d9bfa398ad52668 inherit pub_static_methods_classView"><td class="memItemLeft" align="right" valign="top">static std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classView.html#a52c2e2a7bc56388e7d9bfa398ad52668">str_split</a> (const std::string &amp;str, const std::string delim)</td></tr>
<tr class="separator:a52c2e2a7bc56388e7d9bfa398ad52668 inherit pub_static_methods_classView"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_static_attribs_classViewInfo"><td colspan="2" onclick="javascript:toggleInherit('pro_static_attribs_classViewInfo')"><img src="closed.png" alt="-"/>&#160;Static Protected Attributes inherited from <a class="el" href="classViewInfo.html">ViewInfo</a></td></tr>
<tr class="memitem:a4681a8138f17ea229aca02e6db7357cd inherit pro_static_attribs_classViewInfo"><td class="memItemLeft" align="right" valign="top"><a id="a4681a8138f17ea229aca02e6db7357cd"></a>
@ -180,24 +183,58 @@ constexpr static int&#160;</td><td class="memItemRight" valign="bottom"><b>text_
<tr class="separator:a34a9239c8954a0c27a22cf44d112f5b8 inherit pro_static_attribs_classViewInfo"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_static_attribs_classView"><td colspan="2" onclick="javascript:toggleInherit('pro_static_attribs_classView')"><img src="closed.png" alt="-"/>&#160;Static Protected Attributes inherited from <a class="el" href="classView.html">View</a></td></tr>
<tr class="memitem:a5ddee2bf0b26dbcfa7780be17ff33dd7 inherit pro_static_attribs_classView"><td class="memItemLeft" align="right" valign="top"><a id="a5ddee2bf0b26dbcfa7780be17ff33dd7"></a>
static WINDOW *&#160;</td><td class="memItemRight" valign="bottom"><b>win</b> = nullptr</td></tr>
static WINDOW *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classView.html#a5ddee2bf0b26dbcfa7780be17ff33dd7">win</a> = nullptr</td></tr>
<tr class="memdesc:a5ddee2bf0b26dbcfa7780be17ff33dd7 inherit pro_static_attribs_classView"><td class="mdescLeft">&#160;</td><td class="mdescRight">static window contexts for all views <br /></td></tr>
<tr class="separator:a5ddee2bf0b26dbcfa7780be17ff33dd7 inherit pro_static_attribs_classView"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3554cf8689cad24c643665aa3d182134 inherit pro_static_attribs_classView"><td class="memItemLeft" align="right" valign="top"><a id="a3554cf8689cad24c643665aa3d182134"></a>
constexpr static int&#160;</td><td class="memItemRight" valign="bottom"><b>KEY_ENT</b> = 10</td></tr>
constexpr static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classView.html#a3554cf8689cad24c643665aa3d182134">KEY_ENT</a> = 10</td></tr>
<tr class="memdesc:a3554cf8689cad24c643665aa3d182134 inherit pro_static_attribs_classView"><td class="mdescLeft">&#160;</td><td class="mdescRight">Key value for the Enter key. <br /></td></tr>
<tr class="separator:a3554cf8689cad24c643665aa3d182134 inherit pro_static_attribs_classView"><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 class="el" href="classView.html">View</a> to display all B15 inputs. </p>
<p class="definition">Definition at line <a class="el" href="view__monitor_8h_source.html#l00013">13</a> of file <a class="el" href="view__monitor_8h_source.html">view_monitor.h</a>.</p>
</div><hr/>The documentation for this class was generated from the following files:<ul>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a2224002fe45655df87130fe07a161693"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2224002fe45655df87130fe07a161693">&#9670;&nbsp;</a></span>keypress()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">call_t ViewMonitor::keypress </td>
<td>(</td>
<td class="paramtype">int &amp;&#160;</td>
<td class="paramname"><em>key</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Abstract function for the view to reacted on a keypress. Gets overridden in the derived classes to close for example a view on ESC. </p>
<p>Reimplemented from <a class="el" href="classViewInfo.html#a7d231a44600aa100ad4a0b9f283e5bd8">ViewInfo</a>.</p>
<p class="definition">Definition at line <a class="el" href="view__monitor_8cpp_source.html#l00007">7</a> of file <a class="el" href="view__monitor_8cpp_source.html">view_monitor.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>ui/<a class="el" href="view__monitor_8h_source.html">view_monitor.h</a></li>
<li>ui/<a class="el" href="view__monitor_8cpp_source.html">view_monitor.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jul 31 2019 11:33:44 for B15F by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Wed Jul 31 2019 11:58:58 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>