Partydeck/Druid-Extension
3
0
Fork 0
mirror of https://github.com/Insality/druid synced 2025-09-27 18:12:21 +02:00
Code Issues Packages Projects Releases Wiki Activity

Annotations update

Browse Source
This commit is contained in:
Insality
2023-10-17 21:09:45 +03:00
parent 7fc76ed8c0
commit 86b92f90a7
56 changed files with 540 additions and 574 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
docs/modules/DruidInstance.html
View File

@@ -178,7 +178,7 @@ end
<td class="summary">Create <a href="../modules/DynamicGrid.html#">DynamicGrid</a> component</td>
</tr>
<tr>
<td class="name" nowrap><a href="#new_hotkey">new_hotkey(self, keys_array, callback[, params])</a></td>
<td class="name" nowrap><a href="#new_hotkey">new_hotkey(self, keys_array, callback[, callback_argument])</a></td>
<td class="summary">Create <a href="../modules/Hotkey.html#">Hotkey</a> component</td>
</tr>
<tr>
@@ -302,11 +302,11 @@ end
</li>
<li><span class="parameter">component</span>
<span class="types"><span class="type">Component</span></span>
<span class="types"><span class="type">BaseComponent</span></span>
Component module
</li>
<li><span class="parameter">...</span>
<span class="types"><span class="type">args</span></span>
<span class="types"><span class="type">any</span></span>
Other component params to pass it to component:init function
</li>
</ul>
@@ -331,8 +331,8 @@ end
</li>
<li><span class="parameter">callback</span>
<span class="types"><span class="type">callback</span></span>
On back button
<span class="types"><span class="type">function</span></span>
@The callback(self, custom_args) to call on back event
</li>
<li><span class="parameter">params</span>
<span class="types"><span class="type">any</span></span>
@@ -532,8 +532,8 @@ end
The Scroll instance for Data List component
</li>
<li><span class="parameter">druid_grid</span>
<span class="types"><span class="type">Grid</span></span>
The Grid instance for Data List component
<span class="types"><span class="type">StaticGrid</span> or <span class="type">DynamicGrid</span></span>
The <a href="../modules/StaticGrid.html#">StaticGrid</a> or <a href="../modules/DynamicGrid.html#">DynamicGrid</a> instance for Data List component
</li>
<li><span class="parameter">create_function</span>
<span class="types"><span class="type">function</span></span>
@@ -620,7 +620,7 @@ end
</dd>
<dt>
<a name = "new_hotkey"></a>
<strong>new_hotkey(self, keys_array, callback[, params])</strong>
<strong>new_hotkey(self, keys_array, callback[, callback_argument])</strong>
</dt>
<dd>
Create <a href="../modules/Hotkey.html#">Hotkey</a> component
@@ -638,11 +638,11 @@ end
</li>
<li><span class="parameter">callback</span>
<span class="types"><span class="type">function</span></span>
Button callback
The callback function
</li>
<li><span class="parameter">params</span>
<span class="types"><span class="type">value</span></span>
Button callback params
<li><span class="parameter">callback_argument</span>
<span class="types"><span class="type">any</span></span>
The argument to pass into the callback function
(<em>optional</em>)
</li>
</ul>
@@ -756,7 +756,7 @@ end
Default locale id
</li>
<li><span class="parameter">no_adjust</span>
<span class="types"><span class="type">bool</span></span>
<span class="types"><span class="type">boolean</span></span>
If true, will not correct text size
</li>
</ul>
@@ -1099,7 +1099,7 @@ end
(<em>optional</em>)
</li>
<li><span class="parameter">no_adjust</span>
<span class="types"><span class="type">bool</span></span>
<span class="types"><span class="type">boolean</span></span>
If true, text will be not auto-adjust size
(<em>optional</em>)
</li>
@@ -1189,7 +1189,7 @@ end
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<span class="types"><span class="type">boolean</span></span>
The boolean value is input was consumed
</ol>
@@ -1247,7 +1247,7 @@ end
</li>
<li><span class="parameter">component</span>
<span class="types"><span class="type">Component</span></span>
<span class="types"><span class="type">BaseComponent</span></span>
Component instance
</li>
</ul>
@@ -1274,7 +1274,7 @@ end
<a href="../modules/DruidInstance.html#">DruidInstance</a>
</li>
<li><span class="parameter">blacklist_components</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a> or <span class="type">Component</span></span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a> or <span class="type">BaseComponent</span></span>
The array of component to blacklist
(<em>default</em> nil)
</li>
@@ -1308,7 +1308,7 @@ end
</li>
<li><span class="parameter">whitelist_components</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a> or <span class="type">Component</span></span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a> or <span class="type">BaseComponent</span></span>
The array of component to whitelist
(<em>default</em> nil)
</li>