From 0365722f8549ee93918be99da1b9f901cf0b2c8d Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Fri, 13 Mar 2020 01:05:20 +0100 Subject: API documentation for KVision 3.5.2 --- api/pl.treksoft.kvision.core/-widget/-init-.html | 2 +- .../-widget/-refresh-delegate-provider/-init-.html | 4 +- .../-widget/-refresh-delegate-provider/index.html | 12 +- .../provide-delegate.html | 4 +- .../-widget/-refresh-delegate/-init-.html | 4 +- .../-widget/-refresh-delegate/get-value.html | 4 +- .../-widget/-refresh-delegate/index.html | 17 +- .../-widget/-refresh-delegate/set-value.html | 4 +- .../-widget/add-css-class.html | 3 +- .../-widget/add-css-style.html | 3 +- .../-widget/add-surrounding-css-class.html | 3 +- .../-widget/add-surrounding-css-style.html | 3 +- .../-widget/after-create.html | 2 +- .../-widget/after-destroy.html | 2 +- .../-widget/after-insert.html | 2 +- .../-widget/clear-drag-drop-data.html | 2 +- .../-widget/disable-popover.html | 2 +- .../-widget/disable-tooltip.html | 2 +- .../-widget/dispatch-event.html | 2 +- .../-widget/draggable.html | 2 +- .../-widget/enable-popover.html | 2 +- .../-widget/enable-tooltip.html | 2 +- .../-widget/event-target.html | 2 +- .../-widget/get-attribute.html | 3 +- .../-widget/get-element-j-query-d.html | 3 +- .../-widget/get-element-j-query.html | 3 +- .../-widget/get-element.html | 3 +- .../-widget/get-sn-attrs.html | 2 +- .../-widget/get-sn-class.html | 2 +- .../-widget/get-sn-hooks.html | 2 +- .../-widget/get-sn-on.html | 2 +- .../-widget/hide-popover.html | 2 +- .../-widget/hide-tooltip.html | 2 +- api/pl.treksoft.kvision.core/-widget/hide.html | 2 +- api/pl.treksoft.kvision.core/-widget/id.html | 2 +- api/pl.treksoft.kvision.core/-widget/index.html | 1092 +++++--------------- .../-widget/last-language.html | 2 +- api/pl.treksoft.kvision.core/-widget/parent.html | 3 +- .../-widget/popover-options.html | 2 +- .../-widget/refresh-on-update.html | 6 +- .../-widget/remove-attribute.html | 3 +- .../-widget/remove-css-class.html | 3 +- .../-widget/remove-css-style.html | 3 +- .../-widget/remove-event-listener.html | 2 +- .../-widget/remove-event-listeners.html | 2 +- .../-widget/remove-surrounding-css-class.html | 3 +- .../-widget/remove-surrounding-css-style.html | 3 +- api/pl.treksoft.kvision.core/-widget/render.html | 6 +- api/pl.treksoft.kvision.core/-widget/role.html | 2 +- .../-widget/set-attribute.html | 3 +- .../-widget/set-drag-drop-data.html | 2 +- .../-widget/set-drop-target-data.html | 2 +- .../-widget/set-drop-target.html | 4 +- .../-widget/set-event-listener.html | 4 +- .../-widget/show-popover.html | 2 +- .../-widget/show-tooltip.html | 2 +- api/pl.treksoft.kvision.core/-widget/show.html | 2 +- .../-widget/single-render.html | 4 +- .../-widget/surrounding-span.html | 2 +- api/pl.treksoft.kvision.core/-widget/tabindex.html | 2 +- api/pl.treksoft.kvision.core/-widget/title.html | 2 +- .../-widget/toggle-visible.html | 2 +- .../-widget/tooltip-options.html | 2 +- .../-widget/translate.html | 4 +- api/pl.treksoft.kvision.core/-widget/visible.html | 3 +- api/pl.treksoft.kvision.core/-widget/vnode.html | 2 +- 66 files changed, 369 insertions(+), 920 deletions(-) (limited to 'api/pl.treksoft.kvision.core/-widget') diff --git a/api/pl.treksoft.kvision.core/-widget/-init-.html b/api/pl.treksoft.kvision.core/-widget/-init-.html index 3d40fa05..a97b4712 100644 --- a/api/pl.treksoft.kvision.core/-widget/-init-.html +++ b/api/pl.treksoft.kvision.core/-widget/-init-.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.core / Widget / <init>

<init>

- +(js) Widget(classes: Set<String> = setOf())

Creates basic Widget with given CSS class names.

Parameters

diff --git a/api/pl.treksoft.kvision.core/-widget/-refresh-delegate-provider/-init-.html b/api/pl.treksoft.kvision.core/-widget/-refresh-delegate-provider/-init-.html index de300ba9..95315a72 100644 --- a/api/pl.treksoft.kvision.core/-widget/-refresh-delegate-provider/-init-.html +++ b/api/pl.treksoft.kvision.core/-widget/-refresh-delegate-provider/-init-.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.core / Widget / RefreshDelegateProvider / <init>

<init>

- -RefreshDelegateProvider(initialValue: T?, refreshFunction: (T) -> Unit) +(js) +RefreshDelegateProvider(initialValue: T?, refreshFunction: (T) -> Unit) diff --git a/api/pl.treksoft.kvision.core/-widget/-refresh-delegate-provider/index.html b/api/pl.treksoft.kvision.core/-widget/-refresh-delegate-provider/index.html index 231d340a..ea113a17 100644 --- a/api/pl.treksoft.kvision.core/-widget/-refresh-delegate-provider/index.html +++ b/api/pl.treksoft.kvision.core/-widget/-refresh-delegate-provider/index.html @@ -8,16 +8,17 @@ kvision / pl.treksoft.kvision.core / Widget / RefreshDelegateProvider

RefreshDelegateProvider

-protected inner class RefreshDelegateProvider<T> +(js) protected inner class RefreshDelegateProvider<T>

Constructors

+RefreshDelegateProvider(initialValue: T?, refreshFunction: (T) -> Unit)
-

<init>

+(js) +

<init>

-RefreshDelegateProvider(initialValue: T?, refreshFunction: (T) -> Unit)
@@ -26,10 +27,11 @@ -

provideDelegate

+(js) +

provideDelegate

-operator fun provideDelegate(thisRef: Any?, prop: KProperty<*>): Widget.RefreshDelegate<T> +operator fun provideDelegate(thisRef: Any?, prop: KProperty<*>): RefreshDelegate<T> diff --git a/api/pl.treksoft.kvision.core/-widget/-refresh-delegate-provider/provide-delegate.html b/api/pl.treksoft.kvision.core/-widget/-refresh-delegate-provider/provide-delegate.html index e726c720..9ce525b1 100644 --- a/api/pl.treksoft.kvision.core/-widget/-refresh-delegate-provider/provide-delegate.html +++ b/api/pl.treksoft.kvision.core/-widget/-refresh-delegate-provider/provide-delegate.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.core / Widget / RefreshDelegateProvider / provideDelegate

provideDelegate

- -operator fun provideDelegate(thisRef: Any?, prop: KProperty<*>): Widget.RefreshDelegate<T> +(js) +operator fun provideDelegate(thisRef: Any?, prop: KProperty<*>): RefreshDelegate<T> diff --git a/api/pl.treksoft.kvision.core/-widget/-refresh-delegate/-init-.html b/api/pl.treksoft.kvision.core/-widget/-refresh-delegate/-init-.html index ffe56f3b..32f397ec 100644 --- a/api/pl.treksoft.kvision.core/-widget/-refresh-delegate/-init-.html +++ b/api/pl.treksoft.kvision.core/-widget/-refresh-delegate/-init-.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.core / Widget / RefreshDelegate / <init>

<init>

- -RefreshDelegate(refreshFunction: (T) -> Unit) +(js) +RefreshDelegate(refreshFunction: (T) -> Unit) diff --git a/api/pl.treksoft.kvision.core/-widget/-refresh-delegate/get-value.html b/api/pl.treksoft.kvision.core/-widget/-refresh-delegate/get-value.html index ab2b6578..a435337b 100644 --- a/api/pl.treksoft.kvision.core/-widget/-refresh-delegate/get-value.html +++ b/api/pl.treksoft.kvision.core/-widget/-refresh-delegate/get-value.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.core / Widget / RefreshDelegate / getValue

getValue

- -operator fun getValue(thisRef: StyledComponent, property: KProperty<*>): T +(js) +operator fun getValue(thisRef: StyledComponent, property: KProperty<*>): T diff --git a/api/pl.treksoft.kvision.core/-widget/-refresh-delegate/index.html b/api/pl.treksoft.kvision.core/-widget/-refresh-delegate/index.html index 0aa1544f..bf4d2967 100644 --- a/api/pl.treksoft.kvision.core/-widget/-refresh-delegate/index.html +++ b/api/pl.treksoft.kvision.core/-widget/-refresh-delegate/index.html @@ -8,16 +8,17 @@ kvision / pl.treksoft.kvision.core / Widget / RefreshDelegate

RefreshDelegate

-protected inner class RefreshDelegate<T> +(js) protected inner class RefreshDelegate<T>

Constructors

+RefreshDelegate(refreshFunction: (T) -> Unit)
-

<init>

+(js) +

<init>

-RefreshDelegate(refreshFunction: (T) -> Unit)
@@ -26,17 +27,19 @@ -

getValue

+(js) +

getValue

-operator fun getValue(thisRef: StyledComponent, property: KProperty<*>): T +operator fun getValue(thisRef: StyledComponent, property: KProperty<*>): T -

setValue

+(js) +

setValue

-operator fun setValue(thisRef: StyledComponent, property: KProperty<*>, value: T): Unit +operator fun setValue(thisRef: StyledComponent, property: KProperty<*>, value: T): Unit diff --git a/api/pl.treksoft.kvision.core/-widget/-refresh-delegate/set-value.html b/api/pl.treksoft.kvision.core/-widget/-refresh-delegate/set-value.html index 478219f2..9380bb0c 100644 --- a/api/pl.treksoft.kvision.core/-widget/-refresh-delegate/set-value.html +++ b/api/pl.treksoft.kvision.core/-widget/-refresh-delegate/set-value.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.core / Widget / RefreshDelegate / setValue

setValue

- -operator fun setValue(thisRef: StyledComponent, property: KProperty<*>, value: T): Unit +(js) +operator fun setValue(thisRef: StyledComponent, property: KProperty<*>, value: T): Unit diff --git a/api/pl.treksoft.kvision.core/-widget/add-css-class.html b/api/pl.treksoft.kvision.core/-widget/add-css-class.html index 6f78cf17..9c449236 100644 --- a/api/pl.treksoft.kvision.core/-widget/add-css-class.html +++ b/api/pl.treksoft.kvision.core/-widget/add-css-class.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.core / Widget / addCssClass

addCssClass

- +(js) open fun addCssClass(css: String): Widget -

Overrides Component.addCssClass

Adds given value to the set of CSS classes generated in html code of current component.

Parameters

diff --git a/api/pl.treksoft.kvision.core/-widget/add-css-style.html b/api/pl.treksoft.kvision.core/-widget/add-css-style.html index 06a273f1..a98a7005 100644 --- a/api/pl.treksoft.kvision.core/-widget/add-css-style.html +++ b/api/pl.treksoft.kvision.core/-widget/add-css-style.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.core / Widget / addCssStyle

addCssStyle

- +(js) open fun addCssStyle(css: Style): Widget -

Overrides Component.addCssStyle

Adds given style object to the set of CSS classes generated in html code of current component.

Parameters

diff --git a/api/pl.treksoft.kvision.core/-widget/add-surrounding-css-class.html b/api/pl.treksoft.kvision.core/-widget/add-surrounding-css-class.html index ddcf07ae..229b3cfe 100644 --- a/api/pl.treksoft.kvision.core/-widget/add-surrounding-css-class.html +++ b/api/pl.treksoft.kvision.core/-widget/add-surrounding-css-class.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.core / Widget / addSurroundingCssClass

addSurroundingCssClass

- +(js) open fun addSurroundingCssClass(css: String): Widget -

Overrides Component.addSurroundingCssClass

Adds given value to the set of CSS classes generated in html code of parent component.

Parameters

diff --git a/api/pl.treksoft.kvision.core/-widget/add-surrounding-css-style.html b/api/pl.treksoft.kvision.core/-widget/add-surrounding-css-style.html index 77363008..a2e952e1 100644 --- a/api/pl.treksoft.kvision.core/-widget/add-surrounding-css-style.html +++ b/api/pl.treksoft.kvision.core/-widget/add-surrounding-css-style.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.core / Widget / addSurroundingCssStyle

addSurroundingCssStyle

- +(js) open fun addSurroundingCssStyle(css: Style): Widget -

Overrides Component.addSurroundingCssStyle

Adds given style object to the set of CSS classes generated in html code of parent component.

Parameters

diff --git a/api/pl.treksoft.kvision.core/-widget/after-create.html b/api/pl.treksoft.kvision.core/-widget/after-create.html index eddad85d..eac91770 100644 --- a/api/pl.treksoft.kvision.core/-widget/after-create.html +++ b/api/pl.treksoft.kvision.core/-widget/after-create.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.core / Widget / afterCreate

afterCreate

- +(js) protected open fun afterCreate(node: VNode): Unit

Method called after creating Snabbdom vnode.

diff --git a/api/pl.treksoft.kvision.core/-widget/after-destroy.html b/api/pl.treksoft.kvision.core/-widget/after-destroy.html index cfdc5f09..d2fbd349 100644 --- a/api/pl.treksoft.kvision.core/-widget/after-destroy.html +++ b/api/pl.treksoft.kvision.core/-widget/after-destroy.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.core / Widget / afterDestroy

afterDestroy

- +(js) protected open fun afterDestroy(): Unit

Method called after destroying Snabbdom vnode.

diff --git a/api/pl.treksoft.kvision.core/-widget/after-insert.html b/api/pl.treksoft.kvision.core/-widget/after-insert.html index 04ed6c72..3ea3795a 100644 --- a/api/pl.treksoft.kvision.core/-widget/after-insert.html +++ b/api/pl.treksoft.kvision.core/-widget/after-insert.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.core / Widget / afterInsert

afterInsert

- +(js) protected open fun afterInsert(node: VNode): Unit

Method called after inserting Snabbdom vnode into the DOM.

diff --git a/api/pl.treksoft.kvision.core/-widget/clear-drag-drop-data.html b/api/pl.treksoft.kvision.core/-widget/clear-drag-drop-data.html index 2a6a3dc3..f83e1376 100644 --- a/api/pl.treksoft.kvision.core/-widget/clear-drag-drop-data.html +++ b/api/pl.treksoft.kvision.core/-widget/clear-drag-drop-data.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.core / Widget / clearDragDropData

clearDragDropData

- +(js) open fun clearDragDropData(): Unit

Clears D&D data for the current widget. It also makes it not draggable.

diff --git a/api/pl.treksoft.kvision.core/-widget/disable-popover.html b/api/pl.treksoft.kvision.core/-widget/disable-popover.html index 2db7a056..d34e4d33 100644 --- a/api/pl.treksoft.kvision.core/-widget/disable-popover.html +++ b/api/pl.treksoft.kvision.core/-widget/disable-popover.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.core / Widget / disablePopover

disablePopover

- +(js) open fun disablePopover(): Widget

Disables popover for the current widget.

Return
diff --git a/api/pl.treksoft.kvision.core/-widget/disable-tooltip.html b/api/pl.treksoft.kvision.core/-widget/disable-tooltip.html index dd2eea3f..ee893046 100644 --- a/api/pl.treksoft.kvision.core/-widget/disable-tooltip.html +++ b/api/pl.treksoft.kvision.core/-widget/disable-tooltip.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.core / Widget / disableTooltip

disableTooltip

- +(js) open fun disableTooltip(): Widget

Disables tooltip for the current widget.

Return
diff --git a/api/pl.treksoft.kvision.core/-widget/dispatch-event.html b/api/pl.treksoft.kvision.core/-widget/dispatch-event.html index 2f0cdf19..c804f5d5 100644 --- a/api/pl.treksoft.kvision.core/-widget/dispatch-event.html +++ b/api/pl.treksoft.kvision.core/-widget/dispatch-event.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.core / Widget / dispatchEvent

dispatchEvent

- +(js) protected open fun dispatchEvent(type: String, eventInitDict: CustomEventInit): Boolean? diff --git a/api/pl.treksoft.kvision.core/-widget/draggable.html b/api/pl.treksoft.kvision.core/-widget/draggable.html index 36163175..a395d128 100644 --- a/api/pl.treksoft.kvision.core/-widget/draggable.html +++ b/api/pl.treksoft.kvision.core/-widget/draggable.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.core / Widget / draggable

draggable

- +(js) var draggable: Boolean?

Determines if the current widget is draggable.

Getter
diff --git a/api/pl.treksoft.kvision.core/-widget/enable-popover.html b/api/pl.treksoft.kvision.core/-widget/enable-popover.html index f44dd1af..77a3dd86 100644 --- a/api/pl.treksoft.kvision.core/-widget/enable-popover.html +++ b/api/pl.treksoft.kvision.core/-widget/enable-popover.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.core / Widget / enablePopover

enablePopover

- +(js) open fun enablePopover(options: PopoverOptions = PopoverOptions()): Widget

Enables popover for the current widget.

Parameters

diff --git a/api/pl.treksoft.kvision.core/-widget/enable-tooltip.html b/api/pl.treksoft.kvision.core/-widget/enable-tooltip.html index 60de137e..1a6737a0 100644 --- a/api/pl.treksoft.kvision.core/-widget/enable-tooltip.html +++ b/api/pl.treksoft.kvision.core/-widget/enable-tooltip.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.core / Widget / enableTooltip

enableTooltip

- +(js) open fun enableTooltip(options: TooltipOptions = TooltipOptions()): Widget

Enables tooltip for the current widget.

Parameters

diff --git a/api/pl.treksoft.kvision.core/-widget/event-target.html b/api/pl.treksoft.kvision.core/-widget/event-target.html index df803991..2a577394 100644 --- a/api/pl.treksoft.kvision.core/-widget/event-target.html +++ b/api/pl.treksoft.kvision.core/-widget/event-target.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.core / Widget / eventTarget

eventTarget

- +(js) var eventTarget: Widget? diff --git a/api/pl.treksoft.kvision.core/-widget/get-attribute.html b/api/pl.treksoft.kvision.core/-widget/get-attribute.html index 52218802..eda2481a 100644 --- a/api/pl.treksoft.kvision.core/-widget/get-attribute.html +++ b/api/pl.treksoft.kvision.core/-widget/get-attribute.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.core / Widget / getAttribute

getAttribute

- +(js) open fun getAttribute(name: String): String? -

Overrides Component.getAttribute

Returns the value of an additional attribute.

Parameters

diff --git a/api/pl.treksoft.kvision.core/-widget/get-element-j-query-d.html b/api/pl.treksoft.kvision.core/-widget/get-element-j-query-d.html index 18f83cee..1a285d89 100644 --- a/api/pl.treksoft.kvision.core/-widget/get-element-j-query-d.html +++ b/api/pl.treksoft.kvision.core/-widget/get-element-j-query-d.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.core / Widget / getElementJQueryD

getElementJQueryD

- +(js) open fun getElementJQueryD(): dynamic -

Overrides Component.getElementJQueryD

Returns JQuery element bound to the current component as a dynamic type.

Return
JQuery element as a dynamic type

diff --git a/api/pl.treksoft.kvision.core/-widget/get-element-j-query.html b/api/pl.treksoft.kvision.core/-widget/get-element-j-query.html index ea593270..57526fb6 100644 --- a/api/pl.treksoft.kvision.core/-widget/get-element-j-query.html +++ b/api/pl.treksoft.kvision.core/-widget/get-element-j-query.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.core / Widget / getElementJQuery

getElementJQuery

- +(js) open fun getElementJQuery(): JQuery? -

Overrides Component.getElementJQuery

Returns JQuery element bound to the current component.

Return
JQuery element

diff --git a/api/pl.treksoft.kvision.core/-widget/get-element.html b/api/pl.treksoft.kvision.core/-widget/get-element.html index 440bd249..2479ad92 100644 --- a/api/pl.treksoft.kvision.core/-widget/get-element.html +++ b/api/pl.treksoft.kvision.core/-widget/get-element.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.core / Widget / getElement

getElement

- +(js) open fun getElement(): Node? -

Overrides Component.getElement

Returns DOM element bound to the current component.

Return
DOM element

diff --git a/api/pl.treksoft.kvision.core/-widget/get-sn-attrs.html b/api/pl.treksoft.kvision.core/-widget/get-sn-attrs.html index d884aedf..7ee398fa 100644 --- a/api/pl.treksoft.kvision.core/-widget/get-sn-attrs.html +++ b/api/pl.treksoft.kvision.core/-widget/get-sn-attrs.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.core / Widget / getSnAttrs

getSnAttrs

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

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

Return
diff --git a/api/pl.treksoft.kvision.core/-widget/get-sn-class.html b/api/pl.treksoft.kvision.core/-widget/get-sn-class.html index 9e93c61e..24b62e2c 100644 --- a/api/pl.treksoft.kvision.core/-widget/get-sn-class.html +++ b/api/pl.treksoft.kvision.core/-widget/get-sn-class.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.core / Widget / getSnClass

getSnClass

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

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

Return
diff --git a/api/pl.treksoft.kvision.core/-widget/get-sn-hooks.html b/api/pl.treksoft.kvision.core/-widget/get-sn-hooks.html index 0d34c2f7..9ac039cd 100644 --- a/api/pl.treksoft.kvision.core/-widget/get-sn-hooks.html +++ b/api/pl.treksoft.kvision.core/-widget/get-sn-hooks.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.core / Widget /