khanat-opennel-code/code/web/docs/ams/html/classGui__Elements.html

251 lines
12 KiB
HTML
Raw Normal View History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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"/>
<title>Ryzom Account Management System: Gui_Elements Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Ryzom Account Management System
&#160;<span id="projectnumber">1.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">Gui_Elements Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="Gui_Elements" -->
<p>Helper class for generating gui related elements.
<a href="classGui__Elements.html#details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGui__Elements.html#a639930203d81ff01840ac90a51cbbfe7">make_table</a> ($inputList, $funcArray, $fieldArray)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">creates an array of information out of a list of objects which can be used to form a table. <a href="#a639930203d81ff01840ac90a51cbbfe7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGui__Elements.html#ae3c8c19fce4cdd7d87d4ae759ab06f24">make_table_with_key_is_id</a> ($inputList, $funcArray, $idFunction)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">creates an array of information out of a list of objects which can be used to form a table with a key as id. <a href="#ae3c8c19fce4cdd7d87d4ae759ab06f24"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGui__Elements.html#a04d9bc70e65231a470426f0a94b7583d">time_elapsed_string</a> ($ptime)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">returns the elapsed time from a timestamp up till now. <a href="#a04d9bc70e65231a470426f0a94b7583d"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Helper class for generating gui related elements. </p>
<p>This class contains functions that generate data-arrays for tables, or other visual entities </p>
<dl class="author"><dt><b>Author:</b></dt><dd>Daan Janssens, mentored by Matthew Lagoe </dd></dl>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a639930203d81ff01840ac90a51cbbfe7"></a><!-- doxytag: member="Gui_Elements::make_table" ref="a639930203d81ff01840ac90a51cbbfe7" args="($inputList, $funcArray, $fieldArray)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classGui__Elements.html#a639930203d81ff01840ac90a51cbbfe7">make_table</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>inputList</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>funcArray</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>fieldArray</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>creates an array of information out of a list of objects which can be used to form a table. </p>
<p>The idea of this is that you can pass an array of objects, an array of functions to perform on each object and a name for the index of the returning array to store the result. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$inputList</td><td>the list of objects of which we want to make a table. </td></tr>
<tr><td class="paramname">$funcArray</td><td>a list of methods of that object we want to perform. </td></tr>
<tr><td class="paramname">$fieldArray</td><td>a list of strings, that will be used to store our result into. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>an array with the indexes listed in $fieldArray and which holds the results of the methods in $funcArray on each object in the $inputList </dd></dl>
</div>
</div>
<a class="anchor" id="ae3c8c19fce4cdd7d87d4ae759ab06f24"></a><!-- doxytag: member="Gui_Elements::make_table_with_key_is_id" ref="ae3c8c19fce4cdd7d87d4ae759ab06f24" args="($inputList, $funcArray, $idFunction)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classGui__Elements.html#ae3c8c19fce4cdd7d87d4ae759ab06f24">make_table_with_key_is_id</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>inputList</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>funcArray</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>idFunction</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>creates an array of information out of a list of objects which can be used to form a table with a key as id. </p>
<p>The idea is comparable to the <a class="el" href="classGui__Elements.html#a639930203d81ff01840ac90a51cbbfe7" title="creates an array of information out of a list of objects which can be used to form a table...">make_table()</a> function, though this time the results are stored in the index that is returned by the idFunction() </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$inputList</td><td>the list of objects of which we want to make a table. </td></tr>
<tr><td class="paramname">$funcArray</td><td>a list of methods of that object we want to perform. </td></tr>
<tr><td class="paramname">$idFunction</td><td>a function that returns an id that will be used as index to store our result </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>an array which holds the results of the methods in $funcArray on each object in the $inputList, though thearrays indexes are formed by using the idFunction. </dd></dl>
</div>
</div>
<a class="anchor" id="a04d9bc70e65231a470426f0a94b7583d"></a><!-- doxytag: member="Gui_Elements::time_elapsed_string" ref="a04d9bc70e65231a470426f0a94b7583d" args="($ptime)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classGui__Elements.html#a04d9bc70e65231a470426f0a94b7583d">time_elapsed_string</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>ptime</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>returns the elapsed time from a timestamp up till now. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$ptime</td><td>a timestamp. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a string in the form of A years, B months, C days, D hours, E minutes, F seconds ago. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/home/daan/ryzom/ryzomcore/code/ryzom/tools/server/ryzom_ams/ams_lib/autoload/<a class="el" href="gui__elements_8php.html">gui_elements.php</a></li>
</ul>
</div><!-- contents -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></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>
<hr class="footer"/><address class="footer"><small>
2013-09-15 16:27:07 +00:00
Generated on Sun Sep 15 2013 17:49:37 for Ryzom Account Management System by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
</body>
</html>