diff options
Added files from project 1 (mirror)
1 files changed, 750 insertions, 0 deletions
| -rw-r--r-- | Year 1/Object-oriented Programming/Project 1/docs/html/Toolbox_8hpp.html | 750 |
diff --git a/Year 1/Object-oriented Programming/Project 1/docs/html/Toolbox_8hpp.html b/Year 1/Object-oriented Programming/Project 1/docs/html/Toolbox_8hpp.html new file mode 100644 index 0000000..3c48890 --- /dev/null +++ b/Year 1/Object-oriented Programming/Project 1/docs/html/Toolbox_8hpp.html @@ -0,0 +1,750 @@ +<!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/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 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="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 /> +</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:ac8bb3912a3ce86b15842e79d0b421204"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="Toolbox_8hpp.html#ac8bb3912a3ce86b15842e79d0b421204">clear</a> ()</td></tr> +<tr class="memdesc:ac8bb3912a3ce86b15842e79d0b421204"><td class="mdescLeft"> </td><td class="mdescRight">Clears the console screen. <a href="Toolbox_8hpp.html#ac8bb3912a3ce86b15842e79d0b421204">More...</a><br /></td></tr> +<tr class="separator:ac8bb3912a3ce86b15842e79d0b421204"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a24a3fa9050ea032396c213ea85a1de0b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="Toolbox_8hpp.html#a24a3fa9050ea032396c213ea85a1de0b">titleBox</a> (const char *title)</td></tr> +<tr class="memdesc:a24a3fa9050ea032396c213ea85a1de0b"><td class="mdescLeft"> </td><td class="mdescRight">Prints a title box. <a href="Toolbox_8hpp.html#a24a3fa9050ea032396c213ea85a1de0b">More...</a><br /></td></tr> +<tr class="separator:a24a3fa9050ea032396c213ea85a1de0b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad557e4a1167be4e0c57fe530ce74a120"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="Toolbox_8hpp.html#ad557e4a1167be4e0c57fe530ce74a120">subTitleBox</a> (const char *title)</td></tr> +<tr class="memdesc:ad557e4a1167be4e0c57fe530ce74a120"><td class="mdescLeft"> </td><td class="mdescRight">Prints a title sub box. <a href="Toolbox_8hpp.html#ad557e4a1167be4e0c57fe530ce74a120">More...</a><br /></td></tr> +<tr class="separator:ad557e4a1167be4e0c57fe530ce74a120"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6c82ac6987703376c17c74a81fb0a91a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="Toolbox_8hpp.html#a6c82ac6987703376c17c74a81fb0a91a">successBox</a> (const char *message)</td></tr> +<tr class="memdesc:a6c82ac6987703376c17c74a81fb0a91a"><td class="mdescLeft"> </td><td class="mdescRight">Prints a success box. <a href="Toolbox_8hpp.html#a6c82ac6987703376c17c74a81fb0a91a">More...</a><br /></td></tr> +<tr class="separator:a6c82ac6987703376c17c74a81fb0a91a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa78e2e87fff9b64ca032a5b1c7054081"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="Toolbox_8hpp.html#aa78e2e87fff9b64ca032a5b1c7054081">successSubBox</a> (const char *message)</td></tr> +<tr class="memdesc:aa78e2e87fff9b64ca032a5b1c7054081"><td class="mdescLeft"> </td><td class="mdescRight">Prints a success box as a sub box. <a href="Toolbox_8hpp.html#aa78e2e87fff9b64ca032a5b1c7054081">More...</a><br /></td></tr> +<tr class="separator:aa78e2e87fff9b64ca032a5b1c7054081"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a52222c9ff8739ef87c89df899deb5052"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="Toolbox_8hpp.html#a52222c9ff8739ef87c89df899deb5052">warningBox</a> (const char *message)</td></tr> +<tr class="memdesc:a52222c9ff8739ef87c89df899deb5052"><td class="mdescLeft"> </td><td class="mdescRight">Prints a warning box. <a href="Toolbox_8hpp.html#a52222c9ff8739ef87c89df899deb5052">More...</a><br /></td></tr> +<tr class="separator:a52222c9ff8739ef87c89df899deb5052"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a22f8b3135115d1b9fca09eea98dc6d92"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="Toolbox_8hpp.html#a22f8b3135115d1b9fca09eea98dc6d92">warningSubBox</a> (const char *message)</td></tr> +<tr class="memdesc:a22f8b3135115d1b9fca09eea98dc6d92"><td class="mdescLeft"> </td><td class="mdescRight">Prints a warning box as a sub box. <a href="Toolbox_8hpp.html#a22f8b3135115d1b9fca09eea98dc6d92">More...</a><br /></td></tr> +<tr class="separator:a22f8b3135115d1b9fca09eea98dc6d92"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9d709a3db7de05368cc38671c896bb2d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="Toolbox_8hpp.html#a9d709a3db7de05368cc38671c896bb2d">errorBox</a> (const char *message)</td></tr> +<tr class="memdesc:a9d709a3db7de05368cc38671c896bb2d"><td class="mdescLeft"> </td><td class="mdescRight">Prints an error box. <a href="Toolbox_8hpp.html#a9d709a3db7de05368cc38671c896bb2d">More...</a><br /></td></tr> +<tr class="separator:a9d709a3db7de05368cc38671c896bb2d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ade748c3f15151748c9f978097715d2e7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="Toolbox_8hpp.html#ade748c3f15151748c9f978097715d2e7">errorSubBox</a> (const char *message)</td></tr> +<tr class="memdesc:ade748c3f15151748c9f978097715d2e7"><td class="mdescLeft"> </td><td class="mdescRight">Prints an error box as a sub box. <a href="Toolbox_8hpp.html#ade748c3f15151748c9f978097715d2e7">More...</a><br /></td></tr> +<tr class="separator:ade748c3f15151748c9f978097715d2e7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa49b4d5a7b00249bc1fb08eec5e3aeaf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="Toolbox_8hpp.html#aa49b4d5a7b00249bc1fb08eec5e3aeaf">inputLineBox</a> (const char *label, char *output, unsigned maxWidth, bool ignore=true)</td></tr> +<tr class="memdesc:aa49b4d5a7b00249bc1fb08eec5e3aeaf"><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#aa49b4d5a7b00249bc1fb08eec5e3aeaf">More...</a><br /></td></tr> +<tr class="separator:aa49b4d5a7b00249bc1fb08eec5e3aeaf"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad2c61ce27ec52d14e427d6f6e93d38f2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="Toolbox_8hpp.html#ad2c61ce27ec52d14e427d6f6e93d38f2">inputLineSubBox</a> (const char *label, char *output, unsigned maxWidth, bool ignore=true)</td></tr> +<tr class="memdesc:ad2c61ce27ec52d14e427d6f6e93d38f2"><td class="mdescLeft"> </td><td class="mdescRight">Prints label as a sub box, gets a whole line of input and stores it to output. <a href="Toolbox_8hpp.html#ad2c61ce27ec52d14e427d6f6e93d38f2">More...</a><br /></td></tr> +<tr class="separator:ad2c61ce27ec52d14e427d6f6e93d38f2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac7f54319bf4e70a46e3155ae1b39e832"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="Toolbox_8hpp.html#ac7f54319bf4e70a46e3155ae1b39e832">pressEnterToContinue</a> (bool ignore=true)</td></tr> +<tr class="memdesc:ac7f54319bf4e70a46e3155ae1b39e832"><td class="mdescLeft"> </td><td class="mdescRight">Waits for user to press enter. <a href="Toolbox_8hpp.html#ac7f54319bf4e70a46e3155ae1b39e832">More...</a><br /></td></tr> +<tr class="separator:ac7f54319bf4e70a46e3155ae1b39e832"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4456d10f7e141c4fc1a29aff4ad29108"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="Toolbox_8hpp.html#a4456d10f7e141c4fc1a29aff4ad29108">resetOrderedList</a> (int starter=1)</td></tr> +<tr class="memdesc:a4456d10f7e141c4fc1a29aff4ad29108"><td class="mdescLeft"> </td><td class="mdescRight">Resets the ordered list starting number. <a href="Toolbox_8hpp.html#a4456d10f7e141c4fc1a29aff4ad29108">More...</a><br /></td></tr> +<tr class="separator:a4456d10f7e141c4fc1a29aff4ad29108"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6c90056ede686f0319d0fb0a408d02e5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="Toolbox_8hpp.html#a6c90056ede686f0319d0fb0a408d02e5">table</a> (unsigned startNumber, unsigned columns, const char *items)</td></tr> +<tr class="memdesc:a6c90056ede686f0319d0fb0a408d02e5"><td class="mdescLeft"> </td><td class="mdescRight">Prints a string as a table. <a href="Toolbox_8hpp.html#a6c90056ede686f0319d0fb0a408d02e5">More...</a><br /></td></tr> +<tr class="separator:a6c90056ede686f0319d0fb0a408d02e5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac17b91efad13dbe9e10e5550ee4707c6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="Toolbox_8hpp.html#ac17b91efad13dbe9e10e5550ee4707c6">_printSubBoxSpacing</a> ()</td></tr> +<tr class="memdesc:ac17b91efad13dbe9e10e5550ee4707c6"><td class="mdescLeft"> </td><td class="mdescRight">Semi-internal function that prints the spacing for sub boxes. <a href="Toolbox_8hpp.html#ac17b91efad13dbe9e10e5550ee4707c6">More...</a><br /></td></tr> +<tr class="separator:ac17b91efad13dbe9e10e5550ee4707c6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab3ce613add75d2385c8e1424527d2c3d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="Toolbox_8hpp.html#ab3ce613add75d2385c8e1424527d2c3d">_printInputBoxLabel</a> (const char *label)</td></tr> +<tr class="memdesc:ab3ce613add75d2385c8e1424527d2c3d"><td class="mdescLeft"> </td><td class="mdescRight">Semi-internal function that prints the label of an input box. <a href="Toolbox_8hpp.html#ab3ce613add75d2385c8e1424527d2c3d">More...</a><br /></td></tr> +<tr class="separator:ab3ce613add75d2385c8e1424527d2c3d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a27b565355e018d36b6ce47169cc26fad"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="Toolbox_8hpp.html#a27b565355e018d36b6ce47169cc26fad">_printOrderedListBeginning</a> ()</td></tr> +<tr class="memdesc:a27b565355e018d36b6ce47169cc26fad"><td class="mdescLeft"> </td><td class="mdescRight">Semi-internal function that prints the latest ordered list index. <a href="Toolbox_8hpp.html#a27b565355e018d36b6ce47169cc26fad">More...</a><br /></td></tr> +<tr class="separator:a27b565355e018d36b6ce47169cc26fad"><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> +<tr class="memitem:abe3a449632ee6d40eb59101dd2d2f114"><td class="memTemplParams" colspan="2"><a id="abe3a449632ee6d40eb59101dd2d2f114" name="abe3a449632ee6d40eb59101dd2d2f114"></a> +template<typename T > </td></tr> +<tr class="memitem:abe3a449632ee6d40eb59101dd2d2f114"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><b>printOrderedListElem</b> (const T &elem)</td></tr> +<tr class="memdesc:abe3a449632ee6d40eb59101dd2d2f114"><td class="mdescLeft"> </td><td class="mdescRight">Prints the element as the latest list item. <br /></td></tr> +<tr class="separator:abe3a449632ee6d40eb59101dd2d2f114"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab7651f0a92f8d0d0be3d63c1045eee1e"><td class="memTemplParams" colspan="2"><a id="ab7651f0a92f8d0d0be3d63c1045eee1e" name="ab7651f0a92f8d0d0be3d63c1045eee1e"></a> +template<typename T > </td></tr> +<tr class="memitem:ab7651f0a92f8d0d0be3d63c1045eee1e"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><b>inputBox</b> (const char *label, T *output)</td></tr> +<tr class="memdesc:ab7651f0a92f8d0d0be3d63c1045eee1e"><td class="mdescLeft"> </td><td class="mdescRight">Prints a label and then reads user input and stores it. <br /></td></tr> +<tr class="separator:ab7651f0a92f8d0d0be3d63c1045eee1e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a92da1c5f0023cd5c4809d9c1f682e92f"><td class="memTemplParams" colspan="2">template<typename T > </td></tr> +<tr class="memitem:a92da1c5f0023cd5c4809d9c1f682e92f"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="Toolbox_8hpp.html#a92da1c5f0023cd5c4809d9c1f682e92f">inputSubBox</a> (const char *label, T *output)</td></tr> +<tr class="separator:a92da1c5f0023cd5c4809d9c1f682e92f"><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="ab3ce613add75d2385c8e1424527d2c3d" name="ab3ce613add75d2385c8e1424527d2c3d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ab3ce613add75d2385c8e1424527d2c3d">◆ </a></span>_printInputBoxLabel()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void _printInputBoxLabel </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>label</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Semi-internal function that prints the label of an input box. </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 checks so it could wrap</td></tr> + </table> + </dd> +</dl> +<p>Prints "(+)" and then the given label. It doesn't create spacing after label, so it should exist in the label itself.</p> +<dl class="section remark"><dt>Remarks</dt><dd>Semi-internal means the function is defined in the header out of necessity (for templated functions) </dd></dl> + +</div> +</div> +<a id="a27b565355e018d36b6ce47169cc26fad" name="a27b565355e018d36b6ce47169cc26fad"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a27b565355e018d36b6ce47169cc26fad">◆ </a></span>_printOrderedListBeginning()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void _printOrderedListBeginning </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Semi-internal function that prints the latest ordered list index. </p> +<p >Prints the latests ordered list index, surrounded by square brackets, and increments the ordered list index.</p> +<dl class="section remark"><dt>Remarks</dt><dd>There are no size checks, so list index could overflow.</dd> +<dd> +Semi-internal means the function is defined in the header out of necessity (for templated functions) </dd></dl> + +</div> +</div> +<a id="ac17b91efad13dbe9e10e5550ee4707c6" name="ac17b91efad13dbe9e10e5550ee4707c6"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac17b91efad13dbe9e10e5550ee4707c6">◆ </a></span>_printSubBoxSpacing()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void _printSubBoxSpacing </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Semi-internal function that prints the spacing for sub boxes. </p> +<p >Sub boxes are like normal boxes, but indented with 4 spaces. </p> + +</div> +</div> +<a id="ac8bb3912a3ce86b15842e79d0b421204" name="ac8bb3912a3ce86b15842e79d0b421204"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac8bb3912a3ce86b15842e79d0b421204">◆ </a></span>clear()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void clear </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Clears the console screen. </p> +<p >Erases display and moves cursor to top left corner via ANSI escape sequences: <code>ESC</code>[2J <code>ESC</code>[1;1H</p> +<dl class="section warning"><dt>Warning</dt><dd>Not all terminals support any or all ANSI escape sequences</dd></dl> +<dl class="section note"><dt>Note</dt><dd>Source: <a href="https://stackoverflow.com/a/52895729/12036073">https://stackoverflow.com/a/52895729/12036073</a> </dd></dl> + +</div> +</div> +<a id="a9d709a3db7de05368cc38671c896bb2d" name="a9d709a3db7de05368cc38671c896bb2d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a9d709a3db7de05368cc38671c896bb2d">◆ </a></span>errorBox()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void errorBox </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>message</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Prints an error box. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">message</td><td>C-style string, there are no size checks so it could wrap</td></tr> + </table> + </dd> +</dl> +<p>Error boxes start with "<E>" and print the message.</p> +<dl class="section remark"><dt>Remarks</dt><dd>Success/Warning/Error boxes start with "<C>" where C is an appropriate character. </dd></dl> + +</div> +</div> +<a id="ade748c3f15151748c9f978097715d2e7" name="ade748c3f15151748c9f978097715d2e7"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ade748c3f15151748c9f978097715d2e7">◆ </a></span>errorSubBox()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void errorSubBox </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>message</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Prints an error box as a sub box. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">message</td><td>C-style string, there are no size checks so it could wrap</td></tr> + </table> + </dd> +</dl> +<p>Error boxes start with "<E>" and print the message.</p> +<dl class="section remark"><dt>Remarks</dt><dd>Success/Warning/Error boxes start with "<C>" where C is an appropriate character. </dd></dl> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="Toolbox_8hpp.html#ac17b91efad13dbe9e10e5550ee4707c6" title="Semi-internal function that prints the spacing for sub boxes.">_printSubBoxSpacing()</a> </dd></dl> + +</div> +</div> +<a id="aa49b4d5a7b00249bc1fb08eec5e3aeaf" name="aa49b4d5a7b00249bc1fb08eec5e3aeaf"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aa49b4d5a7b00249bc1fb08eec5e3aeaf">◆ </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">const char * </td> + <td class="paramname"><em>label</em>, </td> + </tr> + <tr> + <td class="paramkey"></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="ad2c61ce27ec52d14e427d6f6e93d38f2" name="ad2c61ce27ec52d14e427d6f6e93d38f2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ad2c61ce27ec52d14e427d6f6e93d38f2">◆ </a></span>inputLineSubBox()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void inputLineSubBox </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>label</em>, </td> + </tr> + <tr> + <td class="paramkey"></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 as a sub box, 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><dl class="section see"><dt>See also</dt><dd><a class="el" href="Toolbox_8hpp.html#ac17b91efad13dbe9e10e5550ee4707c6" title="Semi-internal function that prints the spacing for sub boxes.">_printSubBoxSpacing()</a> </dd></dl> + +</div> +</div> +<a id="a92da1c5f0023cd5c4809d9c1f682e92f" name="a92da1c5f0023cd5c4809d9c1f682e92f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a92da1c5f0023cd5c4809d9c1f682e92f">◆ </a></span>inputSubBox()</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename T > </div> + <table class="memname"> + <tr> + <td class="memname">void inputSubBox </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>label</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">T * </td> + <td class="paramname"><em>output</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p >Prints a label with sub box spacing and then reads user input and stores it </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="Toolbox_8hpp.html#ac17b91efad13dbe9e10e5550ee4707c6" title="Semi-internal function that prints the spacing for sub boxes.">_printSubBoxSpacing()</a> </dd></dl> + +</div> +</div> +<a id="ac7f54319bf4e70a46e3155ae1b39e832" name="ac7f54319bf4e70a46e3155ae1b39e832"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac7f54319bf4e70a46e3155ae1b39e832">◆ </a></span>pressEnterToContinue()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void pressEnterToContinue </td> + <td>(</td> + <td class="paramtype">bool </td> + <td class="paramname"><em>ignore</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Waits for user to press enter. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <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 a "Press enter to continue" message and waits for the user </p> + +</div> +</div> +<a id="a4456d10f7e141c4fc1a29aff4ad29108" name="a4456d10f7e141c4fc1a29aff4ad29108"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a4456d10f7e141c4fc1a29aff4ad29108">◆ </a></span>resetOrderedList()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void resetOrderedList </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"><em>starter</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Resets the ordered list starting number. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">starter</td><td>Sets the starting number by which ordered list will enumerate</td></tr> + </table> + </dd> +</dl> +<dl class="section remark"><dt>Remarks</dt><dd>Although starter can be a negative number, ordered list will always increment up the number. </dd></dl> + +</div> +</div> +<a id="ad557e4a1167be4e0c57fe530ce74a120" name="ad557e4a1167be4e0c57fe530ce74a120"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ad557e4a1167be4e0c57fe530ce74a120">◆ </a></span>subTitleBox()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void subTitleBox </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>title</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Prints a title sub box. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">title</td><td>C-style string, there are no size checks so it could wrap</td></tr> + </table> + </dd> +</dl> +<p>Prints the title, surrounded by "---". </p> + +</div> +</div> +<a id="a6c82ac6987703376c17c74a81fb0a91a" name="a6c82ac6987703376c17c74a81fb0a91a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a6c82ac6987703376c17c74a81fb0a91a">◆ </a></span>successBox()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void successBox </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>message</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Prints a success box. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">message</td><td>C-style string, there are no size checks so it could wrap</td></tr> + </table> + </dd> +</dl> +<p>Success boxes start with "<S>" and print the message.</p> +<dl class="section remark"><dt>Remarks</dt><dd>Success/Warning/Error boxes start with "<C>" where C is an appropriate character. </dd></dl> + +</div> +</div> +<a id="aa78e2e87fff9b64ca032a5b1c7054081" name="aa78e2e87fff9b64ca032a5b1c7054081"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aa78e2e87fff9b64ca032a5b1c7054081">◆ </a></span>successSubBox()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void successSubBox </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>message</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Prints a success box as a sub box. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">message</td><td>C-style string, there are no size checks so it could wrap</td></tr> + </table> + </dd> +</dl> +<p>Success boxes start with "<S>" and print the message.</p> +<dl class="section remark"><dt>Remarks</dt><dd>Success/Warning/Error boxes start with "<C>" where C is an appropriate character. </dd></dl> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="Toolbox_8hpp.html#ac17b91efad13dbe9e10e5550ee4707c6" title="Semi-internal function that prints the spacing for sub boxes.">_printSubBoxSpacing()</a> </dd></dl> + +</div> +</div> +<a id="a6c90056ede686f0319d0fb0a408d02e5" name="a6c90056ede686f0319d0fb0a408d02e5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a6c90056ede686f0319d0fb0a408d02e5">◆ </a></span>table()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void table </td> + <td>(</td> + <td class="paramtype">unsigned </td> + <td class="paramname"><em>startNumber</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 class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>items</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Prints a string 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 >Table is printed until a terminating zero is encountered. The rows are "calculated" from the columns count and the items length. </p> + +</div> +</div> +<a id="a24a3fa9050ea032396c213ea85a1de0b" name="a24a3fa9050ea032396c213ea85a1de0b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a24a3fa9050ea032396c213ea85a1de0b">◆ </a></span>titleBox()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void titleBox </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>title</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Prints a title box. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">title</td><td>C-style string, there are no size checks so it could wrap</td></tr> + </table> + </dd> +</dl> +<p>Prints the title, surrounded by "===". </p> + +</div> +</div> +<a id="a52222c9ff8739ef87c89df899deb5052" name="a52222c9ff8739ef87c89df899deb5052"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a52222c9ff8739ef87c89df899deb5052">◆ </a></span>warningBox()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void warningBox </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>message</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Prints a warning box. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">message</td><td>C-style string, there are no size checks so it could wrap</td></tr> + </table> + </dd> +</dl> +<p>Warning boxes start with "<W>" and print the message.</p> +<dl class="section remark"><dt>Remarks</dt><dd>Success/Warning/Error boxes start with "<C>" where C is an appropriate character. </dd></dl> + +</div> +</div> +<a id="a22f8b3135115d1b9fca09eea98dc6d92" name="a22f8b3135115d1b9fca09eea98dc6d92"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a22f8b3135115d1b9fca09eea98dc6d92">◆ </a></span>warningSubBox()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void warningSubBox </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>message</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Prints a warning box as a sub box. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">message</td><td>C-style string, there are no size checks so it could wrap</td></tr> + </table> + </dd> +</dl> +<p>Warning boxes start with "<W>" and print the message.</p> +<dl class="section remark"><dt>Remarks</dt><dd>Success/Warning/Error boxes start with "<C>" where C is an appropriate character. </dd></dl> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="Toolbox_8hpp.html#ac17b91efad13dbe9e10e5550ee4707c6" title="Semi-internal function that prints the spacing for sub boxes.">_printSubBoxSpacing()</a> </dd></dl> + +</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> |
