Update ldoc

2025-09-27 18:12:19 +02:00 · 2020-04-18 14:39:27 +03:00
parent 668ecff090
commit dd2627c4d2
29 changed files with 894 additions and 56 deletions
--- a/docs/topics/01-components.md.html
+++ b/docs/topics/01-components.md.html
@@ -58,6 +58,7 @@
  <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>
 <h2>Modules</h2>
@@ -279,8 +280,17 @@ Key is value from druid const: const.SIDE.X (or just "x") or const.SIDE.Y (or ju
 <p>Basic Druid text input component (unimplemented)</p>

 <h3>Setup</h3>
+<p>Create input component with druid: <code>input = druid:new_input(button_node_name, text_node_name, keyboard_type)</code></p>

 <h3>Notes</h3>
+<p>- Input component handle user text input. Input contains from button and text components. Button needed for selecting/unselecting input field
+- Long click on input field for clear and select input field (clearing can be disable via styles)
+- Click outside of button to unselect input field
+- On focus lost (game minimized) input field will be unselected
+- You can setup max length of the text
+- You can setup allowed characters. On add not allowed characters <code>on_input_wrong</code> will be called. By default it cause simple shake animation
+- The keyboard for input will not show on mobile HTML5. So input field in mobile HTML5 is not working now
+- To make work different keyboard type, make sure value in game.project Android:InputMethod set to HidderInputField (https://defold.com/manuals/project-settings/#input-method)</p>


 <p><a name="Checkbox"></a></p>
@@ -402,7 +412,7 @@ Key is value from druid const: const.SIDE.X (or just "x") or const.SIDE.Y (or ju
 </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-04-17 20:13:54 </i>
+<i style="float:right;">Last updated 2020-04-18 14:39:17 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>
--- a/docs/topics/02-creating_custom_components.md.html
+++ b/docs/topics/02-creating_custom_components.md.html
@@ -46,6 +46,7 @@
  <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>
 <h2>Modules</h2>
@@ -115,8 +116,8 @@
 </span><span class="keyword">function</span> M.on_message(self, message_id, message, sender)
 <span class="keyword">end</span>

-<span class="comment">-- Call only if component with ON_CHANGE_LANGUAGE interest
-</span><span class="keyword">function</span> M.on_change_language(self)
+<span class="comment">-- Call only if component with ON_LANGUAGE_CHANGE interest
+</span><span class="keyword">function</span> M.on_language_change(self)
 <span class="keyword">end</span>

 <span class="comment">-- Call only if component with ON_LAYOUT_CHANGE interest
@@ -128,6 +129,14 @@
 </span><span class="keyword">function</span> M.on_input_interrupt(self)
 <span class="keyword">end</span>

+<span class="comment">-- Call, if game lost focus. Need ON_FOCUS_LOST intereset
+</span><span class="keyword">function</span> M.on_focus_lost(self)
+<span class="keyword">end</span>
+
+<span class="comment">-- Call, if game gained focus. Need ON_FOCUS_GAINED intereset
+</span><span class="keyword">function</span> M.on_focus_gained(self)
+<span class="keyword">end</span>
+
 <span class="comment">-- Call on component remove or on druid:final
 </span><span class="keyword">function</span> M.on_remove(self)
 <span class="keyword">end</span>
@@ -178,11 +187,12 @@ There is next interests in druid:
    <li><p><strong>ON_UPDATE</strong> - component will be updated from update</p></li>
    <li><p><strong>ON<em>INPUT</em>HIGH</strong> - component will receive input from on<em>input, before other components with ON</em>INPUT</p></li>
    <li><p><strong>ON_INPUT</strong> - component will receive input from on<em>input, after other components with ON</em>INPUT_HIGH</p></li>
-    <li><p><strong>ON<em>CHANGE</em>LANGUAGE</strong> - will call <em>on</em>change<em>language</em> function on language change trigger</p></li>
-    <li><p><strong>ON<em>LAYOUT</em>CHANGED</strong> will call <em>on</em>layout<em>change</em> function on layout change trigger</p></li>
+    <li><p><strong>ON<em>LANGUAGE</em>CHANGE</strong> - will call <em>on</em>language<em>change</em> function on language change trigger</p></li>
+    <li><p><strong>ON<em>LAYOUT</em>CHANGE</strong> will call <em>on</em>layout<em>change</em> function on layout change trigger</p></li>
+    <li><p><strong>ON<em>FOCUS</em>LOST</strong> will call <em>on</em>focust<em>lost</em> function in on focus lost event. You need to pass window_callback to global <a href="../modules/druid.html#on_window_callback">druid:on_window_callback</a></p></li>
+    <li><p><strong>ON<em>FOCUS</em>GAINED</strong> will call <em>on</em>focust<em>gained</em> function in on focus gained event. You need to pass window_callback to global <a href="../modules/druid.html#on_window_callback">druid:on_window_callback</a></p></li>
 </ul>

-
 <p><a name="Best_practice_on_custom_components"></a></p>
 <h2>Best practice on custom components</h2>
 <p>On each component recommended describe component scheme in next way:</p>
@@ -234,7 +244,7 @@ There is next interests in druid:
 </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-04-17 20:13:54 </i>
+<i style="float:right;">Last updated 2020-04-18 14:39:17 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>
--- a/docs/topics/03-styles.md.html
+++ b/docs/topics/03-styles.md.html
@@ -34,7 +34,6 @@
 <ul>
 <li><a href="#Overview">Overview </a></li>
 <li><a href="#Usage">Usage </a></li>
-<li><a href="#Create_custom_components">Create custom components </a></li>
 </ul>


@@ -45,6 +44,7 @@
  <li><strong>Styles</strong></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>
 <h2>Modules</h2>
@@ -89,7 +89,7 @@

 <p><a name="Usage"></a></p>
 <h2>Usage</h2>
-<p>Setup default druid style for all druid instances via <code>druid.set_default_style</code></p>
+<p>Setup default druid style for all druid instances via <a href="../modules/druid.html#set_default_style">druid.set_default_style</a></p>

 <pre>
 <span class="keyword">local</span> druid = <span class="global">require</span>(<span class="string">"druid.druid"</span>)
@@ -129,17 +129,12 @@
 </pre>


-<p><a name="Create_custom_components"></a></p>
-<h2>Create custom components</h2>
-<p>Styles is just lua table, so it can be described in just one single file
-<strong>TODO</strong></p>
-

 </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-04-17 20:13:54 </i>
+<i style="float:right;">Last updated 2020-04-18 14:39:17 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>
--- a/docs/topics/04-druid_assets.md.html
+++ b/docs/topics/04-druid_assets.md.html
@@ -43,6 +43,7 @@
  <li><a href="../topics/03-styles.md.html">Styles</a></li>
  <li><strong>Druid assets</strong></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>
 <h2>Modules</h2>
@@ -90,7 +91,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-04-17 20:13:54 </i>
+<i style="float:right;">Last updated 2020-04-18 14:39:17 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>
--- a/docs/topics/05-examples.md.html
+++ b/docs/topics/05-examples.md.html
@@ -43,6 +43,7 @@
  <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><strong>Examples</strong></li>
+  <li><a href="../topics/changelog.md.html">changelog</a></li>
  <li><a href="../topics/README.md.html">README</a></li>
 </ul>
 <h2>Modules</h2>
@@ -88,7 +89,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-04-17 20:13:54 </i>
+<i style="float:right;">Last updated 2020-04-18 14:39:17 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>
--- a/docs/topics/README.md.html
+++ b/docs/topics/README.md.html
@@ -53,6 +53,7 @@
  <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><strong>README</strong></li>
 </ul>
 <h2>Modules</h2>
@@ -110,11 +111,14 @@

 <ul>
    <li>Mouse trigger - <code>Button 1</code> -> <code>touch</code> <em>For basic input components</em></li>
-    <li>Key trigger - <code>Backspace</code> -> <code>back</code>  <em>For back</em>handler component_</li>
-    <li>Key trigger - <code>Back</code> -> <code>back</code>  <em>For back</em>handler component, Android back button_</li>
+    <li>Key trigger - <code>Backspace</code> -> <code>key_backspace</code>  <em>For back</em>handler component, input component_</li>
+    <li>Key trigger - <code>Back</code> -> <code>key_back</code>  <em>For back</em>handler component, Android back button, input component_</li>
+    <li>Key trigger - <code>Enter</code> -> <code>key_enter</code> <em>For input component, optional</em></li>
+    <li>Key trigger - <code>Esc</code> -> <code>key_esc</code> <em>For input component, optional</em></li>
 </ul>

-<p><img src="media/input_binding.png" alt=""/></p>
+<p><img src="media/input_binding_2.png" alt=""/>
+<img src="media/input_binding_1.png" alt=""/></p>


 <h3>Input capturing [optional]</h3>
@@ -144,6 +148,18 @@

 <span class="comment">-- Used for change default druid style
 </span>druid.set_default_style(your_style)
+
+<span class="comment">-- Call this function on language changing in the game,
+</span><span class="comment">-- to retranslate all lang_text components:
+</span>druid.on_languge_change()
+
+<span class="comment">-- Call this function on layout changing in the game,
+</span><span class="comment">-- to reapply layouts
+</span>druid.on_layout_change()
+
+<span class="comment">-- Call this function inside window.set_listener
+</span><span class="comment">-- to catch game focus lost/gained callbacks:
+</span>druid.on_window_callback(event)
 </pre>


@@ -192,11 +208,15 @@
    <span class="global">print</span>(<span class="string">"Button was clicked!"</span>)
 <span class="keyword">end</span>

-<span class="keyword">local</span> <span class="keyword">function</span> init(self)
+<span class="keyword">function</span> init(self)
    self.druid = druid.new(self)
    self.druid:new_button(<span class="string">"button_node_name"</span>, button_callback)
 <span class="keyword">end</span>

+<span class="keyword">function</span> final(self)
+    self.druid:final()
+<span class="keyword">end</span>
+
 <span class="keyword">function</span> on_input(self, action_id, action)
    <span class="keyword">return</span> self.druid:on_input(action_id, action)
 <span class="keyword">end</span>
@@ -316,7 +336,7 @@ https://insality.github.io/druid/</p>
 </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-04-17 20:13:54 </i>
+<i style="float:right;">Last updated 2020-04-18 14:39:17 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>
--- a/docs/topics/changelog.md.html
+++ b/docs/topics/changelog.md.html
@@ -0,0 +1,132 @@
+<!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>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><strong>changelog</strong></li>
+  <li><a href="../topics/README.md.html">README</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.hover.html">druid.hover</a></li>
+  <li><a href="../modules/druid.input.html">druid.input</a></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>
+
+</div>
+
+<div id="content">
+
+
+<p>Druid 0.3.0:</p>
+
+<ul>
+    <li><p><code>Druid:final</code> now is important function for correct working</p></li>
+    <li><p>Add <em>swipe</em> basic component</p>
+
+<pre>
+- Swipe component handle simple swipe gestures on node. It has single callback with direction on swipe. You can adjust a several parameters of swipe <span class="keyword">in</span> druid style.
+- Swipe can be triggered on action.released <span class="keyword">or</span> <span class="keyword">while</span> user is make swiping (<span class="keyword">in</span> process)
+- Add swipe example at main Druid example. Try swipe left/right to switch example pages.
+</pre>
+</li>
+    <li><p>Add <em>input</em> basic component</p>
+
+<pre>
+- Input component handle user text input. Input contains from button <span class="keyword">and</span> text components. Button needed <span class="keyword">for</span> selecting/unselecting input field
+- Long click on input field <span class="keyword">for</span> clear <span class="keyword">and</span> <span class="global">select</span> input field (clearing can be disable via styles)
+- Click outside of button to unselect input field
+- On focus lost (game minimized) input field will be unselected
+- You can setup max length of the text
+- You can setup allowed characters. On add <span class="keyword">not</span> allowed characters <span class="backtick"><code>on_input_wrong</code></span> will be called. By default it cause simple shake animation
+- The keyboard <span class="keyword">for</span> input will <span class="keyword">not</span> show on mobile HTML5. So input field <span class="keyword">in</span> mobile HTML5 is <span class="keyword">not</span> working now
+- To make work different keyboard <span class="global">type</span>, make sure value <span class="keyword">in</span> game.project Android:InputMethod set to HidderInputField (https://defold.com/manuals/project-settings/#input-method)
+</pre>
+</li>
+    <li><p>Add button on<em>click</em>outside event. You can subscribe on this event in button. Was needed for Input component (click outside to deselect input field).</p></li>
+    <li><p>Add start_pos to button component</p></li>
+    <li><p>Changed input binding settings. Add backspace, enter, text and marked_text. Backspace now is different from android back button.</p></li>
+    <li><p>Renamed on<em>change</em>language -> on<em>language</em>change component interest</p></li>
+    <li><p>Add basic component two functions: <code>increase_input_priority</code> and <code>reset_input_priority</code>. It used to process component input first in current input stack (there is two input stacks: INPUT and INPUT_HIGH). Example: on selecting input field, it increase input self priority until it be unselected</p></li>
+    <li><p>Add two new component interests: <code>on_focus_gain</code> and <code>on_focus_lost</code></p></li>
+    <li><p>Add global druid events:</p>
+
+<pre>
+- on_window_callback: call <span class="backtick"><code>druid.on_window_callback(event)</code></span> <span class="keyword">for</span> on_focus_gain/lost correct work
+- on_language_change: call <span class="backtick"><code>druid.on_language_change()</code></span> (#<span class="number">38</span>) <span class="keyword">for</span> update all druid instances lang components
+- on_layout_change: call <span class="backtick"><code>druid.on_layout_change()</code></span> (#<span class="number">37</span>) <span class="keyword">for</span> update all gui layouts (unimplemented now)
+</pre>
+</li>
+    <li><p>Add several examples to druid-assets respository</p></li>
+    <li><p>Known issues:</p>
+
+<pre>
+- Adjusting text size by height works wrong. Adjusting single line texting works fine
+</pre>
+</li>
+</ul>
+
+
+</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-04-18 14:39:17 </i>
+</div> <!-- id="about" -->
+</div> <!-- id="container" -->
+</body>
+</html>