Summary Files Commits Branches @commit @diff @stats
path: root / Year 1 / Object-oriented Programming / Project 1 / docs / html / classMenu.html
diff options
context:
space:
mode:
Commit24bdf39e6c21ab846f6c86803761d78a094e05c0 (patch)
Author
 Syndamia <kamen.d.mladenov@protonmail.com>
2022-05-26 20:31:26 +0300
Committer
 Syndamia <kamen.d.mladenov@protonmail.com>
2022-05-26 20:31:26 +0300
Files1b2077b088098cc7ae6afc946b10a4d680110294 /Year 1/Object-oriented Programming/Project 1/docs/html/classMenu.html
uni-projects-24bdf39e6c21ab846f6c86803761d78a094e05c0.tar
uni-projects-24bdf39e6c21ab846f6c86803761d78a094e05c0.tar.gz
uni-projects-24bdf39e6c21ab846f6c86803761d78a094e05c0.zip
Parentcbe944835cc0951a946d01f034b4d28ff9874a4e (diff)
Added files from project 1 (mirror)
1 files changed, 330 insertions, 0 deletions
-rw-r--r--Year 1/Object-oriented Programming/Project 1/docs/html/classMenu.html330
diff --git a/Year 1/Object-oriented Programming/Project 1/docs/html/classMenu.html b/Year 1/Object-oriented Programming/Project 1/docs/html/classMenu.html
new file mode 100644
index 0000000..15580eb
--- /dev/null
+++ b/Year 1/Object-oriented Programming/Project 1/docs/html/classMenu.html
@@ -0,0 +1,330 @@
+<!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: Menu Class Reference</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&amp;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&amp;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><!-- top -->
+<div class="header">
+ <div class="summary">
+<a href="#pub-methods">Public Member Functions</a> &#124;
+<a href="classMenu-members.html">List of all members</a> </div>
+ <div class="headertitle"><div class="title">Menu Class Reference</div></div>
+</div><!--header-->
+<div class="contents">
+
+<p>Handles navigation between multiple commands.
+ <a href="classMenu.html#details">More...</a></p>
+
+<p><code>#include &lt;<a class="el" href="Menu_8h_source.html">Menu.h</a>&gt;</code></p>
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
+Public Member Functions</h2></td></tr>
+<tr class="memitem:ad466dd83355124a6ed958430450bfe94"><td class="memItemLeft" align="right" valign="top"><a id="ad466dd83355124a6ed958430450bfe94" name="ad466dd83355124a6ed958430450bfe94"></a>
+&#160;</td><td class="memItemRight" valign="bottom"><b>Menu</b> ()</td></tr>
+<tr class="memdesc:ad466dd83355124a6ed958430450bfe94"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets name as "Menu", leaves all flags to false and creates an empty <a class="el" href="classCommand.html" title="Stores a 256 character name and a function pointer to be executed when calling run()">Command</a> list. <br /></td></tr>
+<tr class="separator:ad466dd83355124a6ed958430450bfe94"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aeec919379638ad526df5167ed755a1f3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMenu.html#aeec919379638ad526df5167ed755a1f3">Menu</a> (const char *title, bool backExistsApp, bool isSubMenu)</td></tr>
+<tr class="memdesc:aeec919379638ad526df5167ed755a1f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copies title, saves flags and creates and empty <a class="el" href="classCommand.html" title="Stores a 256 character name and a function pointer to be executed when calling run()">Command</a> list. <a href="classMenu.html#aeec919379638ad526df5167ed755a1f3">More...</a><br /></td></tr>
+<tr class="separator:aeec919379638ad526df5167ed755a1f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a12057ad84f3a9d41bc7092cc2d86c87a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMenu.html#a12057ad84f3a9d41bc7092cc2d86c87a">Menu</a> (const char *title, bool backExistsApp, bool isSubMenu, const <a class="el" href="classCommand.html">Command</a> *commands, unsigned commandCount)</td></tr>
+<tr class="memdesc:a12057ad84f3a9d41bc7092cc2d86c87a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copies title, saves flags and copies commands. <a href="classMenu.html#a12057ad84f3a9d41bc7092cc2d86c87a">More...</a><br /></td></tr>
+<tr class="separator:a12057ad84f3a9d41bc7092cc2d86c87a"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a1f022cc8b705369073f8fd7b90b30c8d"><td class="memItemLeft" align="right" valign="top"><a id="a1f022cc8b705369073f8fd7b90b30c8d" name="a1f022cc8b705369073f8fd7b90b30c8d"></a>
+void&#160;</td><td class="memItemRight" valign="bottom"><b>addCommand</b> (const <a class="el" href="classCommand.html">Command</a> &amp;command)</td></tr>
+<tr class="memdesc:a1f022cc8b705369073f8fd7b90b30c8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a command to the internal <a class="el" href="classCommand.html" title="Stores a 256 character name and a function pointer to be executed when calling run()">Command</a> list. <br /></td></tr>
+<tr class="separator:a1f022cc8b705369073f8fd7b90b30c8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aad506cb9a7f35dea98c60484bb2d095c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMenu.html#aad506cb9a7f35dea98c60484bb2d095c">registerError</a> (const char *message) const</td></tr>
+<tr class="memdesc:aad506cb9a7f35dea98c60484bb2d095c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tell <a class="el" href="classMenu.html" title="Handles navigation between multiple commands.">Menu</a> to show an error message next time it prints. <a href="classMenu.html#aad506cb9a7f35dea98c60484bb2d095c">More...</a><br /></td></tr>
+<tr class="separator:aad506cb9a7f35dea98c60484bb2d095c"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a5350b1addf9bf365351486cd161696ad"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMenu.html#a5350b1addf9bf365351486cd161696ad">registerWarning</a> (const char *message) const</td></tr>
+<tr class="memdesc:a5350b1addf9bf365351486cd161696ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tell <a class="el" href="classMenu.html" title="Handles navigation between multiple commands.">Menu</a> to show a warning message next time it prints. <a href="classMenu.html#a5350b1addf9bf365351486cd161696ad">More...</a><br /></td></tr>
+<tr class="separator:a5350b1addf9bf365351486cd161696ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a3504e28b5d05e1ad70dada190bbc3a9c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMenu.html#a3504e28b5d05e1ad70dada190bbc3a9c">registerSuccess</a> (const char *message) const</td></tr>
+<tr class="memdesc:a3504e28b5d05e1ad70dada190bbc3a9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tell <a class="el" href="classMenu.html" title="Handles navigation between multiple commands.">Menu</a> to show a success message next time it prints. <a href="classMenu.html#a3504e28b5d05e1ad70dada190bbc3a9c">More...</a><br /></td></tr>
+<tr class="separator:a3504e28b5d05e1ad70dada190bbc3a9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a0400751da7f8583029b7a12d3003c36d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMenu.html#a0400751da7f8583029b7a12d3003c36d">navigate</a> () const</td></tr>
+<tr class="memdesc:a0400751da7f8583029b7a12d3003c36d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lists commands and after user input executes an appropriate command run() function. <a href="classMenu.html#a0400751da7f8583029b7a12d3003c36d">More...</a><br /></td></tr>
+<tr class="separator:a0400751da7f8583029b7a12d3003c36d"><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 >Handles navigation between multiple commands. </p>
+<p >Shows the title, then below it an Error/Warning/Success message if set, lists all command options as an enumerated list, takes command index and calls the chosen command's run() function. </p>
+</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
+<a id="aeec919379638ad526df5167ed755a1f3" name="aeec919379638ad526df5167ed755a1f3"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aeec919379638ad526df5167ed755a1f3">&#9670;&nbsp;</a></span>Menu() <span class="overload">[1/2]</span></h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">Menu::Menu </td>
+ <td>(</td>
+ <td class="paramtype">const char *&#160;</td>
+ <td class="paramname"><em>title</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">bool&#160;</td>
+ <td class="paramname"><em>backExistsApp</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">bool&#160;</td>
+ <td class="paramname"><em>isSubMenu</em>&#160;</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>Copies title, saves flags and creates and empty <a class="el" href="classCommand.html" title="Stores a 256 character name and a function pointer to be executed when calling run()">Command</a> list. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">title</td><td>C-style string, class stores at most 255 characters (last character is always terminating zero) </td></tr>
+ <tr><td class="paramname">backExistsApp</td><td>Flag whether or not to list the 0-th option as "Exit", rather than "Go Back" </td></tr>
+ <tr><td class="paramname">isSubMenu</td><td>Flag whether or not to show the title as a subTitle or not </td></tr>
+ </table>
+ </dd>
+</dl>
+
+</div>
+</div>
+<a id="a12057ad84f3a9d41bc7092cc2d86c87a" name="a12057ad84f3a9d41bc7092cc2d86c87a"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a12057ad84f3a9d41bc7092cc2d86c87a">&#9670;&nbsp;</a></span>Menu() <span class="overload">[2/2]</span></h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">Menu::Menu </td>
+ <td>(</td>
+ <td class="paramtype">const char *&#160;</td>
+ <td class="paramname"><em>title</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">bool&#160;</td>
+ <td class="paramname"><em>backExistsApp</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">bool&#160;</td>
+ <td class="paramname"><em>isSubMenu</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">const <a class="el" href="classCommand.html">Command</a> *&#160;</td>
+ <td class="paramname"><em>commands</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">unsigned&#160;</td>
+ <td class="paramname"><em>commandCount</em>&#160;</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>Copies title, saves flags and copies commands. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">title</td><td>C-style string, class stores at most 255 characters (last character is always terminating zero) </td></tr>
+ <tr><td class="paramname">backExistsApp</td><td>Flag whether or not to list the 0-th option as "Exit", rather than "Go Back" </td></tr>
+ <tr><td class="paramname">isSubMenu</td><td>Flag whether or not to show the title as a subTitle or not </td></tr>
+ <tr><td class="paramname">commands</td><td>Pointer to an array of <a class="el" href="classCommand.html" title="Stores a 256 character name and a function pointer to be executed when calling run()">Command</a> instances </td></tr>
+ <tr><td class="paramname">commandCount</td><td>Number of elements that "commands" points to </td></tr>
+ </table>
+ </dd>
+</dl>
+
+</div>
+</div>
+<h2 class="groupheader">Member Function Documentation</h2>
+<a id="a0400751da7f8583029b7a12d3003c36d" name="a0400751da7f8583029b7a12d3003c36d"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a0400751da7f8583029b7a12d3003c36d">&#9670;&nbsp;</a></span>navigate()</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">void Menu::navigate </td>
+ <td>(</td>
+ <td class="paramname"></td><td>)</td>
+ <td> const</td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>Lists commands and after user input executes an appropriate command run() function. </p>
+<p >Prints the title, then an Error/Warning/Sucess message (if set), prints all command names as an ordered list (starting from 1), waits for user input to select one of those commands (by list number) and finally executes the appropriate command's run() function.</p>
+<p >After the run() function exists, everything is reprinted. The 0 list index is always "Go Back"/"Exit" and it always stops the reprinting loop.</p>
+<p >If there are no commands, prints "Menu is empty!". If user input doesn't correspond to any command, registers an error message and reprints. </p>
+
+</div>
+</div>
+<a id="aad506cb9a7f35dea98c60484bb2d095c" name="aad506cb9a7f35dea98c60484bb2d095c"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aad506cb9a7f35dea98c60484bb2d095c">&#9670;&nbsp;</a></span>registerError()</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">void Menu::registerError </td>
+ <td>(</td>
+ <td class="paramtype">const char *&#160;</td>
+ <td class="paramname"><em>message</em></td><td>)</td>
+ <td> const</td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>Tell <a class="el" href="classMenu.html" title="Handles navigation between multiple commands.">Menu</a> to show an error message next time it prints. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">message</td><td>C-style string, saves to pointer for later reuse when showing the message.</td></tr>
+ </table>
+ </dd>
+</dl>
+<p>Stores the message pointer in a global variable (in the cpp file) and sets it's type as an Error in another global variable (in the cpp file).</p>
+<p >The next time the whole <a class="el" href="classMenu.html" title="Handles navigation between multiple commands.">Menu</a> is shown, the message will appear below the title. </p>
+
+</div>
+</div>
+<a id="a3504e28b5d05e1ad70dada190bbc3a9c" name="a3504e28b5d05e1ad70dada190bbc3a9c"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a3504e28b5d05e1ad70dada190bbc3a9c">&#9670;&nbsp;</a></span>registerSuccess()</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">void Menu::registerSuccess </td>
+ <td>(</td>
+ <td class="paramtype">const char *&#160;</td>
+ <td class="paramname"><em>message</em></td><td>)</td>
+ <td> const</td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>Tell <a class="el" href="classMenu.html" title="Handles navigation between multiple commands.">Menu</a> to show a success message next time it prints. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">message</td><td>C-style string, saves to pointer for later reuse when showing the message.</td></tr>
+ </table>
+ </dd>
+</dl>
+<p>Stores the message pointer in a global variable (in the cpp file) and sets it's type as Success in another global variable (in the cpp file).</p>
+<p >The next time the whole <a class="el" href="classMenu.html" title="Handles navigation between multiple commands.">Menu</a> is shown, the message will appear below the title. </p>
+
+</div>
+</div>
+<a id="a5350b1addf9bf365351486cd161696ad" name="a5350b1addf9bf365351486cd161696ad"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a5350b1addf9bf365351486cd161696ad">&#9670;&nbsp;</a></span>registerWarning()</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">void Menu::registerWarning </td>
+ <td>(</td>
+ <td class="paramtype">const char *&#160;</td>
+ <td class="paramname"><em>message</em></td><td>)</td>
+ <td> const</td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>Tell <a class="el" href="classMenu.html" title="Handles navigation between multiple commands.">Menu</a> to show a warning message next time it prints. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">message</td><td>C-style string, saves to pointer for later reuse when showing the message.</td></tr>
+ </table>
+ </dd>
+</dl>
+<p>Stores the message pointer in a global variable (in the cpp file) and sets it's type as a Warning in another global variable (in the cpp file).</p>
+<p >The next time the whole <a class="el" href="classMenu.html" title="Handles navigation between multiple commands.">Menu</a> is shown, the message will appear below the title. </p>
+
+</div>
+</div>
+<hr/>The documentation for this class was generated from the following files:<ul>
+<li>src/Generic/ConsoleInterface/<a class="el" href="Menu_8h_source.html">Menu.h</a></li>
+<li>src/Generic/ConsoleInterface/Menu.cpp</li>
+</ul>
+</div><!-- contents -->
+<!-- start footer part -->
+<hr class="footer"/><address class="footer"><small>
+Generated by&#160;<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>