diff options
Completely reworked documentation
1 files changed, 117 insertions, 0 deletions
| -rw-r--r-- | docs/html/Menu_8h_source.html | 117 |
diff --git a/docs/html/Menu_8h_source.html b/docs/html/Menu_8h_source.html new file mode 100644 index 0000000..88f81c1 --- /dev/null +++ b/docs/html/Menu_8h_source.html @@ -0,0 +1,117 @@ +<!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=11"/> +<meta name="generator" content="Doxygen 1.9.3"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>FMI Ticket System: src/Generic/ConsoleInterface/Menu.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 id="projectrow"> + <td id="projectalign"> + <div id="projectname">FMI Ticket System + </div> + <div id="projectbrief">| Kamen Mladenov | FMI Computer Science Year 1 Group 6 | Project 1 | Project Topic 4 |</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.9.3 --> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ +var searchBox = new SearchBox("searchBox", "search",'Search','.html'); +/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ +$(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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_b37d33ceb7f5c107fb027d4db224bc89.html">Generic</a></li><li class="navelem"><a class="el" href="dir_d8d09372644efb2ea8af4d02a2b08c8b.html">ConsoleInterface</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"><div class="title">Menu.h</div></div> +</div><!--header--> +<div class="contents"> +<a href="Menu_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef HEADER_CONSOLEINTERFACE_MENU</span></div> +<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define HEADER_CONSOLEINTERFACE_MENU</span></div> +<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div> +<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include "<a class="code" href="Command_8h.html">Command.h</a>"</span></div> +<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include "../List/List.hpp"</span></div> +<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div> +<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="classMenu.html"> 17</a></span><span class="keyword">class </span><a class="code hl_class" href="classMenu.html">Menu</a> {</div> +<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <span class="keywordtype">char</span> title[256];</div> +<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <a class="code hl_class" href="classList.html">List<Command></a> menuOptions;</div> +<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div> +<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <span class="keywordtype">bool</span> backExistsApp;</div> +<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <span class="keywordtype">bool</span> isSubMenu;</div> +<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div> +<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="keyword">public</span>:</div> +<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <a class="code hl_function" href="classMenu.html#ad466dd83355124a6ed958430450bfe94">Menu</a>();</div> +<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <a class="code hl_function" href="classMenu.html#ad466dd83355124a6ed958430450bfe94">Menu</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* title, <span class="keywordtype">bool</span> backExistsApp, <span class="keywordtype">bool</span> isSubMenu);</div> +<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <a class="code hl_function" href="classMenu.html#ad466dd83355124a6ed958430450bfe94">Menu</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* title, <span class="keywordtype">bool</span> backExistsApp, <span class="keywordtype">bool</span> isSubMenu, <span class="keyword">const</span> <a class="code hl_class" href="classCommand.html">Command</a>* commands, <span class="keywordtype">unsigned</span> commandCount);</div> +<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div> +<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classMenu.html#a1f022cc8b705369073f8fd7b90b30c8d">addCommand</a>(<span class="keyword">const</span> <a class="code hl_class" href="classCommand.html">Command</a>& command);</div> +<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div> +<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classMenu.html#aad506cb9a7f35dea98c60484bb2d095c">registerError</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* message) <span class="keyword">const</span>;</div> +<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classMenu.html#a5350b1addf9bf365351486cd161696ad">registerWarning</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* message) <span class="keyword">const</span>;</div> +<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classMenu.html#a3504e28b5d05e1ad70dada190bbc3a9c">registerSuccess</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* message) <span class="keyword">const</span>;</div> +<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div> +<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classMenu.html#a0400751da7f8583029b7a12d3003c36d">navigate</a>() <span class="keyword">const</span>;</div> +<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span>};</div> +<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div> +<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="preprocessor">#endif</span></div> +<div class="ttc" id="aCommand_8h_html"><div class="ttname"><a href="Command_8h.html">Command.h</a></div><div class="ttdoc">Stores the declaration of class Command.</div></div> +<div class="ttc" id="aclassCommand_html"><div class="ttname"><a href="classCommand.html">Command</a></div><div class="ttdoc">Stores a 256 character name and a function pointer to be executed when calling run()</div><div class="ttdef"><b>Definition:</b> Command.h:12</div></div> +<div class="ttc" id="aclassList_html"><div class="ttname"><a href="classList.html">List< Command ></a></div></div> +<div class="ttc" id="aclassMenu_html"><div class="ttname"><a href="classMenu.html">Menu</a></div><div class="ttdoc">Handles navigation between multiple commands.</div><div class="ttdef"><b>Definition:</b> Menu.h:17</div></div> +<div class="ttc" id="aclassMenu_html_a0400751da7f8583029b7a12d3003c36d"><div class="ttname"><a href="classMenu.html#a0400751da7f8583029b7a12d3003c36d">Menu::navigate</a></div><div class="ttdeci">void navigate() const</div><div class="ttdoc">Lists commands and after user input executes an appropriate command run() function.</div><div class="ttdef"><b>Definition:</b> Menu.cpp:93</div></div> +<div class="ttc" id="aclassMenu_html_a1f022cc8b705369073f8fd7b90b30c8d"><div class="ttname"><a href="classMenu.html#a1f022cc8b705369073f8fd7b90b30c8d">Menu::addCommand</a></div><div class="ttdeci">void addCommand(const Command &command)</div><div class="ttdoc">Adds a command to the internal Command list.</div><div class="ttdef"><b>Definition:</b> Menu.cpp:32</div></div> +<div class="ttc" id="aclassMenu_html_a3504e28b5d05e1ad70dada190bbc3a9c"><div class="ttname"><a href="classMenu.html#a3504e28b5d05e1ad70dada190bbc3a9c">Menu::registerSuccess</a></div><div class="ttdeci">void registerSuccess(const char *message) const</div><div class="ttdoc">Tell Menu to show a success message next time it prints.</div><div class="ttdef"><b>Definition:</b> Menu.cpp:76</div></div> +<div class="ttc" id="aclassMenu_html_a5350b1addf9bf365351486cd161696ad"><div class="ttname"><a href="classMenu.html#a5350b1addf9bf365351486cd161696ad">Menu::registerWarning</a></div><div class="ttdeci">void registerWarning(const char *message) const</div><div class="ttdoc">Tell Menu to show a warning message next time it prints.</div><div class="ttdef"><b>Definition:</b> Menu.cpp:64</div></div> +<div class="ttc" id="aclassMenu_html_aad506cb9a7f35dea98c60484bb2d095c"><div class="ttname"><a href="classMenu.html#aad506cb9a7f35dea98c60484bb2d095c">Menu::registerError</a></div><div class="ttdeci">void registerError(const char *message) const</div><div class="ttdoc">Tell Menu to show an error message next time it prints.</div><div class="ttdef"><b>Definition:</b> Menu.cpp:52</div></div> +<div class="ttc" id="aclassMenu_html_ad466dd83355124a6ed958430450bfe94"><div class="ttname"><a href="classMenu.html#ad466dd83355124a6ed958430450bfe94">Menu::Menu</a></div><div class="ttdeci">Menu()</div><div class="ttdoc">Sets name as "Menu", leaves all flags to false and creates an empty Command list.</div><div class="ttdef"><b>Definition:</b> Menu.cpp:5</div></div> +</div><!-- fragment --></div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3 +</small></address> +</body> +</html> |