aboutsummaryrefslogtreecommitdiff
path: root/api/pl.treksoft.kvision.html/-icon
diff options
context:
space:
mode:
authorRobert Jaros <rjaros@finn.pl>2018-10-22 00:01:39 +0200
committerRobert Jaros <rjaros@finn.pl>2018-10-22 00:01:39 +0200
commiteb930482e9972a21d39f2aea8b813acf58ff5b64 (patch)
tree1c64052b39527aca51793860894baa37791cc94f /api/pl.treksoft.kvision.html/-icon
parent7c2850063697f94a0d8b8d8f8588136dd4b3d05e (diff)
downloadkvision-eb930482e9972a21d39f2aea8b813acf58ff5b64.tar.gz
kvision-eb930482e9972a21d39f2aea8b813acf58ff5b64.tar.bz2
kvision-eb930482e9972a21d39f2aea8b813acf58ff5b64.zip
API documentation for KVision 0.0.19
Diffstat (limited to 'api/pl.treksoft.kvision.html/-icon')
-rw-r--r--api/pl.treksoft.kvision.html/-icon/-init-.html19
-rw-r--r--api/pl.treksoft.kvision.html/-icon/get-sn-class.html18
-rw-r--r--api/pl.treksoft.kvision.html/-icon/icon.html25
-rw-r--r--api/pl.treksoft.kvision.html/-icon/index.html141
4 files changed, 203 insertions, 0 deletions
diff --git a/api/pl.treksoft.kvision.html/-icon/-init-.html b/api/pl.treksoft.kvision.html/-icon/-init-.html
new file mode 100644
index 00000000..08671b45
--- /dev/null
+++ b/api/pl.treksoft.kvision.html/-icon/-init-.html
@@ -0,0 +1,19 @@
+<HTML>
+<HEAD>
+<meta charset="UTF-8">
+<title>Icon.<init> - kvision</title>
+<link rel="stylesheet" href="../../../style.css">
+</HEAD>
+<BODY>
+<a href="../../index.html">kvision</a>&nbsp;/&nbsp;<a href="../index.html">pl.treksoft.kvision.html</a>&nbsp;/&nbsp;<a href="index.html">Icon</a>&nbsp;/&nbsp;<a href="./-init-.html">&lt;init&gt;</a><br/>
+<br/>
+<h1>&lt;init&gt;</h1>
+<a name="pl.treksoft.kvision.html.Icon$&lt;init&gt;(kotlin.String)"></a>
+<code><span class="identifier">Icon</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.html.Icon$<init>(kotlin.String)/icon">icon</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">)</span></code>
+<h3>Parameters</h3>
+<p><a name="icon"></a>
+<code>icon</code> - icon name</p>
+<p><strong>Constructor</strong><br/>
+</p>
+</BODY>
+</HTML>
diff --git a/api/pl.treksoft.kvision.html/-icon/get-sn-class.html b/api/pl.treksoft.kvision.html/-icon/get-sn-class.html
new file mode 100644
index 00000000..ae52c838
--- /dev/null
+++ b/api/pl.treksoft.kvision.html/-icon/get-sn-class.html
@@ -0,0 +1,18 @@
+<HTML>
+<HEAD>
+<meta charset="UTF-8">
+<title>Icon.getSnClass - kvision</title>
+<link rel="stylesheet" href="../../../style.css">
+</HEAD>
+<BODY>
+<a href="../../index.html">kvision</a>&nbsp;/&nbsp;<a href="../index.html">pl.treksoft.kvision.html</a>&nbsp;/&nbsp;<a href="index.html">Icon</a>&nbsp;/&nbsp;<a href="./get-sn-class.html">getSnClass</a><br/>
+<br/>
+<h1>getSnClass</h1>
+<a name="pl.treksoft.kvision.html.Icon$getSnClass()"></a>
+<code><span class="keyword">protected</span> <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">&lt;</span><a href="../../pl.treksoft.kvision.core/-string-bool-pair.html"><span class="identifier">StringBoolPair</span></a><span class="symbol">&gt;</span></code>
+<p>Overrides <a href="../-tag/get-sn-class.html">Tag.getSnClass</a></p>
+<p>Returns list of CSS class names for current widget in the form of a List.</p>
+<p><strong>Return</strong><br/>
+list of CSS class names</p>
+</BODY>
+</HTML>
diff --git a/api/pl.treksoft.kvision.html/-icon/icon.html b/api/pl.treksoft.kvision.html/-icon/icon.html
new file mode 100644
index 00000000..2183247f
--- /dev/null
+++ b/api/pl.treksoft.kvision.html/-icon/icon.html
@@ -0,0 +1,25 @@
+<HTML>
+<HEAD>
+<meta charset="UTF-8">
+<title>Icon.icon - kvision</title>
+<link rel="stylesheet" href="../../../style.css">
+</HEAD>
+<BODY>
+<a href="../../index.html">kvision</a>&nbsp;/&nbsp;<a href="../index.html">pl.treksoft.kvision.html</a>&nbsp;/&nbsp;<a href="index.html">Icon</a>&nbsp;/&nbsp;<a href="./icon.html">icon</a><br/>
+<br/>
+<h1>icon</h1>
+<a name="pl.treksoft.kvision.html.Icon$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></code>
+<p>Icon type.</p>
+<p><strong>Getter</strong><br/>
+<p>Icon type.</p>
+</p>
+<p><strong>Setter</strong><br/>
+<p>Icon type.</p>
+</p>
+<a name="pl.treksoft.kvision.html.Icon.Companion$icon(pl.treksoft.kvision.core.Container, kotlin.String, kotlin.Function1((pl.treksoft.kvision.html.Icon, kotlin.Unit)))"></a>
+<code><span class="keyword">fun </span><a href="../../pl.treksoft.kvision.core/-container/index.html"><span class="identifier">Container</span></a><span class="symbol">.</span><span class="identifier">icon</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.html.Icon.Companion$icon(pl.treksoft.kvision.core.Container, kotlin.String, kotlin.Function1((pl.treksoft.kvision.html.Icon, kotlin.Unit)))/icon">icon</span><span class="symbol">:</span>&nbsp;<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.Icon.Companion$icon(pl.treksoft.kvision.core.Container, kotlin.String, kotlin.Function1((pl.treksoft.kvision.html.Icon, kotlin.Unit)))/init">init</span><span class="symbol">:</span>&nbsp;<a href="index.html"><span class="identifier">Icon</span></a><span class="symbol">.</span><span class="symbol">(</span><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</span><span class="symbol">: </span><a href="index.html"><span class="identifier">Icon</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/pl.treksoft.kvision.html/-icon/index.html b/api/pl.treksoft.kvision.html/-icon/index.html
new file mode 100644
index 00000000..53bc8b48
--- /dev/null
+++ b/api/pl.treksoft.kvision.html/-icon/index.html
@@ -0,0 +1,141 @@
+<HTML>
+<HEAD>
+<meta charset="UTF-8">
+<title>Icon - kvision</title>
+<link rel="stylesheet" href="../../../style.css">
+</HEAD>
+<BODY>
+<a href="../../index.html">kvision</a>&nbsp;/&nbsp;<a href="../index.html">pl.treksoft.kvision.html</a>&nbsp;/&nbsp;<a href="./index.html">Icon</a><br/>
+<br/>
+<h1>Icon</h1>
+<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">Icon</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../-tag/index.html"><span class="identifier">Tag</span></a></code>
+<p>Icon component with support for FontAwesome and Bootstrap glyphicons.</p>
+<h3>Constructors</h3>
+<table>
+<tbody>
+<tr>
+<td>
+<p><a href="-init-.html">&lt;init&gt;</a></p>
+</td>
+<td>
+<code><span class="identifier">Icon</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.html.Icon$<init>(kotlin.String)/icon">icon</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><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></code>
+<p>Icon type.</p>
+</td>
+</tr>
+</tbody>
+</table>
+<h3>Inherited Properties</h3>
+<table>
+<tbody>
+<tr>
+<td>
+<p><a href="../-tag/align.html">align</a></p>
+</td>
+<td>
+<code><span class="keyword">var </span><span class="identifier">align</span><span class="symbol">: </span><a href="../-align/index.html"><span class="identifier">Align</span></a><span class="symbol">?</span></code>
+<p>Text align.</p>
+</td>
+</tr>
+<tr>
+<td>
+<p><a href="../-tag/content.html">content</a></p>
+</td>
+<td>
+<code><span class="keyword">open</span> <span class="keyword">var </span><span class="identifier">content</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>Text content of the tag.</p>
+</td>
+</tr>
+<tr>
+<td>
+<p><a href="../-tag/rich.html">rich</a></p>
+</td>
+<td>
+<code><span class="keyword">open</span> <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="../-tag/content.html">content</a> can contain HTML code.</p>
+</td>
+</tr>
+<tr>
+<td>
+<p><a href="../-tag/template.html">template</a></p>
+</td>
+<td>
+<code><span class="keyword">open</span> <span class="keyword">var </span><span class="identifier">template</span><span class="symbol">: </span><span class="symbol">(</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html"><span class="identifier">Any</span></a><span class="symbol">?</span><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code>
+<p>Handlebars template.</p>
+</td>
+</tr>
+<tr>
+<td>
+<p><a href="../-tag/templates.html">templates</a></p>
+</td>
+<td>
+<code><span class="keyword">open</span> <span class="keyword">var </span><span class="identifier">templates</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html"><span class="identifier">Map</span></a><span class="symbol">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">,</span>&nbsp;<span class="symbol">(</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html"><span class="identifier">Any</span></a><span class="symbol">?</span><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">&gt;</span></code>
+<p>Handlebars templates for i18n.</p>
+</td>
+</tr>
+<tr>
+<td>
+<p><a href="../-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="../-t-a-g/index.html"><span class="identifier">TAG</span></a></code>
+<p>Tag type.</p>
+</td>
+</tr>
+</tbody>
+</table>
+<h3>Functions</h3>
+<table>
+<tbody>
+<tr>
+<td>
+<p><a href="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">&lt;</span><a href="../../pl.treksoft.kvision.core/-string-bool-pair.html"><span class="identifier">StringBoolPair</span></a><span class="symbol">&gt;</span></code>
+<p>Returns list of CSS class names for current widget in the form of a List.</p>
+</td>
+</tr>
+</tbody>
+</table>
+<h3>Inherited Functions</h3>
+<table>
+<tbody>
+<tr>
+<td>
+<p><a href="../-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="icon.html">icon</a></p>
+</td>
+<td>
+<code><span class="keyword">fun </span><a href="../../pl.treksoft.kvision.core/-container/index.html"><span class="identifier">Container</span></a><span class="symbol">.</span><span class="identifier">icon</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.html.Icon.Companion$icon(pl.treksoft.kvision.core.Container, kotlin.String, kotlin.Function1((pl.treksoft.kvision.html.Icon, kotlin.Unit)))/icon">icon</span><span class="symbol">:</span>&nbsp;<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.Icon.Companion$icon(pl.treksoft.kvision.core.Container, kotlin.String, kotlin.Function1((pl.treksoft.kvision.html.Icon, kotlin.Unit)))/init">init</span><span class="symbol">:</span>&nbsp;<a href="./index.html"><span class="identifier">Icon</span></a><span class="symbol">.</span><span class="symbol">(</span><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</span><span class="symbol">: </span><a href="./index.html"><span class="identifier">Icon</span></a></code>
+<p>DSL builder extension function.</p>
+</td>
+</tr>
+</tbody>
+</table>
+</BODY>
+</HTML>