blob: 9fb2e10c04eaa070e37627ad825bc49535c71118 [file] [log] [blame] [edit]
<!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=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>32blit API: blit::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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">32blit API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classblit_1_1Menu.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classblit_1_1Menu-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">blit::Menu Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for blit::Menu:</div>
<div class="dyncontent">
<div class="center"><img src="classblit_1_1Menu__coll__graph.png" border="0" usemap="#ablit_1_1Menu_coll__map" alt="Collaboration graph"/></div>
<map name="ablit_1_1Menu_coll__map" id="ablit_1_1Menu_coll__map">
<area shape="rect" title=" " alt="" coords="247,153,334,180"/>
<area shape="rect" href="structblit_1_1Pen.html" title=" " alt="" coords="5,5,80,32"/>
<area shape="rect" href="structblit_1_1Font.html" title=" " alt="" coords="189,5,267,32"/>
<area shape="rect" href="structblit_1_1Rect.html" title=" " alt="" coords="292,5,372,32"/>
<area shape="rect" href="structblit_1_1Menu_1_1Item.html" title=" " alt="" coords="396,5,521,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structblit_1_1Menu_1_1Item.html">Item</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a6d6d3e66124977bb641ca0a10a516b8a"><td class="memItemLeft" align="right" valign="top"><a id="a6d6d3e66124977bb641ca0a10a516b8a"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Menu</b> (std::string_view title, const <a class="el" href="structblit_1_1Menu_1_1Item.html">Item</a> *items=nullptr, int num_items=0, const <a class="el" href="structblit_1_1Font.html">Font</a> &amp;font=minimal_font)</td></tr>
<tr class="separator:a6d6d3e66124977bb641ca0a10a516b8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab3a92133de8a23ffd3d838da727231f3"><td class="memItemLeft" align="right" valign="top"><a id="ab3a92133de8a23ffd3d838da727231f3"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>render</b> ()</td></tr>
<tr class="separator:ab3a92133de8a23ffd3d838da727231f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a349ea8857a5e76f4a95dd02b1df564"><td class="memItemLeft" align="right" valign="top"><a id="a4a349ea8857a5e76f4a95dd02b1df564"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>update</b> (uint32_t time)</td></tr>
<tr class="separator:a4a349ea8857a5e76f4a95dd02b1df564"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1e31650f60b03eeab0da637d4744509"><td class="memItemLeft" align="right" valign="top"><a id="af1e31650f60b03eeab0da637d4744509"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_items</b> (const <a class="el" href="structblit_1_1Menu_1_1Item.html">Item</a> *items, int num_items)</td></tr>
<tr class="separator:af1e31650f60b03eeab0da637d4744509"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a375eee11dd48bd9e52be84e5925aeb2d"><td class="memItemLeft" align="right" valign="top"><a id="a375eee11dd48bd9e52be84e5925aeb2d"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_display_rect</b> (<a class="el" href="structblit_1_1Rect.html">Rect</a> rect)</td></tr>
<tr class="separator:a375eee11dd48bd9e52be84e5925aeb2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a6c914f8ea91cfab608fd260180859b7b"><td class="memItemLeft" align="right" valign="top"><a id="a6c914f8ea91cfab608fd260180859b7b"></a>
std::string_view&#160;</td><td class="memItemRight" valign="bottom"><b>title</b></td></tr>
<tr class="separator:a6c914f8ea91cfab608fd260180859b7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a6734ff9c0c5a9bec35f0b820c4989b48"><td class="memItemLeft" align="right" valign="top"><a id="a6734ff9c0c5a9bec35f0b820c4989b48"></a>
static const uint16_t&#160;</td><td class="memItemRight" valign="bottom"><b>Separator</b> = 65535</td></tr>
<tr class="separator:a6734ff9c0c5a9bec35f0b820c4989b48"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a871f08eeb26b3e23a28bcaa5fa77db5a"><td class="memItemLeft" align="right" valign="top"><a id="a871f08eeb26b3e23a28bcaa5fa77db5a"></a>
static const uint16_t&#160;</td><td class="memItemRight" valign="bottom"><b>AnyId</b> = 65534</td></tr>
<tr class="separator:a871f08eeb26b3e23a28bcaa5fa77db5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a2d242b11f9e10d6a0d2fb5efc22d1b58"><td class="memItemLeft" align="right" valign="top"><a id="a2d242b11f9e10d6a0d2fb5efc22d1b58"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>render_menu</b> ()</td></tr>
<tr class="separator:a2d242b11f9e10d6a0d2fb5efc22d1b58"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae22e3640400db53ec7fb5b5913edf06b"><td class="memItemLeft" align="right" valign="top"><a id="ae22e3640400db53ec7fb5b5913edf06b"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>render_item</b> (const <a class="el" href="structblit_1_1Menu_1_1Item.html">Item</a> &amp;item, int y, int index) const</td></tr>
<tr class="separator:ae22e3640400db53ec7fb5b5913edf06b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0ad1e9302312370568edc3ae62d2407"><td class="memItemLeft" align="right" valign="top"><a id="ae0ad1e9302312370568edc3ae62d2407"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>update_menu</b> (uint32_t time)</td></tr>
<tr class="separator:ae0ad1e9302312370568edc3ae62d2407"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc92a46f6ed380408cd7dd009096fcad"><td class="memItemLeft" align="right" valign="top"><a id="abc92a46f6ed380408cd7dd009096fcad"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>update_item</b> (const <a class="el" href="structblit_1_1Menu_1_1Item.html">Item</a> &amp;item)</td></tr>
<tr class="separator:abc92a46f6ed380408cd7dd009096fcad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad85a3b69bd34af0c4be0b0c07d263d07"><td class="memItemLeft" align="right" valign="top"><a id="ad85a3b69bd34af0c4be0b0c07d263d07"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>item_activated</b> (const <a class="el" href="structblit_1_1Menu_1_1Item.html">Item</a> &amp;item)</td></tr>
<tr class="separator:ad85a3b69bd34af0c4be0b0c07d263d07"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6a0813b44ccb53d963c19e6041239d31"><td class="memItemLeft" align="right" valign="top"><a id="a6a0813b44ccb53d963c19e6041239d31"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>render_header</b> (int x, int y, int w)</td></tr>
<tr class="separator:a6a0813b44ccb53d963c19e6041239d31"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a85cc4e5e75446e396a54bb9cf2449cb6"><td class="memItemLeft" align="right" valign="top"><a id="a85cc4e5e75446e396a54bb9cf2449cb6"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>render_footer</b> (int x, int y, int w)</td></tr>
<tr class="separator:a85cc4e5e75446e396a54bb9cf2449cb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:ac7e22cb0c6668fe2c35e69cfe397fa12"><td class="memItemLeft" align="right" valign="top"><a id="ac7e22cb0c6668fe2c35e69cfe397fa12"></a>
const <a class="el" href="structblit_1_1Menu_1_1Item.html">Item</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>items</b></td></tr>
<tr class="separator:ac7e22cb0c6668fe2c35e69cfe397fa12"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d7078d64d1396ca983d449215dd08bc"><td class="memItemLeft" align="right" valign="top"><a id="a8d7078d64d1396ca983d449215dd08bc"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>num_items</b></td></tr>
<tr class="separator:a8d7078d64d1396ca983d449215dd08bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a335a93098e5e2ef4c214e1d95ec0bf7e"><td class="memItemLeft" align="right" valign="top"><a id="a335a93098e5e2ef4c214e1d95ec0bf7e"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>current_item</b> = 0</td></tr>
<tr class="separator:a335a93098e5e2ef4c214e1d95ec0bf7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c8c84fdae9bdf63de28255abb0b849c"><td class="memItemLeft" align="right" valign="top"><a id="a9c8c84fdae9bdf63de28255abb0b849c"></a>
float&#160;</td><td class="memItemRight" valign="bottom"><b>scroll_offset</b> = 0.0f</td></tr>
<tr class="separator:a9c8c84fdae9bdf63de28255abb0b849c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adee2b2629b110961b4ccba3ed14cf973"><td class="memItemLeft" align="right" valign="top"><a id="adee2b2629b110961b4ccba3ed14cf973"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>repeat_start_time</b> = 0</td></tr>
<tr class="separator:adee2b2629b110961b4ccba3ed14cf973"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8fc4998c24ad6d71eafd70e7ae97f986"><td class="memItemLeft" align="right" valign="top"><a id="a8fc4998c24ad6d71eafd70e7ae97f986"></a>
<a class="el" href="structblit_1_1Rect.html">Rect</a>&#160;</td><td class="memItemRight" valign="bottom"><b>display_rect</b></td></tr>
<tr class="separator:a8fc4998c24ad6d71eafd70e7ae97f986"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a598cb7aec1314856a0836d1b522eb77c"><td class="memItemLeft" align="right" valign="top"><a id="a598cb7aec1314856a0836d1b522eb77c"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>header_h</b> = 16</td></tr>
<tr class="separator:a598cb7aec1314856a0836d1b522eb77c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a248af8294c6d240cf58d41dd3aa21f4c"><td class="memItemLeft" align="right" valign="top"><a id="a248af8294c6d240cf58d41dd3aa21f4c"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>footer_h</b> = 16</td></tr>
<tr class="separator:a248af8294c6d240cf58d41dd3aa21f4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c8371acbbffa5cf654818fbb07755cb"><td class="memItemLeft" align="right" valign="top"><a id="a7c8371acbbffa5cf654818fbb07755cb"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>margin_y</b> = 5</td></tr>
<tr class="separator:a7c8371acbbffa5cf654818fbb07755cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a75c2522f8fad5ca706d9adf3f7c6ea5e"><td class="memItemLeft" align="right" valign="top"><a id="a75c2522f8fad5ca706d9adf3f7c6ea5e"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>item_h</b> = 9</td></tr>
<tr class="separator:a75c2522f8fad5ca706d9adf3f7c6ea5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a37813819831c0b6499e86297d66cd80e"><td class="memItemLeft" align="right" valign="top"><a id="a37813819831c0b6499e86297d66cd80e"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>item_padding_x</b> = 5</td></tr>
<tr class="separator:a37813819831c0b6499e86297d66cd80e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39d9790a26c4b2e911fae0fd8f8e66fe"><td class="memItemLeft" align="right" valign="top"><a id="a39d9790a26c4b2e911fae0fd8f8e66fe"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>item_adjust_y</b> = 1</td></tr>
<tr class="separator:a39d9790a26c4b2e911fae0fd8f8e66fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a594be51b4af203eea7d8cfefd42ead89"><td class="memItemLeft" align="right" valign="top"><a id="a594be51b4af203eea7d8cfefd42ead89"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>item_spacing</b> = 1</td></tr>
<tr class="separator:a594be51b4af203eea7d8cfefd42ead89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b9cbed89de5ce452ff6f4f315f9098b"><td class="memItemLeft" align="right" valign="top"><a id="a7b9cbed89de5ce452ff6f4f315f9098b"></a>
const <a class="el" href="structblit_1_1Font.html">Font</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>font</b></td></tr>
<tr class="separator:a7b9cbed89de5ce452ff6f4f315f9098b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ec7dba71a1dfab6b1ccfe539deb275f"><td class="memItemLeft" align="right" valign="top"><a id="a2ec7dba71a1dfab6b1ccfe539deb275f"></a>
<a class="el" href="structblit_1_1Pen.html">Pen</a>&#160;</td><td class="memItemRight" valign="bottom"><b>background_colour</b> = <a class="el" href="structblit_1_1Pen.html">Pen</a>(30, 30, 50, 200)</td></tr>
<tr class="separator:a2ec7dba71a1dfab6b1ccfe539deb275f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9996b18437b73f2c614486c8e093612b"><td class="memItemLeft" align="right" valign="top"><a id="a9996b18437b73f2c614486c8e093612b"></a>
<a class="el" href="structblit_1_1Pen.html">Pen</a>&#160;</td><td class="memItemRight" valign="bottom"><b>foreground_colour</b> = <a class="el" href="structblit_1_1Pen.html">Pen</a>(255, 255, 255)</td></tr>
<tr class="separator:a9996b18437b73f2c614486c8e093612b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac903103d270e2e70d4caa2a3af8e57a9"><td class="memItemLeft" align="right" valign="top"><a id="ac903103d270e2e70d4caa2a3af8e57a9"></a>
<a class="el" href="structblit_1_1Pen.html">Pen</a>&#160;</td><td class="memItemRight" valign="bottom"><b>selected_item_background</b> = <a class="el" href="structblit_1_1Pen.html">Pen</a>(50, 50, 70)</td></tr>
<tr class="separator:ac903103d270e2e70d4caa2a3af8e57a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9bd3e14907650bd0a03b0b94ccd42ec7"><td class="memItemLeft" align="right" valign="top"><a id="a9bd3e14907650bd0a03b0b94ccd42ec7"></a>
<a class="el" href="structblit_1_1Pen.html">Pen</a>&#160;</td><td class="memItemRight" valign="bottom"><b>header_background</b> = <a class="el" href="structblit_1_1Pen.html">Pen</a>(235, 245, 255)</td></tr>
<tr class="separator:a9bd3e14907650bd0a03b0b94ccd42ec7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae24722571ce3008c0b604eeae6693f07"><td class="memItemLeft" align="right" valign="top"><a id="ae24722571ce3008c0b604eeae6693f07"></a>
<a class="el" href="structblit_1_1Pen.html">Pen</a>&#160;</td><td class="memItemRight" valign="bottom"><b>header_foreground</b> = <a class="el" href="structblit_1_1Pen.html">Pen</a>(3, 5, 7)</td></tr>
<tr class="separator:ae24722571ce3008c0b604eeae6693f07"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>engine/<a class="el" href="menu_8hpp_source.html">menu.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceblit.html">blit</a></li><li class="navelem"><a class="el" href="classblit_1_1Menu.html">Menu</a></li>
<li class="footer">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.1 </li>
</ul>
</div>
</body>
</html>