From 61545b3f1fb1844af350d187edd26285e98f0466 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Mon, 26 Feb 2018 14:21:46 +0100 Subject: API documentation update --- .../pl.treksoft.kvision.html/-image/-init-.html | 4 +- docs/api/pl.treksoft.kvision.html/-image/alt.html | 6 +++ .../pl.treksoft.kvision.html/-image/centered.html | 6 +++ .../api/pl.treksoft.kvision.html/-image/image.html | 4 +- .../api/pl.treksoft.kvision.html/-image/index.html | 52 ++++++++++++++++++++-- .../-image/responsive.html | 6 +++ .../api/pl.treksoft.kvision.html/-image/shape.html | 8 +++- docs/api/pl.treksoft.kvision.html/-image/src.html | 6 +++ 8 files changed, 84 insertions(+), 8 deletions(-) (limited to 'docs/api/pl.treksoft.kvision.html/-image') diff --git a/docs/api/pl.treksoft.kvision.html/-image/-init-.html b/docs/api/pl.treksoft.kvision.html/-image/-init-.html index 273c2b0b..b0677b33 100644 --- a/docs/api/pl.treksoft.kvision.html/-image/-init-.html +++ b/docs/api/pl.treksoft.kvision.html/-image/-init-.html @@ -8,8 +8,8 @@ kvision / pl.treksoft.kvision.html / Image / <init>

<init>

- -Image(src: ResString, alt: String? = null, responsive: Boolean = false, shape: IMAGESHAPE? = null, centered: Boolean = false, classes: Set<String> = setOf()) + +Image(src: ResString, alt: String? = null, responsive: Boolean = false, shape: ImageShape? = null, centered: Boolean = false, classes: Set<String> = setOf())

Parameters

src - image URL

diff --git a/docs/api/pl.treksoft.kvision.html/-image/alt.html b/docs/api/pl.treksoft.kvision.html/-image/alt.html index 1013f25a..3714f0e8 100644 --- a/docs/api/pl.treksoft.kvision.html/-image/alt.html +++ b/docs/api/pl.treksoft.kvision.html/-image/alt.html @@ -11,5 +11,11 @@ var alt: String?

The alternative text of the image.

+

Getter
+

The alternative text of the image.

+

+

Setter
+

The alternative text of the image.

+

diff --git a/docs/api/pl.treksoft.kvision.html/-image/centered.html b/docs/api/pl.treksoft.kvision.html/-image/centered.html index eeab6899..1c0a1eeb 100644 --- a/docs/api/pl.treksoft.kvision.html/-image/centered.html +++ b/docs/api/pl.treksoft.kvision.html/-image/centered.html @@ -11,5 +11,11 @@ var centered: Boolean

Determines if the image is rendered as centered.

+

Getter
+

Determines if the image is rendered as centered.

+

+

Setter
+

Determines if the image is rendered as centered.

+

diff --git a/docs/api/pl.treksoft.kvision.html/-image/image.html b/docs/api/pl.treksoft.kvision.html/-image/image.html index 4f07afd4..036314a9 100644 --- a/docs/api/pl.treksoft.kvision.html/-image/image.html +++ b/docs/api/pl.treksoft.kvision.html/-image/image.html @@ -8,8 +8,8 @@ kvision / pl.treksoft.kvision.html / Image / image

image

- -fun Container.image(src: ResString, alt: String? = null, responsive: Boolean = false, shape: IMAGESHAPE? = null, centered: Boolean = false, classes: Set<String> = setOf(), init: Image.() -> Unit = null): Image + +fun Container.image(src: ResString, alt: String? = null, responsive: Boolean = false, shape: ImageShape? = null, centered: Boolean = false, classes: Set<String> = setOf(), init: Image.() -> Unit = null): Image

DSL builder extension function.

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

diff --git a/docs/api/pl.treksoft.kvision.html/-image/index.html b/docs/api/pl.treksoft.kvision.html/-image/index.html index c065fc12..bb3d9315 100644 --- a/docs/api/pl.treksoft.kvision.html/-image/index.html +++ b/docs/api/pl.treksoft.kvision.html/-image/index.html @@ -18,7 +18,7 @@

<init>

-Image(src: ResString, alt: String? = null, responsive: Boolean = false, shape: IMAGESHAPE? = null, centered: Boolean = false, classes: Set<String> = setOf()) +Image(src: ResString, alt: String? = null, responsive: Boolean = false, shape: ImageShape? = null, centered: Boolean = false, classes: Set<String> = setOf()) @@ -57,7 +57,7 @@

shape

-var shape: IMAGESHAPE? +var shape: ImageShape?

The shape of the image.

@@ -77,6 +77,15 @@ +

draggable

+ + +var draggable: Boolean? +

Determines if the current widget is draggable.

+ + + +

id

@@ -213,6 +222,15 @@ +

clearDragDropData

+ + +open fun clearDragDropData(): Unit +

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

+ + + +

getElement

@@ -304,6 +322,34 @@ +

setDragDropData

+ + +open fun setDragDropData(format: String, data: String): Unit +

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

+ + + + +

setDropTarget

+ + +open fun setDropTarget(format: String, callback: (DragEvent) -> Unit): Unit
+open fun setDropTarget(formats: Set<String>? = null, callback: (DragEvent) -> Unit): Unit +

Sets the current widget as a D&D drop target.

+ + + + +

setDropTargetData

+ + +open fun setDropTargetData(format: String, callback: (String?) -> Unit): Unit +

Sets the current widget as a D&D drop target with helper callback accepting String data.

+ + + +

setEventListener

@@ -341,7 +387,7 @@

image

-fun Container.image(src: ResString, alt: String? = null, responsive: Boolean = false, shape: IMAGESHAPE? = null, centered: Boolean = false, classes: Set<String> = setOf(), init: Image.() -> Unit = null): Image +fun Container.image(src: ResString, alt: String? = null, responsive: Boolean = false, shape: ImageShape? = null, centered: Boolean = false, classes: Set<String> = setOf(), init: Image.() -> Unit = null): Image

DSL builder extension function.

diff --git a/docs/api/pl.treksoft.kvision.html/-image/responsive.html b/docs/api/pl.treksoft.kvision.html/-image/responsive.html index 74a6f6f6..20d3b977 100644 --- a/docs/api/pl.treksoft.kvision.html/-image/responsive.html +++ b/docs/api/pl.treksoft.kvision.html/-image/responsive.html @@ -11,5 +11,11 @@ var responsive: Boolean

Determines if the image is rendered as responsive.

+

Getter
+

Determines if the image is rendered as responsive.

+

+

Setter
+

Determines if the image is rendered as responsive.

+

diff --git a/docs/api/pl.treksoft.kvision.html/-image/shape.html b/docs/api/pl.treksoft.kvision.html/-image/shape.html index fffca115..2c23cb61 100644 --- a/docs/api/pl.treksoft.kvision.html/-image/shape.html +++ b/docs/api/pl.treksoft.kvision.html/-image/shape.html @@ -9,7 +9,13 @@

shape

-var shape: IMAGESHAPE? +var shape: ImageShape?

The shape of the image.

+

Getter
+

The shape of the image.

+

+

Setter
+

The shape of the image.

+

diff --git a/docs/api/pl.treksoft.kvision.html/-image/src.html b/docs/api/pl.treksoft.kvision.html/-image/src.html index a8c16278..c78b41b6 100644 --- a/docs/api/pl.treksoft.kvision.html/-image/src.html +++ b/docs/api/pl.treksoft.kvision.html/-image/src.html @@ -11,5 +11,11 @@ var src: ResString

URL of the image.

+

Getter
+

URL of the image.

+

+

Setter
+

URL of the image.

+

-- cgit