mirror of
https://github.com/Insality/druid.git
synced 2025-06-27 18:37:44 +02:00
396 lines
11 KiB
HTML
396 lines
11 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_fixed.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/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.drag.html">druid.drag</a></li>
|
|
<li><a href="../modules/druid.grid.html">druid.grid</a></li>
|
|
<li><a href="../modules/druid.hover.html">druid.hover</a></li>
|
|
<li><strong>druid.input</strong></li>
|
|
<li><a href="../modules/druid.lang_text.html">druid.lang_text</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.swipe.html">druid.swipe</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/component.html">component</a></li>
|
|
<li><a href="../modules/druid.html">druid</a></li>
|
|
<li><a href="../modules/druid_event.html">druid_event</a></li>
|
|
<li><a href="../modules/druid.helper.html">druid.helper</a></li>
|
|
<li><a href="../modules/druid_instance.html">druid_instance</a></li>
|
|
</ul>
|
|
<h2>Topics</h2>
|
|
<ul class="">
|
|
<li><a href="../topics/01-components.md.html">01-components</a></li>
|
|
<li><a href="../topics/02-creating_custom_components.md.html">Creating custom components</a></li>
|
|
<li><a href="../topics/03-styles.md.html">Styles</a></li>
|
|
<li><a href="../topics/04-druid_assets.md.html">Druid assets</a></li>
|
|
<li><a href="../topics/05-examples.md.html">Examples</a></li>
|
|
<li><a href="../topics/changelog.md.html">changelog</a></li>
|
|
<li><a href="../topics/README.md.html">README</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
<div id="content">
|
|
|
|
<h1>Module <code>druid.input</code></h1>
|
|
<p>Druid input text component.</p>
|
|
<p> Carry on user text input</p>
|
|
<h3>Info:</h3>
|
|
<ul>
|
|
<li><strong>Author</strong>: Part of code from Britzl gooey input component</li>
|
|
</ul>
|
|
|
|
|
|
<h2><a href="#Functions">Functions</a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap><a href="#set_text">set_text(input_text)</a></td>
|
|
<td class="summary">Set text for input field</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#get_text">get_text()</a></td>
|
|
<td class="summary">Return current input field text</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#set_max_length">set_max_length(max_length)</a></td>
|
|
<td class="summary">Set maximum length for input field.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#set_allowerd_characters">set_allowerd_characters(characters)</a></td>
|
|
<td class="summary">Set allowed charaters for input field.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#reset_changes">reset_changes()</a></td>
|
|
<td class="summary">Reset current input selection and return previous value</td>
|
|
</tr>
|
|
</table>
|
|
<h2><a href="#Tables">Tables</a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap><a href="#Events">Events</a></td>
|
|
<td class="summary">Component events</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#Fields">Fields</a></td>
|
|
<td class="summary">Component fields</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#Style">Style</a></td>
|
|
<td class="summary">Component style params.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br/>
|
|
<br/>
|
|
|
|
|
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
|
|
|
<dl class="function">
|
|
<dt>
|
|
<a name = "set_text"></a>
|
|
<strong>set_text(input_text)</strong>
|
|
</dt>
|
|
<dd>
|
|
Set text for input field
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">input_text</span>
|
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
|
The string to apply for input field
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "get_text"></a>
|
|
<strong>get_text()</strong>
|
|
</dt>
|
|
<dd>
|
|
Return current input field text
|
|
|
|
|
|
|
|
<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 current input field text
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "set_max_length"></a>
|
|
<strong>set_max_length(max_length)</strong>
|
|
</dt>
|
|
<dd>
|
|
Set maximum length for input field.
|
|
Pass nil to make input field unliminted (by default)
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">max_length</span>
|
|
<span class="types"><span class="type">number</span></span>
|
|
Maximum length for input text field
|
|
</li>
|
|
</ul>
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><span class="type">druid.input</span></span>
|
|
Current input instance
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "set_allowerd_characters"></a>
|
|
<strong>set_allowerd_characters(characters)</strong>
|
|
</dt>
|
|
<dd>
|
|
Set allowed charaters for input field.
|
|
See: https://defold.com/ref/stable/string/
|
|
ex: [%a%d] for alpha and numeric
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">characters</span>
|
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
|
Regulax exp. for validate user input
|
|
</li>
|
|
</ul>
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><span class="type">druid.input</span></span>
|
|
Current input instance
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "reset_changes"></a>
|
|
<strong>reset_changes()</strong>
|
|
</dt>
|
|
<dd>
|
|
Reset current input selection and return previous value
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
|
|
|
|
<dl class="function">
|
|
<dt>
|
|
<a name = "Events"></a>
|
|
<strong>Events</strong>
|
|
</dt>
|
|
<dd>
|
|
Component events
|
|
|
|
|
|
<h3>Fields:</h3>
|
|
<ul>
|
|
<li><span class="parameter">on_input_select</span>
|
|
<span class="types"><span class="type">druid_event</span></span>
|
|
(self, button_node) On input field select callback
|
|
</li>
|
|
<li><span class="parameter">on_input_unselect</span>
|
|
<span class="types"><span class="type">druid_event</span></span>
|
|
(self, button_node) On input field unselect callback
|
|
</li>
|
|
<li><span class="parameter">on_input_text</span>
|
|
<span class="types"><span class="type">druid_event</span></span>
|
|
(self, input_text) On input field text change callback
|
|
</li>
|
|
<li><span class="parameter">on_input_empty</span>
|
|
<span class="types"><span class="type">druid_event</span></span>
|
|
(self, input_text) On input field text change to empty string callback
|
|
</li>
|
|
<li><span class="parameter">on_input_full</span>
|
|
<span class="types"><span class="type">druid_event</span></span>
|
|
(self, input_text) On input field text change to max length string callback
|
|
</li>
|
|
<li><span class="parameter">on_input_wrong</span>
|
|
<span class="types"><span class="type">druid_event</span></span>
|
|
(self, params, button_instance) On trying user input with not allowed character callback
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "Fields"></a>
|
|
<strong>Fields</strong>
|
|
</dt>
|
|
<dd>
|
|
Component fields
|
|
|
|
|
|
<h3>Fields:</h3>
|
|
<ul>
|
|
<li><span class="parameter">text</span>
|
|
<span class="types"><span class="type">druid.text</span></span>
|
|
Text component
|
|
</li>
|
|
<li><span class="parameter">button</span>
|
|
<span class="types"><span class="type">druid.button</span></span>
|
|
Button component
|
|
</li>
|
|
<li><span class="parameter">is_selected</span>
|
|
<span class="types"><span class="type">bool</span></span>
|
|
Is current input selected now
|
|
</li>
|
|
<li><span class="parameter">is_empty</span>
|
|
<span class="types"><span class="type">bool</span></span>
|
|
Is current input is empty now
|
|
</li>
|
|
<li><span class="parameter">max_length</span>
|
|
<span class="types"><span class="type">number</span></span>
|
|
Max length for input text
|
|
(<em>optional</em>)
|
|
</li>
|
|
<li><span class="parameter">allowerd_characters</span>
|
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
|
Pattern matching for user input
|
|
(<em>optional</em>)
|
|
</li>
|
|
<li><span class="parameter">keyboard_type</span>
|
|
<span class="types"><span class="type">number</span></span>
|
|
Gui keyboard type for input field
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "Style"></a>
|
|
<strong>Style</strong>
|
|
</dt>
|
|
<dd>
|
|
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">IS_LONGTAP_ERASE</span>
|
|
<span class="types"><span class="type">bool</span></span>
|
|
Is long tap will erase current input data
|
|
(<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>
|
|
(self, button_node) Callback on input field selecting
|
|
</li>
|
|
<li><span class="parameter">on_unselect</span>
|
|
<span class="types"><span class="type">function</span></span>
|
|
(self, button_node) Callback on input field unselecting
|
|
</li>
|
|
<li><span class="parameter">on_input_wrong</span>
|
|
<span class="types"><span class="type">function</span></span>
|
|
(self, button_node) Callback on wrong user input
|
|
</li>
|
|
<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>
|
|
</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 2020-06-14 20:13:02 </i>
|
|
</div> <!-- id="about" -->
|
|
</div> <!-- id="container" -->
|
|
</body>
|
|
</html>
|