mirrors/love-luigi
1
0
Fork 0
mirror of https://github.com/airstruck/luigi.git synced 2025-11-18 12:25:06 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
69703fdce0b7394fc9810d8f310126d39100ee43
love-luigi/doc/classes/Widget.html
airstruck 69703fdce0 simplify style system
2015-12-07 04:22:36 -05:00

629 lines
15 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>Reference</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</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">
<!-- Menu -->
<div id="navigation">
<br/>
<h1>LUIGI</h1>
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<h2>Contents</h2>
<ul>
<li><a href="#Functions">Functions</a></li>
<li><a href="#Methods">Methods</a></li>
<li><a href="#Constructor">Constructor</a></li>
</ul>
<h2>Classes</h2>
<ul class="$(kind=='Topics' and '' or 'nowrap'">
<li><a href="../classes/Event.html">Event</a></li>
<li><a href="../classes/Layout.html">Layout</a></li>
<li><strong>Widget</strong></li>
</ul>
<h2>Widgets</h2>
<ul class="$(kind=='Topics' and '' or 'nowrap'">
<li><a href="../widgets/button.html">button</a></li>
<li><a href="../widgets/check.html">check</a></li>
<li><a href="../widgets/menu.html">menu</a></li>
<li><a href="../widgets/menu.item.html">menu.item</a></li>
<li><a href="../widgets/progress.html">progress</a></li>
<li><a href="../widgets/radio.html">radio</a></li>
<li><a href="../widgets/sash.html">sash</a></li>
<li><a href="../widgets/slider.html">slider</a></li>
<li><a href="../widgets/status.html">status</a></li>
<li><a href="../widgets/stepper.html">stepper</a></li>
<li><a href="../widgets/text.html">text</a></li>
</ul>
<h2>Modules</h2>
<ul class="$(kind=='Topics' and '' or 'nowrap'">
<li><a href="../modules/attribute.html">attribute</a></li>
</ul>
</div>
<div id="content">
<h1>Class <code>Widget</code></h1>
<p>Widget class.</p>
<p>
</p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#Widget.register">Widget.register (name, decorator)</a></td>
<td class="summary">Register a custom widget type.</td>
</tr>
</table>
<h2><a href="#Methods">Methods</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#Widget:bubbleEvent">Widget:bubbleEvent (eventName[, data])</a></td>
<td class="summary">Fire an event on this widget and each ancestor.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Widget:getPreviousSibling">Widget:getPreviousSibling ()</a></td>
<td class="summary">Get widget's previous sibling.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Widget:getNextSibling">Widget:getNextSibling ()</a></td>
<td class="summary">Get widget's next sibling.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Widget:focus">Widget:focus ()</a></td>
<td class="summary">Attempt to focus the widget.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Widget:getNextNeighbor">Widget:getNextNeighbor ()</a></td>
<td class="summary">Get the next widget, depth-first.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Widget:getPreviousNeighbor">Widget:getPreviousNeighbor ()</a></td>
<td class="summary">Get the previous widget, depth-first.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Widget:addChild">Widget:addChild (data)</a></td>
<td class="summary">Add a child to this widget.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Widget:getX">Widget:getX ()</a></td>
<td class="summary">Get the widget's X coordinate.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Widget:getY">Widget:getY ()</a></td>
<td class="summary">Get the widget's Y coordinate.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Widget:getWidth">Widget:getWidth ()</a></td>
<td class="summary">Get the widget's calculated width.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Widget:getHeight">Widget:getHeight ()</a></td>
<td class="summary">Get the widget's calculated height.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Widget:getContentWidth">Widget:getContentWidth ()</a></td>
<td class="summary">Get the content width.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Widget:getContentHeight">Widget:getContentHeight ()</a></td>
<td class="summary">Get the content height.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Widget:getRectangle">Widget:getRectangle (useMargin, usePadding)</a></td>
<td class="summary">Get x/y/width/height values describing a rectangle within the widget.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Widget:isAt">Widget:isAt (x, y)</a></td>
<td class="summary">Determine whether a point is within a widget.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Widget:reshape">Widget:reshape ()</a></td>
<td class="summary">Reshape the widget.</td>
</tr>
</table>
<h2><a href="#Constructor">Constructor</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#Luigi.Widget">Luigi.Widget (layout[, data])</a></td>
<td class="summary">Widget pseudo-constructor.</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
Methods
<dl class="function">
<dt>
<a name = "Widget.register"></a>
<strong>Widget.register (name, decorator)</strong>
</dt>
<dd>
Register a custom widget type.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">name</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
A unique name for this type of widget.
</li>
<li><span class="parameter">decorator</span>
<span class="types"><span class="type">function(Widget)</span></span>
An initialization function for this type of widget.
</li>
</ul>
</dd>
</dl>
<h2 class="section-header "><a name="Methods"></a>Methods</h2>
<dl class="function">
<dt>
<a name = "Widget:bubbleEvent"></a>
<strong>Widget:bubbleEvent (eventName[, data])</strong>
</dt>
<dd>
Fire an event on this widget and each ancestor. </p>
<p>If any event handler returns non-nil, stop the event from propagating.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">eventName</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
The name of the Event.
</li>
<li><span class="parameter">data</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
Information about the event to send to handlers.
(<em>optional</em>)
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">mixed</span></span>
The first value returned by an event handler.
</ol>
</dd>
<dt>
<a name = "Widget:getPreviousSibling"></a>
<strong>Widget:getPreviousSibling ()</strong>
</dt>
<dd>
Get widget's previous sibling.
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../classes/Widget.html#">Widget</a> or <span class="type">nil</span></span>
The widget's previous sibling, if any.
</ol>
</dd>
<dt>
<a name = "Widget:getNextSibling"></a>
<strong>Widget:getNextSibling ()</strong>
</dt>
<dd>
Get widget's next sibling.
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../classes/Widget.html#">Widget</a> or <span class="type">nil</span></span>
The widget's next sibling, if any.
</ol>
</dd>
<dt>
<a name = "Widget:focus"></a>
<strong>Widget:focus ()</strong>
</dt>
<dd>
Attempt to focus the widget. </p>
<p>Unfocus currently focused widget, and focus this widget if it's focusable.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">boolean</span></span>
true if this widget was focused, else false.
</ol>
</dd>
<dt>
<a name = "Widget:getNextNeighbor"></a>
<strong>Widget:getNextNeighbor ()</strong>
</dt>
<dd>
Get the next widget, depth-first. </p>
<p>If the widget has children, returns the first child.
Otherwise, returns the next sibling of the nearest possible ancestor.
Cycles back around to the layout root from the last widget in the tree.
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../classes/Widget.html#">Widget</a></span>
The next widget in the tree.
</ol>
</dd>
<dt>
<a name = "Widget:getPreviousNeighbor"></a>
<strong>Widget:getPreviousNeighbor ()</strong>
</dt>
<dd>
Get the previous widget, depth-first. </p>
<p>Uses the reverse of the traversal order used by <a href="../classes/Widget.html#Widget:getNextNeighbor">getNextNeighbor</a>.
Cycles back around to the last widget in the tree from the layout root.
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../classes/Widget.html#">Widget</a></span>
The previous widget in the tree.
</ol>
</dd>
<dt>
<a name = "Widget:addChild"></a>
<strong>Widget:addChild (data)</strong>
</dt>
<dd>
Add a child to this widget.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">data</span>
<span class="types"><a class="type" href="../classes/Widget.html#">Widget</a> or <a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
A widget or definition table representing a widget.
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../classes/Widget.html#">Widget</a></span>
The newly added child widget.
</ol>
</dd>
<dt>
<a name = "Widget:getX"></a>
<strong>Widget:getX ()</strong>
</dt>
<dd>
Get the widget's X coordinate.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">number</span></span>
The widget's X coordinate.
</ol>
</dd>
<dt>
<a name = "Widget:getY"></a>
<strong>Widget:getY ()</strong>
</dt>
<dd>
Get the widget's Y coordinate.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">number</span></span>
The widget's Y coordinate.
</ol>
</dd>
<dt>
<a name = "Widget:getWidth"></a>
<strong>Widget:getWidth ()</strong>
</dt>
<dd>
Get the widget's calculated width.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">number</span></span>
The widget's calculated width.
</ol>
</dd>
<dt>
<a name = "Widget:getHeight"></a>
<strong>Widget:getHeight ()</strong>
</dt>
<dd>
Get the widget's calculated height.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">number</span></span>
The widget's calculated height.
</ol>
</dd>
<dt>
<a name = "Widget:getContentWidth"></a>
<strong>Widget:getContentWidth ()</strong>
</dt>
<dd>
Get the content width. </p>
<p>Gets the combined width of the widget's children.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">number</span></span>
The content width.
</ol>
</dd>
<dt>
<a name = "Widget:getContentHeight"></a>
<strong>Widget:getContentHeight ()</strong>
</dt>
<dd>
Get the content height. </p>
<p>Gets the combined height of the widget's children.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">number</span></span>
The content height.
</ol>
</dd>
<dt>
<a name = "Widget:getRectangle"></a>
<strong>Widget:getRectangle (useMargin, usePadding)</strong>
</dt>
<dd>
Get x/y/width/height values describing a rectangle within the widget.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">useMargin</span>
<span class="types"><span class="type">boolean</span></span>
Whether to adjust the rectangle based on the widget's margin.
</li>
<li><span class="parameter">usePadding</span>
<span class="types"><span class="type">boolean</span></span>
Whether to adjust the rectangle based on the widget's padding.
</li>
</ul>
<h3>Returns:</h3>
<ol>
<li>
<span class="types"><span class="type">number</span></span>
The upper left corner's X position.</li>
<li>
<span class="types"><span class="type">number</span></span>
The upper left corner's Y position.</li>
<li>
<span class="types"><span class="type">number</span></span>
The rectangle's width</li>
<li>
<span class="types"><span class="type">number</span></span>
The rectangle's height</li>
</ol>
</dd>
<dt>
<a name = "Widget:isAt"></a>
<strong>Widget:isAt (x, y)</strong>
</dt>
<dd>
Determine whether a point is within a widget.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">x</span>
<span class="types"><span class="type">number</span></span>
The point's X coordinate.
</li>
<li><span class="parameter">y</span>
<span class="types"><span class="type">number</span></span>
The point's Y coordinate.
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">boolean</span></span>
true if the point is within the widget, else false.
</ol>
</dd>
<dt>
<a name = "Widget:reshape"></a>
<strong>Widget:reshape ()</strong>
</dt>
<dd>
Reshape the widget. </p>
<p>Clears calculated widget dimensions, allowing them to be recalculated, and
fires a Reshape event (does not bubble). Called recursively for each child.</p>
<p>When setting a widget's width or height, this function is automatically called
on the parent widget.
</dd>
</dl>
<h2 class="section-header "><a name="Constructor"></a>Constructor</h2>
<dl class="function">
<dt>
<a name = "Luigi.Widget"></a>
<strong>Luigi.Widget (layout[, data])</strong>
</dt>
<dd>
Widget pseudo-constructor.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">layout</span>
<span class="types"><a class="type" href="../classes/Layout.html#">Layout</a></span>
The layout this widget belongs to.
</li>
<li><span class="parameter">data</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
The data definition table for this widget.
This table is identical to the constructed widget.
(<em>optional</em>)
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../classes/Widget.html#">Widget</a></span>
A Widget instance.
</ol>
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
<i style="float:right;">Last updated 2015-12-07 03:00:19 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink