diff options
Diffstat (limited to 'api/kvision/pl.treksoft.kvision.modal/-alert/index.html')
| -rw-r--r-- | api/kvision/pl.treksoft.kvision.modal/-alert/index.html | 240 |
1 files changed, 240 insertions, 0 deletions
diff --git a/api/kvision/pl.treksoft.kvision.modal/-alert/index.html b/api/kvision/pl.treksoft.kvision.modal/-alert/index.html new file mode 100644 index 00000000..4a5a7428 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.modal/-alert/index.html @@ -0,0 +1,240 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Alert - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.modal</a> / <a href="./index.html">Alert</a><br/> +<br/> +<h1>Alert</h1> +<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">Alert</span> <span class="symbol">:</span> <a href="../-modal/index.html"><span class="identifier">Modal</span></a></code> +<p>Alert window based on Bootstrap modal.</p> +<h3>Constructors</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="-init-.html"><init></a></p> +</td> +<td> +<code><span class="identifier">Alert</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.modal.Alert$<init>(kotlin.String, kotlin.String, kotlin.Boolean, pl.treksoft.kvision.html.Align, pl.treksoft.kvision.modal.ModalSize, kotlin.Boolean, kotlin.Function0((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.modal.Alert$<init>(kotlin.String, kotlin.String, kotlin.Boolean, pl.treksoft.kvision.html.Align, pl.treksoft.kvision.modal.ModalSize, kotlin.Boolean, kotlin.Function0((kotlin.Unit)))/text">text</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.modal.Alert$<init>(kotlin.String, kotlin.String, kotlin.Boolean, pl.treksoft.kvision.html.Align, pl.treksoft.kvision.modal.ModalSize, kotlin.Boolean, kotlin.Function0((kotlin.Unit)))/rich">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> <span class="symbol">=</span> false<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.modal.Alert$<init>(kotlin.String, kotlin.String, kotlin.Boolean, pl.treksoft.kvision.html.Align, pl.treksoft.kvision.modal.ModalSize, kotlin.Boolean, kotlin.Function0((kotlin.Unit)))/align">align</span><span class="symbol">:</span> <a href="../../pl.treksoft.kvision.html/-align/index.html"><span class="identifier">Align</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.modal.Alert$<init>(kotlin.String, kotlin.String, kotlin.Boolean, pl.treksoft.kvision.html.Align, pl.treksoft.kvision.modal.ModalSize, kotlin.Boolean, kotlin.Function0((kotlin.Unit)))/size">size</span><span class="symbol">:</span> <a href="../-modal-size/index.html"><span class="identifier">ModalSize</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.modal.Alert$<init>(kotlin.String, kotlin.String, kotlin.Boolean, pl.treksoft.kvision.html.Align, pl.treksoft.kvision.modal.ModalSize, kotlin.Boolean, kotlin.Function0((kotlin.Unit)))/animation">animation</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.modal.Alert$<init>(kotlin.String, kotlin.String, kotlin.Boolean, pl.treksoft.kvision.html.Align, pl.treksoft.kvision.modal.ModalSize, kotlin.Boolean, kotlin.Function0((kotlin.Unit)))/callback">callback</span><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="align.html">align</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">align</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.html/-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="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="text.html">text</a> can contain HTML code.</p> +</td> +</tr> +<tr> +<td> +<p><a href="text.html">text</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">text</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 content text.</p> +</td> +</tr> +</tbody> +</table> +<h3>Inherited Properties</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="../-modal/animation.html">animation</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">animation</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 animations are used.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../-modal/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="../-modal/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="../-modal/size.html">size</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">size</span><span class="symbol">: </span><a href="../-modal-size/index.html"><span class="identifier">ModalSize</span></a><span class="symbol">?</span></code> +<p>Window size.</p> +</td> +</tr> +</tbody> +</table> +<h3>Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="hide.html">hide</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">hide</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> +<p>Makes current widget invisible.</p> +</td> +</tr> +</tbody> +</table> +<h3>Inherited Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="../-modal/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.modal.Modal$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="../-modal/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.modal.Modal$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="../-modal/add-button.html">addButton</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">addButton</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.modal.Modal$addButton(pl.treksoft.kvision.html.Button)/button">button</span><span class="symbol">:</span> <a href="../../pl.treksoft.kvision.html/-button/index.html"><span class="identifier">Button</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../-modal/index.html"><span class="identifier">Modal</span></a></code> +<p>Adds given button to the bottom section of dialog window.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../-modal/after-insert.html">afterInsert</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">afterInsert</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.modal.Modal$afterInsert(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 inserting Snabbdom vnode into the DOM.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../-modal/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="../-modal/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="../-modal/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="../-modal/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.modal.Modal$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="../-modal/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> +<tr> +<td> +<p><a href="../-modal/remove-all-buttons.html">removeAllButtons</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">removeAllButtons</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../-modal/index.html"><span class="identifier">Modal</span></a></code> +<p>Removes all buttons from the bottom section of dialog window.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../-modal/remove-button.html">removeButton</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">removeButton</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.modal.Modal$removeButton(pl.treksoft.kvision.html.Button)/button">button</span><span class="symbol">:</span> <a href="../../pl.treksoft.kvision.html/-button/index.html"><span class="identifier">Button</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../-modal/index.html"><span class="identifier">Modal</span></a></code> +<p>Removes given button from the bottom section of dialog window.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../-modal/toggle.html">toggle</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">toggle</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></code> +<p>Toggle modal window visibility.</p> +</td> +</tr> +</tbody> +</table> +<h3>Companion Object Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="show.html">show</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="identifier">show</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.modal.Alert.Companion$show(kotlin.String, kotlin.String, kotlin.Boolean, pl.treksoft.kvision.html.Align, pl.treksoft.kvision.modal.ModalSize, kotlin.Boolean, kotlin.Function0((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.modal.Alert.Companion$show(kotlin.String, kotlin.String, kotlin.Boolean, pl.treksoft.kvision.html.Align, pl.treksoft.kvision.modal.ModalSize, kotlin.Boolean, kotlin.Function0((kotlin.Unit)))/text">text</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.modal.Alert.Companion$show(kotlin.String, kotlin.String, kotlin.Boolean, pl.treksoft.kvision.html.Align, pl.treksoft.kvision.modal.ModalSize, kotlin.Boolean, kotlin.Function0((kotlin.Unit)))/rich">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> <span class="symbol">=</span> false<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.modal.Alert.Companion$show(kotlin.String, kotlin.String, kotlin.Boolean, pl.treksoft.kvision.html.Align, pl.treksoft.kvision.modal.ModalSize, kotlin.Boolean, kotlin.Function0((kotlin.Unit)))/align">align</span><span class="symbol">:</span> <a href="../../pl.treksoft.kvision.html/-align/index.html"><span class="identifier">Align</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.modal.Alert.Companion$show(kotlin.String, kotlin.String, kotlin.Boolean, pl.treksoft.kvision.html.Align, pl.treksoft.kvision.modal.ModalSize, kotlin.Boolean, kotlin.Function0((kotlin.Unit)))/size">size</span><span class="symbol">:</span> <a href="../-modal-size/index.html"><span class="identifier">ModalSize</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.modal.Alert.Companion$show(kotlin.String, kotlin.String, kotlin.Boolean, pl.treksoft.kvision.html.Align, pl.treksoft.kvision.modal.ModalSize, kotlin.Boolean, kotlin.Function0((kotlin.Unit)))/animation">animation</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.modal.Alert.Companion$show(kotlin.String, kotlin.String, kotlin.Boolean, pl.treksoft.kvision.html.Align, pl.treksoft.kvision.modal.ModalSize, kotlin.Boolean, kotlin.Function0((kotlin.Unit)))/callback">callback</span><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="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code> +<p>Helper function for opening Alert window.</p> +</td> +</tr> +</tbody> +</table> +</BODY> +</HTML> |