jpt-archive/zengine-gewi
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
2203a2e7b2
zengine-gewi/doc/html/classGewi_1_1WidgetList.html

331 lines
14 KiB
HTML
Raw Normal View History

0.2.0 docs
2003-06-16 07:27:48 +00:00
<!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::WidgetList 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; </center>
<hr><h1>Gewi::WidgetList Class Reference</h1><code>#include &lt;<a class="el" href="GewiWidgetList_8h-source.html">GewiWidgetList.h</a>&gt;</code>
<p>
<a href="classGewi_1_1WidgetList-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Linked list of widgets, and various utility functions for containers. Class is internally used only, <a class="el" href="classGewi_1_1GContainer.html">GContainer</a> and <a class="el" href="classGewi_1_1GewiEngine.html">GewiEngine</a> heavily rely on it.
<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>&nbsp;</td><td valign=bottom><a class="el" href="classGewi_1_1WidgetList.html#a0">WidgetList</a> ()</td></tr>
<tr><td>&nbsp;</td><td><em class="mdesc">Constructor for the linked list.</em> <a href="#a0"></a><em></em><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classGewi_1_1WidgetList.html#a1">AddWidget</a> (<a class="el" href="classGewi_1_1WidgetNode.html">WidgetNode</a> *node)</td></tr>
<tr><td>&nbsp;</td><td><em class="mdesc">Add a <a class="el" href="classGewi_1_1WidgetNode.html">WidgetNode</a> to the list.</em> <a href="#a1"></a><em></em><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classGewi_1_1WidgetList.html#a2">DeleteWidget</a> (<a class="el" href="classGewi_1_1GWidget.html">GWidget</a> *widget)</td></tr>
<tr><td>&nbsp;</td><td><em class="mdesc">Delete a widget.</em> <a href="#a2"></a><em></em><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classGewi_1_1WidgetList.html#a3">DeleteWidgets</a> ()</td></tr>
<tr><td>&nbsp;</td><td><em class="mdesc">Delete all widgets.</em> <a href="#a3"></a><em></em><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classGewi_1_1WidgetList.html#a4">Message</a> (SDL_Event *rawEvent, <a class="el" href="namespaceGewi.html#a18">GewiEvent</a> event, Uint16 mouseX, Uint16 mouseY, char ch)</td></tr>
<tr><td>&nbsp;</td><td><em class="mdesc">Intercepts a message to process.</em> <a href="#a4"></a><em></em><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classGewi_1_1WidgetList.html#a5">FitParent</a> ()</td></tr>
<tr><td>&nbsp;</td><td><em class="mdesc">Fit all widgets to the parent.</em> <a href="#a5"></a><em></em><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classGewi_1_1WidgetList.html#a6">ShowWidgets</a> ()</td></tr>
<tr><td>&nbsp;</td><td><em class="mdesc">Show widgets.</em> <a href="#a6"></a><em></em><br><br></td></tr>
<tr><td colspan=2><br><h2>Private Member Functions</h2></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classGewi_1_1WidgetList.html#c0">DeleteWidgetMem</a> (<a class="el" href="classGewi_1_1WidgetNode.html">WidgetNode</a> *node)</td></tr>
<tr><td>&nbsp;</td><td><em class="mdesc">Internal function to delete widget memory.</em> <a href="#c0"></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::WidgetList::mWidgetList"></a>
<a class="el" href="classGewi_1_1WidgetNode.html">WidgetNode</a> *&nbsp;</td><td valign=bottom><a class="el" href="classGewi_1_1WidgetList.html#o0">mWidgetList</a></td></tr>
<tr><td>&nbsp;</td><td><em class="mdesc">Pointer to head of list.</em><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="o1" doxytag="Gewi::WidgetList::mClick"></a>
<a class="el" href="classGewi_1_1WidgetNode.html">WidgetNode</a> *&nbsp;</td><td valign=bottom><a class="el" href="classGewi_1_1WidgetList.html#o1">mClick</a></td></tr>
<tr><td>&nbsp;</td><td><em class="mdesc">Variable keeping track of where the last click was, to change focus.</em><br><br></td></tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="Gewi::WidgetList::WidgetList"></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::WidgetList::WidgetList </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Simply NULLs pointers for the linked list. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="c0" doxytag="Gewi::WidgetList::DeleteWidgetMem"></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::WidgetList::DeleteWidgetMem </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="classGewi_1_1WidgetNode.html">WidgetNode</a> *&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>node</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [private]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Deletes the memory used by a widget node, interally used. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>node</em>&nbsp;</td><td>Node to delete. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a1" doxytag="Gewi::WidgetList::AddWidget"></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::WidgetList::AddWidget </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="classGewi_1_1WidgetNode.html">WidgetNode</a> *&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>node</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Adds a <a class="el" href="classGewi_1_1WidgetNode.html">WidgetNode</a> to the list, in the 'front'. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>node</em>&nbsp;</td><td>Node to add to list. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a2" doxytag="Gewi::WidgetList::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::WidgetList::DeleteWidget </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="classGewi_1_1GWidget.html">GWidget</a> *&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>widget</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Deletes a widget, it's memory and frees it from it's container or <a class="el" href="classGewi_1_1GewiEngine.html">GewiEngine</a>. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>widget</em>&nbsp;</td><td>Widget to delete. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a3" doxytag="Gewi::WidgetList::DeleteWidgets"></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::WidgetList::DeleteWidgets </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Deletes all widgets and their memory. </td>
</tr>
</table>
<a name="a4" doxytag="Gewi::WidgetList::Message"></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::WidgetList::Message </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">SDL_Event *&nbsp;</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>&nbsp;</td>
<td class="mdname" nowrap> <em>event</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>Uint16&nbsp;</td>
<td class="mdname" nowrap> <em>mouseX</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>Uint16&nbsp;</td>
<td class="mdname" nowrap> <em>mouseY</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>char&nbsp;</td>
<td class="mdname" nowrap> <em>ch</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Intercepts and processes incoming messages, delegating them where they belong. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>rawEvent</em>&nbsp;</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>&nbsp;</td><td>GewiEvent enum, description of event recieved. </td></tr>
<tr><td valign=top><em>mouseX</em>&nbsp;</td><td>Mouse x position in event, if not mouse event may be incorrect. </td></tr>
<tr><td valign=top><em>mouseY</em>&nbsp;</td><td>Mouse y position in event, if not mouse event may be incorrect. </td></tr>
<tr><td valign=top><em>ch</em>&nbsp;</td><td>Character pressed in event, may be 0 if not a keypress event. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a5" doxytag="Gewi::WidgetList::FitParent"></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::WidgetList::FitParent </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Fits widgets to parent of which this linked list is a part of. </td>
</tr>
</table>
<a name="a6" doxytag="Gewi::WidgetList::ShowWidgets"></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::WidgetList::ShowWidgets </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Calls Show method of widgets in reverse order for proper appearance. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li>/include/<a class="el" href="GewiWidgetList_8h-source.html">GewiWidgetList.h</a><li>/src/<a class="el" href="GewiWidgetList_8cpp.html">GewiWidgetList.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>
Reference in New Issue Copy Permalink