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 --- .../-widget/clear-drag-drop-data.html | 15 +++ .../-widget/draggable.html | 21 ++++ docs/api/pl.treksoft.kvision.core/-widget/id.html | 6 ++ .../pl.treksoft.kvision.core/-widget/index.html | 120 ++++++++++++++++++++- .../api/pl.treksoft.kvision.core/-widget/role.html | 6 ++ .../-widget/set-drag-drop-data.html | 20 ++++ .../-widget/set-drop-target-data.html | 20 ++++ .../-widget/set-drop-target.html | 28 +++++ .../pl.treksoft.kvision.core/-widget/title.html | 6 ++ 9 files changed, 241 insertions(+), 1 deletion(-) create mode 100644 docs/api/pl.treksoft.kvision.core/-widget/clear-drag-drop-data.html create mode 100644 docs/api/pl.treksoft.kvision.core/-widget/draggable.html create mode 100644 docs/api/pl.treksoft.kvision.core/-widget/set-drag-drop-data.html create mode 100644 docs/api/pl.treksoft.kvision.core/-widget/set-drop-target-data.html create mode 100644 docs/api/pl.treksoft.kvision.core/-widget/set-drop-target.html (limited to 'docs/api/pl.treksoft.kvision.core/-widget') diff --git a/docs/api/pl.treksoft.kvision.core/-widget/clear-drag-drop-data.html b/docs/api/pl.treksoft.kvision.core/-widget/clear-drag-drop-data.html new file mode 100644 index 00000000..2a6a3dc3 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-widget/clear-drag-drop-data.html @@ -0,0 +1,15 @@ + + + +Widget.clearDragDropData - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / clearDragDropData
+
+

clearDragDropData

+ +open fun clearDragDropData(): Unit +

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

+ + diff --git a/docs/api/pl.treksoft.kvision.core/-widget/draggable.html b/docs/api/pl.treksoft.kvision.core/-widget/draggable.html new file mode 100644 index 00000000..36163175 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-widget/draggable.html @@ -0,0 +1,21 @@ + + + +Widget.draggable - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / draggable
+
+

draggable

+ +var draggable: Boolean? +

Determines if the current widget is draggable.

Getter
+

Determines if the current widget is draggable.

Setter
+

Determines if the current widget is draggable.

+ + diff --git a/docs/api/pl.treksoft.kvision.core/-widget/id.html b/docs/api/pl.treksoft.kvision.core/-widget/id.html index b2df32cd..6dc07ce1 100644 --- a/docs/api/pl.treksoft.kvision.core/-widget/id.html +++ b/docs/api/pl.treksoft.kvision.core/-widget/id.html @@ -11,5 +11,11 @@ var id: String?

An ID attribute of generated HTML element.

Getter
+

An ID attribute of generated HTML element.

Setter
+

An ID attribute of generated HTML element.

diff --git a/docs/api/pl.treksoft.kvision.core/-widget/index.html b/docs/api/pl.treksoft.kvision.core/-widget/index.html index e8fca9b0..302b75d8 100644 --- a/docs/api/pl.treksoft.kvision.core/-widget/index.html +++ b/docs/api/pl.treksoft.kvision.core/-widget/index.html @@ -30,6 +30,15 @@ +

draggable

+ + +var draggable: Boolean? +

Determines if the current widget is draggable.

+ + + +

@@ -134,6 +143,15 @@ +

bottom

+ + +var bottom: CssSize? +

Bottom edge of the current component.

+ + + +

color

@@ -155,7 +173,7 @@

colorName

-var colorName: COLOR? +var colorName: Col?

Text color for the current component given with named constant (write only).

@@ -170,6 +188,15 @@ +

left

+ + +var left: CssSize? +

Left edge of the current component.

+ + + +

margin

@@ -260,6 +287,15 @@ +

overflow

+ + +var overflow: Overflow? +

CSS overflow of the current component.

+ + + +

padding

@@ -305,6 +341,42 @@ +

position

+ + +var position: Position? +

CSS position of the current component.

+ + + + +

resize

+ + +var resize: Resize? +

CSS resize of the current component.

+ + + + +

right

+ + +var right: CssSize? +

Right edge of the current component.

+ + + + +

top

+ + +var top: CssSize? +

Top edge of the current component.

+ + + +

width

@@ -312,6 +384,15 @@

Width of the current component.

+ + +

zIndex

+ + +var zIndex: Int? +

Z-index of the current component.

+ +

Functions

@@ -373,6 +454,15 @@ +

clearDragDropData

+ + +open fun clearDragDropData(): Unit +

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

+ + + +

getElement

@@ -483,6 +573,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

diff --git a/docs/api/pl.treksoft.kvision.core/-widget/role.html b/docs/api/pl.treksoft.kvision.core/-widget/role.html index 1b08d3b9..f70ff167 100644 --- a/docs/api/pl.treksoft.kvision.core/-widget/role.html +++ b/docs/api/pl.treksoft.kvision.core/-widget/role.html @@ -11,5 +11,11 @@ var role: String?

A role attribute of generated HTML element.

Getter
+

A role attribute of generated HTML element.

Setter
+

A role attribute of generated HTML element.

diff --git a/docs/api/pl.treksoft.kvision.core/-widget/set-drag-drop-data.html b/docs/api/pl.treksoft.kvision.core/-widget/set-drag-drop-data.html new file mode 100644 index 00000000..f3a125fc --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-widget/set-drag-drop-data.html @@ -0,0 +1,20 @@ + + + +Widget.setDragDropData - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / setDragDropData
+
+

setDragDropData

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

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

Parameters

+format - D&D data format

+data - D&D data transferred to a drop target

+ + diff --git a/docs/api/pl.treksoft.kvision.core/-widget/set-drop-target-data.html b/docs/api/pl.treksoft.kvision.core/-widget/set-drop-target-data.html new file mode 100644 index 00000000..9be734e9 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-widget/set-drop-target-data.html @@ -0,0 +1,20 @@ + + + +Widget.setDropTargetData - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / setDropTargetData
+
+

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.

Parameters

+format - accepted D&D data format

+callback - a callback function accepting String data called after any drop event

+ + diff --git a/docs/api/pl.treksoft.kvision.core/-widget/set-drop-target.html b/docs/api/pl.treksoft.kvision.core/-widget/set-drop-target.html new file mode 100644 index 00000000..238c5f81 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-widget/set-drop-target.html @@ -0,0 +1,28 @@ + + + +Widget.setDropTarget - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / setDropTarget
+
+

setDropTarget

+ +open fun setDropTarget(format: String, callback: (DragEvent) -> Unit): Unit +

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

Parameters

+format - accepted D&D data format

+callback - a callback function accepting event object called after any drop event

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

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

Parameters

+formats - a set of accepted D&D data formats

+callback - a callback function accepting event object called after any drop event

+ + diff --git a/docs/api/pl.treksoft.kvision.core/-widget/title.html b/docs/api/pl.treksoft.kvision.core/-widget/title.html index 98fe3eda..31ca42cc 100644 --- a/docs/api/pl.treksoft.kvision.core/-widget/title.html +++ b/docs/api/pl.treksoft.kvision.core/-widget/title.html @@ -11,5 +11,11 @@ var title: String?

A title attribute of generated HTML element.

Getter
+

A title attribute of generated HTML element.

Setter
+

A title attribute of generated HTML element.

-- cgit