mirrors/love-luigi
1
0
Fork 0
mirror of https://github.com/airstruck/luigi.git synced 2025-12-19 02:16:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

improve widget docs

Browse Source
This commit is contained in:
airstruck
2015-12-15 14:21:30 -05:00
parent 8d7011ca81
commit ed4e8b562a
20 changed files with 550 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/widgets/button.html
View File

@@ -99,7 +99,7 @@ layout:show()
</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 05:47:24 </i>
<i style="float:right;">Last updated 2015-12-15 13:53:58 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
doc/widgets/check.html
View File

@@ -83,7 +83,7 @@ standard themes, the widget's value should be indicated in some other way.</p>
</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 05:47:24 </i>
<i style="float:right;">Last updated 2015-12-15 13:53:58 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
doc/widgets/menu.html
View File

@@ -79,7 +79,7 @@
</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 05:47:24 </i>
<i style="float:right;">Last updated 2015-12-15 13:53:58 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
doc/widgets/menu.item.html
View File

@@ -79,7 +79,7 @@ not be explicitly created.</p>
</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 05:47:24 </i>
<i style="float:right;">Last updated 2015-12-15 13:53:58 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
doc/widgets/progress.html
View File

@@ -78,7 +78,7 @@ between 0 and 1 (inclusive) to change the width of the bar.</p>
</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 05:47:24 </i>
<i style="float:right;">Last updated 2015-12-15 13:53:58 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

47
doc/widgets/radio.html
View File

@@ -30,6 +30,10 @@
<li><a href="../index.html">Index</a></li>
</ul>
<h2>Contents</h2>
<ul>
<li><a href="#Special_Attributes">Special Attributes </a></li>
</ul>
<h2>Widgets</h2>
@@ -62,12 +66,10 @@
<div id="content">
<h1>Widget <code>radio</code></h1>
<p>A radio button.</p>
<p>Radio buttons change their <a href="../modules/attribute.html#value">value</a> attribute to
<code>true</code> when pressed. Radio buttons should also have a <code>group</code>
attribute. When a radio button is pressed, other radio buttons
in the same layout with the same <code>group</code> attribute change their values
to <code>false</code>.</p>
<p>A radio widget.</p>
<p>When pressed, a radio widget's <a href="../modules/attribute.html#value">value</a> changes to
<code>true</code>, and the values of other radio widgets in the same <a href="../widgets/radio.html#group">group</a>
change to <code>false</code>.</p>
<p>Changing the value of a radio button causes it to change its appearance to
indicate its value. The standard themes use the <a href="../modules/attribute.html#icon">icon</a>
@@ -75,18 +77,49 @@ attribute for this purpose. If a custom icon is provided when using the
standard themes, the widget's value should be indicated in some other way.</p>
<h2><a href="#Special_Attributes">Special Attributes </a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#group">group</a></td>
<td class="summary">Widget group.</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Special_Attributes"></a>Special Attributes </h2>
<dl class="function">
<dt>
<a name = "group"></a>
<strong>group</strong>
</dt>
<dd>
Widget group. </p>
<p>Should contain a string identifying the widget's group.
If not defined, defaults to the string <code>&apos;default&apos;</code>.</p>
<p>When a radio widget is pressed, the values of other radio widgets
in the same group change to <code>false</code>.
</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 05:47:24 </i>
<i style="float:right;">Last updated 2015-12-15 13:53:58 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
doc/widgets/sash.html
View File

@@ -98,7 +98,7 @@ layout:show()
</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 05:47:24 </i>
<i style="float:right;">Last updated 2015-12-15 13:53:58 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
doc/widgets/slider.html
View File

@@ -78,7 +78,7 @@ number between 0 and 1, inclusive.</p>
</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 05:47:24 </i>
<i style="float:right;">Last updated 2015-12-15 13:53:58 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
doc/widgets/status.html
View File

@@ -96,7 +96,7 @@ layout:show()
</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 05:47:24 </i>
<i style="float:right;">Last updated 2015-12-15 13:53:58 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
doc/widgets/stepper.html
View File

@@ -81,7 +81,7 @@ item displayed in the content area.</p>
</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 05:47:24 </i>
<i style="float:right;">Last updated 2015-12-15 13:53:58 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

35
doc/widgets/text.html
View File

@@ -30,6 +30,10 @@
<li><a href="../index.html">Index</a></li>
</ul>
<h2>Contents</h2>
<ul>
<li><a href="#Special_Attributes">Special Attributes </a></li>
</ul>
<h2>Widgets</h2>
@@ -68,18 +72,47 @@
</p>
<h2><a href="#Special_Attributes">Special Attributes </a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#highlight">highlight</a></td>
<td class="summary">Highlight color.</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Special_Attributes"></a>Special Attributes </h2>
<dl class="function">
<dt>
<a name = "highlight"></a>
<strong>highlight</strong>
</dt>
<dd>
Highlight color. </p>
<p>Should contain an array with 3 or 4 values (RGB or RGBA) from 0 to 255.</p>
<p>This color is used to indicate the selected range of text.
</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 05:47:24 </i>
<i style="float:right;">Last updated 2015-12-15 13:53:58 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>