diff options
| author | Robert Jaros <rjaros@finn.pl> | 2018-10-21 23:59:34 +0200 |
|---|---|---|
| committer | Robert Jaros <rjaros@finn.pl> | 2018-10-21 23:59:34 +0200 |
| commit | 7c2850063697f94a0d8b8d8f8588136dd4b3d05e (patch) | |
| tree | d36036066bd3ef3f3e034c6dfc1e4283b1e69ece /api/kvision/pl.treksoft.kvision.dropdown/-context-menu | |
| parent | a70acf853de62d0754ca95aa4103712b82afdef8 (diff) | |
| download | kvision-7c2850063697f94a0d8b8d8f8588136dd4b3d05e.tar.gz kvision-7c2850063697f94a0d8b8d8f8588136dd4b3d05e.tar.bz2 kvision-7c2850063697f94a0d8b8d8f8588136dd4b3d05e.zip | |
API documentation for KVision 0.0.19
Diffstat (limited to 'api/kvision/pl.treksoft.kvision.dropdown/-context-menu')
4 files changed, 173 insertions, 0 deletions
diff --git a/api/kvision/pl.treksoft.kvision.dropdown/-context-menu/-init-.html b/api/kvision/pl.treksoft.kvision.dropdown/-context-menu/-init-.html new file mode 100644 index 00000000..7a456e63 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.dropdown/-context-menu/-init-.html @@ -0,0 +1,19 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>ContextMenu.<init> - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.dropdown</a> / <a href="index.html">ContextMenu</a> / <a href="./-init-.html"><init></a><br/> +<br/> +<h1><init></h1> +<a name="pl.treksoft.kvision.dropdown.ContextMenu$<init>(kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.dropdown.ContextMenu, kotlin.Unit)))"></a> +<code><span class="identifier">ContextMenu</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.dropdown.ContextMenu$<init>(kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.dropdown.ContextMenu, kotlin.Unit)))/classes">classes</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html"><span class="identifier">Set</span></a><span class="symbol"><</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">></span> <span class="symbol">=</span> setOf()<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.dropdown.ContextMenu$<init>(kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.dropdown.ContextMenu, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <a href="index.html"><span class="identifier">ContextMenu</span></a><span class="symbol">.</span><span class="symbol">(</span><span class="symbol">)</span> <span class="symbol">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a> <span class="symbol">=</span> null<span class="symbol">)</span></code> +<h3>Parameters</h3> +<p><a name="classes"></a> +<code>classes</code> - a set of CSS class names</p> +<p><strong>Constructor</strong><br/> +</p> +</BODY> +</HTML> diff --git a/api/kvision/pl.treksoft.kvision.dropdown/-context-menu/context-menu.html b/api/kvision/pl.treksoft.kvision.dropdown/-context-menu/context-menu.html new file mode 100644 index 00000000..8b896973 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.dropdown/-context-menu/context-menu.html @@ -0,0 +1,16 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>ContextMenu.contextMenu - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.dropdown</a> / <a href="index.html">ContextMenu</a> / <a href="./context-menu.html">contextMenu</a><br/> +<br/> +<h1>contextMenu</h1> +<a name="pl.treksoft.kvision.dropdown.ContextMenu.Companion$contextMenu(pl.treksoft.kvision.core.Widget, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.dropdown.ContextMenu, kotlin.Unit)))"></a> +<code><span class="keyword">fun </span><a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a><span class="symbol">.</span><span class="identifier">contextMenu</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.dropdown.ContextMenu.Companion$contextMenu(pl.treksoft.kvision.core.Widget, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.dropdown.ContextMenu, kotlin.Unit)))/classes">classes</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html"><span class="identifier">Set</span></a><span class="symbol"><</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">></span> <span class="symbol">=</span> setOf()<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.dropdown.ContextMenu.Companion$contextMenu(pl.treksoft.kvision.core.Widget, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.dropdown.ContextMenu, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <a href="index.html"><span class="identifier">ContextMenu</span></a><span class="symbol">.</span><span class="symbol">(</span><span class="symbol">)</span> <span class="symbol">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a> <span class="symbol">=</span> null<span class="symbol">)</span><span class="symbol">: </span><a href="index.html"><span class="identifier">ContextMenu</span></a></code> +<p>DSL builder extension function.</p> +<p>It takes the same parameters as the constructor of the built component.</p> +</BODY> +</HTML> diff --git a/api/kvision/pl.treksoft.kvision.dropdown/-context-menu/index.html b/api/kvision/pl.treksoft.kvision.dropdown/-context-menu/index.html new file mode 100644 index 00000000..2c9823f1 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.dropdown/-context-menu/index.html @@ -0,0 +1,118 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>ContextMenu - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.dropdown</a> / <a href="./index.html">ContextMenu</a><br/> +<br/> +<h1>ContextMenu</h1> +<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">ContextMenu</span> <span class="symbol">:</span> <a href="../../pl.treksoft.kvision.html/-list-tag/index.html"><span class="identifier">ListTag</span></a></code> +<p>Context menu component.</p> +<h3>Constructors</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="-init-.html"><init></a></p> +</td> +<td> +<code><span class="identifier">ContextMenu</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.dropdown.ContextMenu$<init>(kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.dropdown.ContextMenu, kotlin.Unit)))/classes">classes</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html"><span class="identifier">Set</span></a><span class="symbol"><</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">></span> <span class="symbol">=</span> setOf()<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.dropdown.ContextMenu$<init>(kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.dropdown.ContextMenu, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <a href="./index.html"><span class="identifier">ContextMenu</span></a><span class="symbol">.</span><span class="symbol">(</span><span class="symbol">)</span> <span class="symbol">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a> <span class="symbol">=</span> null<span class="symbol">)</span></code></td> +</tr> +</tbody> +</table> +<h3>Inherited Properties</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.html/-list-tag/elements.html">elements</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">elements</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol"><</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">></span><span class="symbol">?</span></code> +<p>List of elements.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.html/-list-tag/rich.html">rich</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">rich</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a></code> +<p>Determines if <a href="../../pl.treksoft.kvision.html/-list-tag/elements.html">elements</a> can contain HTML code.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.html/-list-tag/type.html">type</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">type</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.html/-list-type/index.html"><span class="identifier">ListType</span></a></code> +<p>List type.</p> +</td> +</tr> +</tbody> +</table> +<h3>Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="position-menu.html">positionMenu</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">positionMenu</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.dropdown.ContextMenu$positionMenu(org.w3c.dom.events.MouseEvent)/mouseEvent">mouseEvent</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom.events/-mouse-event/index.html"><span class="identifier">MouseEvent</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="./index.html"><span class="identifier">ContextMenu</span></a></code> +<p>Positions and shows a context menu based on a mouse event.</p> +</td> +</tr> +</tbody> +</table> +<h3>Inherited Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.html/-list-tag/children-v-nodes.html">childrenVNodes</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">childrenVNodes</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html"><span class="identifier">Array</span></a><span class="symbol"><</span><span class="identifier">VNode</span><span class="symbol">></span></code> +<p>Returns the array of the children Snabbdom vnodes.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.html/-list-tag/get-sn-class.html">getSnClass</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">getSnClass</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol"><</span><a href="../../pl.treksoft.kvision.core/-string-bool-pair.html"><span class="identifier">StringBoolPair</span></a><span class="symbol">></span></code> +<p>Returns list of CSS class names for current widget in the form of a List.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.html/-list-tag/render.html">render</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">render</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">VNode</span></code> +<p>Renders current component as a Snabbdom vnode.</p> +</td> +</tr> +</tbody> +</table> +<h3>Companion Object Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="context-menu.html">contextMenu</a></p> +</td> +<td> +<code><span class="keyword">fun </span><a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a><span class="symbol">.</span><span class="identifier">contextMenu</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.dropdown.ContextMenu.Companion$contextMenu(pl.treksoft.kvision.core.Widget, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.dropdown.ContextMenu, kotlin.Unit)))/classes">classes</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html"><span class="identifier">Set</span></a><span class="symbol"><</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">></span> <span class="symbol">=</span> setOf()<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.dropdown.ContextMenu.Companion$contextMenu(pl.treksoft.kvision.core.Widget, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.dropdown.ContextMenu, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <a href="./index.html"><span class="identifier">ContextMenu</span></a><span class="symbol">.</span><span class="symbol">(</span><span class="symbol">)</span> <span class="symbol">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a> <span class="symbol">=</span> null<span class="symbol">)</span><span class="symbol">: </span><a href="./index.html"><span class="identifier">ContextMenu</span></a></code> +<p>DSL builder extension function.</p> +</td> +</tr> +</tbody> +</table> +</BODY> +</HTML> diff --git a/api/kvision/pl.treksoft.kvision.dropdown/-context-menu/position-menu.html b/api/kvision/pl.treksoft.kvision.dropdown/-context-menu/position-menu.html new file mode 100644 index 00000000..ded70c2c --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.dropdown/-context-menu/position-menu.html @@ -0,0 +1,20 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>ContextMenu.positionMenu - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.dropdown</a> / <a href="index.html">ContextMenu</a> / <a href="./position-menu.html">positionMenu</a><br/> +<br/> +<h1>positionMenu</h1> +<a name="pl.treksoft.kvision.dropdown.ContextMenu$positionMenu(org.w3c.dom.events.MouseEvent)"></a> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">positionMenu</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.dropdown.ContextMenu$positionMenu(org.w3c.dom.events.MouseEvent)/mouseEvent">mouseEvent</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom.events/-mouse-event/index.html"><span class="identifier">MouseEvent</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="index.html"><span class="identifier">ContextMenu</span></a></code> +<p>Positions and shows a context menu based on a mouse event.</p> +<h3>Parameters</h3> +<p><a name="mouseEvent"></a> +<code>mouseEvent</code> - mouse event</p> +<p><strong>Return</strong><br/> +current context menu</p> +</BODY> +</HTML> |