From eb930482e9972a21d39f2aea8b813acf58ff5b64 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Mon, 22 Oct 2018 00:01:39 +0200 Subject: API documentation for KVision 0.0.19 --- .../-button-group-size/-l-a-r-g-e.html | 14 ++ .../-button-group-size/-s-m-a-l-l.html | 14 ++ .../-button-group-size/-x-s-m-a-l-l.html | 14 ++ .../-button-group-size/index.html | 40 ++++++ .../-button-group-style/-j-u-s-t-i-f-i-e-d.html | 14 ++ .../-button-group-style/-v-e-r-t-i-c-a-l.html | 14 ++ .../-button-group-style/index.html | 33 +++++ .../-button-group/-init-.html | 25 ++++ .../-button-group/button-group.html | 16 +++ .../-button-group/get-sn-class.html | 18 +++ .../-button-group/index.html | 154 +++++++++++++++++++++ .../-button-group/size.html | 21 +++ .../-button-group/style.html | 21 +++ .../-toolbar/-init-.html | 21 +++ .../-toolbar/index.html | 117 ++++++++++++++++ .../-toolbar/toolbar.html | 16 +++ api/pl.treksoft.kvision.toolbar/index.html | 54 ++++++++ 17 files changed, 606 insertions(+) create mode 100644 api/pl.treksoft.kvision.toolbar/-button-group-size/-l-a-r-g-e.html create mode 100644 api/pl.treksoft.kvision.toolbar/-button-group-size/-s-m-a-l-l.html create mode 100644 api/pl.treksoft.kvision.toolbar/-button-group-size/-x-s-m-a-l-l.html create mode 100644 api/pl.treksoft.kvision.toolbar/-button-group-size/index.html create mode 100644 api/pl.treksoft.kvision.toolbar/-button-group-style/-j-u-s-t-i-f-i-e-d.html create mode 100644 api/pl.treksoft.kvision.toolbar/-button-group-style/-v-e-r-t-i-c-a-l.html create mode 100644 api/pl.treksoft.kvision.toolbar/-button-group-style/index.html create mode 100644 api/pl.treksoft.kvision.toolbar/-button-group/-init-.html create mode 100644 api/pl.treksoft.kvision.toolbar/-button-group/button-group.html create mode 100644 api/pl.treksoft.kvision.toolbar/-button-group/get-sn-class.html create mode 100644 api/pl.treksoft.kvision.toolbar/-button-group/index.html create mode 100644 api/pl.treksoft.kvision.toolbar/-button-group/size.html create mode 100644 api/pl.treksoft.kvision.toolbar/-button-group/style.html create mode 100644 api/pl.treksoft.kvision.toolbar/-toolbar/-init-.html create mode 100644 api/pl.treksoft.kvision.toolbar/-toolbar/index.html create mode 100644 api/pl.treksoft.kvision.toolbar/-toolbar/toolbar.html create mode 100644 api/pl.treksoft.kvision.toolbar/index.html (limited to 'api/pl.treksoft.kvision.toolbar') diff --git a/api/pl.treksoft.kvision.toolbar/-button-group-size/-l-a-r-g-e.html b/api/pl.treksoft.kvision.toolbar/-button-group-size/-l-a-r-g-e.html new file mode 100644 index 00000000..b0c8a5d3 --- /dev/null +++ b/api/pl.treksoft.kvision.toolbar/-button-group-size/-l-a-r-g-e.html @@ -0,0 +1,14 @@ + + + +ButtonGroupSize.LARGE - kvision + + + +kvision / pl.treksoft.kvision.toolbar / ButtonGroupSize / LARGE
+
+

LARGE

+ +LARGE + + diff --git a/api/pl.treksoft.kvision.toolbar/-button-group-size/-s-m-a-l-l.html b/api/pl.treksoft.kvision.toolbar/-button-group-size/-s-m-a-l-l.html new file mode 100644 index 00000000..accaddfd --- /dev/null +++ b/api/pl.treksoft.kvision.toolbar/-button-group-size/-s-m-a-l-l.html @@ -0,0 +1,14 @@ + + + +ButtonGroupSize.SMALL - kvision + + + +kvision / pl.treksoft.kvision.toolbar / ButtonGroupSize / SMALL
+
+

SMALL

+ +SMALL + + diff --git a/api/pl.treksoft.kvision.toolbar/-button-group-size/-x-s-m-a-l-l.html b/api/pl.treksoft.kvision.toolbar/-button-group-size/-x-s-m-a-l-l.html new file mode 100644 index 00000000..f80e438c --- /dev/null +++ b/api/pl.treksoft.kvision.toolbar/-button-group-size/-x-s-m-a-l-l.html @@ -0,0 +1,14 @@ + + + +ButtonGroupSize.XSMALL - kvision + + + +kvision / pl.treksoft.kvision.toolbar / ButtonGroupSize / XSMALL
+
+

XSMALL

+ +XSMALL + + diff --git a/api/pl.treksoft.kvision.toolbar/-button-group-size/index.html b/api/pl.treksoft.kvision.toolbar/-button-group-size/index.html new file mode 100644 index 00000000..b7c2cf4d --- /dev/null +++ b/api/pl.treksoft.kvision.toolbar/-button-group-size/index.html @@ -0,0 +1,40 @@ + + + +ButtonGroupSize - kvision + + + +kvision / pl.treksoft.kvision.toolbar / ButtonGroupSize
+
+

ButtonGroupSize

+enum class ButtonGroupSize +

Button group sizes.

Enum Values

+ + + + + + + + + + + + + + + +

+ LARGE +	+
+ SMALL +	+
+ XSMALL +	+

+ + diff --git a/api/pl.treksoft.kvision.toolbar/-button-group-style/-j-u-s-t-i-f-i-e-d.html b/api/pl.treksoft.kvision.toolbar/-button-group-style/-j-u-s-t-i-f-i-e-d.html new file mode 100644 index 00000000..a18fad28 --- /dev/null +++ b/api/pl.treksoft.kvision.toolbar/-button-group-style/-j-u-s-t-i-f-i-e-d.html @@ -0,0 +1,14 @@ + + + +ButtonGroupStyle.JUSTIFIED - kvision + + + +kvision / pl.treksoft.kvision.toolbar / ButtonGroupStyle / JUSTIFIED
+
+

JUSTIFIED

+ +JUSTIFIED + + diff --git a/api/pl.treksoft.kvision.toolbar/-button-group-style/-v-e-r-t-i-c-a-l.html b/api/pl.treksoft.kvision.toolbar/-button-group-style/-v-e-r-t-i-c-a-l.html new file mode 100644 index 00000000..c5b93cc3 --- /dev/null +++ b/api/pl.treksoft.kvision.toolbar/-button-group-style/-v-e-r-t-i-c-a-l.html @@ -0,0 +1,14 @@ + + + +ButtonGroupStyle.VERTICAL - kvision + + + +kvision / pl.treksoft.kvision.toolbar / ButtonGroupStyle / VERTICAL
+
+

VERTICAL

+ +VERTICAL + + diff --git a/api/pl.treksoft.kvision.toolbar/-button-group-style/index.html b/api/pl.treksoft.kvision.toolbar/-button-group-style/index.html new file mode 100644 index 00000000..19f947e7 --- /dev/null +++ b/api/pl.treksoft.kvision.toolbar/-button-group-style/index.html @@ -0,0 +1,33 @@ + + + +ButtonGroupStyle - kvision + + + +kvision / pl.treksoft.kvision.toolbar / ButtonGroupStyle
+
+

ButtonGroupStyle

+enum class ButtonGroupStyle +

Button group styles.

Enum Values

+ + + + + + + + + + + +

+ VERTICAL +	+
+ JUSTIFIED +	+

+ + diff --git a/api/pl.treksoft.kvision.toolbar/-button-group/-init-.html b/api/pl.treksoft.kvision.toolbar/-button-group/-init-.html new file mode 100644 index 00000000..78e5fd3c --- /dev/null +++ b/api/pl.treksoft.kvision.toolbar/-button-group/-init-.html @@ -0,0 +1,25 @@ + + + +ButtonGroup.<init> - kvision + + + +kvision / pl.treksoft.kvision.toolbar / ButtonGroup / <init>
+
+

<init>

+ +

ButtonGroup(size: ButtonGroupSize? = null, style: ButtonGroupStyle? = null, classes: Set<String> = setOf(), init: ButtonGroup.() -> Unit = null)

Parameters

+size - button group size

+style - button group style

+classes - a set of CSS class names

+init - an initializer extension function

Constructor
+

+ + diff --git a/api/pl.treksoft.kvision.toolbar/-button-group/button-group.html b/api/pl.treksoft.kvision.toolbar/-button-group/button-group.html new file mode 100644 index 00000000..de865d64 --- /dev/null +++ b/api/pl.treksoft.kvision.toolbar/-button-group/button-group.html @@ -0,0 +1,16 @@ + + + +ButtonGroup.buttonGroup - kvision + + + +kvision / pl.treksoft.kvision.toolbar / ButtonGroup / buttonGroup
+
+

buttonGroup

+ +

fun Container.buttonGroup(size: ButtonGroupSize? = null, style: ButtonGroupStyle? = null, classes: Set<String> = setOf(), init: ButtonGroup.() -> Unit = null): ButtonGroup

DSL builder extension function.

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

+ + diff --git a/api/pl.treksoft.kvision.toolbar/-button-group/get-sn-class.html b/api/pl.treksoft.kvision.toolbar/-button-group/get-sn-class.html new file mode 100644 index 00000000..aeab6d5d --- /dev/null +++ b/api/pl.treksoft.kvision.toolbar/-button-group/get-sn-class.html @@ -0,0 +1,18 @@ + + + +ButtonGroup.getSnClass - kvision + + + +kvision / pl.treksoft.kvision.toolbar / ButtonGroup / getSnClass
+
+

getSnClass

+ +protected open fun getSnClass(): List<StringBoolPair> +

Overrides Widget.getSnClass

Returns list of CSS class names for current widget in the form of a List.

Return
+list of CSS class names

+ + diff --git a/api/pl.treksoft.kvision.toolbar/-button-group/index.html b/api/pl.treksoft.kvision.toolbar/-button-group/index.html new file mode 100644 index 00000000..1bd557f5 --- /dev/null +++ b/api/pl.treksoft.kvision.toolbar/-button-group/index.html @@ -0,0 +1,154 @@ + + + +ButtonGroup - kvision + + + +kvision / pl.treksoft.kvision.toolbar / ButtonGroup
+
+

ButtonGroup

+open class ButtonGroup : SimplePanel +

The Bootstrap button group.

Constructors

+ + + + + + + +

<init>

ButtonGroup(size: ButtonGroupSize? = null, style: ButtonGroupStyle? = null, classes: Set<String> = setOf(), init: ButtonGroup.() -> Unit = null)

Properties

+ + + + + + + + + + + +

+ size +	+`var size: ButtonGroupSize?` + Button group size. +
+ style +	+`var style: ButtonGroupStyle?` + Button group style. +

Functions

+ + + + + + + +

getSnClass

+open fun getSnClass(): List<StringBoolPair> +

Returns list of CSS class names for current widget in the form of a List.

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. +
+ render +	+`open fun render(): VNode` + Renders current component as a Snabbdom vnode. +

Companion Object Functions

+ + + + + + + +

buttonGroup

fun Container.buttonGroup(size: ButtonGroupSize? = null, style: ButtonGroupStyle? = null, classes: Set<String> = setOf(), init: ButtonGroup.() -> Unit = null): ButtonGroup

DSL builder extension function.

+ + diff --git a/api/pl.treksoft.kvision.toolbar/-button-group/size.html b/api/pl.treksoft.kvision.toolbar/-button-group/size.html new file mode 100644 index 00000000..7df5d98c --- /dev/null +++ b/api/pl.treksoft.kvision.toolbar/-button-group/size.html @@ -0,0 +1,21 @@ + + + +ButtonGroup.size - kvision + + + +kvision / pl.treksoft.kvision.toolbar / ButtonGroup / size
+
+

size

+ +var size: ButtonGroupSize? +

Button group size.

Getter
+

Button group size.

Setter
+

Button group size.

+ + diff --git a/api/pl.treksoft.kvision.toolbar/-button-group/style.html b/api/pl.treksoft.kvision.toolbar/-button-group/style.html new file mode 100644 index 00000000..6797cd38 --- /dev/null +++ b/api/pl.treksoft.kvision.toolbar/-button-group/style.html @@ -0,0 +1,21 @@ + + + +ButtonGroup.style - kvision + + + +kvision / pl.treksoft.kvision.toolbar / ButtonGroup / style
+
+

style

+ +var style: ButtonGroupStyle? +

Button group style.

Getter
+

Button group style.

Setter
+

Button group style.

+ + diff --git a/api/pl.treksoft.kvision.toolbar/-toolbar/-init-.html b/api/pl.treksoft.kvision.toolbar/-toolbar/-init-.html new file mode 100644 index 00000000..204b5b01 --- /dev/null +++ b/api/pl.treksoft.kvision.toolbar/-toolbar/-init-.html @@ -0,0 +1,21 @@ + + + +Toolbar.<init> - kvision + + + +kvision / pl.treksoft.kvision.toolbar / Toolbar / <init>
+
+

<init>

+ +Toolbar(classes: Set<String> = setOf(), init: Toolbar.() -> Unit = null) +

Parameters

+classes - a set of CSS class names

+init - an initializer extension function

Constructor
+

+ + diff --git a/api/pl.treksoft.kvision.toolbar/-toolbar/index.html b/api/pl.treksoft.kvision.toolbar/-toolbar/index.html new file mode 100644 index 00000000..bb1c3757 --- /dev/null +++ b/api/pl.treksoft.kvision.toolbar/-toolbar/index.html @@ -0,0 +1,117 @@ + + + +Toolbar - kvision + + + +kvision / pl.treksoft.kvision.toolbar / Toolbar
+
+

Toolbar

+open class Toolbar : SimplePanel +

The Bootstrap toolbar.

Constructors

+ + + + + + + +

<init>

+Toolbar(classes: Set<String> = setOf(), init: Toolbar.() -> Unit = null)

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. +
+ render +	+`open fun render(): VNode` + Renders current component as a Snabbdom vnode. +

Companion Object Functions

+ + + + + + + +

toolbar

+fun Container.toolbar(classes: Set<String> = setOf(), init: Toolbar.() -> Unit = null): Toolbar +

DSL builder extension function.

+ + diff --git a/api/pl.treksoft.kvision.toolbar/-toolbar/toolbar.html b/api/pl.treksoft.kvision.toolbar/-toolbar/toolbar.html new file mode 100644 index 00000000..21bcfa63 --- /dev/null +++ b/api/pl.treksoft.kvision.toolbar/-toolbar/toolbar.html @@ -0,0 +1,16 @@ + + + +Toolbar.toolbar - kvision + + + +kvision / pl.treksoft.kvision.toolbar / Toolbar / toolbar
+
+

toolbar

+ +fun Container.toolbar(classes: Set<String> = setOf(), init: Toolbar.() -> Unit = null): Toolbar +

DSL builder extension function.

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

+ + diff --git a/api/pl.treksoft.kvision.toolbar/index.html b/api/pl.treksoft.kvision.toolbar/index.html new file mode 100644 index 00000000..fa8e63b1 --- /dev/null +++ b/api/pl.treksoft.kvision.toolbar/index.html @@ -0,0 +1,54 @@ + + + +pl.treksoft.kvision.toolbar - kvision + + + +kvision / pl.treksoft.kvision.toolbar
+
+

Package pl.treksoft.kvision.toolbar

Toolbar and button group components.

Types

+ + + + + + + + + + + + + + + + + + + +

+ ButtonGroup +	+`open class ButtonGroup : SimplePanel` + The Bootstrap button group. +
+ ButtonGroupSize +	+`enum class ButtonGroupSize` + Button group sizes. +
+ ButtonGroupStyle +	+`enum class ButtonGroupStyle` + Button group styles. +
+ Toolbar +	+`open class Toolbar : SimplePanel` + The Bootstrap toolbar. +

+ + -- cgit