mirror of
https://github.com/Insality/druid
synced 2025-06-27 10:27:48 +02:00
Generate ldoc
This commit is contained in:
Insality
parent
88a37f77af
commit
da27d6edd8
103
docs/index.html
103
docs/index.html
@ -29,6 +29,28 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Modules</h2>
|
||||||
|
<ul class="nowrap">
|
||||||
|
<li><a href="modules/base.back_handler.html">base.back_handler</a></li>
|
||||||
|
<li><a href="modules/base.blocker.html">base.blocker</a></li>
|
||||||
|
<li><a href="modules/base.button.html">base.button</a></li>
|
||||||
|
<li><a href="modules/base.checkbox.html">base.checkbox</a></li>
|
||||||
|
<li><a href="modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="modules/base.grid.html">base.grid</a></li>
|
||||||
|
<li><a href="modules/base.progress.html">base.progress</a></li>
|
||||||
|
<li><a href="modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="modules/base.scroll.html">base.scroll</a></li>
|
||||||
|
<li><a href="modules/base.slider.html">base.slider</a></li>
|
||||||
|
<li><a href="modules/base.text.html">base.text</a></li>
|
||||||
|
<li><a href="modules/base.timer.html">base.timer</a></li>
|
||||||
|
<li><a href="modules/constants.html">constants</a></li>
|
||||||
|
<li><a href="modules/druid.html">druid</a></li>
|
||||||
|
<li><a href="modules/helper.html">helper</a></li>
|
||||||
|
<li><a href="modules/helper.animate.html">helper.animate</a></li>
|
||||||
|
<li><a href="modules/helper.formats.html">helper.formats</a></li>
|
||||||
|
<li><a href="modules/rich.progress_rich.html">rich.progress_rich</a></li>
|
||||||
|
<li><a href="modules/settings.html">settings</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -37,12 +59,91 @@
|
|||||||
|
|
||||||
<h2>Documentation for Druid Library</h2>
|
<h2>Documentation for Druid Library</h2>
|
||||||
|
|
||||||
|
<h2>Modules</h2>
|
||||||
|
<table class="module_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="modules/base.back_handler.html">base.back_handler</a></td>
|
||||||
|
<td class="summary">Component to handle back key (android, backspace)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="modules/base.blocker.html">base.blocker</a></td>
|
||||||
|
<td class="summary">Component to block input on specify zone (node)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="modules/base.button.html">base.button</a></td>
|
||||||
|
<td class="summary">Component to handle basic GUI button</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="modules/base.checkbox.html">base.checkbox</a></td>
|
||||||
|
<td class="summary">Druid checkbox component</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="modules/base.checkbox_group.html">base.checkbox_group</a></td>
|
||||||
|
<td class="summary">Checkboux group module</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="modules/base.grid.html">base.grid</a></td>
|
||||||
|
<td class="summary">Component to handle placing components by row and columns.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="modules/base.progress.html">base.progress</a></td>
|
||||||
|
<td class="summary">Basic progress bar component</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="modules/base.checkbox_group.html">base.checkbox_group</a></td>
|
||||||
|
<td class="summary">Radio group module</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="modules/base.scroll.html">base.scroll</a></td>
|
||||||
|
<td class="summary">Component to handle scroll content</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="modules/base.slider.html">base.slider</a></td>
|
||||||
|
<td class="summary">Druid slider component</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="modules/base.text.html">base.text</a></td>
|
||||||
|
<td class="summary">Component to handle all GUI texts Good working with localization system</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="modules/base.timer.html">base.timer</a></td>
|
||||||
|
<td class="summary">Component to handle GUI timers</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="modules/constants.html">constants</a></td>
|
||||||
|
<td class="summary">Druid constants</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="modules/druid.html">druid</a></td>
|
||||||
|
<td class="summary">Druid UI Library.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="modules/helper.html">helper</a></td>
|
||||||
|
<td class="summary">Druid helper module</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="modules/helper.animate.html">helper.animate</a></td>
|
||||||
|
<td class="summary">Druid helper module for animating GUI nodes</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="modules/helper.formats.html">helper.formats</a></td>
|
||||||
|
<td class="summary">Druid module with utils on string formats</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="modules/rich.progress_rich.html">rich.progress_rich</a></td>
|
||||||
|
<td class="summary">Component for rich progress component</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="modules/settings.html">settings</a></td>
|
||||||
|
<td class="summary">Druid settings file</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
</div> <!-- id="content" -->
|
</div> <!-- id="content" -->
|
||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||||
<i style="float:right;">Last updated 2019-09-25 19:57:43 </i>
|
<i style="float:right;">Last updated 2019-12-05 22:04:11 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
155
docs/modules/back_handler.html
Normal file
155
docs/modules/back_handler.html
Normal file
@ -0,0 +1,155 @@
|
|||||||
|
<!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>Defold Druid UI Library</title>
|
||||||
|
<link rel="stylesheet" href="../ldoc_pale.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>Druid</h1>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="../index.html">Index</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h2>Contents</h2>
|
||||||
|
<ul>
|
||||||
|
<li><a href="#Functions">Functions</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Modules</h2>
|
||||||
|
<ul class="nowrap">
|
||||||
|
<li><strong>back_handler</strong></li>
|
||||||
|
<li><a href="../modules/base.blocker.html">base.blocker</a></li>
|
||||||
|
<li><a href="../modules/base.button.html">base.button</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||||
|
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||||
|
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||||
|
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||||
|
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||||
|
<li><a href="../modules/constants.html">constants</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
|
<li><a href="../modules/helper.html">helper</a></li>
|
||||||
|
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||||
|
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||||
|
<li><a href="../modules/settings.html">settings</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="content">
|
||||||
|
|
||||||
|
<h1>Module <code>back_handler</code></h1>
|
||||||
|
<p>Component to handle back key</p>
|
||||||
|
<p></p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#init">init(self, callback[, Callback])</a></td>
|
||||||
|
<td class="summary">Component init function</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#on_input">on_input(action_id, action)</a></td>
|
||||||
|
<td class="summary">Input handler for component</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "init"></a>
|
||||||
|
<strong>init(self, callback[, Callback])</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component init function
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Component instance
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">callback</span>
|
||||||
|
<span class="types"><span class="type">callback</span></span>
|
||||||
|
On back button
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">Callback</span>
|
||||||
|
<span class="types"><span class="type">params</span></span>
|
||||||
|
argument
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_input"></a>
|
||||||
|
<strong>on_input(action_id, action)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Input handler for component
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">action_id</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
||||||
|
on_input action id
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">action</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
on_input action
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
|
||||||
|
|
||||||
|
</div> <!-- id="content" -->
|
||||||
|
</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 2019-12-05 21:37:51 </i>
|
||||||
|
</div> <!-- id="about" -->
|
||||||
|
</div> <!-- id="container" -->
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
156
docs/modules/base.back_handler.html
Normal file
156
docs/modules/base.back_handler.html
Normal file
@ -0,0 +1,156 @@
|
|||||||
|
<!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>Defold Druid UI Library</title>
|
||||||
|
<link rel="stylesheet" href="../ldoc_pale.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>Druid</h1>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="../index.html">Index</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h2>Contents</h2>
|
||||||
|
<ul>
|
||||||
|
<li><a href="#Functions">Functions</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Modules</h2>
|
||||||
|
<ul class="nowrap">
|
||||||
|
<li><strong>base.back_handler</strong></li>
|
||||||
|
<li><a href="../modules/base.blocker.html">base.blocker</a></li>
|
||||||
|
<li><a href="../modules/base.button.html">base.button</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||||
|
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||||
|
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||||
|
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||||
|
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||||
|
<li><a href="../modules/constants.html">constants</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
|
<li><a href="../modules/helper.html">helper</a></li>
|
||||||
|
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||||
|
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||||
|
<li><a href="../modules/rich.progress_rich.html">rich.progress_rich</a></li>
|
||||||
|
<li><a href="../modules/settings.html">settings</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="content">
|
||||||
|
|
||||||
|
<h1>Module <code>base.back_handler</code></h1>
|
||||||
|
<p>Component to handle back key (android, backspace)</p>
|
||||||
|
<p></p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#init">init(self, callback[, Callback])</a></td>
|
||||||
|
<td class="summary">Component init function</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#on_input">on_input(action_id, action)</a></td>
|
||||||
|
<td class="summary">Input handler for component</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "init"></a>
|
||||||
|
<strong>init(self, callback[, Callback])</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component init function
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Component instance
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">callback</span>
|
||||||
|
<span class="types"><span class="type">callback</span></span>
|
||||||
|
On back button
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">Callback</span>
|
||||||
|
<span class="types"><span class="type">params</span></span>
|
||||||
|
argument
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_input"></a>
|
||||||
|
<strong>on_input(action_id, action)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Input handler for component
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">action_id</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
||||||
|
on_input action id
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">action</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
on_input action
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
|
||||||
|
|
||||||
|
</div> <!-- id="content" -->
|
||||||
|
</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 2019-12-05 22:04:11 </i>
|
||||||
|
</div> <!-- id="about" -->
|
||||||
|
</div> <!-- id="container" -->
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
82
docs/modules/base.blocker.html
Normal file
82
docs/modules/base.blocker.html
Normal file
@ -0,0 +1,82 @@
|
|||||||
|
<!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>Defold Druid UI Library</title>
|
||||||
|
<link rel="stylesheet" href="../ldoc_pale.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>Druid</h1>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="../index.html">Index</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Modules</h2>
|
||||||
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/base.back_handler.html">base.back_handler</a></li>
|
||||||
|
<li><strong>base.blocker</strong></li>
|
||||||
|
<li><a href="../modules/base.button.html">base.button</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||||
|
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||||
|
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||||
|
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||||
|
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||||
|
<li><a href="../modules/constants.html">constants</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
|
<li><a href="../modules/helper.html">helper</a></li>
|
||||||
|
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||||
|
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||||
|
<li><a href="../modules/rich.progress_rich.html">rich.progress_rich</a></li>
|
||||||
|
<li><a href="../modules/settings.html">settings</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="content">
|
||||||
|
|
||||||
|
<h1>Module <code>base.blocker</code></h1>
|
||||||
|
<p>Component to block input on specify zone (node)</p>
|
||||||
|
<p></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</div> <!-- id="content" -->
|
||||||
|
</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 2019-12-05 22:04:11 </i>
|
||||||
|
</div> <!-- id="about" -->
|
||||||
|
</div> <!-- id="container" -->
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
195
docs/modules/base.button.html
Normal file
195
docs/modules/base.button.html
Normal file
@ -0,0 +1,195 @@
|
|||||||
|
<!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>Defold Druid UI Library</title>
|
||||||
|
<link rel="stylesheet" href="../ldoc_pale.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>Druid</h1>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="../index.html">Index</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h2>Contents</h2>
|
||||||
|
<ul>
|
||||||
|
<li><a href="#Functions">Functions</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Modules</h2>
|
||||||
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/base.back_handler.html">base.back_handler</a></li>
|
||||||
|
<li><a href="../modules/base.blocker.html">base.blocker</a></li>
|
||||||
|
<li><strong>base.button</strong></li>
|
||||||
|
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||||
|
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||||
|
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||||
|
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||||
|
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||||
|
<li><a href="../modules/constants.html">constants</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
|
<li><a href="../modules/helper.html">helper</a></li>
|
||||||
|
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||||
|
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||||
|
<li><a href="../modules/rich.progress_rich.html">rich.progress_rich</a></li>
|
||||||
|
<li><a href="../modules/settings.html">settings</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="content">
|
||||||
|
|
||||||
|
<h1>Module <code>base.button</code></h1>
|
||||||
|
<p>Component to handle basic GUI button</p>
|
||||||
|
<p></p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#init">init(self, node, callback[, params[, anim_node[, event]]])</a></td>
|
||||||
|
<td class="summary">Component init function</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#disable_animation">disable_animation(self)</a></td>
|
||||||
|
<td class="summary">Disable all button animations</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_click_zone">set_click_zone(self, zone)</a></td>
|
||||||
|
<td class="summary">Strict button click area.</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "init"></a>
|
||||||
|
<strong>init(self, node, callback[, params[, anim_node[, event]]])</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component init function
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Component instance
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">node</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
Gui node
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">callback</span>
|
||||||
|
<span class="types"><span class="type">function</span></span>
|
||||||
|
Button callback
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">params</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Button callback params
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">anim_node</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
Button anim node (node, if not provided)
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">event</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
||||||
|
Button react event, const.ACTION_TOUCH by default
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "disable_animation"></a>
|
||||||
|
<strong>disable_animation(self)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Disable all button animations
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Component instance
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_click_zone"></a>
|
||||||
|
<strong>set_click_zone(self, zone)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Strict button click area. Useful for no click events outside stencil node
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Component instance
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">zone</span>
|
||||||
|
<span class="types"><span class="type">node</span></span>
|
||||||
|
Gui node
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
|
||||||
|
|
||||||
|
</div> <!-- id="content" -->
|
||||||
|
</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 2019-12-05 22:04:11 </i>
|
||||||
|
</div> <!-- id="about" -->
|
||||||
|
</div> <!-- id="container" -->
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
82
docs/modules/base.checkbox.html
Normal file
82
docs/modules/base.checkbox.html
Normal file
@ -0,0 +1,82 @@
|
|||||||
|
<!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>Defold Druid UI Library</title>
|
||||||
|
<link rel="stylesheet" href="../ldoc_pale.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>Druid</h1>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="../index.html">Index</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Modules</h2>
|
||||||
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/base.back_handler.html">base.back_handler</a></li>
|
||||||
|
<li><a href="../modules/base.blocker.html">base.blocker</a></li>
|
||||||
|
<li><a href="../modules/base.button.html">base.button</a></li>
|
||||||
|
<li><strong>base.checkbox</strong></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||||
|
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||||
|
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||||
|
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||||
|
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||||
|
<li><a href="../modules/constants.html">constants</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
|
<li><a href="../modules/helper.html">helper</a></li>
|
||||||
|
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||||
|
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||||
|
<li><a href="../modules/rich.progress_rich.html">rich.progress_rich</a></li>
|
||||||
|
<li><a href="../modules/settings.html">settings</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="content">
|
||||||
|
|
||||||
|
<h1>Module <code>base.checkbox</code></h1>
|
||||||
|
<p>Druid checkbox component</p>
|
||||||
|
<p></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</div> <!-- id="content" -->
|
||||||
|
</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 2019-12-05 22:04:11 </i>
|
||||||
|
</div> <!-- id="about" -->
|
||||||
|
</div> <!-- id="container" -->
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
82
docs/modules/base.checkbox_group.html
Normal file
82
docs/modules/base.checkbox_group.html
Normal file
@ -0,0 +1,82 @@
|
|||||||
|
<!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>Defold Druid UI Library</title>
|
||||||
|
<link rel="stylesheet" href="../ldoc_pale.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>Druid</h1>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="../index.html">Index</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Modules</h2>
|
||||||
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/base.back_handler.html">base.back_handler</a></li>
|
||||||
|
<li><a href="../modules/base.blocker.html">base.blocker</a></li>
|
||||||
|
<li><a href="../modules/base.button.html">base.button</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||||
|
<li><strong>base.checkbox_group</strong></li>
|
||||||
|
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||||
|
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||||
|
<li><strong>base.checkbox_group</strong></li>
|
||||||
|
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||||
|
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||||
|
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||||
|
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||||
|
<li><a href="../modules/constants.html">constants</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
|
<li><a href="../modules/helper.html">helper</a></li>
|
||||||
|
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||||
|
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||||
|
<li><a href="../modules/rich.progress_rich.html">rich.progress_rich</a></li>
|
||||||
|
<li><a href="../modules/settings.html">settings</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="content">
|
||||||
|
|
||||||
|
<h1>Module <code>base.checkbox_group</code></h1>
|
||||||
|
<p>Radio group module</p>
|
||||||
|
<p></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</div> <!-- id="content" -->
|
||||||
|
</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 2019-12-05 22:04:11 </i>
|
||||||
|
</div> <!-- id="about" -->
|
||||||
|
</div> <!-- id="container" -->
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
82
docs/modules/base.grid.html
Normal file
82
docs/modules/base.grid.html
Normal file
@ -0,0 +1,82 @@
|
|||||||
|
<!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>Defold Druid UI Library</title>
|
||||||
|
<link rel="stylesheet" href="../ldoc_pale.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>Druid</h1>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="../index.html">Index</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Modules</h2>
|
||||||
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/base.back_handler.html">base.back_handler</a></li>
|
||||||
|
<li><a href="../modules/base.blocker.html">base.blocker</a></li>
|
||||||
|
<li><a href="../modules/base.button.html">base.button</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><strong>base.grid</strong></li>
|
||||||
|
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||||
|
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||||
|
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||||
|
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||||
|
<li><a href="../modules/constants.html">constants</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
|
<li><a href="../modules/helper.html">helper</a></li>
|
||||||
|
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||||
|
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||||
|
<li><a href="../modules/rich.progress_rich.html">rich.progress_rich</a></li>
|
||||||
|
<li><a href="../modules/settings.html">settings</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="content">
|
||||||
|
|
||||||
|
<h1>Module <code>base.grid</code></h1>
|
||||||
|
<p>Component to handle placing components by row and columns.</p>
|
||||||
|
<p>Grid can anchor your elements, get content size and other</p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</div> <!-- id="content" -->
|
||||||
|
</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 2019-12-05 22:04:11 </i>
|
||||||
|
</div> <!-- id="about" -->
|
||||||
|
</div> <!-- id="container" -->
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
155
docs/modules/base.html
Normal file
155
docs/modules/base.html
Normal file
@ -0,0 +1,155 @@
|
|||||||
|
<!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>Defold Druid UI Library</title>
|
||||||
|
<link rel="stylesheet" href="../ldoc_pale.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>Druid</h1>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="../index.html">Index</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h2>Contents</h2>
|
||||||
|
<ul>
|
||||||
|
<li><a href="#Functions">Functions</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Modules</h2>
|
||||||
|
<ul class="nowrap">
|
||||||
|
<li><strong>base</strong></li>
|
||||||
|
<li><a href="../modules/base.blocker.html">base.blocker</a></li>
|
||||||
|
<li><a href="../modules/base.button.html">base.button</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||||
|
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||||
|
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||||
|
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||||
|
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||||
|
<li><a href="../modules/constants.html">constants</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
|
<li><a href="../modules/helper.html">helper</a></li>
|
||||||
|
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||||
|
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||||
|
<li><a href="../modules/settings.html">settings</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="content">
|
||||||
|
|
||||||
|
<h1>Module <code>base</code></h1>
|
||||||
|
<p>Component to handle back key</p>
|
||||||
|
<p></p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#back_handler:init">back_handler:init(self, callback[, Callback])</a></td>
|
||||||
|
<td class="summary">Component init function</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#back_handler:on_input">back_handler:on_input(action_id, action)</a></td>
|
||||||
|
<td class="summary">Input handler for component</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "back_handler:init"></a>
|
||||||
|
<strong>back_handler:init(self, callback[, Callback])</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component init function
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Component instance
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">callback</span>
|
||||||
|
<span class="types"><span class="type">callback</span></span>
|
||||||
|
On back button
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">Callback</span>
|
||||||
|
<span class="types"><span class="type">params</span></span>
|
||||||
|
argument
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "back_handler:on_input"></a>
|
||||||
|
<strong>back_handler:on_input(action_id, action)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Input handler for component
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">action_id</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
||||||
|
on_input action id
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">action</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
on_input action
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
|
||||||
|
|
||||||
|
</div> <!-- id="content" -->
|
||||||
|
</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 2019-12-05 21:36:59 </i>
|
||||||
|
</div> <!-- id="about" -->
|
||||||
|
</div> <!-- id="container" -->
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
301
docs/modules/base.progress.html
Normal file
301
docs/modules/base.progress.html
Normal file
@ -0,0 +1,301 @@
|
|||||||
|
<!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>Defold Druid UI Library</title>
|
||||||
|
<link rel="stylesheet" href="../ldoc_pale.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>Druid</h1>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="../index.html">Index</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h2>Contents</h2>
|
||||||
|
<ul>
|
||||||
|
<li><a href="#Functions">Functions</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Modules</h2>
|
||||||
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/base.back_handler.html">base.back_handler</a></li>
|
||||||
|
<li><a href="../modules/base.blocker.html">base.blocker</a></li>
|
||||||
|
<li><a href="../modules/base.button.html">base.button</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||||
|
<li><strong>base.progress</strong></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||||
|
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||||
|
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||||
|
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||||
|
<li><a href="../modules/constants.html">constants</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
|
<li><a href="../modules/helper.html">helper</a></li>
|
||||||
|
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||||
|
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||||
|
<li><a href="../modules/rich.progress_rich.html">rich.progress_rich</a></li>
|
||||||
|
<li><a href="../modules/settings.html">settings</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="content">
|
||||||
|
|
||||||
|
<h1>Module <code>base.progress</code></h1>
|
||||||
|
<p>Basic progress bar component</p>
|
||||||
|
<p></p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#init">init(self, node, key, init_value)</a></td>
|
||||||
|
<td class="summary">Component init function</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#empty">empty(self)</a></td>
|
||||||
|
<td class="summary">Fill a progress bar and stop progress animation</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#empty">empty(self)</a></td>
|
||||||
|
<td class="summary">Empty a progress bar</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_to">set_to(self, to)</a></td>
|
||||||
|
<td class="summary">Instant fill progress bar to value</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#get">get(self)</a></td>
|
||||||
|
<td class="summary">Return current progress bar value</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_steps">set_steps(self, steps, callback)</a></td>
|
||||||
|
<td class="summary">Set points on progress bar to fire the callback</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#to">to(self, to[, callback])</a></td>
|
||||||
|
<td class="summary">Start animation of a progress bar</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "init"></a>
|
||||||
|
<strong>init(self, node, key, init_value)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component init function
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Component instance
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">node</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a> or <span class="type">node</span></span>
|
||||||
|
Progress bar fill node or node name
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">key</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
||||||
|
Progress bar direction (x or y)
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">init_value</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Initial value of progress bar
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "empty"></a>
|
||||||
|
<strong>empty(self)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Fill a progress bar and stop progress animation
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Component instance
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "empty"></a>
|
||||||
|
<strong>empty(self)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Empty a progress bar
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Component instance
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_to"></a>
|
||||||
|
<strong>set_to(self, to)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Instant fill progress bar to value
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Component instance
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">to</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Progress bar value, from 0 to 1
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "get"></a>
|
||||||
|
<strong>get(self)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Return current progress bar value
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Component instance
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_steps"></a>
|
||||||
|
<strong>set_steps(self, steps, callback)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set points on progress bar to fire the callback
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Component instance
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">steps</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Array of progress bar values
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">callback</span>
|
||||||
|
<span class="types"><span class="type">function</span></span>
|
||||||
|
Callback on intersect step value
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "to"></a>
|
||||||
|
<strong>to(self, to[, callback])</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Start animation of a progress bar
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Component instance
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">to</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
value between 0..1
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">callback</span>
|
||||||
|
<span class="types"><span class="type">function</span></span>
|
||||||
|
Callback on animation ends
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
|
||||||
|
|
||||||
|
</div> <!-- id="content" -->
|
||||||
|
</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 2019-12-05 22:04:11 </i>
|
||||||
|
</div> <!-- id="about" -->
|
||||||
|
</div> <!-- id="container" -->
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
278
docs/modules/base.scroll.html
Normal file
278
docs/modules/base.scroll.html
Normal file
@ -0,0 +1,278 @@
|
|||||||
|
<!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>Defold Druid UI Library</title>
|
||||||
|
<link rel="stylesheet" href="../ldoc_pale.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>Druid</h1>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="../index.html">Index</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h2>Contents</h2>
|
||||||
|
<ul>
|
||||||
|
<li><a href="#Functions">Functions</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Modules</h2>
|
||||||
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/base.back_handler.html">base.back_handler</a></li>
|
||||||
|
<li><a href="../modules/base.blocker.html">base.blocker</a></li>
|
||||||
|
<li><a href="../modules/base.button.html">base.button</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||||
|
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><strong>base.scroll</strong></li>
|
||||||
|
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||||
|
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||||
|
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||||
|
<li><a href="../modules/constants.html">constants</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
|
<li><a href="../modules/helper.html">helper</a></li>
|
||||||
|
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||||
|
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||||
|
<li><a href="../modules/rich.progress_rich.html">rich.progress_rich</a></li>
|
||||||
|
<li><a href="../modules/settings.html">settings</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="content">
|
||||||
|
|
||||||
|
<h1>Module <code>base.scroll</code></h1>
|
||||||
|
<p>Component to handle scroll content</p>
|
||||||
|
<p></p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#scroll_to">scroll_to(vector3[, is_instant])</a></td>
|
||||||
|
<td class="summary">Start scroll to target point</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#init">init(self, index[, skip_cb])</a></td>
|
||||||
|
<td class="summary">Scroll to item in scroll by point index</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_points">set_points(self, points)</a></td>
|
||||||
|
<td class="summary">Set points of interest.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_inert">set_inert(self, state)</a></td>
|
||||||
|
<td class="summary">Enable or disable scroll inert.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#on_point_move">on_point_move(self, callback)</a></td>
|
||||||
|
<td class="summary">Set the callback on scrolling to point (if exist)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_border">set_border(self, border)</a></td>
|
||||||
|
<td class="summary">Set the scroll possibly area</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "scroll_to"></a>
|
||||||
|
<strong>scroll_to(vector3[, is_instant])</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Start scroll to target point
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">vector3</span>
|
||||||
|
<span class="types"><span class="type">point</span></span>
|
||||||
|
target point
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">is_instant</span>
|
||||||
|
<span class="types"><span class="type">bool</span></span>
|
||||||
|
instant scroll flag
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><pre class="example">scroll:scroll_to(vmath.vector3(<span class="number">0</span>, <span class="number">50</span>, <span class="number">0</span>))</pre></li>
|
||||||
|
<li><pre class="example">scroll:scroll_to(vmath.vector3(<span class="number">0</span>), <span class="keyword">true</span>)</pre></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "init"></a>
|
||||||
|
<strong>init(self, index[, skip_cb])</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Scroll to item in scroll by point index
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Component instance
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">index</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Point index
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">skip_cb</span>
|
||||||
|
<span class="types"><span class="type">boolean</span></span>
|
||||||
|
If true, skip the point callback
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_points"></a>
|
||||||
|
<strong>set_points(self, points)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set points of interest. Scroll will always centered on closer points
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Component instance
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">points</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Array of vector3 points
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_inert"></a>
|
||||||
|
<strong>set_inert(self, state)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Enable or disable scroll inert. If disabled, scroll through points (if exist) If no points, just simple drag without inertion
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Component instance
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">state</span>
|
||||||
|
<span class="types"><span class="type">boolean</span></span>
|
||||||
|
Inert scroll state
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_point_move"></a>
|
||||||
|
<strong>on_point_move(self, callback)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set the callback on scrolling to point (if exist)
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Component instance
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">callback</span>
|
||||||
|
<span class="types"><span class="type">function</span></span>
|
||||||
|
Callback on scroll to point of interest
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_border"></a>
|
||||||
|
<strong>set_border(self, border)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set the scroll possibly area
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Component instance
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">border</span>
|
||||||
|
<span class="types"><span class="type">vmath.vector3</span></span>
|
||||||
|
Size of scrolling area
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
|
||||||
|
|
||||||
|
</div> <!-- id="content" -->
|
||||||
|
</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 2019-12-05 22:04:11 </i>
|
||||||
|
</div> <!-- id="about" -->
|
||||||
|
</div> <!-- id="container" -->
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
82
docs/modules/base.slider.html
Normal file
82
docs/modules/base.slider.html
Normal file
@ -0,0 +1,82 @@
|
|||||||
|
<!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>Defold Druid UI Library</title>
|
||||||
|
<link rel="stylesheet" href="../ldoc_pale.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>Druid</h1>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="../index.html">Index</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Modules</h2>
|
||||||
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/base.back_handler.html">base.back_handler</a></li>
|
||||||
|
<li><a href="../modules/base.blocker.html">base.blocker</a></li>
|
||||||
|
<li><a href="../modules/base.button.html">base.button</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||||
|
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||||
|
<li><strong>base.slider</strong></li>
|
||||||
|
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||||
|
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||||
|
<li><a href="../modules/constants.html">constants</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
|
<li><a href="../modules/helper.html">helper</a></li>
|
||||||
|
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||||
|
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||||
|
<li><a href="../modules/rich.progress_rich.html">rich.progress_rich</a></li>
|
||||||
|
<li><a href="../modules/settings.html">settings</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="content">
|
||||||
|
|
||||||
|
<h1>Module <code>base.slider</code></h1>
|
||||||
|
<p>Druid slider component</p>
|
||||||
|
<p></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</div> <!-- id="content" -->
|
||||||
|
</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 2019-12-05 22:04:11 </i>
|
||||||
|
</div> <!-- id="about" -->
|
||||||
|
</div> <!-- id="container" -->
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
238
docs/modules/base.text.html
Normal file
238
docs/modules/base.text.html
Normal file
@ -0,0 +1,238 @@
|
|||||||
|
<!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>Defold Druid UI Library</title>
|
||||||
|
<link rel="stylesheet" href="../ldoc_pale.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>Druid</h1>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="../index.html">Index</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h2>Contents</h2>
|
||||||
|
<ul>
|
||||||
|
<li><a href="#Functions">Functions</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Modules</h2>
|
||||||
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/base.back_handler.html">base.back_handler</a></li>
|
||||||
|
<li><a href="../modules/base.blocker.html">base.blocker</a></li>
|
||||||
|
<li><a href="../modules/base.button.html">base.button</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||||
|
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||||
|
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||||
|
<li><strong>base.text</strong></li>
|
||||||
|
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||||
|
<li><a href="../modules/constants.html">constants</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
|
<li><a href="../modules/helper.html">helper</a></li>
|
||||||
|
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||||
|
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||||
|
<li><a href="../modules/rich.progress_rich.html">rich.progress_rich</a></li>
|
||||||
|
<li><a href="../modules/settings.html">settings</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="content">
|
||||||
|
|
||||||
|
<h1>Module <code>base.text</code></h1>
|
||||||
|
<p>Component to handle all GUI texts Good working with localization system</p>
|
||||||
|
<p></p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#translate">translate(self, locale_id)</a></td>
|
||||||
|
<td class="summary">Translate the text by locale_id</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>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_color">set_color(self, color)</a></td>
|
||||||
|
<td class="summary">Set color</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_alpha">set_alpha(self, alpha)</a></td>
|
||||||
|
<td class="summary">Set alpha</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_scale">set_scale(self, scale)</a></td>
|
||||||
|
<td class="summary">Set scale</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "translate"></a>
|
||||||
|
<strong>translate(self, locale_id)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Translate the text by locale_id
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Component instance
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">locale_id</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
||||||
|
Locale id
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_to"></a>
|
||||||
|
<strong>set_to(self, set_to)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set text to text field
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Component instance
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">set_to</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
||||||
|
Text for node
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_color"></a>
|
||||||
|
<strong>set_color(self, color)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set color
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Component instance
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">color</span>
|
||||||
|
<span class="types"><span class="type">vmath.vector4</span></span>
|
||||||
|
Color for node
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_alpha"></a>
|
||||||
|
<strong>set_alpha(self, alpha)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set alpha
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Component instance
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">alpha</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Alpha for node
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_scale"></a>
|
||||||
|
<strong>set_scale(self, scale)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set scale
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Component instance
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">scale</span>
|
||||||
|
<span class="types"><span class="type">vmath.vector3</span></span>
|
||||||
|
Scale for node
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
|
||||||
|
|
||||||
|
</div> <!-- id="content" -->
|
||||||
|
</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 2019-12-05 22:04:11 </i>
|
||||||
|
</div> <!-- id="about" -->
|
||||||
|
</div> <!-- id="container" -->
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
184
docs/modules/base.timer.html
Normal file
184
docs/modules/base.timer.html
Normal file
@ -0,0 +1,184 @@
|
|||||||
|
<!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>Defold Druid UI Library</title>
|
||||||
|
<link rel="stylesheet" href="../ldoc_pale.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>Druid</h1>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="../index.html">Index</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h2>Contents</h2>
|
||||||
|
<ul>
|
||||||
|
<li><a href="#Functions">Functions</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Modules</h2>
|
||||||
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/base.back_handler.html">base.back_handler</a></li>
|
||||||
|
<li><a href="../modules/base.blocker.html">base.blocker</a></li>
|
||||||
|
<li><a href="../modules/base.button.html">base.button</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||||
|
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||||
|
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||||
|
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||||
|
<li><strong>base.timer</strong></li>
|
||||||
|
<li><a href="../modules/constants.html">constants</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
|
<li><a href="../modules/helper.html">helper</a></li>
|
||||||
|
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||||
|
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||||
|
<li><a href="../modules/rich.progress_rich.html">rich.progress_rich</a></li>
|
||||||
|
<li><a href="../modules/settings.html">settings</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="content">
|
||||||
|
|
||||||
|
<h1>Module <code>base.timer</code></h1>
|
||||||
|
<p>Component to handle GUI timers</p>
|
||||||
|
<p></p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<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>
|
||||||
|
</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>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "set_to"></a>
|
||||||
|
<strong>set_to(self, set_to)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set text to text field
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Component instance
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">set_to</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Value in seconds
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_state"></a>
|
||||||
|
<strong>set_state(self, is_on)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Called when update
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Component instance
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">is_on</span>
|
||||||
|
<span class="types"><span class="type">boolean</span></span>
|
||||||
|
Timer enable state
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "set_interval"></a>
|
||||||
|
<strong>set_interval(self, from, to)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Set time interval
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Component instance
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">from</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
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
|
||||||
|
|
||||||
|
</div> <!-- id="content" -->
|
||||||
|
</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 2019-12-05 22:04:11 </i>
|
||||||
|
</div> <!-- id="about" -->
|
||||||
|
</div> <!-- id="container" -->
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
155
docs/modules/components.back_handler.html
Normal file
155
docs/modules/components.back_handler.html
Normal file
@ -0,0 +1,155 @@
|
|||||||
|
<!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>Defold Druid UI Library</title>
|
||||||
|
<link rel="stylesheet" href="../ldoc_pale.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>Druid</h1>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="../index.html">Index</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h2>Contents</h2>
|
||||||
|
<ul>
|
||||||
|
<li><a href="#Functions">Functions</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Modules</h2>
|
||||||
|
<ul class="nowrap">
|
||||||
|
<li><strong>components.back_handler</strong></li>
|
||||||
|
<li><a href="../modules/base.blocker.html">base.blocker</a></li>
|
||||||
|
<li><a href="../modules/base.button.html">base.button</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||||
|
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||||
|
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||||
|
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||||
|
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||||
|
<li><a href="../modules/constants.html">constants</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
|
<li><a href="../modules/helper.html">helper</a></li>
|
||||||
|
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||||
|
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||||
|
<li><a href="../modules/settings.html">settings</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="content">
|
||||||
|
|
||||||
|
<h1>Module <code>components.back_handler</code></h1>
|
||||||
|
<p>Component to handle back key</p>
|
||||||
|
<p></p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#init">init(self, callback[, Callback])</a></td>
|
||||||
|
<td class="summary">Component init function</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#on_input">on_input(action_id, action)</a></td>
|
||||||
|
<td class="summary">Input handler for component</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "init"></a>
|
||||||
|
<strong>init(self, callback[, Callback])</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Component init function
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Component instance
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">callback</span>
|
||||||
|
<span class="types"><span class="type">callback</span></span>
|
||||||
|
On back button
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">Callback</span>
|
||||||
|
<span class="types"><span class="type">params</span></span>
|
||||||
|
argument
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "on_input"></a>
|
||||||
|
<strong>on_input(action_id, action)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Input handler for component
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">action_id</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
||||||
|
on_input action id
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">action</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
on_input action
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
|
||||||
|
|
||||||
|
</div> <!-- id="content" -->
|
||||||
|
</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 2019-12-05 21:38:00 </i>
|
||||||
|
</div> <!-- id="about" -->
|
||||||
|
</div> <!-- id="container" -->
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
111
docs/modules/constants.html
Normal file
111
docs/modules/constants.html
Normal file
@ -0,0 +1,111 @@
|
|||||||
|
<!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>Defold Druid UI Library</title>
|
||||||
|
<link rel="stylesheet" href="../ldoc_pale.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>Druid</h1>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="../index.html">Index</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h2>Contents</h2>
|
||||||
|
<ul>
|
||||||
|
<li><a href="#Fields">Fields</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Modules</h2>
|
||||||
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/base.back_handler.html">base.back_handler</a></li>
|
||||||
|
<li><a href="../modules/base.blocker.html">base.blocker</a></li>
|
||||||
|
<li><a href="../modules/base.button.html">base.button</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||||
|
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||||
|
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||||
|
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||||
|
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||||
|
<li><strong>constants</strong></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
|
<li><a href="../modules/helper.html">helper</a></li>
|
||||||
|
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||||
|
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||||
|
<li><a href="../modules/rich.progress_rich.html">rich.progress_rich</a></li>
|
||||||
|
<li><a href="../modules/settings.html">settings</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="content">
|
||||||
|
|
||||||
|
<h1>Module <code>constants</code></h1>
|
||||||
|
<p>Druid constants</p>
|
||||||
|
<p></p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Fields">Fields</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#ON_MESSAGE">ON_MESSAGE</a></td>
|
||||||
|
<td class="summary">Interests</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="Fields"></a>Fields</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "ON_MESSAGE"></a>
|
||||||
|
<strong>ON_MESSAGE</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Interests
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
|
||||||
|
|
||||||
|
</div> <!-- id="content" -->
|
||||||
|
</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 2019-12-05 22:04:11 </i>
|
||||||
|
</div> <!-- id="about" -->
|
||||||
|
</div> <!-- id="container" -->
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
309
docs/modules/druid.html
Normal file
309
docs/modules/druid.html
Normal file
@ -0,0 +1,309 @@
|
|||||||
|
<!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>Defold Druid UI Library</title>
|
||||||
|
<link rel="stylesheet" href="../ldoc_pale.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>Druid</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="#Tables">Tables</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Modules</h2>
|
||||||
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/base.back_handler.html">base.back_handler</a></li>
|
||||||
|
<li><a href="../modules/base.blocker.html">base.blocker</a></li>
|
||||||
|
<li><a href="../modules/base.button.html">base.button</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||||
|
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||||
|
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||||
|
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||||
|
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||||
|
<li><a href="../modules/constants.html">constants</a></li>
|
||||||
|
<li><strong>druid</strong></li>
|
||||||
|
<li><a href="../modules/helper.html">helper</a></li>
|
||||||
|
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||||
|
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||||
|
<li><a href="../modules/rich.progress_rich.html">rich.progress_rich</a></li>
|
||||||
|
<li><a href="../modules/settings.html">settings</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="content">
|
||||||
|
|
||||||
|
<h1>Module <code>druid</code></h1>
|
||||||
|
<p>Druid UI Library.</p>
|
||||||
|
<p>Component based UI library to make your life easier. Contains a lot of base components and give API to create your own rich components.</p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#register">register(name, module)</a></td>
|
||||||
|
<td class="summary">Register external module</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#new">new(component_script)</a></td>
|
||||||
|
<td class="summary">Create UI instance for ui elements</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#_fct_metatable.on_message">_fct_metatable.on_message(self, message_id, message, sender)</a></td>
|
||||||
|
<td class="summary">Called on_message</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#_fct_metatable.on_input">_fct_metatable.on_input(self, action_id, action)</a></td>
|
||||||
|
<td class="summary">Called ON_INPUT</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#_fct_metatable.update">_fct_metatable.update(self, dt)</a></td>
|
||||||
|
<td class="summary">Called on_update</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<h2><a href="#Tables">Tables</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#comps">comps</a></td>
|
||||||
|
<td class="summary">Basic components</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "register"></a>
|
||||||
|
<strong>register(name, module)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Register external module
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">name</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
||||||
|
module name
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">module</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
lua table with module
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "new"></a>
|
||||||
|
<strong>new(component_script)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Create UI instance for ui elements
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">component_script</span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
instance with all ui components
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "_fct_metatable.on_message"></a>
|
||||||
|
<strong>_fct_metatable.on_message(self, message_id, message, sender)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Called on_message
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">message_id</span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">message</span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">sender</span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "_fct_metatable.on_input"></a>
|
||||||
|
<strong>_fct_metatable.on_input(self, action_id, action)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Called ON_INPUT
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">action_id</span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">action</span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "_fct_metatable.update"></a>
|
||||||
|
<strong>_fct_metatable.update(self, dt)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Called on_update
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">dt</span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "comps"></a>
|
||||||
|
<strong>comps</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Basic components
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Fields:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">button</span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">blocker</span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">back_handler</span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">text</span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">timer</span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">progress</span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">grid</span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">scroll</span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">slider</span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">checkbox</span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">checkbox_group</span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">radio_group</span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">progress_rich</span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
|
||||||
|
|
||||||
|
</div> <!-- id="content" -->
|
||||||
|
</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 2019-12-05 22:04:11 </i>
|
||||||
|
</div> <!-- id="about" -->
|
||||||
|
</div> <!-- id="container" -->
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
82
docs/modules/helper.animate.html
Normal file
82
docs/modules/helper.animate.html
Normal file
@ -0,0 +1,82 @@
|
|||||||
|
<!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>Defold Druid UI Library</title>
|
||||||
|
<link rel="stylesheet" href="../ldoc_pale.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>Druid</h1>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="../index.html">Index</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Modules</h2>
|
||||||
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/base.back_handler.html">base.back_handler</a></li>
|
||||||
|
<li><a href="../modules/base.blocker.html">base.blocker</a></li>
|
||||||
|
<li><a href="../modules/base.button.html">base.button</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||||
|
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||||
|
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||||
|
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||||
|
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||||
|
<li><a href="../modules/constants.html">constants</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
|
<li><a href="../modules/helper.html">helper</a></li>
|
||||||
|
<li><strong>helper.animate</strong></li>
|
||||||
|
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||||
|
<li><a href="../modules/rich.progress_rich.html">rich.progress_rich</a></li>
|
||||||
|
<li><a href="../modules/settings.html">settings</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="content">
|
||||||
|
|
||||||
|
<h1>Module <code>helper.animate</code></h1>
|
||||||
|
<p>Druid helper module for animating GUI nodes</p>
|
||||||
|
<p></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</div> <!-- id="content" -->
|
||||||
|
</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 2019-12-05 22:04:11 </i>
|
||||||
|
</div> <!-- id="about" -->
|
||||||
|
</div> <!-- id="container" -->
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
191
docs/modules/helper.formats.html
Normal file
191
docs/modules/helper.formats.html
Normal file
@ -0,0 +1,191 @@
|
|||||||
|
<!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>Defold Druid UI Library</title>
|
||||||
|
<link rel="stylesheet" href="../ldoc_pale.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>Druid</h1>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="../index.html">Index</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h2>Contents</h2>
|
||||||
|
<ul>
|
||||||
|
<li><a href="#Functions">Functions</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Modules</h2>
|
||||||
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/base.back_handler.html">base.back_handler</a></li>
|
||||||
|
<li><a href="../modules/base.blocker.html">base.blocker</a></li>
|
||||||
|
<li><a href="../modules/base.button.html">base.button</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||||
|
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||||
|
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||||
|
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||||
|
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||||
|
<li><a href="../modules/constants.html">constants</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
|
<li><a href="../modules/helper.html">helper</a></li>
|
||||||
|
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||||
|
<li><strong>helper.formats</strong></li>
|
||||||
|
<li><a href="../modules/rich.progress_rich.html">rich.progress_rich</a></li>
|
||||||
|
<li><a href="../modules/settings.html">settings</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="content">
|
||||||
|
|
||||||
|
<h1>Module <code>helper.formats</code></h1>
|
||||||
|
<p>Druid module with utils on string formats</p>
|
||||||
|
<p></p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#add_prefix_zeros">add_prefix_zeros(num, count)</a></td>
|
||||||
|
<td class="summary">Return number with zero number prefix</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#second_string_min">second_string_min(sec)</a></td>
|
||||||
|
<td class="summary">Convert seconds to string minutes:seconds</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#second_string_min">second_string_min(s, tab)</a></td>
|
||||||
|
<td class="summary">Interpolate string with named Parameters in Table</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "add_prefix_zeros"></a>
|
||||||
|
<strong>add_prefix_zeros(num, count)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Return number with zero number prefix
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">num</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Number for conversion
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">count</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Count of numerals
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
string with need count of zero (1,3) -> 001
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "second_string_min"></a>
|
||||||
|
<strong>second_string_min(sec)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Convert seconds to string minutes:seconds
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">sec</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Seconds
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
string minutes:seconds
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "second_string_min"></a>
|
||||||
|
<strong>second_string_min(s, tab)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Interpolate string with named Parameters in Table
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">s</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
||||||
|
Target string
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">tab</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Table with parameters
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Returns:</h3>
|
||||||
|
<ol>
|
||||||
|
|
||||||
|
string with replaced parameters
|
||||||
|
</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.6</a></i>
|
||||||
|
<i style="float:right;">Last updated 2019-12-05 22:04:11 </i>
|
||||||
|
</div> <!-- id="about" -->
|
||||||
|
</div> <!-- id="container" -->
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
153
docs/modules/helper.html
Normal file
153
docs/modules/helper.html
Normal file
@ -0,0 +1,153 @@
|
|||||||
|
<!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>Defold Druid UI Library</title>
|
||||||
|
<link rel="stylesheet" href="../ldoc_pale.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>Druid</h1>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="../index.html">Index</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h2>Contents</h2>
|
||||||
|
<ul>
|
||||||
|
<li><a href="#Functions">Functions</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Modules</h2>
|
||||||
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/base.back_handler.html">base.back_handler</a></li>
|
||||||
|
<li><a href="../modules/base.blocker.html">base.blocker</a></li>
|
||||||
|
<li><a href="../modules/base.button.html">base.button</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||||
|
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||||
|
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||||
|
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||||
|
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||||
|
<li><a href="../modules/constants.html">constants</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
|
<li><strong>helper</strong></li>
|
||||||
|
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||||
|
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||||
|
<li><a href="../modules/rich.progress_rich.html">rich.progress_rich</a></li>
|
||||||
|
<li><a href="../modules/settings.html">settings</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="content">
|
||||||
|
|
||||||
|
<h1>Module <code>helper</code></h1>
|
||||||
|
<p>Druid helper module</p>
|
||||||
|
<p></p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#centrate_text_with_icon">centrate_text_with_icon(text_node, icon_node, margin)</a></td>
|
||||||
|
<td class="summary">Text node or icon node can be nil</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#centrate_icon_with_text">centrate_icon_with_text(icon_node, text_node, margin)</a></td>
|
||||||
|
<td class="summary">Icon node or text node can be nil</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "centrate_text_with_icon"></a>
|
||||||
|
<strong>centrate_text_with_icon(text_node, icon_node, margin)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Text node or icon node can be nil
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">text_node</span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">icon_node</span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">margin</span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "centrate_icon_with_text"></a>
|
||||||
|
<strong>centrate_icon_with_text(icon_node, text_node, margin)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Icon node or text node can be nil
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">icon_node</span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">text_node</span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">margin</span>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
|
||||||
|
|
||||||
|
</div> <!-- id="content" -->
|
||||||
|
</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 2019-12-05 22:04:11 </i>
|
||||||
|
</div> <!-- id="about" -->
|
||||||
|
</div> <!-- id="container" -->
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
181
docs/modules/rich.progress_rich.html
Normal file
181
docs/modules/rich.progress_rich.html
Normal file
@ -0,0 +1,181 @@
|
|||||||
|
<!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>Defold Druid UI Library</title>
|
||||||
|
<link rel="stylesheet" href="../ldoc_pale.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>Druid</h1>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="../index.html">Index</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h2>Contents</h2>
|
||||||
|
<ul>
|
||||||
|
<li><a href="#Functions">Functions</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Modules</h2>
|
||||||
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/base.back_handler.html">base.back_handler</a></li>
|
||||||
|
<li><a href="../modules/base.blocker.html">base.blocker</a></li>
|
||||||
|
<li><a href="../modules/base.button.html">base.button</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||||
|
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||||
|
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||||
|
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||||
|
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||||
|
<li><a href="../modules/constants.html">constants</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
|
<li><a href="../modules/helper.html">helper</a></li>
|
||||||
|
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||||
|
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||||
|
<li><strong>rich.progress_rich</strong></li>
|
||||||
|
<li><a href="../modules/settings.html">settings</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="content">
|
||||||
|
|
||||||
|
<h1>Module <code>rich.progress_rich</code></h1>
|
||||||
|
<p>Component for rich progress component</p>
|
||||||
|
<p></p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#set_to">set_to(self, value)</a></td>
|
||||||
|
<td class="summary">Instant fill progress bar to value</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#empty">empty(self)</a></td>
|
||||||
|
<td class="summary">Empty a progress bar</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#to">to(self, to[, callback])</a></td>
|
||||||
|
<td class="summary">Start animation of a progress bar</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "set_to"></a>
|
||||||
|
<strong>set_to(self, value)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Instant fill progress bar to value
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Component instance
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">value</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
Progress bar value, from 0 to 1
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "empty"></a>
|
||||||
|
<strong>empty(self)</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Empty a progress bar
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Component instance
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "to"></a>
|
||||||
|
<strong>to(self, to[, callback])</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Start animation of a progress bar
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">self</span>
|
||||||
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||||
|
Component instance
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">to</span>
|
||||||
|
<span class="types"><span class="type">number</span></span>
|
||||||
|
value between 0..1
|
||||||
|
</li>
|
||||||
|
<li><span class="parameter">callback</span>
|
||||||
|
<span class="types"><span class="type">function</span></span>
|
||||||
|
Callback on animation ends
|
||||||
|
(<em>optional</em>)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
|
||||||
|
|
||||||
|
</div> <!-- id="content" -->
|
||||||
|
</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 2019-12-05 22:04:11 </i>
|
||||||
|
</div> <!-- id="about" -->
|
||||||
|
</div> <!-- id="container" -->
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
82
docs/modules/settings.html
Normal file
82
docs/modules/settings.html
Normal file
@ -0,0 +1,82 @@
|
|||||||
|
<!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>Defold Druid UI Library</title>
|
||||||
|
<link rel="stylesheet" href="../ldoc_pale.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>Druid</h1>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="../index.html">Index</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Modules</h2>
|
||||||
|
<ul class="nowrap">
|
||||||
|
<li><a href="../modules/base.back_handler.html">base.back_handler</a></li>
|
||||||
|
<li><a href="../modules/base.blocker.html">base.blocker</a></li>
|
||||||
|
<li><a href="../modules/base.button.html">base.button</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox.html">base.checkbox</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.grid.html">base.grid</a></li>
|
||||||
|
<li><a href="../modules/base.progress.html">base.progress</a></li>
|
||||||
|
<li><a href="../modules/base.checkbox_group.html">base.checkbox_group</a></li>
|
||||||
|
<li><a href="../modules/base.scroll.html">base.scroll</a></li>
|
||||||
|
<li><a href="../modules/base.slider.html">base.slider</a></li>
|
||||||
|
<li><a href="../modules/base.text.html">base.text</a></li>
|
||||||
|
<li><a href="../modules/base.timer.html">base.timer</a></li>
|
||||||
|
<li><a href="../modules/constants.html">constants</a></li>
|
||||||
|
<li><a href="../modules/druid.html">druid</a></li>
|
||||||
|
<li><a href="../modules/helper.html">helper</a></li>
|
||||||
|
<li><a href="../modules/helper.animate.html">helper.animate</a></li>
|
||||||
|
<li><a href="../modules/helper.formats.html">helper.formats</a></li>
|
||||||
|
<li><a href="../modules/rich.progress_rich.html">rich.progress_rich</a></li>
|
||||||
|
<li><strong>settings</strong></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="content">
|
||||||
|
|
||||||
|
<h1>Module <code>settings</code></h1>
|
||||||
|
<p>Druid settings file</p>
|
||||||
|
<p></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</div> <!-- id="content" -->
|
||||||
|
</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 2019-12-05 22:04:11 </i>
|
||||||
|
</div> <!-- id="about" -->
|
||||||
|
</div> <!-- id="container" -->
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
Loading…
x
Reference in New Issue
Block a user