<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" |
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
<html> |
<head> |
<title>Reference</title> |
<link rel="stylesheet" href="../../luadoc.css" type="text/css" /> |
<!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/--> |
</head> |
|
<body> |
<div id="container"> |
|
<div id="product"> |
<div id="product_logo"></div> |
<div id="product_name"><big><b></b></big></div> |
<div id="product_description"></div> |
</div> <!-- id="product" --> |
|
<div id="main"> |
|
<div id="navigation"> |
|
|
<h1>LuaDoc</h1> |
<ul> |
|
<li><a href="../../index.html">Index</a></li> |
|
</ul> |
|
|
<!-- Module list --> |
|
|
|
<!-- File list --> |
|
<h1>Files</h1> |
<ul> |
|
<li> |
<a href="../../files/Control.html">Control.lua</a> |
</li> |
|
<li> |
<a href="../../files/Control/Button.html">Control/Button.lua</a> |
</li> |
|
<li> |
<a href="../../files/Control/Checkbox.html">Control/Checkbox.lua</a> |
</li> |
|
<li> |
<a href="../../files/Control/ColorPicker.html">Control/ColorPicker.lua</a> |
</li> |
|
<li> |
<a href="../../files/Control/Dropdown.html">Control/Dropdown.lua</a> |
</li> |
|
<li> |
<a href="../../files/Control/EditBox.html">Control/EditBox.lua</a> |
</li> |
|
<li> |
<a href="../../files/Control/Header.html">Control/Header.lua</a> |
</li> |
|
<li> |
<a href="../../files/Control/Slider.html">Control/Slider.lua</a> |
</li> |
|
<li> |
<a href="../../files/Control/Text.html">Control/Text.lua</a> |
</li> |
|
<li><strong>Control/Window.lua</strong></li> |
|
<li> |
<a href="../../files/Portfolio.html">Portfolio.lua</a> |
</li> |
|
<li> |
<a href="../../files/RegisterControl.html">RegisterControl.lua</a> |
</li> |
|
</ul> |
|
|
|
|
|
|
</div> <!-- id="navigation" --> |
|
<div id="content"> |
|
<h1>File <code>Control/Window.lua</code></h1> |
|
|
<p>Window Control Registration and Methods <br/>A window acts as a bordered frame within the parent window/page. <br/>It defaults to 200px height and almost as wide as the parent window/page. <br/>It will add a scrollbar if there are enough child controls. <br/>PassThrough Methods called on the window are called on all the children that have that method. </p> |
|
|
|
|
|
|
|
<h2>Functions</h2> |
<table class="function_list"> |
|
<tr> |
<td class="name" nowrap><a href="#Cancel">Cancel</a> (self)</td> |
<td class="summary">PassThrough Method.</td> |
</tr> |
|
<tr> |
<td class="name" nowrap><a href="#Disable">Disable</a> (self)</td> |
<td class="summary">PassThrough Method.</td> |
</tr> |
|
<tr> |
<td class="name" nowrap><a href="#Enable">Enable</a> (self)</td> |
<td class="summary">PassThrough Method.</td> |
</tr> |
|
<tr> |
<td class="name" nowrap><a href="#Okay">Okay</a> (self)</td> |
<td class="summary">PassThrough Method.</td> |
</tr> |
|
<tr> |
<td class="name" nowrap><a href="#Refresh">Refresh</a> (self)</td> |
<td class="summary">PassThrough Method.</td> |
</tr> |
|
<tr> |
<td class="name" nowrap><a href="#Reset">Reset</a> (self)</td> |
<td class="summary">PassThrough Method.</td> |
</tr> |
|
<tr> |
<td class="name" nowrap><a href="#Update">Update</a> (self)</td> |
<td class="summary">PassThrough Method.</td> |
</tr> |
|
<tr> |
<td class="name" nowrap><a href="#UpdateBox">UpdateBox</a> (self)</td> |
<td class="summary">Update Window size based on the parent window's size.</td> |
</tr> |
|
</table> |
|
|
|
|
<h2>Tables</h2> |
<table class="table_list"> |
|
<tr> |
<td class="name" nowrap><a href="#Portfolio.Control.Window ">Portfolio.Control.Window </a></td> |
<td class="summary">Window Control Registration and Methods </td> |
</tr> |
|
</table> |
|
|
|
<br/> |
<br/> |
|
|
|
|
<h2><a name="functions"></a>Functions</h2> |
<dl class="function"> |
|
|
|
<dt><a name="Cancel"></a><strong>Cancel</strong> (self)</dt> |
<dd> |
PassThrough Method. See <a href="../Control.html#Cancel">Control.Cancel</a> |
|
|
<h3>Parameters</h3> |
<ul> |
|
<li> |
self: control |
</li> |
|
</ul> |
|
|
|
|
|
|
|
|
</dd> |
|
|
|
|
<dt><a name="Disable"></a><strong>Disable</strong> (self)</dt> |
<dd> |
PassThrough Method. See <a href="../Control.html#Disable">Control.Disable</a> |
|
|
<h3>Parameters</h3> |
<ul> |
|
<li> |
self: control |
</li> |
|
</ul> |
|
|
|
|
|
|
|
|
</dd> |
|
|
|
|
<dt><a name="Enable"></a><strong>Enable</strong> (self)</dt> |
<dd> |
PassThrough Method. See <a href="../Control.html#Enable">Control.Enable</a> |
|
|
<h3>Parameters</h3> |
<ul> |
|
<li> |
self: control |
</li> |
|
</ul> |
|
|
|
|
|
|
|
|
</dd> |
|
|
|
|
<dt><a name="Okay"></a><strong>Okay</strong> (self)</dt> |
<dd> |
PassThrough Method. See <a href="../Control.html#Okay">Control.Okay</a> |
|
|
<h3>Parameters</h3> |
<ul> |
|
<li> |
self: control |
</li> |
|
</ul> |
|
|
|
|
|
|
|
|
</dd> |
|
|
|
|
<dt><a name="Refresh"></a><strong>Refresh</strong> (self)</dt> |
<dd> |
PassThrough Method. See <a href="../Control.html#Refresh">Control.Refresh</a> |
|
|
<h3>Parameters</h3> |
<ul> |
|
<li> |
self: control |
</li> |
|
</ul> |
|
|
|
|
|
|
|
|
</dd> |
|
|
|
|
<dt><a name="Reset"></a><strong>Reset</strong> (self)</dt> |
<dd> |
PassThrough Method. See <a href="../Control.html#Reset">Control.Reset</a> |
|
|
<h3>Parameters</h3> |
<ul> |
|
<li> |
self: control |
</li> |
|
</ul> |
|
|
|
|
|
|
|
|
</dd> |
|
|
|
|
<dt><a name="Update"></a><strong>Update</strong> (self)</dt> |
<dd> |
PassThrough Method. See <a href="../Control.html#Update">Control.Update</a> |
|
|
<h3>Parameters</h3> |
<ul> |
|
<li> |
self: control |
</li> |
|
</ul> |
|
|
|
|
|
|
|
|
</dd> |
|
|
|
|
<dt><a name="UpdateBox"></a><strong>UpdateBox</strong> (self)</dt> |
<dd> |
Update Window size based on the parent window's size. Called OnScrollRangeChanged of the parent window. PassThrough Method. |
|
|
<h3>Parameters</h3> |
<ul> |
|
<li> |
self: control |
</li> |
|
</ul> |
|
|
|
|
<h3>Usage:</h3> |
control:UpdateBox() |
|
|
|
|
|
</dd> |
|
|
</dl> |
|
|
|
|
<h2><a name="tables"></a>Tables</h2> |
<dl class="table"> |
|
<dt><a name="Portfolio.Control.Window "></a><strong>Portfolio.Control.Window </strong></dt> |
<dd>Window Control Registration and Methods |
|
|
|
</dd> |
|
|
</dl> |
|
|
|
|
</div> <!-- id="content" --> |
|
</div> <!-- id="main" --> |
|
<div id="about"> |
<p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p> |
</div> <!-- id="about" --> |
|
</div> <!-- id="container" --> |
</body> |
</html> |