From 7c2850063697f94a0d8b8d8f8588136dd4b3d05e Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sun, 21 Oct 2018 23:59:34 +0200 Subject: API documentation for KVision 0.0.19 --- api/pl.treksoft.kvision.html/-link/-init-.html | 27 --- .../-link/get-sn-attrs.html | 18 -- api/pl.treksoft.kvision.html/-link/icon.html | 21 --- api/pl.treksoft.kvision.html/-link/image.html | 21 --- api/pl.treksoft.kvision.html/-link/index.html | 191 --------------------- api/pl.treksoft.kvision.html/-link/label.html | 21 --- .../-link/link-disabled.html | 18 -- api/pl.treksoft.kvision.html/-link/link.html | 16 -- api/pl.treksoft.kvision.html/-link/on-click.html | 15 -- api/pl.treksoft.kvision.html/-link/render.html | 18 -- api/pl.treksoft.kvision.html/-link/url.html | 21 --- 11 files changed, 387 deletions(-) delete mode 100644 api/pl.treksoft.kvision.html/-link/-init-.html delete mode 100644 api/pl.treksoft.kvision.html/-link/get-sn-attrs.html delete mode 100644 api/pl.treksoft.kvision.html/-link/icon.html delete mode 100644 api/pl.treksoft.kvision.html/-link/image.html delete mode 100644 api/pl.treksoft.kvision.html/-link/index.html delete mode 100644 api/pl.treksoft.kvision.html/-link/label.html delete mode 100644 api/pl.treksoft.kvision.html/-link/link-disabled.html delete mode 100644 api/pl.treksoft.kvision.html/-link/link.html delete mode 100644 api/pl.treksoft.kvision.html/-link/on-click.html delete mode 100644 api/pl.treksoft.kvision.html/-link/render.html delete mode 100644 api/pl.treksoft.kvision.html/-link/url.html (limited to 'api/pl.treksoft.kvision.html/-link') diff --git a/api/pl.treksoft.kvision.html/-link/-init-.html b/api/pl.treksoft.kvision.html/-link/-init-.html deleted file mode 100644 index 40df5810..00000000 --- a/api/pl.treksoft.kvision.html/-link/-init-.html +++ /dev/null @@ -1,27 +0,0 @@ - - - -Link.<init> - kvision - - - -kvision / pl.treksoft.kvision.html / Link / <init>
-
-

<init>

- -

Link(label: String, url: String? = null, icon: String? = null, image: ResString? = null, classes: Set<String> = setOf())

Parameters

-label - link label

-url - link URL address

-icon - link icon

-image - link image

-classes - a set of CSS class names

Constructor
-

- - diff --git a/api/pl.treksoft.kvision.html/-link/get-sn-attrs.html b/api/pl.treksoft.kvision.html/-link/get-sn-attrs.html deleted file mode 100644 index 2adbd0fe..00000000 --- a/api/pl.treksoft.kvision.html/-link/get-sn-attrs.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -Link.getSnAttrs - kvision - - - -kvision / pl.treksoft.kvision.html / Link / getSnAttrs
-
-

getSnAttrs

- -protected open fun getSnAttrs(): List<StringPair> -

Overrides Widget.getSnAttrs

Returns list of element attributes in the form of a List.

Return
-list of element attributes

- - diff --git a/api/pl.treksoft.kvision.html/-link/icon.html b/api/pl.treksoft.kvision.html/-link/icon.html deleted file mode 100644 index 1dd6cb19..00000000 --- a/api/pl.treksoft.kvision.html/-link/icon.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -Link.icon - kvision - - - -kvision / pl.treksoft.kvision.html / Link / icon
-
-

icon

- -var icon: String? -

Link icon.

Getter
-

Link icon.

Setter
-

Link icon.

- - diff --git a/api/pl.treksoft.kvision.html/-link/image.html b/api/pl.treksoft.kvision.html/-link/image.html deleted file mode 100644 index 2d4687cf..00000000 --- a/api/pl.treksoft.kvision.html/-link/image.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -Link.image - kvision - - - -kvision / pl.treksoft.kvision.html / Link / image
-
-

image

- -var image: ResString? -

Link image.

Getter
-

Link image.

Setter
-

Link image.

- - diff --git a/api/pl.treksoft.kvision.html/-link/index.html b/api/pl.treksoft.kvision.html/-link/index.html deleted file mode 100644 index 267823d6..00000000 --- a/api/pl.treksoft.kvision.html/-link/index.html +++ /dev/null @@ -1,191 +0,0 @@ - - - -Link - kvision - - - -kvision / pl.treksoft.kvision.html / Link
-
-

Link

-open class Link : SimplePanel -

Link component.

Constructors

- - - - - - - -

<init>

Link(label: String, url: String? = null, icon: String? = null, image: ResString? = null, classes: Set<String> = setOf())

Properties

- - - - - - - - - - - - - - - - - - - -

- icon -	-`var icon: String?` - Link icon. -
- image -	-`var image: ResString?` - Link image. -
- label -	-`var label: String` - Link label. -
- url -	-`var url: String?` - Link URL address. -

Functions

- - - - - - - - - - - - - - - -

- getSnAttrs -	-`open fun getSnAttrs(): List<StringPair>` - Returns list of element attributes in the form of a List. -
- onClick -	-`open fun onClick(handler: Link.(MouseEvent) -> Unit): Link` - A convenient helper for easy setting onClick event handler. -
- render -	-`open fun render(): VNode` - Renders current component as a Snabbdom vnode. -

Inherited Functions

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

- add -	-`open fun add(child: Component): SimplePanel` - Adds given component to the current container. -
- addAll -	-`open fun addAll(children: List<Component>): SimplePanel` - Adds a list of components to the current container. -
- addInternal -	-`fun addInternal(child: Component): SimplePanel` - Protected and final method to add given component to the current container. -
- childrenVNodes -	-`open fun childrenVNodes(): Array<VNode>` - Returns the array of the children Snabbdom vnodes. -
- getChildren -	-`open fun getChildren(): List<Component>` - Returns a list of children of the current container. -
- remove -	-`open fun remove(child: Component): SimplePanel` - Removes given component from the current container. -
- removeAll -	-`open fun removeAll(): SimplePanel` - Removes all children from the current container. -

Companion Object Functions

- - - - - - - - - - - -

- link -	-`fun Container.link(label: String, url: String? = null, icon: String? = null, image: ResString? = null, classes: Set<String> = setOf(), init: Link.() -> Unit = null): Link` - DSL builder extension function. -
- linkDisabled -	-`fun ListTag.linkDisabled(label: String, icon: String? = null, image: ResString? = null, classes: Set<String> = setOf(), init: Link.() -> Unit = null): Link` -`fun DropDown.linkDisabled(label: String, icon: String? = null, image: ResString? = null, classes: Set<String> = setOf(), init: Link.() -> Unit = null): Link` - DSL builder extension function for a disabled link in a dropdown list. -

- - diff --git a/api/pl.treksoft.kvision.html/-link/label.html b/api/pl.treksoft.kvision.html/-link/label.html deleted file mode 100644 index 2210e2d1..00000000 --- a/api/pl.treksoft.kvision.html/-link/label.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -Link.label - kvision - - - -kvision / pl.treksoft.kvision.html / Link / label
-
-

label

- -var label: String -

Link label.

Getter
-

Link label.

Setter
-

Link label.

- - diff --git a/api/pl.treksoft.kvision.html/-link/link-disabled.html b/api/pl.treksoft.kvision.html/-link/link-disabled.html deleted file mode 100644 index c0fb5a9f..00000000 --- a/api/pl.treksoft.kvision.html/-link/link-disabled.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -Link.linkDisabled - kvision - - - -kvision / pl.treksoft.kvision.html / Link / linkDisabled
-
-

linkDisabled

- -

fun ListTag.linkDisabled(label: String, icon: String? = null, image: ResString? = null, classes: Set<String> = setOf(), init: Link.() -> Unit = null): Link

- -

fun DropDown.linkDisabled(label: String, icon: String? = null, image: ResString? = null, classes: Set<String> = setOf(), init: Link.() -> Unit = null): Link

DSL builder extension function for a disabled link in a dropdown list.

It takes the same parameters as the constructor of the built component.

- - diff --git a/api/pl.treksoft.kvision.html/-link/link.html b/api/pl.treksoft.kvision.html/-link/link.html deleted file mode 100644 index 1ec358d0..00000000 --- a/api/pl.treksoft.kvision.html/-link/link.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -Link.link - kvision - - - -kvision / pl.treksoft.kvision.html / Link / link
-
-

link

- -

fun Container.link(label: String, url: String? = null, icon: String? = null, image: ResString? = null, classes: Set<String> = setOf(), init: Link.() -> Unit = null): Link

DSL builder extension function.

It takes the same parameters as the constructor of the built component.

- - diff --git a/api/pl.treksoft.kvision.html/-link/on-click.html b/api/pl.treksoft.kvision.html/-link/on-click.html deleted file mode 100644 index ca274fbf..00000000 --- a/api/pl.treksoft.kvision.html/-link/on-click.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -Link.onClick - kvision - - - -kvision / pl.treksoft.kvision.html / Link / onClick
-
-

onClick

- -open fun onClick(handler: Link.(MouseEvent) -> Unit): Link -

A convenient helper for easy setting onClick event handler.

- - diff --git a/api/pl.treksoft.kvision.html/-link/render.html b/api/pl.treksoft.kvision.html/-link/render.html deleted file mode 100644 index 295bfb6f..00000000 --- a/api/pl.treksoft.kvision.html/-link/render.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -Link.render - kvision - - - -kvision / pl.treksoft.kvision.html / Link / render
-
-

render

- -protected open fun render(): VNode -

Overrides SimplePanel.render

Renders current component as a Snabbdom vnode.

Return
-Snabbdom vnode

- - diff --git a/api/pl.treksoft.kvision.html/-link/url.html b/api/pl.treksoft.kvision.html/-link/url.html deleted file mode 100644 index dd509277..00000000 --- a/api/pl.treksoft.kvision.html/-link/url.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -Link.url - kvision - - - -kvision / pl.treksoft.kvision.html / Link / url
-
-

url

- -var url: String? -

Link URL address.

Getter
-

Link URL address.

Setter
-

Link URL address.

- - -- cgit