mirror of
https://github.com/Insality/druid
synced 2025-09-27 10:02:19 +02:00
Updated documentation to 0.4.0
This commit is contained in:
@@ -83,13 +83,9 @@
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#get_style">get_style()</a></td>
|
||||
<td class="summary">Get current component style table</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#set_style">set_style(style)</a></td>
|
||||
<td class="summary">Set current component style table</td>
|
||||
<td class="summary">Set current component style table.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#get_template">get_template()</a></td>
|
||||
@@ -136,11 +132,19 @@
|
||||
<td class="summary">Return druid with context of calling component.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#setup_component">setup_component(table, table)</a></td>
|
||||
<td class="name" nowrap><a href="#is_child_of">is_child_of()</a></td>
|
||||
<td class="summary">Return true, if current component is child of another component</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#get_name">get_name()</a></td>
|
||||
<td class="summary">Return component name</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#setup_component">setup_component(table, table, table)</a></td>
|
||||
<td class="summary">Setup component context and his style table</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Component.create">Component.create(name, interest)</a></td>
|
||||
<td class="name" nowrap><a href="#Component.create">Component.create(name[, interest={}])</a></td>
|
||||
<td class="summary">Create new component.</td>
|
||||
</tr>
|
||||
</table>
|
||||
@@ -152,32 +156,14 @@
|
||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "get_style"></a>
|
||||
<strong>get_style()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Get current component style table
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Component style table
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "set_style"></a>
|
||||
<strong>set_style(style)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Set current component style table
|
||||
Set current component style table.
|
||||
Invoke <code>on_style_change</code> on component, if exist. Component should handle
|
||||
their style changing and store all style params
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
@@ -414,10 +400,50 @@
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "is_child_of"></a>
|
||||
<strong>is_child_of()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Return true, if current component is child of another component
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">bool</span></span>
|
||||
True, if current component is child of another
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "get_name"></a>
|
||||
<strong>get_name()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Return component name
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
||||
The component name
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "setup_component"></a>
|
||||
<strong>setup_component(table, table)</strong>
|
||||
<strong>setup_component(table, table, table)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Setup component context and his style table
|
||||
@@ -433,6 +459,10 @@
|
||||
<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>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
@@ -448,7 +478,7 @@
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Component.create"></a>
|
||||
<strong>Component.create(name, interest)</strong>
|
||||
<strong>Component.create(name[, interest={}])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Create new component. It will inheritance from basic
|
||||
@@ -464,6 +494,7 @@
|
||||
<li><span class="parameter">interest</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
List of component's interest
|
||||
(<em>default</em> {})
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -479,7 +510,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2020-05-04 00:51:46 </i>
|
||||
<i style="float:right;">Last updated 2020-05-09 16:07:15 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@@ -218,7 +218,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2020-05-04 00:51:46 </i>
|
||||
<i style="float:right;">Last updated 2020-05-09 16:07:15 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@@ -237,7 +237,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2020-05-04 00:51:46 </i>
|
||||
<i style="float:right;">Last updated 2020-05-09 16:07:15 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@@ -123,7 +123,7 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Style">Style</a></td>
|
||||
<td class="summary">Component style params</td>
|
||||
<td class="summary">Component style params.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
@@ -382,11 +382,28 @@
|
||||
<strong>Style</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Component style params
|
||||
Component style params.
|
||||
You can override this component styles params in druid styles table
|
||||
or create your own style
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">LONGTAP_TIME</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
Minimum time to trigger on<em>hold</em>callback
|
||||
(<em>default</em> 0.4)
|
||||
</li>
|
||||
<li><span class="parameter">AUTOHOLD_TRIGGER</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
Maximum hold time to trigger button release while holding
|
||||
(<em>default</em> 0.8)
|
||||
</li>
|
||||
<li><span class="parameter">DOUBLETAP_TIME</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
Time between double taps
|
||||
(<em>default</em> 0.4)
|
||||
</li>
|
||||
<li><span class="parameter">on_click</span>
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
(self, node)
|
||||
@@ -399,6 +416,10 @@
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
(self, node, hover_state)
|
||||
</li>
|
||||
<li><span class="parameter">on_mouse_hover</span>
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
(self, node, hover_state)
|
||||
</li>
|
||||
<li><span class="parameter">on_set_enabled</span>
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
(self, node, enabled_state)
|
||||
@@ -417,7 +438,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2020-05-04 00:51:46 </i>
|
||||
<i style="float:right;">Last updated 2020-05-09 16:07:15 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@@ -111,7 +111,7 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Style">Style</a></td>
|
||||
<td class="summary">Component style params</td>
|
||||
<td class="summary">Component style params.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
@@ -257,7 +257,9 @@
|
||||
<strong>Style</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Component style params
|
||||
Component style params.
|
||||
You can override this component styles params in druid styles table
|
||||
or create your own style
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
@@ -280,7 +282,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2020-05-04 00:51:46 </i>
|
||||
<i style="float:right;">Last updated 2020-05-09 16:07:15 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@@ -242,7 +242,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2020-05-04 00:51:46 </i>
|
||||
<i style="float:right;">Last updated 2020-05-09 16:07:15 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@@ -107,7 +107,7 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Style">Style</a></td>
|
||||
<td class="summary">Component style params</td>
|
||||
<td class="summary">Component style params.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
@@ -256,7 +256,9 @@
|
||||
<strong>Style</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Component style params
|
||||
Component style params.
|
||||
You can override this component styles params in druid styles table
|
||||
or create your own style
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
@@ -264,6 +266,7 @@
|
||||
<li><span class="parameter">DRAG_DEADZONE</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
Distance in pixels to start dragging
|
||||
(<em>default</em> 10)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -279,7 +282,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2020-05-04 00:51:46 </i>
|
||||
<i style="float:right;">Last updated 2020-05-09 16:07:15 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@@ -110,7 +110,7 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#clear">clear()</a></td>
|
||||
<td class="summary">Clear all items from the grid</td>
|
||||
<td class="summary">Clear grid nodes array.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Tables">Tables</a></h2>
|
||||
@@ -275,7 +275,8 @@
|
||||
<strong>clear()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Clear all items from the grid
|
||||
Clear grid nodes array. GUI nodes will be not deleted!
|
||||
If you want to delete GUI nodes, use grid.nodes array before grid:clear
|
||||
|
||||
|
||||
|
||||
@@ -373,7 +374,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2020-05-04 00:51:46 </i>
|
||||
<i style="float:right;">Last updated 2020-05-09 16:07:15 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@@ -298,7 +298,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2020-05-04 00:51:46 </i>
|
||||
<i style="float:right;">Last updated 2020-05-09 16:07:15 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@@ -95,6 +95,10 @@
|
||||
<td class="summary">Set hover state</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#set_mouse_hover">set_mouse_hover(state)</a></td>
|
||||
<td class="summary">Set mouse hover state</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#set_click_zone">set_click_zone(zone)</a></td>
|
||||
<td class="summary">Strict hover click area.</td>
|
||||
</tr>
|
||||
@@ -159,6 +163,27 @@
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "set_mouse_hover"></a>
|
||||
<strong>set_mouse_hover(state)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Set mouse hover state
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">state</span>
|
||||
<span class="types"><span class="type">bool</span></span>
|
||||
The mouse hover state
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "set_click_zone"></a>
|
||||
@@ -198,7 +223,11 @@
|
||||
<ul>
|
||||
<li><span class="parameter">on_hover</span>
|
||||
<span class="types"><span class="type">druid_event</span></span>
|
||||
On hover callback
|
||||
On hover callback (Touch pressed)
|
||||
</li>
|
||||
<li><span class="parameter">on_mouse_hover</span>
|
||||
<span class="types"><span class="type">druid_event</span></span>
|
||||
On mouse hover callback (Touch over without action_id)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -214,7 +243,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2020-05-04 00:51:46 </i>
|
||||
<i style="float:right;">Last updated 2020-05-09 16:07:15 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@@ -329,7 +329,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2020-05-04 00:51:46 </i>
|
||||
<i style="float:right;">Last updated 2020-05-09 16:07:15 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@@ -121,7 +121,7 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Style">Style</a></td>
|
||||
<td class="summary">Component style params</td>
|
||||
<td class="summary">Component style params.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
@@ -341,7 +341,9 @@
|
||||
<strong>Style</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Component style params
|
||||
Component style params.
|
||||
You can override this component styles params in druid styles table
|
||||
or create your own style
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
@@ -349,14 +351,12 @@
|
||||
<li><span class="parameter">IS_LONGTAP_ERASE</span>
|
||||
<span class="types"><span class="type">bool</span></span>
|
||||
Is long tap will erase current input data
|
||||
</li>
|
||||
<li><span class="parameter">BUTTON_SELECT_INCREASE</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
Button scale multiplier on selecting input field
|
||||
(<em>default</em> false)
|
||||
</li>
|
||||
<li><span class="parameter">MASK_DEFAULT_CHAR</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
||||
Default character mask for password input
|
||||
(<em>default</em> *)
|
||||
</li>
|
||||
<li><span class="parameter">on_select</span>
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
@@ -370,7 +370,7 @@
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
(self, button_node) Callback on wrong user input
|
||||
</li>
|
||||
<li><span class="parameter">button</span>
|
||||
<li><span class="parameter">button_style</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Custom button style for input node
|
||||
</li>
|
||||
@@ -388,7 +388,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2020-05-04 00:51:46 </i>
|
||||
<i style="float:right;">Last updated 2020-05-09 16:07:15 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@@ -243,7 +243,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2020-05-04 00:51:46 </i>
|
||||
<i style="float:right;">Last updated 2020-05-09 16:07:15 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@@ -125,7 +125,7 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Style">Style</a></td>
|
||||
<td class="summary">Component style params</td>
|
||||
<td class="summary">Component style params.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
@@ -355,7 +355,9 @@
|
||||
<strong>Style</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Component style params
|
||||
Component style params.
|
||||
You can override this component styles params in druid styles table
|
||||
or create your own style
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
@@ -363,10 +365,12 @@
|
||||
<li><span class="parameter">SPEED</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
Progress bas fill rate. More -> faster
|
||||
(<em>default</em> 5)
|
||||
</li>
|
||||
<li><span class="parameter">MIN_DELTA</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
Minimum step to fill progress bar
|
||||
(<em>default</em> 0.005)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -382,7 +386,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2020-05-04 00:51:46 </i>
|
||||
<i style="float:right;">Last updated 2020-05-09 16:07:15 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@@ -242,7 +242,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2020-05-04 00:51:46 </i>
|
||||
<i style="float:right;">Last updated 2020-05-09 16:07:15 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@@ -122,7 +122,7 @@
|
||||
<td class="summary">Return if scroll have inertion.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#set_extra_strech_size">set_extra_strech_size(stretch_size)</a></td>
|
||||
<td class="name" nowrap><a href="#set_extra_strech_size">set_extra_strech_size([stretch_size=0])</a></td>
|
||||
<td class="summary">Set extra size for scroll stretching.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -146,7 +146,7 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Style">Style</a></td>
|
||||
<td class="summary">Component style params</td>
|
||||
<td class="summary">Component style params.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
@@ -369,7 +369,7 @@
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "set_extra_strech_size"></a>
|
||||
<strong>set_extra_strech_size(stretch_size)</strong>
|
||||
<strong>set_extra_strech_size([stretch_size=0])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Set extra size for scroll stretching.
|
||||
@@ -381,6 +381,7 @@
|
||||
<li><span class="parameter">stretch_size</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
Size in pixels of additional scroll area
|
||||
(<em>default</em> 0)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -543,46 +544,57 @@
|
||||
<strong>Style</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Component style params
|
||||
Component style params.
|
||||
You can override this component styles params in druid styles table
|
||||
or create your own style
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">FRICT_HOLD</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
Multiplier for inertion, while touching
|
||||
</li>
|
||||
<li><span class="parameter">FRICT</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
Multiplier for free inertion
|
||||
(<em>default</em> 0)
|
||||
</li>
|
||||
<li><span class="parameter">FRICT_HOLD</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
Multiplier for inertion, while touching
|
||||
(<em>default</em> 0)
|
||||
</li>
|
||||
<li><span class="parameter">INERT_THRESHOLD</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
Scroll speed to stop inertion
|
||||
(<em>default</em> 3)
|
||||
</li>
|
||||
<li><span class="parameter">INERT_SPEED</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
Multiplier for inertion speed
|
||||
(<em>default</em> 30)
|
||||
</li>
|
||||
<li><span class="parameter">POINTS_DEADZONE</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
Speed to check points of interests in no_inertion mode
|
||||
(<em>default</em> 20)
|
||||
</li>
|
||||
<li><span class="parameter">BACK_SPEED</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
Scroll back returning lerp speed
|
||||
(<em>default</em> 0.35)
|
||||
</li>
|
||||
<li><span class="parameter">ANIM_SPEED</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
Scroll gui.animation speed for scroll_to function
|
||||
(<em>default</em> 0.2)
|
||||
</li>
|
||||
<li><span class="parameter">EXTRA_STRECH_SIZE</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
extra size in pixels outside of scroll (stretch effect)
|
||||
(<em>default</em> 0)
|
||||
</li>
|
||||
<li><span class="parameter">SMALL_CONTENT_SCROLL</span>
|
||||
<span class="types"><span class="type">bool</span></span>
|
||||
If true, content node with size less than view node size can be scrolled
|
||||
(<em>default</em> false)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -598,7 +610,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2020-05-04 00:51:46 </i>
|
||||
<i style="float:right;">Last updated 2020-05-09 16:07:15 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@@ -281,7 +281,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2020-05-04 00:51:46 </i>
|
||||
<i style="float:right;">Last updated 2020-05-09 16:07:15 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@@ -106,7 +106,7 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Style">Style</a></td>
|
||||
<td class="summary">Component style params</td>
|
||||
<td class="summary">Component style params.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
@@ -220,7 +220,9 @@
|
||||
<strong>Style</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Component style params
|
||||
Component style params.
|
||||
You can override this component styles params in druid styles table
|
||||
or create your own style
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
@@ -228,14 +230,17 @@
|
||||
<li><span class="parameter">SWIPE_TIME</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
Maximum time for swipe trigger
|
||||
(<em>default</em> 0.4)
|
||||
</li>
|
||||
<li><span class="parameter">SWIPE_THRESHOLD</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
Minimum distance for swipe trigger
|
||||
(<em>default</em> 50)
|
||||
</li>
|
||||
<li><span class="parameter">SWIPE_TRIGGER_ON_MOVE</span>
|
||||
<span class="types"><span class="type">bool</span></span>
|
||||
If true, trigger on swipe moving, not only release action
|
||||
(<em>default</em> false)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -251,7 +256,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2020-05-04 00:51:46 </i>
|
||||
<i style="float:right;">Last updated 2020-05-09 16:07:15 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@@ -407,7 +407,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2020-05-04 00:51:46 </i>
|
||||
<i style="float:right;">Last updated 2020-05-09 16:07:15 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@@ -296,7 +296,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2020-05-04 00:51:46 </i>
|
||||
<i style="float:right;">Last updated 2020-05-09 16:07:15 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@@ -242,7 +242,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2020-05-04 00:51:46 </i>
|
||||
<i style="float:right;">Last updated 2020-05-09 16:07:15 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
@@ -211,6 +211,10 @@
|
||||
<td class="name" nowrap><a href="#druid:new_swipe">druid:new_swipe(...)</a></td>
|
||||
<td class="summary">Create swipe basic component</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#druid:new_drag">druid:new_drag(...)</a></td>
|
||||
<td class="summary">Create drag basic component</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
@@ -874,6 +878,33 @@
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "druid:new_drag"></a>
|
||||
<strong>druid:new_drag(...)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Create drag basic component
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">...</span>
|
||||
<span class="types"><span class="type">args</span></span>
|
||||
drag init args
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">Componetn</span></span>
|
||||
drag component
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -882,7 +913,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2020-05-04 00:51:46 </i>
|
||||
<i style="float:right;">Last updated 2020-05-09 16:07:15 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
Reference in New Issue
Block a user