602 lines
27 KiB
HTML
Executable File
602 lines
27 KiB
HTML
Executable File
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
|
<title>Gewi::GewiEngine class Reference</title>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css">
|
|
</head><body>
|
|
<!-- Generated by Doxygen 1.3 -->
|
|
<center>
|
|
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> </center>
|
|
<hr><h1>Gewi::GewiEngine Class Reference</h1><code>#include <<a class="el" href="GewiEngine_8h-source.html">GewiEngine.h</a>></code>
|
|
<p>
|
|
<a href="classGewi_1_1GewiEngine-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
<a class="el" href="classGewi_1_1GewiEngine.html">GewiEngine</a> Singleton Class, accessible from anywhere in a program via GetInstance. Contains widgets in global context (those drawn in relation to screen, with a NULL parent) also handles resource management of fonts and images.
|
|
<p>
|
|
<table border=0 cellpadding=0 cellspacing=0>
|
|
<tr><td></td></tr>
|
|
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classGewi_1_1GewiEngine.html#a0">Display</a> ()</td></tr>
|
|
<tr><td> </td><td><em class="mdesc">Draw all widgets in the <a class="el" href="namespaceGewi.html">Gewi</a> system.</em> <a href="#a0"></a><em></em><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a class="el" href="namespaceGewi.html#a2">ResourceID</a> </td><td valign=bottom><a class="el" href="classGewi_1_1GewiEngine.html#a1">AddResource</a> (ZE::ZImage *image)</td></tr>
|
|
<tr><td> </td><td><em class="mdesc">Adds an image resource to the private vector.</em> <a href="#a1"></a><em></em><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a class="el" href="namespaceGewi.html#a2">ResourceID</a> </td><td valign=bottom><a class="el" href="classGewi_1_1GewiEngine.html#a2">AddResource</a> (ZE::ZFont *font)</td></tr>
|
|
<tr><td> </td><td><em class="mdesc">Adds a font resource to the private vector.</em> <a href="#a2"></a><em></em><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>ZE::ZImage * </td><td valign=bottom><a class="el" href="classGewi_1_1GewiEngine.html#a3">Image</a> (<a class="el" href="namespaceGewi.html#a2">ResourceID</a> id)</td></tr>
|
|
<tr><td> </td><td><em class="mdesc">Access an image in the resource vector.</em> <a href="#a3"></a><em></em><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>ZE::ZFont * </td><td valign=bottom><a class="el" href="classGewi_1_1GewiEngine.html#a4">Font</a> (<a class="el" href="namespaceGewi.html#a2">ResourceID</a> id)</td></tr>
|
|
<tr><td> </td><td><em class="mdesc">Access a font in the resource vector.</em> <a href="#a4"></a><em></em><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classGewi_1_1GewiEngine.html#a5">FreeResources</a> ()</td></tr>
|
|
<tr><td> </td><td><em class="mdesc">Free all resources.</em> <a href="#a5"></a><em></em><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classGewi_1_1GewiEngine.html#a6">Register</a> (<a class="el" href="classGewi_1_1GWidget.html">GWidget</a> *widget)</td></tr>
|
|
<tr><td> </td><td><em class="mdesc">Register a widget, adding it to the list of widgets.</em> <a href="#a6"></a><em></em><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classGewi_1_1GewiEngine.html#a7">SendMessage</a> (SDL_Event *rawEvent, <a class="el" href="namespaceGewi.html#a18">GewiEvent</a> event, Uint16 mouseX, Uint16 mouseY, char ch)</td></tr>
|
|
<tr><td> </td><td><em class="mdesc">Send a message to the widgets, this function will decide which widgets the message is relevant to.</em> <a href="#a7"></a><em></em><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classGewi_1_1GewiEngine.html#a8">DeleteWidget</a> (<a class="el" href="classGewi_1_1GWidget.html">GWidget</a> *widget)</td></tr>
|
|
<tr><td> </td><td><em class="mdesc">Delete a widget.</em> <a href="#a8"></a><em></em><br><br></td></tr>
|
|
<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr>
|
|
<tr><td nowrap align=right valign=top>GewiEngine * </td><td valign=bottom><a class="el" href="classGewi_1_1GewiEngine.html#d0">GetInstance</a> ()</td></tr>
|
|
<tr><td> </td><td><em class="mdesc">Get the static instance of <a class="el" href="classGewi_1_1GewiEngine.html">GewiEngine</a>.</em> <a href="#d0"></a><em></em><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classGewi_1_1GewiEngine.html#d1">ReleaseInstance</a> ()</td></tr>
|
|
<tr><td> </td><td><em class="mdesc">Release static instance.</em> <a href="#d1"></a><em></em><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classGewi_1_1GewiEngine.html#d2">EventFilter</a> (SDL_Event *event)</td></tr>
|
|
<tr><td> </td><td><em class="mdesc">Static event filter, defined to SDL specifications.</em> <a href="#d2"></a><em></em><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classGewi_1_1GewiEngine.html#d3">TranslateKey</a> (SDL_keysym key)</td></tr>
|
|
<tr><td> </td><td><em class="mdesc">Translate an SDL structure into a character, used by EventFilter.</em> <a href="#d3"></a><em></em><br><br></td></tr>
|
|
<tr><td colspan=2><br><h2>Static Public Attributes</h2></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="p0" doxytag="Gewi::GewiEngine::Version"></a>
|
|
VersionInfo </td><td valign=bottom><a class="el" href="classGewi_1_1GewiEngine.html#p0">Version</a></td></tr>
|
|
<tr><td> </td><td><em class="mdesc">Static version information.</em><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="p1" doxytag="Gewi::GewiEngine::MinZEVersion"></a>
|
|
VersionInfo </td><td valign=bottom><a class="el" href="classGewi_1_1GewiEngine.html#p1">MinZEVersion</a></td></tr>
|
|
<tr><td> </td><td><em class="mdesc">Required ZEngine version.</em><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="p2" doxytag="Gewi::GewiEngine::InvalidID"></a>
|
|
const <a class="el" href="namespaceGewi.html#a2">ResourceID</a> </td><td valign=bottom><a class="el" href="classGewi_1_1GewiEngine.html#p2">InvalidID</a> = UINT_MAX</td></tr>
|
|
<tr><td> </td><td><em class="mdesc">Static variable used to represent invalid IDs (before an ID has been assigned all resourceIDs should == InvalidID).</em><br><br></td></tr>
|
|
<tr><td colspan=2><br><h2>Private Member Functions</h2></td></tr>
|
|
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classGewi_1_1GewiEngine.html#c0">GewiEngine</a> ()</td></tr>
|
|
<tr><td> </td><td><em class="mdesc"><a class="el" href="classGewi_1_1GewiEngine.html">GewiEngine</a> constructor, private due to singleton design.</em> <a href="#c0"></a><em></em><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classGewi_1_1GewiEngine.html#c1">InsertWidget</a> (<a class="el" href="classGewi_1_1WidgetNode.html">WidgetNode</a> *node)</td></tr>
|
|
<tr><td> </td><td><em class="mdesc">Inserts a child to the child list.</em> <a href="#c1"></a><em></em><br><br></td></tr>
|
|
<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="o0" doxytag="Gewi::GewiEngine::mImageVec"></a>
|
|
std::vector< ZE::ZImage * > </td><td valign=bottom><a class="el" href="classGewi_1_1GewiEngine.html#o0">mImageVec</a></td></tr>
|
|
<tr><td> </td><td><em class="mdesc">Vector of pointers to ZImages, used by resource management system.</em><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="o1" doxytag="Gewi::GewiEngine::mFontVec"></a>
|
|
std::vector< ZE::ZFont * > </td><td valign=bottom><a class="el" href="classGewi_1_1GewiEngine.html#o1">mFontVec</a></td></tr>
|
|
<tr><td> </td><td><em class="mdesc">Vector of pointers to ZFonts, used by resource management system.</em><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="o2" doxytag="Gewi::GewiEngine::mWidgetList"></a>
|
|
<a class="el" href="classGewi_1_1WidgetList.html">WidgetList</a> </td><td valign=bottom><a class="el" href="classGewi_1_1GewiEngine.html#o2">mWidgetList</a></td></tr>
|
|
<tr><td> </td><td><em class="mdesc">List of widgets in global context.</em><br><br></td></tr>
|
|
<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="r0" doxytag="Gewi::GewiEngine::sInstance"></a>
|
|
GewiEngine * </td><td valign=bottom><a class="el" href="classGewi_1_1GewiEngine.html#r0">sInstance</a> = NULL</td></tr>
|
|
<tr><td> </td><td><em class="mdesc">Singleton static instance of <a class="el" href="classGewi_1_1GewiEngine.html">GewiEngine</a>.</em><br><br></td></tr>
|
|
</table>
|
|
<hr><h2>Constructor & Destructor Documentation</h2>
|
|
<a name="c0" doxytag="Gewi::GewiEngine::GewiEngine"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> Gewi::GewiEngine::GewiEngine </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [private]</code></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Initializes <a class="el" href="classGewi_1_1GewiEngine.html">GewiEngine</a> instance variables, can only be called once per run of program due to design. </td>
|
|
</tr>
|
|
</table>
|
|
<hr><h2>Member Function Documentation</h2>
|
|
<a name="d0" doxytag="Gewi::GewiEngine::GetInstance"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> GewiEngine * Gewi::GewiEngine::GetInstance </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [static]</code></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Important key to the singleton's design, gets the static instance stored within. Creates static instance on first call. <dl compact><dt><b>Returns:</b></dt><dd>Pointer to static instance of <a class="el" href="classGewi_1_1GewiEngine.html">GewiEngine</a>. </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a name="d1" doxytag="Gewi::GewiEngine::ReleaseInstance"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> void Gewi::GewiEngine::ReleaseInstance </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [static]</code></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Releases the instance of <a class="el" href="classGewi_1_1GewiEngine.html">GewiEngine</a>, basically only called at very end of program. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="d2" doxytag="Gewi::GewiEngine::EventFilter"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> int Gewi::GewiEngine::EventFilter </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">SDL_Event * </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>event</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [static]</code></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Replaces SDL default event filter, and filters events into static <a class="el" href="classGewi_1_1GewiEngine.html">GewiEngine</a> instance. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>event</em> </td><td>SDL_Event to handle. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>Return values specified by SDL. </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a name="d3" doxytag="Gewi::GewiEngine::TranslateKey"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> char Gewi::GewiEngine::TranslateKey </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">SDL_keysym </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>key</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [static]</code></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Converts SDL_keysym into a standard char, only works for certain meaningful keys. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>key</em> </td><td>SDL_keysm structure to convert. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>Converted character. </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a name="a0" doxytag="Gewi::GewiEngine::Display"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> void Gewi::GewiEngine::Display </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Draws all top level widgets and containers, container widgets are expected to draw their own children. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a1" doxytag="Gewi::GewiEngine::AddResource"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> <a class="el" href="namespaceGewi.html#a2">ResourceID</a> Gewi::GewiEngine::AddResource </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">ZE::ZImage * </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>image</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Add a ZImage to the private vector of images and assign it a ResourceID. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>image</em> </td><td>Image to add to resources. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>ID number of new resource. </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a name="a2" doxytag="Gewi::GewiEngine::AddResource"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> <a class="el" href="namespaceGewi.html#a2">ResourceID</a> Gewi::GewiEngine::AddResource </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">ZE::ZFont * </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>font</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Add a ZFont to the private vector of fonts and assign it a ResourceID. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>font</em> </td><td>Font to add to resources. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>ID number of new resource. </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a name="a3" doxytag="Gewi::GewiEngine::Image"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> ZE::ZImage * Gewi::GewiEngine::Image </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="namespaceGewi.html#a2">ResourceID</a> </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>id</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Given the images ID get a pointer to an image stored in the image vector. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>id</em> </td><td>ID of image to retrieve. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>Pointer to image or NULL if invalid ID for images. </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a name="a4" doxytag="Gewi::GewiEngine::Font"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> ZE::ZFont * Gewi::GewiEngine::Font </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="namespaceGewi.html#a2">ResourceID</a> </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>id</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Given the fonts ID get a pointer to a font stored in the font vector. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>id</em> </td><td>ID of font to retrieve. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>Pointer to font or NULL if invalid ID for fonts. </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a name="a5" doxytag="Gewi::GewiEngine::FreeResources"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> void Gewi::GewiEngine::FreeResources </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Frees memory for all resources. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="c1" doxytag="Gewi::GewiEngine::InsertWidget"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> void Gewi::GewiEngine::InsertWidget </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="classGewi_1_1WidgetNode.html">WidgetNode</a> * </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>node</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [private]</code></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Calls needed function of <a class="el" href="classGewi_1_1WidgetList.html">WidgetList</a> class to put widget into the linked list. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>node</em> </td><td><a class="el" href="classGewi_1_1WidgetNode.html">WidgetNode</a> to insert into mWidgetList. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a name="a6" doxytag="Gewi::GewiEngine::Register"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> void Gewi::GewiEngine::Register </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="classGewi_1_1GWidget.html">GWidget</a> * </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>widget</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Add a widget to the list of widgets, all widgets register themselves. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>widget</em> </td><td>Widget to register. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a name="a7" doxytag="Gewi::GewiEngine::SendMessage"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> void Gewi::GewiEngine::SendMessage </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">SDL_Event * </td>
|
|
<td class="mdname" nowrap> <em>rawEvent</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap><a class="el" href="namespaceGewi.html#a18">GewiEvent</a> </td>
|
|
<td class="mdname" nowrap> <em>event</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>Uint16 </td>
|
|
<td class="mdname" nowrap> <em>mouseX</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>Uint16 </td>
|
|
<td class="mdname" nowrap> <em>mouseY</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>char </td>
|
|
<td class="mdname" nowrap> <em>ch</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Send a message to the widgets, this function will decide which widgets the message is relevant to. This generally isn't called by the client of <a class="el" href="classGewi_1_1GewiEngine.html">GewiEngine</a>, instead the EventFilter hook on events will filter and process. This can be used to fake an event however. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>rawEvent</em> </td><td>SDL_Event of original message, may be needed if more information is available on event. (May be NULL). </td></tr>
|
|
<tr><td valign=top><em>event</em> </td><td>GewiEvent enum, description of event recieved. </td></tr>
|
|
<tr><td valign=top><em>mouseX</em> </td><td>Mouse x position in event, if not mouse event may be incorrect. </td></tr>
|
|
<tr><td valign=top><em>mouseY</em> </td><td>Mouse y position in event, if not mouse event may be incorrect. </td></tr>
|
|
<tr><td valign=top><em>ch</em> </td><td>Character pressed in event, may be 0 if not a keypress event. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a name="a8" doxytag="Gewi::GewiEngine::DeleteWidget"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> void Gewi::GewiEngine::DeleteWidget </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="classGewi_1_1GWidget.html">GWidget</a> * </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>widget</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
This deletes a widget and memory associated with that widget, like register, widgets do this for themselves. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>widget</em> </td><td>to delete </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<hr>The documentation for this class was generated from the following files:<ul>
|
|
<li>/include/<a class="el" href="GewiEngine_8h-source.html">GewiEngine.h</a><li>/src/<a class="el" href="GewiEngine_8cpp.html">GewiEngine.cpp</a></ul>
|
|
<hr><address style="align: right;"><small>Generated on Mon Jun 16 03:27:18 2003 for Gewi by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img src="doxygen.png" alt="doxygen" align="middle" border=0
|
|
width=110 height=53></a>1.3 </small></address>
|
|
</body>
|
|
</html>
|