diff options
Added files from project 2 (mirror)
1 files changed, 227 insertions, 0 deletions
| -rw-r--r-- | Year 1/Object-oriented Programming/Project 2/docs/html/Toolbox_8hpp.html | 227 |
diff --git a/Year 1/Object-oriented Programming/Project 2/docs/html/Toolbox_8hpp.html b/Year 1/Object-oriented Programming/Project 2/docs/html/Toolbox_8hpp.html new file mode 100644 index 0000000..b48ff34 --- /dev/null +++ b/Year 1/Object-oriented Programming/Project 2/docs/html/Toolbox_8hpp.html @@ -0,0 +1,227 @@ +<!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: src/Generic/ConsoleInterface/Toolbox.hpp File 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 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="summary"> +<a href="#define-members">Macros</a> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"><div class="title">Toolbox.hpp File Reference</div></div> +</div><!--header--> +<div class="contents"> + +<p>Stores a wide range of functions for simpler/more automated printing. +<a href="#details">More...</a></p> +<div class="textblock"><code>#include <iostream></code><br /> +<code>#include "<a class="el" href="List_8hpp_source.html">../List/List.hpp</a>"</code><br /> +<code>#include "<a class="el" href="String_8h_source.html">../String/String.h</a>"</code><br /> +</div> +<p><a href="Toolbox_8hpp_source.html">Go to the source code of this file.</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a> +Macros</h2></td></tr> +<tr class="memitem:a09f908aa6474fe2b1f82b1aaade947f6"><td class="memItemLeft" align="right" valign="top"><a id="a09f908aa6474fe2b1f82b1aaade947f6" name="a09f908aa6474fe2b1f82b1aaade947f6"></a> +#define </td><td class="memItemRight" valign="bottom"><b>MAX_LINE_WIDTH</b>   1024</td></tr> +<tr class="separator:a09f908aa6474fe2b1f82b1aaade947f6"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:a65477b86cd99f1670bf1234960255baf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="Toolbox_8hpp.html#a65477b86cd99f1670bf1234960255baf">inputLineBox</a> (char *output, unsigned maxWidth, bool ignore=true)</td></tr> +<tr class="memdesc:a65477b86cd99f1670bf1234960255baf"><td class="mdescLeft"> </td><td class="mdescRight">Prints label, gets a whole line of input and stores it to output. <a href="Toolbox_8hpp.html#a65477b86cd99f1670bf1234960255baf">More...</a><br /></td></tr> +<tr class="separator:a65477b86cd99f1670bf1234960255baf"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a138328aaa20f2a8a514e4d7e6fc9c325"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="Toolbox_8hpp.html#a138328aaa20f2a8a514e4d7e6fc9c325">printTable</a> (const <a class="el" href="classList.html">List</a>< <a class="el" href="classString.html">String</a> > &items, unsigned columns)</td></tr> +<tr class="memdesc:a138328aaa20f2a8a514e4d7e6fc9c325"><td class="mdescLeft"> </td><td class="mdescRight">Prints a string list as a table. <a href="Toolbox_8hpp.html#a138328aaa20f2a8a514e4d7e6fc9c325">More...</a><br /></td></tr> +<tr class="separator:a138328aaa20f2a8a514e4d7e6fc9c325"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3c9098dc2b305107367c56ded5dec787"><td class="memTemplParams" colspan="2"><a id="a3c9098dc2b305107367c56ded5dec787" name="a3c9098dc2b305107367c56ded5dec787"></a> +template<typename T > </td></tr> +<tr class="memitem:a3c9098dc2b305107367c56ded5dec787"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><b>read</b> (T *storage)</td></tr> +<tr class="memdesc:a3c9098dc2b305107367c56ded5dec787"><td class="mdescLeft"> </td><td class="mdescRight">Reads user input and stores it. <br /></td></tr> +<tr class="separator:a3c9098dc2b305107367c56ded5dec787"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a06ca09434be2a02543a2371d477acfa0"><td class="memTemplParams" colspan="2"><a id="a06ca09434be2a02543a2371d477acfa0" name="a06ca09434be2a02543a2371d477acfa0"></a> +template<typename T > </td></tr> +<tr class="memitem:a06ca09434be2a02543a2371d477acfa0"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><b>read</b> (T &storage)</td></tr> +<tr class="memdesc:a06ca09434be2a02543a2371d477acfa0"><td class="mdescLeft"> </td><td class="mdescRight">Reads user input and stores it. <br /></td></tr> +<tr class="separator:a06ca09434be2a02543a2371d477acfa0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5ca1093462d3266fceb8522e144c1e73"><td class="memTemplParams" colspan="2"><a id="a5ca1093462d3266fceb8522e144c1e73" name="a5ca1093462d3266fceb8522e144c1e73"></a> +template<typename T > </td></tr> +<tr class="memitem:a5ca1093462d3266fceb8522e144c1e73"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><b>print</b> (const T *item)</td></tr> +<tr class="memdesc:a5ca1093462d3266fceb8522e144c1e73"><td class="mdescLeft"> </td><td class="mdescRight">Prints given item. <br /></td></tr> +<tr class="separator:a5ca1093462d3266fceb8522e144c1e73"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9c0a0d7d3210ca5f12f02ac4cb88476e"><td class="memTemplParams" colspan="2"><a id="a9c0a0d7d3210ca5f12f02ac4cb88476e" name="a9c0a0d7d3210ca5f12f02ac4cb88476e"></a> +template<typename T > </td></tr> +<tr class="memitem:a9c0a0d7d3210ca5f12f02ac4cb88476e"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><b>print</b> (const T &item)</td></tr> +<tr class="memdesc:a9c0a0d7d3210ca5f12f02ac4cb88476e"><td class="mdescLeft"> </td><td class="mdescRight">Prints given item. <br /></td></tr> +<tr class="separator:a9c0a0d7d3210ca5f12f02ac4cb88476e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a148d9d6b8b15bbfc2b1f4cdb16c2ee81"><td class="memTemplParams" colspan="2"><a id="a148d9d6b8b15bbfc2b1f4cdb16c2ee81" name="a148d9d6b8b15bbfc2b1f4cdb16c2ee81"></a> +template<typename T > </td></tr> +<tr class="memitem:a148d9d6b8b15bbfc2b1f4cdb16c2ee81"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><b>printLine</b> (const T *item)</td></tr> +<tr class="memdesc:a148d9d6b8b15bbfc2b1f4cdb16c2ee81"><td class="mdescLeft"> </td><td class="mdescRight">Prints given item and an endline character. <br /></td></tr> +<tr class="separator:a148d9d6b8b15bbfc2b1f4cdb16c2ee81"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a799f4cb5b4da3d40261e25d9e41995aa"><td class="memTemplParams" colspan="2"><a id="a799f4cb5b4da3d40261e25d9e41995aa" name="a799f4cb5b4da3d40261e25d9e41995aa"></a> +template<typename T > </td></tr> +<tr class="memitem:a799f4cb5b4da3d40261e25d9e41995aa"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><b>printLine</b> (const T &item)</td></tr> +<tr class="memdesc:a799f4cb5b4da3d40261e25d9e41995aa"><td class="mdescLeft"> </td><td class="mdescRight">Prints given item and an endline character. <br /></td></tr> +<tr class="separator:a799f4cb5b4da3d40261e25d9e41995aa"><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 wide range of functions for simpler/more automated printing. </p> +<p >Adds a lot of functions for printing.</p> +<dl class="section remark"><dt>Remarks</dt><dd>iostream is included by necessity (templated functions), you should only use the provided functions, if you can. </dd></dl> +</div><h2 class="groupheader">Function Documentation</h2> +<a id="a65477b86cd99f1670bf1234960255baf" name="a65477b86cd99f1670bf1234960255baf"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a65477b86cd99f1670bf1234960255baf">◆ </a></span>inputLineBox()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void inputLineBox </td> + <td>(</td> + <td class="paramtype">char * </td> + <td class="paramname"><em>output</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">unsigned </td> + <td class="paramname"><em>maxWidth</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>ignore</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Prints label, gets a whole line of input and stores it to output. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">label</td><td>C-style string, there are no size check so it could wrap </td></tr> + <tr><td class="paramname">output</td><td>Pointer to a char array </td></tr> + <tr><td class="paramname">maxWidth</td><td>Maximum count of characters to read from user input. output MUST be able to hold that many characters! </td></tr> + <tr><td class="paramname">ignore</td><td>Whether or not to ignore the first new-line delimiter. true by default, should be set to false only when an inputLineBox/SubBox has been issued directly prior or when it's the very first issued box command.</td></tr> + </table> + </dd> +</dl> +<p>Prints "(+)" before the label. </p> + +</div> +</div> +<a id="a138328aaa20f2a8a514e4d7e6fc9c325" name="a138328aaa20f2a8a514e4d7e6fc9c325"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a138328aaa20f2a8a514e4d7e6fc9c325">◆ </a></span>printTable()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void printTable </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classList.html">List</a>< <a class="el" href="classString.html">String</a> > & </td> + <td class="paramname"><em>items</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">unsigned </td> + <td class="paramname"><em>columns</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Prints a string list as a table. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">startNumber</td><td>The number by which column and row enumeration begins </td></tr> + <tr><td class="paramname">columns</td><td>How many columns the table should have </td></tr> + <tr><td class="paramname">items</td><td>C-style string, each cell is a single character from the string</td></tr> + </table> + </dd> +</dl> +<p>Prints a string as a grid/table of characters from top to bottom, left to right. The first character is on the top left, the last one is on the bottom right.</p> +<p ><a class="el" href="classTable.html" title="A 2D collection of Cell instances.">Table</a> is printed until a terminating zero is encountered. The rows are "calculated" from the columns count and the items length. </p> + +</div> +</div> +</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> |
