diff options
| author | Robert Jaros <rjaros@finn.pl> | 2018-02-26 14:21:46 +0100 |
|---|---|---|
| committer | Robert Jaros <rjaros@finn.pl> | 2018-02-26 14:21:46 +0100 |
| commit | 61545b3f1fb1844af350d187edd26285e98f0466 (patch) | |
| tree | 332e6d6b246d6829e021a722ac721a43ad6e98d2 /docs/api/pl.treksoft.kvision.window/-window/index.html | |
| parent | aa350102b7dea200fdd152b16a2948e681a98a0e (diff) | |
| download | kvision-61545b3f1fb1844af350d187edd26285e98f0466.tar.gz kvision-61545b3f1fb1844af350d187edd26285e98f0466.tar.bz2 kvision-61545b3f1fb1844af350d187edd26285e98f0466.zip | |
API documentation update
Diffstat (limited to 'docs/api/pl.treksoft.kvision.window/-window/index.html')
| -rw-r--r-- | docs/api/pl.treksoft.kvision.window/-window/index.html | 190 |
1 files changed, 190 insertions, 0 deletions
diff --git a/docs/api/pl.treksoft.kvision.window/-window/index.html b/docs/api/pl.treksoft.kvision.window/-window/index.html new file mode 100644 index 00000000..9e238bee --- /dev/null +++ b/docs/api/pl.treksoft.kvision.window/-window/index.html @@ -0,0 +1,190 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Window - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.window</a> / <a href="./index.html">Window</a><br/> +<br/> +<h1>Window</h1> +<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">Window</span> <span class="symbol">:</span> <a href="../../pl.treksoft.kvision.panel/-simple-panel/index.html"><span class="identifier">SimplePanel</span></a></code> +<p>Floating window container.</p> +<h3>Constructors</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="-init-.html"><init></a></p> +</td> +<td> +<code><span class="identifier">Window</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.window.Window$<init>(kotlin.String, kotlin.Pair((kotlin.Int, pl.treksoft.kvision.core.UNIT)), kotlin.Pair((kotlin.Int, pl.treksoft.kvision.core.UNIT)), kotlin.Boolean, kotlin.Boolean, kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.window.Window, kotlin.Unit)))/caption">caption</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.window.Window$<init>(kotlin.String, kotlin.Pair((kotlin.Int, pl.treksoft.kvision.core.UNIT)), kotlin.Pair((kotlin.Int, pl.treksoft.kvision.core.UNIT)), kotlin.Boolean, kotlin.Boolean, kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.window.Window, kotlin.Unit)))/contentWidth">contentWidth</span><span class="symbol">:</span> <a href="../../pl.treksoft.kvision.core/-css-size.html"><span class="identifier">CssSize</span></a><span class="symbol">?</span> <span class="symbol">=</span> CssSize(0, UNIT.auto)<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.window.Window$<init>(kotlin.String, kotlin.Pair((kotlin.Int, pl.treksoft.kvision.core.UNIT)), kotlin.Pair((kotlin.Int, pl.treksoft.kvision.core.UNIT)), kotlin.Boolean, kotlin.Boolean, kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.window.Window, kotlin.Unit)))/contentHeight">contentHeight</span><span class="symbol">:</span> <a href="../../pl.treksoft.kvision.core/-css-size.html"><span class="identifier">CssSize</span></a><span class="symbol">?</span> <span class="symbol">=</span> CssSize(0, UNIT.auto)<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.window.Window$<init>(kotlin.String, kotlin.Pair((kotlin.Int, pl.treksoft.kvision.core.UNIT)), kotlin.Pair((kotlin.Int, pl.treksoft.kvision.core.UNIT)), kotlin.Boolean, kotlin.Boolean, kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.window.Window, kotlin.Unit)))/isResizable">isResizable</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a> <span class="symbol">=</span> true<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.window.Window$<init>(kotlin.String, kotlin.Pair((kotlin.Int, pl.treksoft.kvision.core.UNIT)), kotlin.Pair((kotlin.Int, pl.treksoft.kvision.core.UNIT)), kotlin.Boolean, kotlin.Boolean, kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.window.Window, kotlin.Unit)))/isDraggable">isDraggable</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a> <span class="symbol">=</span> true<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.window.Window$<init>(kotlin.String, kotlin.Pair((kotlin.Int, pl.treksoft.kvision.core.UNIT)), kotlin.Pair((kotlin.Int, pl.treksoft.kvision.core.UNIT)), kotlin.Boolean, kotlin.Boolean, kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.window.Window, kotlin.Unit)))/closeButton">closeButton</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a> <span class="symbol">=</span> false<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.window.Window$<init>(kotlin.String, kotlin.Pair((kotlin.Int, pl.treksoft.kvision.core.UNIT)), kotlin.Pair((kotlin.Int, pl.treksoft.kvision.core.UNIT)), kotlin.Boolean, kotlin.Boolean, kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.window.Window, 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.window.Window$<init>(kotlin.String, kotlin.Pair((kotlin.Int, pl.treksoft.kvision.core.UNIT)), kotlin.Pair((kotlin.Int, pl.treksoft.kvision.core.UNIT)), kotlin.Boolean, kotlin.Boolean, kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.window.Window, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <a href="./index.html"><span class="identifier">Window</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>Properties</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="caption.html">caption</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">caption</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>Window caption text.</p> +</td> +</tr> +<tr> +<td> +<p><a href="close-button.html">closeButton</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">closeButton</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 Close button is visible.</p> +</td> +</tr> +<tr> +<td> +<p><a href="content-height.html">contentHeight</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">contentHeight</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.core/-css-size.html"><span class="identifier">CssSize</span></a><span class="symbol">?</span></code> +<p>Window content height.</p> +</td> +</tr> +<tr> +<td> +<p><a href="content-width.html">contentWidth</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">contentWidth</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.core/-css-size.html"><span class="identifier">CssSize</span></a><span class="symbol">?</span></code> +<p>Window content width.</p> +</td> +</tr> +<tr> +<td> +<p><a href="is-draggable.html">isDraggable</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">isDraggable</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 the window is draggable.</p> +</td> +</tr> +<tr> +<td> +<p><a href="is-resizable.html">isResizable</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">isResizable</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 the window is resizable.</p> +</td> +</tr> +</tbody> +</table> +<h3>Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="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.window.Window$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="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.window.Window$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="after-create.html">afterCreate</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">afterCreate</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.window.Window$afterCreate(com.github.snabbdom.VNode)/node">node</span><span class="symbol">:</span> <span class="identifier">VNode</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></code> +<p>Method called after creating Snabbdom vnode.</p> +</td> +</tr> +<tr> +<td> +<p><a href="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="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.window.Window$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="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> +<h3>Inherited Functions</h3> +<table> +<tbody> +<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/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="window.html">window</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">window</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.window.Window.Companion$window(pl.treksoft.kvision.core.Container, kotlin.String, kotlin.Pair((kotlin.Int, pl.treksoft.kvision.core.UNIT)), kotlin.Pair((kotlin.Int, pl.treksoft.kvision.core.UNIT)), kotlin.Boolean, kotlin.Boolean, kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.window.Window, kotlin.Unit)))/caption">caption</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.window.Window.Companion$window(pl.treksoft.kvision.core.Container, kotlin.String, kotlin.Pair((kotlin.Int, pl.treksoft.kvision.core.UNIT)), kotlin.Pair((kotlin.Int, pl.treksoft.kvision.core.UNIT)), kotlin.Boolean, kotlin.Boolean, kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.window.Window, kotlin.Unit)))/width">width</span><span class="symbol">:</span> <a href="../../pl.treksoft.kvision.core/-css-size.html"><span class="identifier">CssSize</span></a><span class="symbol">?</span> <span class="symbol">=</span> CssSize(0, UNIT.auto)<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.window.Window.Companion$window(pl.treksoft.kvision.core.Container, kotlin.String, kotlin.Pair((kotlin.Int, pl.treksoft.kvision.core.UNIT)), kotlin.Pair((kotlin.Int, pl.treksoft.kvision.core.UNIT)), kotlin.Boolean, kotlin.Boolean, kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.window.Window, kotlin.Unit)))/height">height</span><span class="symbol">:</span> <a href="../../pl.treksoft.kvision.core/-css-size.html"><span class="identifier">CssSize</span></a><span class="symbol">?</span> <span class="symbol">=</span> CssSize(0, UNIT.auto)<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.window.Window.Companion$window(pl.treksoft.kvision.core.Container, kotlin.String, kotlin.Pair((kotlin.Int, pl.treksoft.kvision.core.UNIT)), kotlin.Pair((kotlin.Int, pl.treksoft.kvision.core.UNIT)), kotlin.Boolean, kotlin.Boolean, kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.window.Window, kotlin.Unit)))/resizable">resizable</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a> <span class="symbol">=</span> true<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.window.Window.Companion$window(pl.treksoft.kvision.core.Container, kotlin.String, kotlin.Pair((kotlin.Int, pl.treksoft.kvision.core.UNIT)), kotlin.Pair((kotlin.Int, pl.treksoft.kvision.core.UNIT)), kotlin.Boolean, kotlin.Boolean, kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.window.Window, kotlin.Unit)))/draggable">draggable</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a> <span class="symbol">=</span> true<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.window.Window.Companion$window(pl.treksoft.kvision.core.Container, kotlin.String, kotlin.Pair((kotlin.Int, pl.treksoft.kvision.core.UNIT)), kotlin.Pair((kotlin.Int, pl.treksoft.kvision.core.UNIT)), kotlin.Boolean, kotlin.Boolean, kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.window.Window, kotlin.Unit)))/closeButton">closeButton</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a> <span class="symbol">=</span> false<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.window.Window.Companion$window(pl.treksoft.kvision.core.Container, kotlin.String, kotlin.Pair((kotlin.Int, pl.treksoft.kvision.core.UNIT)), kotlin.Pair((kotlin.Int, pl.treksoft.kvision.core.UNIT)), kotlin.Boolean, kotlin.Boolean, kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.window.Window, 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.window.Window.Companion$window(pl.treksoft.kvision.core.Container, kotlin.String, kotlin.Pair((kotlin.Int, pl.treksoft.kvision.core.UNIT)), kotlin.Pair((kotlin.Int, pl.treksoft.kvision.core.UNIT)), kotlin.Boolean, kotlin.Boolean, kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.window.Window, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <a href="./index.html"><span class="identifier">Window</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">Window</span></a></code> +<p>DSL builder extension function.</p> +</td> +</tr> +</tbody> +</table> +</BODY> +</HTML> |