diff options
| author | Robert Jaros <rjaros@finn.pl> | 2018-02-09 13:40:35 +0100 |
|---|---|---|
| committer | Robert Jaros <rjaros@finn.pl> | 2018-02-09 13:40:35 +0100 |
| commit | d8cd67062b8de6e8398dc6dfd00d201200c82414 (patch) | |
| tree | 601082ec1eec73bc7a7d6ce8b51352e5345ffe81 /docs/api/pl.treksoft.kvision.html/-link | |
| parent | 955304789ea83aceacbdf4c8a9eb742f6c2518f6 (diff) | |
| download | kvision-d8cd67062b8de6e8398dc6dfd00d201200c82414.tar.gz kvision-d8cd67062b8de6e8398dc6dfd00d201200c82414.tar.bz2 kvision-d8cd67062b8de6e8398dc6dfd00d201200c82414.zip | |
API doc and readme
Diffstat (limited to 'docs/api/pl.treksoft.kvision.html/-link')
| -rw-r--r-- | docs/api/pl.treksoft.kvision.html/-link/-init-.html | 27 | ||||
| -rw-r--r-- | docs/api/pl.treksoft.kvision.html/-link/get-sn-attrs.html | 18 | ||||
| -rw-r--r-- | docs/api/pl.treksoft.kvision.html/-link/icon.html | 15 | ||||
| -rw-r--r-- | docs/api/pl.treksoft.kvision.html/-link/image.html | 15 | ||||
| -rw-r--r-- | docs/api/pl.treksoft.kvision.html/-link/index.html | 158 | ||||
| -rw-r--r-- | docs/api/pl.treksoft.kvision.html/-link/label.html | 15 | ||||
| -rw-r--r-- | docs/api/pl.treksoft.kvision.html/-link/render.html | 18 | ||||
| -rw-r--r-- | docs/api/pl.treksoft.kvision.html/-link/url.html | 15 |
8 files changed, 281 insertions, 0 deletions
diff --git a/docs/api/pl.treksoft.kvision.html/-link/-init-.html b/docs/api/pl.treksoft.kvision.html/-link/-init-.html new file mode 100644 index 00000000..25d0fc1e --- /dev/null +++ b/docs/api/pl.treksoft.kvision.html/-link/-init-.html @@ -0,0 +1,27 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Link.<init> - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.html</a> / <a href="index.html">Link</a> / <a href="./-init-.html"><init></a><br/> +<br/> +<h1><init></h1> +<a name="pl.treksoft.kvision.html.Link$<init>(kotlin.String, kotlin.String, kotlin.String, kotlin.String, kotlin.collections.Set((kotlin.String)))"></a> +<code><span class="identifier">Link</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.html.Link$<init>(kotlin.String, kotlin.String, kotlin.String, kotlin.String, kotlin.collections.Set((kotlin.String)))/label">label</span><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="identifier" id="pl.treksoft.kvision.html.Link$<init>(kotlin.String, kotlin.String, kotlin.String, kotlin.String, kotlin.collections.Set((kotlin.String)))/url">url</span><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="identifier" id="pl.treksoft.kvision.html.Link$<init>(kotlin.String, kotlin.String, kotlin.String, kotlin.String, kotlin.collections.Set((kotlin.String)))/icon">icon</span><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> null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.html.Link$<init>(kotlin.String, kotlin.String, kotlin.String, kotlin.String, kotlin.collections.Set((kotlin.String)))/image">image</span><span class="symbol">:</span> <a href="../../pl.treksoft.kvision.core/-res-string.html"><span class="identifier">ResString</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.html.Link$<init>(kotlin.String, kotlin.String, kotlin.String, kotlin.String, kotlin.collections.Set((kotlin.String)))/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></code> +<h3>Parameters</h3> +<p><a name="label"></a> +<code>label</code> - link label</p> +<p><a name="url"></a> +<code>url</code> - link URL address</p> +<p><a name="icon"></a> +<code>icon</code> - link icon</p> +<p><a name="image"></a> +<code>image</code> - link image</p> +<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/docs/api/pl.treksoft.kvision.html/-link/get-sn-attrs.html b/docs/api/pl.treksoft.kvision.html/-link/get-sn-attrs.html new file mode 100644 index 00000000..2adbd0fe --- /dev/null +++ b/docs/api/pl.treksoft.kvision.html/-link/get-sn-attrs.html @@ -0,0 +1,18 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Link.getSnAttrs - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.html</a> / <a href="index.html">Link</a> / <a href="./get-sn-attrs.html">getSnAttrs</a><br/> +<br/> +<h1>getSnAttrs</h1> +<a name="pl.treksoft.kvision.html.Link$getSnAttrs()"></a> +<code><span class="keyword">protected</span> <span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">getSnAttrs</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-pair.html"><span class="identifier">StringPair</span></a><span class="symbol">></span></code> +<p>Overrides <a href="../../pl.treksoft.kvision.core/-widget/get-sn-attrs.html">Widget.getSnAttrs</a></p> +<p>Returns list of element attributes in the form of a List.</p> +<p><strong>Return</strong><br/> +list of element attributes</p> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.html/-link/icon.html b/docs/api/pl.treksoft.kvision.html/-link/icon.html new file mode 100644 index 00000000..e566b959 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.html/-link/icon.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Link.icon - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.html</a> / <a href="index.html">Link</a> / <a href="./icon.html">icon</a><br/> +<br/> +<h1>icon</h1> +<a name="pl.treksoft.kvision.html.Link$icon"></a> +<code><span class="keyword">var </span><span class="identifier">icon</span><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></code> +<p>Link icon.</p> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.html/-link/image.html b/docs/api/pl.treksoft.kvision.html/-link/image.html new file mode 100644 index 00000000..81612fb2 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.html/-link/image.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Link.image - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.html</a> / <a href="index.html">Link</a> / <a href="./image.html">image</a><br/> +<br/> +<h1>image</h1> +<a name="pl.treksoft.kvision.html.Link$image"></a> +<code><span class="keyword">var </span><span class="identifier">image</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.core/-res-string.html"><span class="identifier">ResString</span></a><span class="symbol">?</span></code> +<p>Link image.</p> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.html/-link/index.html b/docs/api/pl.treksoft.kvision.html/-link/index.html new file mode 100644 index 00000000..427355c4 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.html/-link/index.html @@ -0,0 +1,158 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Link - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.html</a> / <a href="./index.html">Link</a><br/> +<br/> +<h1>Link</h1> +<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">Link</span> <span class="symbol">:</span> <a href="../../pl.treksoft.kvision.panel/-simple-panel/index.html"><span class="identifier">SimplePanel</span></a></code> +<p>Link component.</p> +<h3>Constructors</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="-init-.html"><init></a></p> +</td> +<td> +<code><span class="identifier">Link</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.html.Link$<init>(kotlin.String, kotlin.String, kotlin.String, kotlin.String, kotlin.collections.Set((kotlin.String)))/label">label</span><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="identifier" id="pl.treksoft.kvision.html.Link$<init>(kotlin.String, kotlin.String, kotlin.String, kotlin.String, kotlin.collections.Set((kotlin.String)))/url">url</span><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="identifier" id="pl.treksoft.kvision.html.Link$<init>(kotlin.String, kotlin.String, kotlin.String, kotlin.String, kotlin.collections.Set((kotlin.String)))/icon">icon</span><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> null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.html.Link$<init>(kotlin.String, kotlin.String, kotlin.String, kotlin.String, kotlin.collections.Set((kotlin.String)))/image">image</span><span class="symbol">:</span> <a href="../../pl.treksoft.kvision.core/-res-string.html"><span class="identifier">ResString</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.html.Link$<init>(kotlin.String, kotlin.String, kotlin.String, kotlin.String, kotlin.collections.Set((kotlin.String)))/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></code></td> +</tr> +</tbody> +</table> +<h3>Properties</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="icon.html">icon</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">icon</span><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></code> +<p>Link icon.</p> +</td> +</tr> +<tr> +<td> +<p><a href="image.html">image</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">image</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.core/-res-string.html"><span class="identifier">ResString</span></a><span class="symbol">?</span></code> +<p>Link image.</p> +</td> +</tr> +<tr> +<td> +<p><a href="label.html">label</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">label</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code> +<p>Link label.</p> +</td> +</tr> +<tr> +<td> +<p><a href="url.html">url</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">url</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code> +<p>Link URL address.</p> +</td> +</tr> +</tbody> +</table> +<h3>Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="get-sn-attrs.html">getSnAttrs</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">getSnAttrs</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-pair.html"><span class="identifier">StringPair</span></a><span class="symbol">></span></code> +<p>Returns list of element attributes in the form of a List.</p> +</td> +</tr> +<tr> +<td> +<p><a href="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>Inherited Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.panel/-simple-panel/add.html">add</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">add</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.panel.SimplePanel$add(pl.treksoft.kvision.core.Component)/child">child</span><span class="symbol">:</span> <a href="../../pl.treksoft.kvision.core/-component/index.html"><span class="identifier">Component</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.panel/-simple-panel/index.html"><span class="identifier">SimplePanel</span></a></code> +<p>Adds given component to the current container.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.panel/-simple-panel/add-all.html">addAll</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">addAll</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.panel.SimplePanel$addAll(kotlin.collections.List((pl.treksoft.kvision.core.Component)))/children">children</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/-component/index.html"><span class="identifier">Component</span></a><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.panel/-simple-panel/index.html"><span class="identifier">SimplePanel</span></a></code> +<p>Adds a list of components to the current container.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.panel/-simple-panel/add-internal.html">addInternal</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="identifier">addInternal</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.panel.SimplePanel$addInternal(pl.treksoft.kvision.core.Component)/child">child</span><span class="symbol">:</span> <a href="../../pl.treksoft.kvision.core/-component/index.html"><span class="identifier">Component</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.panel/-simple-panel/index.html"><span class="identifier">SimplePanel</span></a></code> +<p>Protected and final method to add given component to the current container.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.panel/-simple-panel/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.panel/-simple-panel/get-children.html">getChildren</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">getChildren</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/-component/index.html"><span class="identifier">Component</span></a><span class="symbol">></span></code> +<p>Returns a list of children of the current container.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.panel/-simple-panel/remove.html">remove</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">remove</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.panel.SimplePanel$remove(pl.treksoft.kvision.core.Component)/child">child</span><span class="symbol">:</span> <a href="../../pl.treksoft.kvision.core/-component/index.html"><span class="identifier">Component</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.panel/-simple-panel/index.html"><span class="identifier">SimplePanel</span></a></code> +<p>Removes given component from the current container.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.panel/-simple-panel/remove-all.html">removeAll</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">removeAll</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.panel/-simple-panel/index.html"><span class="identifier">SimplePanel</span></a></code> +<p>Removes all children from the current container.</p> +</td> +</tr> +</tbody> +</table> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.html/-link/label.html b/docs/api/pl.treksoft.kvision.html/-link/label.html new file mode 100644 index 00000000..7774a8d4 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.html/-link/label.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Link.label - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.html</a> / <a href="index.html">Link</a> / <a href="./label.html">label</a><br/> +<br/> +<h1>label</h1> +<a name="pl.treksoft.kvision.html.Link$label"></a> +<code><span class="keyword">var </span><span class="identifier">label</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code> +<p>Link label.</p> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.html/-link/render.html b/docs/api/pl.treksoft.kvision.html/-link/render.html new file mode 100644 index 00000000..295bfb6f --- /dev/null +++ b/docs/api/pl.treksoft.kvision.html/-link/render.html @@ -0,0 +1,18 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Link.render - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.html</a> / <a href="index.html">Link</a> / <a href="./render.html">render</a><br/> +<br/> +<h1>render</h1> +<a name="pl.treksoft.kvision.html.Link$render()"></a> +<code><span class="keyword">protected</span> <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>Overrides <a href="../../pl.treksoft.kvision.panel/-simple-panel/render.html">SimplePanel.render</a></p> +<p>Renders current component as a Snabbdom vnode.</p> +<p><strong>Return</strong><br/> +Snabbdom vnode</p> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.html/-link/url.html b/docs/api/pl.treksoft.kvision.html/-link/url.html new file mode 100644 index 00000000..adb256d3 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.html/-link/url.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Link.url - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.html</a> / <a href="index.html">Link</a> / <a href="./url.html">url</a><br/> +<br/> +<h1>url</h1> +<a name="pl.treksoft.kvision.html.Link$url"></a> +<code><span class="keyword">var </span><span class="identifier">url</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code> +<p>Link URL address.</p> +</BODY> +</HTML> |