diff options
1 files changed, 167 insertions, 0 deletions
| -rw-r--r-- | Year 1/Object-oriented Programming/Project 2/docs/html/classCommand.html | 167 |
diff --git a/Year 1/Object-oriented Programming/Project 2/docs/html/classCommand.html b/Year 1/Object-oriented Programming/Project 2/docs/html/classCommand.html new file mode 100644 index 0000000..285455d --- /dev/null +++ b/Year 1/Object-oriented Programming/Project 2/docs/html/classCommand.html @@ -0,0 +1,167 @@ +<!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 Table: Command 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 Table + </div> + <div id="projectbrief">| Kamen Mladenov | FMI Computer Science Year 1 Group 6 | Project 2 | Project Topic 7 |</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><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="classCommand-members.html">List of all members</a> </div> + <div class="headertitle"><div class="title">Command Class Reference</div></div> +</div><!--header--> +<div class="contents"> + +<p>Stores a 256 character name and a function pointer to be executed when calling <a class="el" href="classCommand.html#a2134b97948833d1ef31c6fb5ed200bed" title="Executes the stored function pointer.">run()</a> + <a href="classCommand.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="Command_8h_source.html">Command.h</a>></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:a18df2d81039392daeb0b78c346a70537"><td class="memItemLeft" align="right" valign="top"><a id="a18df2d81039392daeb0b78c346a70537" name="a18df2d81039392daeb0b78c346a70537"></a> + </td><td class="memItemRight" valign="bottom"><b>Command</b> ()</td></tr> +<tr class="memdesc:a18df2d81039392daeb0b78c346a70537"><td class="mdescLeft"> </td><td class="mdescRight">Leaves name empty and exec function pointer to nullptr. <br /></td></tr> +<tr class="separator:a18df2d81039392daeb0b78c346a70537"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a96dda87aba05825c0e8a0323bd25c826"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCommand.html#a96dda87aba05825c0e8a0323bd25c826">Command</a> (const char *name, void(*exec)(const char *params))</td></tr> +<tr class="memdesc:a96dda87aba05825c0e8a0323bd25c826"><td class="mdescLeft"> </td><td class="mdescRight">Copies contents of nameInMenu and stores exec. <a href="classCommand.html#a96dda87aba05825c0e8a0323bd25c826">More...</a><br /></td></tr> +<tr class="separator:a96dda87aba05825c0e8a0323bd25c826"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2134b97948833d1ef31c6fb5ed200bed"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCommand.html#a2134b97948833d1ef31c6fb5ed200bed">run</a> (const char *params) const</td></tr> +<tr class="memdesc:a2134b97948833d1ef31c6fb5ed200bed"><td class="mdescLeft"> </td><td class="mdescRight">Executes the stored function pointer. <a href="classCommand.html#a2134b97948833d1ef31c6fb5ed200bed">More...</a><br /></td></tr> +<tr class="separator:a2134b97948833d1ef31c6fb5ed200bed"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:addaa3c970a31f3babd990ca453538f9b"><td class="memItemLeft" align="right" valign="top"><a id="addaa3c970a31f3babd990ca453538f9b" name="addaa3c970a31f3babd990ca453538f9b"></a> +const char * </td><td class="memItemRight" valign="bottom"><b>get_name</b> () const</td></tr> +<tr class="separator:addaa3c970a31f3babd990ca453538f9b"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p >Stores a 256 character name and a function pointer to be executed when calling <a class="el" href="classCommand.html#a2134b97948833d1ef31c6fb5ed200bed" title="Executes the stored function pointer.">run()</a> </p> +<p ><a class="el" href="classMenu.html" title="Handles navigation between multiple commands.">Menu</a> uses this class for a more generic implementation of it's navigate function. </p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="a96dda87aba05825c0e8a0323bd25c826" name="a96dda87aba05825c0e8a0323bd25c826"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a96dda87aba05825c0e8a0323bd25c826">◆ </a></span>Command()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Command::Command </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void(*)(const char *params) </td> + <td class="paramname"><em>exec</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Copies contents of nameInMenu and stores exec. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">name</td><td>C-style string, class stores at most 255 characters (last character is always terminating zero) </td></tr> + <tr><td class="paramname">exec</td><td>Function pointer that will be executed when <a class="el" href="classCommand.html#a2134b97948833d1ef31c6fb5ed200bed" title="Executes the stored function pointer.">run()</a> is called. Can be nullptr. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="a2134b97948833d1ef31c6fb5ed200bed" name="a2134b97948833d1ef31c6fb5ed200bed"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a2134b97948833d1ef31c6fb5ed200bed">◆ </a></span>run()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void Command::run </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>params</em></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Executes the stored function pointer. </p> +<p >Executes the stored function pointer, when it's not nullptr. Otherwise does nothing. </p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li>src/Generic/ConsoleInterface/<a class="el" href="Command_8h_source.html">Command.h</a></li> +<li>src/Generic/ConsoleInterface/Command.cpp</li> +</ul> +</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> |