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

Doku für view_info

Browse source
This commit is contained in:
Tristan Krause 2019-07-31 15:41:54 +02:00
parent be3545fcbb
commit 69e02c20c2
89 changed files with 576 additions and 218 deletions
Download patch file Download diff file Expand all files Collapse all files

171
docs/html/classViewInfo.html
View file

@ -88,14 +88,13 @@ $(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:abc93067b319df17e19f013a86d762f81"><td class="memItemLeft" align="right" valign="top"><a id="abc93067b319df17e19f013a86d762f81"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>setText</b> (std::string text)</td></tr>
<tr class="memitem:a95a3a81de65ef42615bbe5a843e8d5f6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classViewInfo.html#a95a3a81de65ef42615bbe5a843e8d5f6">ViewInfo</a> (void)</td></tr>
<tr class="separator:a95a3a81de65ef42615bbe5a843e8d5f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc93067b319df17e19f013a86d762f81"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classViewInfo.html#abc93067b319df17e19f013a86d762f81">setText</a> (std::string <a class="el" href="classViewInfo.html#ac392a569ef16af3dc11ee659f3fa1eb4">text</a>)</td></tr>
<tr class="separator:abc93067b319df17e19f013a86d762f81"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c3db4806515ea8b0f07a9864f983377"><td class="memItemLeft" align="right" valign="top"><a id="a4c3db4806515ea8b0f07a9864f983377"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>setLabelClose</b> (std::string label)</td></tr>
<tr class="memitem:a4c3db4806515ea8b0f07a9864f983377"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classViewInfo.html#a4c3db4806515ea8b0f07a9864f983377">setLabelClose</a> (std::string label)</td></tr>
<tr class="separator:a4c3db4806515ea8b0f07a9864f983377"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a45fd0b8b96d15fd92824ce63fb6814ca"><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="memitem:a45fd0b8b96d15fd92824ce63fb6814ca"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classViewInfo.html#a45fd0b8b96d15fd92824ce63fb6814ca">setCall</a> (call_t call)</td></tr>
<tr class="separator:a45fd0b8b96d15fd92824ce63fb6814ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7f9ea145f8cf26dbd27e29982cda206"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
@ -114,16 +113,20 @@ virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>setCall</b> (
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:ac392a569ef16af3dc11ee659f3fa1eb4"><td class="memItemLeft" align="right" valign="top"><a id="ac392a569ef16af3dc11ee659f3fa1eb4"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>text</b></td></tr>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classViewInfo.html#ac392a569ef16af3dc11ee659f3fa1eb4">text</a></td></tr>
<tr class="memdesc:ac392a569ef16af3dc11ee659f3fa1eb4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Benachrichtigungstext dieser <a class="el" href="classView.html">View</a>. <br /></td></tr>
<tr class="separator:ac392a569ef16af3dc11ee659f3fa1eb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34879bd1c0a8fe230429cc600dcd6739"><td class="memItemLeft" align="right" valign="top"><a id="a34879bd1c0a8fe230429cc600dcd6739"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>label_close</b></td></tr>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classViewInfo.html#a34879bd1c0a8fe230429cc600dcd6739">label_close</a></td></tr>
<tr class="memdesc:a34879bd1c0a8fe230429cc600dcd6739"><td class="mdescLeft">&#160;</td><td class="mdescRight">Beschriftung für Button zum Schließen. <br /></td></tr>
<tr class="separator:a34879bd1c0a8fe230429cc600dcd6739"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae4dab70d82761e0f59f51dcae79685fe"><td class="memItemLeft" align="right" valign="top"><a id="ae4dab70d82761e0f59f51dcae79685fe"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>close_offset_x</b> = 0</td></tr>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classViewInfo.html#ae4dab70d82761e0f59f51dcae79685fe">close_offset_x</a> = 0</td></tr>
<tr class="memdesc:ae4dab70d82761e0f59f51dcae79685fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Relative X Koordinate des Buttons zum Schließen im Window. <br /></td></tr>
<tr class="separator:ae4dab70d82761e0f59f51dcae79685fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5954adf853cb44d4655ede731faf1a28"><td class="memItemLeft" align="right" valign="top"><a id="a5954adf853cb44d4655ede731faf1a28"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>close_offset_y</b> = 0</td></tr>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classViewInfo.html#a5954adf853cb44d4655ede731faf1a28">close_offset_y</a> = 0</td></tr>
<tr class="memdesc:a5954adf853cb44d4655ede731faf1a28"><td class="mdescLeft">&#160;</td><td class="mdescRight">Relative Y Koordinate des Buttons zum Schließen im Window. <br /></td></tr>
<tr class="separator:a5954adf853cb44d4655ede731faf1a28"><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>
@ -154,10 +157,12 @@ std::vector&lt; call_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-attribs"></a>
Static Protected Attributes</h2></td></tr>
<tr class="memitem:a4681a8138f17ea229aca02e6db7357cd"><td class="memItemLeft" align="right" valign="top"><a id="a4681a8138f17ea229aca02e6db7357cd"></a>
constexpr static int&#160;</td><td class="memItemRight" valign="bottom"><b>text_offset_x</b> = 2</td></tr>
constexpr static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classViewInfo.html#a4681a8138f17ea229aca02e6db7357cd">text_offset_x</a> = 2</td></tr>
<tr class="memdesc:a4681a8138f17ea229aca02e6db7357cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Relativer Abstand des Textes zum linken Rahmen. <br /></td></tr>
<tr class="separator:a4681a8138f17ea229aca02e6db7357cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34a9239c8954a0c27a22cf44d112f5b8"><td class="memItemLeft" align="right" valign="top"><a id="a34a9239c8954a0c27a22cf44d112f5b8"></a>
constexpr static int&#160;</td><td class="memItemRight" valign="bottom"><b>text_offset_y</b> = 3</td></tr>
constexpr static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classViewInfo.html#a34a9239c8954a0c27a22cf44d112f5b8">text_offset_y</a> = 3</td></tr>
<tr class="memdesc:a34a9239c8954a0c27a22cf44d112f5b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Relativer Abstand des Textes zum oberen Rahmen. <br /></td></tr>
<tr class="separator:a34a9239c8954a0c27a22cf44d112f5b8"><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>
@ -180,10 +185,32 @@ Additional Inherited Members</h2></td></tr>
<tr class="separator:a52c2e2a7bc56388e7d9bfa398ad52668 inherit pub_static_methods_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> for simple text message output. </p>
<div class="textblock"><p>Klasse für einfache Textausgaben (Benachrichtigungen). Diese können mit einem Button geschlossen werden. </p>
<p class="definition">Definition at line <a class="el" href="view__info_8h_source.html#l00008">8</a> of file <a class="el" href="view__info_8h_source.html">view_info.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<p class="definition">Definition at line <a class="el" href="view__info_8h_source.html#l00011">11</a> of file <a class="el" href="view__info_8h_source.html">view_info.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a95a3a81de65ef42615bbe5a843e8d5f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95a3a81de65ef42615bbe5a843e8d5f6">&#9670;&nbsp;</a></span>ViewInfo()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ViewInfo::ViewInfo </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Standard-Konstruktor ohne Argumente </p>
<p class="definition">Definition at line <a class="el" href="view__info_8cpp_source.html#l00003">3</a> of file <a class="el" href="view__info_8cpp_source.html">view_info.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ab7f9ea145f8cf26dbd27e29982cda206"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab7f9ea145f8cf26dbd27e29982cda206">&#9670;&nbsp;</a></span>draw()</h2>
@ -207,7 +234,7 @@ Additional Inherited Members</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Abstract function for drawing ths particular view. Gets overridden in the derived classes to paints for example a promt. </p>
<p>Zeichnet diese <a class="el" href="classView.html">View</a> mit dem Benachrichtigungstext. </p>
<p>Implements <a class="el" href="classView.html#a092a269bf53569af7fca4d710dd5b980">View</a>.</p>
@ -238,7 +265,13 @@ Additional Inherited Members</h2></td></tr>
</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>Verarbeitet einen Tastendruck, z.B. Enter = Button angewählt. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>gedrückte Taste </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Call, der nach dem keypress ausgeführt werden soll </dd></dl>
<p>Implements <a class="el" href="classView.html#a60f77156dc4786bb6227d58a3061d2f6">View</a>.</p>
@ -246,6 +279,108 @@ Additional Inherited Members</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="view__info_8cpp_source.html#l00037">37</a> of file <a class="el" href="view__info_8cpp_source.html">view_info.cpp</a>.</p>
</div>
</div>
<a id="a45fd0b8b96d15fd92824ce63fb6814ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45fd0b8b96d15fd92824ce63fb6814ca">&#9670;&nbsp;</a></span>setCall()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ViewInfo::setCall </td>
<td>(</td>
<td class="paramtype">call_t&#160;</td>
<td class="paramname"><em>call</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>Setzt den Call der aufgerufen wird, wenn der Button angewählt wird. Wurde setCall weggelassen oder setCall(nullptr) gesetzt, wird diese <a class="el" href="classView.html">View</a> nur geschlossen und keine weitere Aktion ausgelöst. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">call</td><td>Nachfolge-Aktion </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="view__info_8cpp_source.html#l00018">18</a> of file <a class="el" href="view__info_8cpp_source.html">view_info.cpp</a>.</p>
</div>
</div>
<a id="a4c3db4806515ea8b0f07a9864f983377"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4c3db4806515ea8b0f07a9864f983377">&#9670;&nbsp;</a></span>setLabelClose()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ViewInfo::setLabelClose </td>
<td>(</td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>label</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>Setzt die Beschriftung des Buttons zum Schließen </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">label</td><td>Beschriftung des Buttons </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="view__info_8cpp_source.html#l00013">13</a> of file <a class="el" href="view__info_8cpp_source.html">view_info.cpp</a>.</p>
</div>
</div>
<a id="abc93067b319df17e19f013a86d762f81"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc93067b319df17e19f013a86d762f81">&#9670;&nbsp;</a></span>setText()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ViewInfo::setText </td>
<td>(</td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>text</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>Setzt den Text dieser Benachrichtigungs-View </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">text</td><td>Text der <a class="el" href="classView.html">View</a> </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="view__info_8cpp_source.html#l00008">8</a> of file <a class="el" href="view__info_8cpp_source.html">view_info.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
@ -255,7 +390,7 @@ Additional Inherited Members</h2></td></tr>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jul 31 2019 11:58:58 for B15F by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Wed Jul 31 2019 15:40:05 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>