mirror of
https://github.com/Insality/druid.git
synced 2025-09-27 18:12:19 +02:00
Update docs
This commit is contained in:
Insality
@@ -40,29 +40,31 @@
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/BackHandler.html">BackHandler</a></li>
|
||||
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
||||
<li><a href="../modules/Blocker.html">Blocker</a></li>
|
||||
<li><a href="../modules/Button.html">Button</a></li>
|
||||
<li><a href="../modules/Drag.html">Drag</a></li>
|
||||
<li><a href="../modules/Hover.html">Hover</a></li>
|
||||
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
||||
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
||||
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
||||
<li><a href="../modules/Text.html">Text</a></li>
|
||||
<li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
|
||||
<li><a href="../modules/druid.html">druid</a></li>
|
||||
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
||||
<li><a href="../modules/Checkbox.html">Checkbox</a></li>
|
||||
<li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
|
||||
<li><a href="../modules/DataList.html">DataList</a></li>
|
||||
<li><a href="../modules/Drag.html">Drag</a></li>
|
||||
<li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
|
||||
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
||||
<li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
|
||||
<li><a href="../modules/Helper.html">Helper</a></li>
|
||||
<li><a href="../modules/Hover.html">Hover</a></li>
|
||||
<li><a href="../modules/Input.html">Input</a></li>
|
||||
<li><a href="../modules/LangText.html">LangText</a></li>
|
||||
<li><a href="../modules/PinKnob.html">PinKnob</a></li>
|
||||
<li><a href="../modules/Progress.html">Progress</a></li>
|
||||
<li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
|
||||
<li><a href="../modules/RichInput.html">RichInput</a></li>
|
||||
<li><a href="../modules/Scroll.html">Scroll</a></li>
|
||||
<li><a href="../modules/Slider.html">Slider</a></li>
|
||||
<li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
|
||||
<li><a href="../modules/Swipe.html">Swipe</a></li>
|
||||
<li><a href="../modules/Text.html">Text</a></li>
|
||||
<li><strong>Timer</strong></li>
|
||||
<li><a href="../modules/druid.helper.html">druid.helper</a></li>
|
||||
<li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
|
||||
<li><a href="../modules/druid.html">druid</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
@@ -83,39 +85,39 @@
|
||||
<td class="summary">Component init function</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#set_to">set_to(self, set_to)</a></td>
|
||||
<td class="summary">Set text to text field</td>
|
||||
<td class="name" nowrap><a href="#set_interval">set_interval(self, from, to)</a></td>
|
||||
<td class="summary">Set time interval</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#set_state">set_state(self, is_on)</a></td>
|
||||
<td class="summary">Called when update</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#set_interval">set_interval(self, from, to)</a></td>
|
||||
<td class="summary">Set time interval</td>
|
||||
<td class="name" nowrap><a href="#set_to">set_to(self, set_to)</a></td>
|
||||
<td class="summary">Set text to text field</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Fields">Fields</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#on_tick">on_tick</a></td>
|
||||
<td class="summary">On timer tick.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#on_set_enabled">on_set_enabled</a></td>
|
||||
<td class="summary">On timer change enabled state callback(self, is_enabled)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#on_timer_end">on_timer_end</a></td>
|
||||
<td class="summary">On timer end callback</td>
|
||||
<td class="name" nowrap><a href="#from">from</a></td>
|
||||
<td class="summary">Initial timer value</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#node">node</a></td>
|
||||
<td class="summary">Trigger node</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#from">from</a></td>
|
||||
<td class="summary">Initial timer value</td>
|
||||
<td class="name" nowrap><a href="#on_set_enabled">on_set_enabled</a></td>
|
||||
<td class="summary">On timer change enabled state callback(self, is_enabled)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#on_tick">on_tick</a></td>
|
||||
<td class="summary">On timer tick.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#on_timer_end">on_timer_end</a></td>
|
||||
<td class="summary">On timer end callback</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#target">target</a></td>
|
||||
@@ -146,7 +148,7 @@
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
<span class="types"><span class="type">Timer</span></span>
|
||||
|
||||
<a href="../modules/Timer.html#">Timer</a>
|
||||
</li>
|
||||
<li><span class="parameter">node</span>
|
||||
<span class="types"><a class="type" href="../modules/Timer.html#node">node</a></span>
|
||||
@@ -174,22 +176,26 @@
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "set_to"></a>
|
||||
<strong>set_to(self, set_to)</strong>
|
||||
<a name = "set_interval"></a>
|
||||
<strong>set_interval(self, from, to)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Set text to text field
|
||||
Set time interval
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
<span class="types"><span class="type">Timer</span></span>
|
||||
|
||||
<a href="../modules/Timer.html#">Timer</a>
|
||||
</li>
|
||||
<li><span class="parameter">set_to</span>
|
||||
<li><span class="parameter">from</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
Value in seconds
|
||||
Start time in seconds
|
||||
</li>
|
||||
<li><span class="parameter">to</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
Target time in seconds
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -210,7 +216,7 @@
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
<span class="types"><span class="type">Timer</span></span>
|
||||
|
||||
<a href="../modules/Timer.html#">Timer</a>
|
||||
</li>
|
||||
<li><span class="parameter">is_on</span>
|
||||
<span class="types"><span class="type">bool</span></span>
|
||||
@@ -224,26 +230,22 @@
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "set_interval"></a>
|
||||
<strong>set_interval(self, from, to)</strong>
|
||||
<a name = "set_to"></a>
|
||||
<strong>set_to(self, set_to)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Set time interval
|
||||
Set text to text field
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
<span class="types"><span class="type">Timer</span></span>
|
||||
|
||||
<a href="../modules/Timer.html#">Timer</a>
|
||||
</li>
|
||||
<li><span class="parameter">from</span>
|
||||
<li><span class="parameter">set_to</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
Start time in seconds
|
||||
</li>
|
||||
<li><span class="parameter">to</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
Target time in seconds
|
||||
Value in seconds
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -257,16 +259,16 @@
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "on_tick"></a>
|
||||
<strong>on_tick</strong>
|
||||
<a name = "from"></a>
|
||||
<strong>from</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
On timer tick. Fire every second callback(self, value)
|
||||
Initial timer value
|
||||
|
||||
|
||||
<ul>
|
||||
<li><span class="parameter">on_tick</span>
|
||||
<span class="types"><span class="type">druid_event</span></span>
|
||||
<li><span class="parameter">from</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
@@ -275,46 +277,6 @@
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "on_set_enabled"></a>
|
||||
<strong>on_set_enabled</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
On timer change enabled state callback(self, is_enabled)
|
||||
|
||||
|
||||
<ul>
|
||||
<li><span class="parameter">on_set_enabled</span>
|
||||
<span class="types"><span class="type">druid_event</span></span>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "on_timer_end"></a>
|
||||
<strong>on_timer_end</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
On timer end callback
|
||||
|
||||
|
||||
<ul>
|
||||
<li><span class="parameter">on_timer_end</span>
|
||||
<span class="types"><span class="type">druid_event</span></span>
|
||||
(self, Timer)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "node"></a>
|
||||
@@ -337,17 +299,57 @@
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "from"></a>
|
||||
<strong>from</strong>
|
||||
<a name = "on_set_enabled"></a>
|
||||
<strong>on_set_enabled</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Initial timer value
|
||||
On timer change enabled state callback(self, is_enabled)
|
||||
|
||||
|
||||
<ul>
|
||||
<li><span class="parameter">from</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
<li><span class="parameter">on_set_enabled</span>
|
||||
<span class="types"><span class="type">DruidEvent</span></span>
|
||||
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "on_tick"></a>
|
||||
<strong>on_tick</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
On timer tick. Fire every second callback(self, value)
|
||||
|
||||
|
||||
<ul>
|
||||
<li><span class="parameter">on_tick</span>
|
||||
<span class="types"><span class="type">DruidEvent</span></span>
|
||||
<a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "on_timer_end"></a>
|
||||
<strong>on_timer_end</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
On timer end callback
|
||||
|
||||
|
||||
<ul>
|
||||
<li><span class="parameter">on_timer_end</span>
|
||||
<span class="types"><span class="type">DruidEvent</span></span>
|
||||
(self, Timer) <a href="../modules/DruidEvent.html#">DruidEvent</a>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -403,7 +405,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2022-02-12 17:16:44 </i>
|
||||
<i style="float:right;">Last updated 2022-03-11 20:55:29 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
||||
Reference in New Issue
Block a user