nishbox/engine/gui_8h.html

259 lines
14 KiB
HTML

<!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" lang="en-US">
<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.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GoldFish Engine: include/gf_type/gui.h 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="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 id="projectrow">
<td id="projectlogo"><img alt="Logo" src="goldfish.png"/></td>
<td id="projectalign">
<div id="projectname">GoldFish Engine
</div>
<div id="projectbrief">Quite simple and lightweight game engine</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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>
</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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('gui_8h.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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle"><div class="title">gui.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Type definitions related to GUI.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;<a class="el" href="gf__pre_8h_source.html">gf_pre.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="gf__macro_8h_source.html">gf_macro.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="draw_8h_source.html">gf_type/draw.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="core_8h_source.html">gf_type/core.h</a>&gt;</code><br />
</div>
<p><a href="gui_8h_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="nested-classes" name="nested-classes"></a>
Data Structures</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="structgf__gui__button__t.html">gf_gui_button_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Button component. <a href="structgf__gui__button__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">union &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uniongf__gui__union__t.html">gf_gui_union_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Component union. <a href="uniongf__gui__union__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgf__gui__component__t.html">gf_gui_component_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Component. <a href="structgf__gui__component__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgf__gui__t.html">gf_gui_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">GUI. <a href="structgf__gui__t.html#details">More...</a><br /></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 id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a33770d9046d53ad607fcc938f1619eb8" id="r_a33770d9046d53ad607fcc938f1619eb8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gui_8h.html#a33770d9046d53ad607fcc938f1619eb8">GF_GUI_MAX_COMPONENTS</a>&#160;&#160;&#160;64</td></tr>
<tr class="memdesc:a33770d9046d53ad607fcc938f1619eb8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Max components GUI can handle. <br /></td></tr>
<tr class="separator:a33770d9046d53ad607fcc938f1619eb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a17ba559c53b849a8391b8f48d91b4f11" id="r_a17ba559c53b849a8391b8f48d91b4f11"><td class="memItemLeft" align="right" valign="top">typedef int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gui_8h.html#a17ba559c53b849a8391b8f48d91b4f11">gf_gui_id_t</a></td></tr>
<tr class="memdesc:a17ba559c53b849a8391b8f48d91b4f11"><td class="mdescLeft">&#160;</td><td class="mdescRight">Component ID. <br /></td></tr>
<tr class="separator:a17ba559c53b849a8391b8f48d91b4f11"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a069cd186008e4a5b6c33776a3fd796af" id="r_a069cd186008e4a5b6c33776a3fd796af"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gui_8h.html#a069cd186008e4a5b6c33776a3fd796af">gf_gui_callback_t</a>) (<a class="el" href="structgf__engine__t.html">gf_engine_t</a> *engine, <a class="el" href="structgf__draw__t.html">gf_draw_t</a> *draw, <a class="el" href="gui_8h.html#a17ba559c53b849a8391b8f48d91b4f11">gf_gui_id_t</a> id, int type)</td></tr>
<tr class="separator:a069cd186008e4a5b6c33776a3fd796af"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a7a5228e21a2d5c98d2b88d5e7bc97d82" id="r_a7a5228e21a2d5c98d2b88d5e7bc97d82"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gui_8h.html#a7a5228e21a2d5c98d2b88d5e7bc97d82">GF_GUI_EVENTS</a> { <b>GF_GUI_PRESS_EVENT</b> = 0
}</td></tr>
<tr class="memdesc:a7a5228e21a2d5c98d2b88d5e7bc97d82"><td class="mdescLeft">&#160;</td><td class="mdescRight">GUI events. <a href="gui_8h.html#a7a5228e21a2d5c98d2b88d5e7bc97d82">More...</a><br /></td></tr>
<tr class="separator:a7a5228e21a2d5c98d2b88d5e7bc97d82"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a29f22c7359d8c3b586f0d4eb82213d03" id="r_a29f22c7359d8c3b586f0d4eb82213d03"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gui_8h.html#a29f22c7359d8c3b586f0d4eb82213d03">GF_GUI_COMPONENT_TYPES</a> { <b>GF_GUI_UNUSED</b> = -1
, <b>GF_GUI_BUTTON</b>
}</td></tr>
<tr class="memdesc:a29f22c7359d8c3b586f0d4eb82213d03"><td class="mdescLeft">&#160;</td><td class="mdescRight">GUI component types. <a href="gui_8h.html#a29f22c7359d8c3b586f0d4eb82213d03">More...</a><br /></td></tr>
<tr class="separator:a29f22c7359d8c3b586f0d4eb82213d03"><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>Type definitions related to GUI. </p>
<p class="definition">Definition in file <a class="el" href="gui_8h_source.html">gui.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a33770d9046d53ad607fcc938f1619eb8" name="a33770d9046d53ad607fcc938f1619eb8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33770d9046d53ad607fcc938f1619eb8">&#9670;&#160;</a></span>GF_GUI_MAX_COMPONENTS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GF_GUI_MAX_COMPONENTS&#160;&#160;&#160;64</td>
</tr>
</table>
</div><div class="memdoc">
<p>Max components GUI can handle. </p>
<p class="definition">Definition at line <a class="el" href="gui_8h_source.html#l00048">48</a> of file <a class="el" href="gui_8h_source.html">gui.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a069cd186008e4a5b6c33776a3fd796af" name="a069cd186008e4a5b6c33776a3fd796af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a069cd186008e4a5b6c33776a3fd796af">&#9670;&#160;</a></span>gf_gui_callback_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* gf_gui_callback_t) (<a class="el" href="structgf__engine__t.html">gf_engine_t</a> *engine, <a class="el" href="structgf__draw__t.html">gf_draw_t</a> *draw, <a class="el" href="gui_8h.html#a17ba559c53b849a8391b8f48d91b4f11">gf_gui_id_t</a> id, int type)</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="gui_8h_source.html#l00042">42</a> of file <a class="el" href="gui_8h_source.html">gui.h</a>.</p>
</div>
</div>
<a id="a17ba559c53b849a8391b8f48d91b4f11" name="a17ba559c53b849a8391b8f48d91b4f11"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17ba559c53b849a8391b8f48d91b4f11">&#9670;&#160;</a></span>gf_gui_id_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int <a class="el" href="gui_8h.html#a17ba559c53b849a8391b8f48d91b4f11">gf_gui_id_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Component ID. </p>
<p class="definition">Definition at line <a class="el" href="gui_8h_source.html#l00017">17</a> of file <a class="el" href="gui_8h_source.html">gui.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a29f22c7359d8c3b586f0d4eb82213d03" name="a29f22c7359d8c3b586f0d4eb82213d03"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a29f22c7359d8c3b586f0d4eb82213d03">&#9670;&#160;</a></span>GF_GUI_COMPONENT_TYPES</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="gui_8h.html#a29f22c7359d8c3b586f0d4eb82213d03">GF_GUI_COMPONENT_TYPES</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>GUI component types. </p>
<p class="definition">Definition at line <a class="el" href="gui_8h_source.html#l00054">54</a> of file <a class="el" href="gui_8h_source.html">gui.h</a>.</p>
</div>
</div>
<a id="a7a5228e21a2d5c98d2b88d5e7bc97d82" name="a7a5228e21a2d5c98d2b88d5e7bc97d82"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a5228e21a2d5c98d2b88d5e7bc97d82">&#9670;&#160;</a></span>GF_GUI_EVENTS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="gui_8h.html#a7a5228e21a2d5c98d2b88d5e7bc97d82">GF_GUI_EVENTS</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>GUI events. </p>
<p class="definition">Definition at line <a class="el" href="gui_8h_source.html#l00023">23</a> of file <a class="el" href="gui_8h_source.html">gui.h</a>.</p>
</div>
</div>
</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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_e60f2706c8c207c5a951446d03370319.html">gf_type</a></li><li class="navelem"><a class="el" href="gui_8h.html">gui.h</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.8 </li>
</ul>
</div>
</body>
</html>