mirror of
https://github.com/Insality/druid.git
synced 2025-06-27 10:27:47 +02:00
717 lines
17 KiB
HTML
717 lines
17 KiB
HTML
<!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/druid.back_handler.html">druid.back_handler</a></li>
|
|
<li><a href="../modules/druid.blocker.html">druid.blocker</a></li>
|
|
<li><a href="../modules/druid.button.html">druid.button</a></li>
|
|
<li><a href="../modules/druid.checkbox.html">druid.checkbox</a></li>
|
|
<li><a href="../modules/druid.checkbox_group.html">druid.checkbox_group</a></li>
|
|
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
|
<li><a href="../modules/druid.locale.html">druid.locale</a></li>
|
|
<li><a href="../modules/druid.progress.html">druid.progress</a></li>
|
|
<li><a href="../modules/druid.radio_group.html">druid.radio_group</a></li>
|
|
<li><a href="../modules/druid.scroll.html">druid.scroll</a></li>
|
|
<li><a href="../modules/druid.slider.html">druid.slider</a></li>
|
|
<li><a href="../modules/druid.text.html">druid.text</a></li>
|
|
<li><a href="../modules/druid.timer.html">druid.timer</a></li>
|
|
<li><a href="../modules/const.html">const</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.formats.html">helper.formats</a></li>
|
|
<li><a href="../modules/druid.progress_rich.html">druid.progress_rich</a></li>
|
|
<li><a href="../modules/component.html">component</a></li>
|
|
<li><strong>druid_instance</strong></li>
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
<div id="content">
|
|
|
|
<h1>Module <code>druid_instance</code></h1>
|
|
<p>Druid main class.</p>
|
|
<p> Create instance of this
|
|
to start creating components</p>
|
|
<h3>See also:</h3>
|
|
<ul>
|
|
<li><a href="../modules/druid.button.html#">druid.button</a></li>
|
|
<li><a href="../modules/druid.blocker.html#">druid.blocker</a></li>
|
|
<li><a href="../modules/druid.back_handler.html#">druid.back_handler</a></li>
|
|
<li><a href="../modules/druid.text.html#">druid.text</a></li>
|
|
<li><a href="../modules/druid.locale.html#">druid.locale</a></li>
|
|
<li><a href="../modules/druid.timer.html#">druid.timer</a></li>
|
|
<li><a href="../modules/druid.progress.html#">druid.progress</a></li>
|
|
<li><a href="../modules/druid.grid.html#">druid.grid</a></li>
|
|
<li><a href="../modules/druid.scroll.html#">druid.scroll</a></li>
|
|
<li><a href="../modules/druid.slider.html#">druid.slider</a></li>
|
|
<li><a href="../modules/druid.checkbox.html#">druid.checkbox</a></li>
|
|
<li><a href="../modules/druid.checkbox_group.html#">druid.checkbox_group</a></li>
|
|
<li><a href="../modules/druid.radio_group.html#">druid.radio_group</a></li>
|
|
</ul>
|
|
|
|
|
|
<h2><a href="#Functions">Functions</a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap><a href="#druid:initialize">druid:initialize(table, table)</a></td>
|
|
<td class="summary">Druid class constructor</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#druid:create">druid:create(component_module, ...)</a></td>
|
|
<td class="summary">Create new druid component</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#druid:remove">druid:remove(component)</a></td>
|
|
<td class="summary">Remove component from druid instance.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#druid:update">druid:update(dt)</a></td>
|
|
<td class="summary">Druid update function</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#druid:on_input">druid:on_input(action_id, action)</a></td>
|
|
<td class="summary">Druid on_input function</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#druid:on_message">druid:on_message(message_id, message, sender)</a></td>
|
|
<td class="summary">Druid on_message function</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#druid:new_button">druid:new_button(...)</a></td>
|
|
<td class="summary">Create button basic component</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#druid:new_blocker">druid:new_blocker(...)</a></td>
|
|
<td class="summary">Create blocker basic component</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#druid:new_back_handler">druid:new_back_handler(...)</a></td>
|
|
<td class="summary">Create back_handler basic component</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#druid:new_text">druid:new_text(...)</a></td>
|
|
<td class="summary">Create text basic component</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#druid:new_locale">druid:new_locale(...)</a></td>
|
|
<td class="summary">Create locale basic component</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#druid:new_timer">druid:new_timer(...)</a></td>
|
|
<td class="summary">Create timer basic component</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#druid:new_progress">druid:new_progress(...)</a></td>
|
|
<td class="summary">Create progress basic component</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#druid:new_grid">druid:new_grid(...)</a></td>
|
|
<td class="summary">Create grid basic component</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#druid:new_scroll">druid:new_scroll(...)</a></td>
|
|
<td class="summary">Create scroll basic component</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#druid:new_slider">druid:new_slider(...)</a></td>
|
|
<td class="summary">Create slider basic component</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#druid:new_checkbox">druid:new_checkbox(...)</a></td>
|
|
<td class="summary">Create checkbox basic component</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#druid:new_checkbox_group">druid:new_checkbox_group(...)</a></td>
|
|
<td class="summary">Create checkbox_group basic component</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#druid:new_radio_group">druid:new_radio_group(...)</a></td>
|
|
<td class="summary">Create radio_group basic component</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#druid:new_progress_rich">druid:new_progress_rich(...)</a></td>
|
|
<td class="summary">Create progress_rich basic component</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br/>
|
|
<br/>
|
|
|
|
|
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
|
|
|
<dl class="function">
|
|
<dt>
|
|
<a name = "druid:initialize"></a>
|
|
<strong>druid:initialize(table, table)</strong>
|
|
</dt>
|
|
<dd>
|
|
Druid class constructor
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">table</span>
|
|
<span class="types"><span class="type">style</span></span>
|
|
Druid style module
|
|
</li>
|
|
<li><span class="parameter">table</span>
|
|
<span class="types"><span class="type">style</span></span>
|
|
Druid style module
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "druid:create"></a>
|
|
<strong>druid:create(component_module, ...)</strong>
|
|
</dt>
|
|
<dd>
|
|
Create new druid component
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">component_module</span>
|
|
<span class="types"><span class="type">Component</span></span>
|
|
Component module
|
|
</li>
|
|
<li><span class="parameter">...</span>
|
|
<span class="types"><span class="type">args</span></span>
|
|
Other component params to pass it to component:init function
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "druid:remove"></a>
|
|
<strong>druid:remove(component)</strong>
|
|
</dt>
|
|
<dd>
|
|
Remove component from druid instance.
|
|
Component `on_remove` function will be invoked, if exist.
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">component</span>
|
|
<span class="types"><span class="type">Component</span></span>
|
|
Component instance
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "druid:update"></a>
|
|
<strong>druid:update(dt)</strong>
|
|
</dt>
|
|
<dd>
|
|
Druid update function
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">dt</span>
|
|
<span class="types"><span class="type">number</span></span>
|
|
Delta time
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "druid:on_input"></a>
|
|
<strong>druid:on_input(action_id, action)</strong>
|
|
</dt>
|
|
<dd>
|
|
Druid on_input function
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">action_id</span>
|
|
<span class="types"><span class="type">hash</span></span>
|
|
Action_id from on_input
|
|
</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>
|
|
Action from on_input
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "druid:on_message"></a>
|
|
<strong>druid:on_message(message_id, message, sender)</strong>
|
|
</dt>
|
|
<dd>
|
|
Druid on_message function
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">message_id</span>
|
|
<span class="types"><span class="type">hash</span></span>
|
|
Message_id from on_message
|
|
</li>
|
|
<li><span class="parameter">message</span>
|
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
|
Message from on_message
|
|
</li>
|
|
<li><span class="parameter">sender</span>
|
|
<span class="types"><span class="type">hash</span></span>
|
|
Sender from on_message
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "druid:new_button"></a>
|
|
<strong>druid:new_button(...)</strong>
|
|
</dt>
|
|
<dd>
|
|
Create button basic component
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">...</span>
|
|
<span class="types"><span class="type">args</span></span>
|
|
button init args
|
|
</li>
|
|
</ul>
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><span class="type">Component</span></span>
|
|
button component
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "druid:new_blocker"></a>
|
|
<strong>druid:new_blocker(...)</strong>
|
|
</dt>
|
|
<dd>
|
|
Create blocker basic component
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">...</span>
|
|
<span class="types"><span class="type">args</span></span>
|
|
blocker init args
|
|
</li>
|
|
</ul>
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><span class="type">Component</span></span>
|
|
blocker component
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "druid:new_back_handler"></a>
|
|
<strong>druid:new_back_handler(...)</strong>
|
|
</dt>
|
|
<dd>
|
|
Create back_handler basic component
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">...</span>
|
|
<span class="types"><span class="type">args</span></span>
|
|
back_handler init args
|
|
</li>
|
|
</ul>
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><span class="type">Component</span></span>
|
|
back_handler component
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "druid:new_text"></a>
|
|
<strong>druid:new_text(...)</strong>
|
|
</dt>
|
|
<dd>
|
|
Create text basic component
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">...</span>
|
|
<span class="types"><span class="type">args</span></span>
|
|
text init args
|
|
</li>
|
|
</ul>
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><span class="type">Component</span></span>
|
|
text component
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "druid:new_locale"></a>
|
|
<strong>druid:new_locale(...)</strong>
|
|
</dt>
|
|
<dd>
|
|
Create locale basic component
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">...</span>
|
|
<span class="types"><span class="type">args</span></span>
|
|
locale init args
|
|
</li>
|
|
</ul>
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><span class="type">Component</span></span>
|
|
locale component
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "druid:new_timer"></a>
|
|
<strong>druid:new_timer(...)</strong>
|
|
</dt>
|
|
<dd>
|
|
Create timer basic component
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">...</span>
|
|
<span class="types"><span class="type">args</span></span>
|
|
timer init args
|
|
</li>
|
|
</ul>
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><span class="type">Component</span></span>
|
|
timer component
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "druid:new_progress"></a>
|
|
<strong>druid:new_progress(...)</strong>
|
|
</dt>
|
|
<dd>
|
|
Create progress basic component
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">...</span>
|
|
<span class="types"><span class="type">args</span></span>
|
|
progress init args
|
|
</li>
|
|
</ul>
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><span class="type">Component</span></span>
|
|
progress component
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "druid:new_grid"></a>
|
|
<strong>druid:new_grid(...)</strong>
|
|
</dt>
|
|
<dd>
|
|
Create grid basic component
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">...</span>
|
|
<span class="types"><span class="type">args</span></span>
|
|
grid init args
|
|
</li>
|
|
</ul>
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><span class="type">Component</span></span>
|
|
grid component
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "druid:new_scroll"></a>
|
|
<strong>druid:new_scroll(...)</strong>
|
|
</dt>
|
|
<dd>
|
|
Create scroll basic component
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">...</span>
|
|
<span class="types"><span class="type">args</span></span>
|
|
scroll init args
|
|
</li>
|
|
</ul>
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><span class="type">Component</span></span>
|
|
scroll component
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "druid:new_slider"></a>
|
|
<strong>druid:new_slider(...)</strong>
|
|
</dt>
|
|
<dd>
|
|
Create slider basic component
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">...</span>
|
|
<span class="types"><span class="type">args</span></span>
|
|
slider init args
|
|
</li>
|
|
</ul>
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><span class="type">Component</span></span>
|
|
slider component
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "druid:new_checkbox"></a>
|
|
<strong>druid:new_checkbox(...)</strong>
|
|
</dt>
|
|
<dd>
|
|
Create checkbox basic component
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">...</span>
|
|
<span class="types"><span class="type">args</span></span>
|
|
checkbox init args
|
|
</li>
|
|
</ul>
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><span class="type">Component</span></span>
|
|
checkbox component
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "druid:new_checkbox_group"></a>
|
|
<strong>druid:new_checkbox_group(...)</strong>
|
|
</dt>
|
|
<dd>
|
|
Create checkbox_group basic component
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">...</span>
|
|
<span class="types"><span class="type">args</span></span>
|
|
checkbox_group init args
|
|
</li>
|
|
</ul>
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><span class="type">Component</span></span>
|
|
checkbox_group component
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "druid:new_radio_group"></a>
|
|
<strong>druid:new_radio_group(...)</strong>
|
|
</dt>
|
|
<dd>
|
|
Create radio_group basic component
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">...</span>
|
|
<span class="types"><span class="type">args</span></span>
|
|
radio_group init args
|
|
</li>
|
|
</ul>
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><span class="type">Component</span></span>
|
|
radio_group component
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "druid:new_progress_rich"></a>
|
|
<strong>druid:new_progress_rich(...)</strong>
|
|
</dt>
|
|
<dd>
|
|
Create progress_rich basic component
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">...</span>
|
|
<span class="types"><span class="type">args</span></span>
|
|
progress_rich init args
|
|
</li>
|
|
</ul>
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><span class="type">Component</span></span>
|
|
progress_rich component
|
|
</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 2020-02-05 02:41:04 </i>
|
|
</div> <!-- id="about" -->
|
|
</div> <!-- id="container" -->
|
|
</body>
|
|
</html>
|