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/-iframe/-init-.html | 31 -- .../-iframe/get-iframe-window.html | 17 - .../-iframe/get-sn-attrs.html | 18 - .../-iframe/iframe-height.html | 21 - .../-iframe/iframe-width.html | 21 - api/pl.treksoft.kvision.html/-iframe/iframe.html | 16 - api/pl.treksoft.kvision.html/-iframe/index.html | 468 --------------------- api/pl.treksoft.kvision.html/-iframe/location.html | 15 - api/pl.treksoft.kvision.html/-iframe/name.html | 21 - api/pl.treksoft.kvision.html/-iframe/render.html | 18 - api/pl.treksoft.kvision.html/-iframe/sandbox.html | 21 - api/pl.treksoft.kvision.html/-iframe/src.html | 21 - api/pl.treksoft.kvision.html/-iframe/srcdoc.html | 21 - 13 files changed, 709 deletions(-) delete mode 100644 api/pl.treksoft.kvision.html/-iframe/-init-.html delete mode 100644 api/pl.treksoft.kvision.html/-iframe/get-iframe-window.html delete mode 100644 api/pl.treksoft.kvision.html/-iframe/get-sn-attrs.html delete mode 100644 api/pl.treksoft.kvision.html/-iframe/iframe-height.html delete mode 100644 api/pl.treksoft.kvision.html/-iframe/iframe-width.html delete mode 100644 api/pl.treksoft.kvision.html/-iframe/iframe.html delete mode 100644 api/pl.treksoft.kvision.html/-iframe/index.html delete mode 100644 api/pl.treksoft.kvision.html/-iframe/location.html delete mode 100644 api/pl.treksoft.kvision.html/-iframe/name.html delete mode 100644 api/pl.treksoft.kvision.html/-iframe/render.html delete mode 100644 api/pl.treksoft.kvision.html/-iframe/sandbox.html delete mode 100644 api/pl.treksoft.kvision.html/-iframe/src.html delete mode 100644 api/pl.treksoft.kvision.html/-iframe/srcdoc.html (limited to 'api/pl.treksoft.kvision.html/-iframe') diff --git a/api/pl.treksoft.kvision.html/-iframe/-init-.html b/api/pl.treksoft.kvision.html/-iframe/-init-.html deleted file mode 100644 index 3823d817..00000000 --- a/api/pl.treksoft.kvision.html/-iframe/-init-.html +++ /dev/null @@ -1,31 +0,0 @@ - - - -Iframe.<init> - kvision - - - -kvision / pl.treksoft.kvision.html / Iframe / <init>
-
-

<init>

- -

Iframe(src: String? = null, srcdoc: String? = null, name: String? = null, iframeWidth: Int? = null, iframeHeight: Int? = null, sandbox: Set<Sandbox>? = null, classes: Set<String> = setOf())

Parameters

-src - the iframe document address

-srcdoc - the HTML content of the iframe

-name - the name of the iframe

-iframeWidth - the width of the iframe

-iframeHeight - the height of the iframe

-sandbox - a set of Sandbox options

-classes - a set of CSS class names

Constructor
-

- - diff --git a/api/pl.treksoft.kvision.html/-iframe/get-iframe-window.html b/api/pl.treksoft.kvision.html/-iframe/get-iframe-window.html deleted file mode 100644 index 41620da2..00000000 --- a/api/pl.treksoft.kvision.html/-iframe/get-iframe-window.html +++ /dev/null @@ -1,17 +0,0 @@ - - - -Iframe.getIframeWindow - kvision - - - -kvision / pl.treksoft.kvision.html / Iframe / getIframeWindow
-
-

getIframeWindow

- -open fun getIframeWindow(): Window -

Returns content window object of the iframe.

Return
-content window object

- - diff --git a/api/pl.treksoft.kvision.html/-iframe/get-sn-attrs.html b/api/pl.treksoft.kvision.html/-iframe/get-sn-attrs.html deleted file mode 100644 index 069b02a2..00000000 --- a/api/pl.treksoft.kvision.html/-iframe/get-sn-attrs.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -Iframe.getSnAttrs - kvision - - - -kvision / pl.treksoft.kvision.html / Iframe / 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/-iframe/iframe-height.html b/api/pl.treksoft.kvision.html/-iframe/iframe-height.html deleted file mode 100644 index a3f72945..00000000 --- a/api/pl.treksoft.kvision.html/-iframe/iframe-height.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -Iframe.iframeHeight - kvision - - - -kvision / pl.treksoft.kvision.html / Iframe / iframeHeight
-
-

iframeHeight

- -var iframeHeight: Int? -

The height of the iframe.

Getter
-

The height of the iframe.

Setter
-

The height of the iframe.

- - diff --git a/api/pl.treksoft.kvision.html/-iframe/iframe-width.html b/api/pl.treksoft.kvision.html/-iframe/iframe-width.html deleted file mode 100644 index 046d9634..00000000 --- a/api/pl.treksoft.kvision.html/-iframe/iframe-width.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -Iframe.iframeWidth - kvision - - - -kvision / pl.treksoft.kvision.html / Iframe / iframeWidth
-
-

iframeWidth

- -var iframeWidth: Int? -

The width of the iframe.

Getter
-

The width of the iframe.

Setter
-

The width of the iframe.

- - diff --git a/api/pl.treksoft.kvision.html/-iframe/iframe.html b/api/pl.treksoft.kvision.html/-iframe/iframe.html deleted file mode 100644 index 56e91573..00000000 --- a/api/pl.treksoft.kvision.html/-iframe/iframe.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -Iframe.iframe - kvision - - - -kvision / pl.treksoft.kvision.html / Iframe / iframe
-
-

iframe

- -

fun Container.iframe(src: String? = null, srcdoc: String? = null, name: String? = null, iframeWidth: Int? = null, iframeHeight: Int? = null, sandbox: Set<Sandbox>? = null, classes: Set<String> = setOf(), init: Iframe.() -> Unit = null): Iframe

DSL builder extension function.

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

- - diff --git a/api/pl.treksoft.kvision.html/-iframe/index.html b/api/pl.treksoft.kvision.html/-iframe/index.html deleted file mode 100644 index 4e03b204..00000000 --- a/api/pl.treksoft.kvision.html/-iframe/index.html +++ /dev/null @@ -1,468 +0,0 @@ - - - -Iframe - kvision - - - -kvision / pl.treksoft.kvision.html / Iframe
-
-

Iframe

-open class Iframe : Widget -

Iframe component.

Constructors

- - - - - - - -

<init>

Iframe(src: String? = null, srcdoc: String? = null, name: String? = null, iframeWidth: Int? = null, iframeHeight: Int? = null, sandbox: Set<Sandbox>? = null, classes: Set<String> = setOf())

Properties

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

- iframeHeight -	-`var iframeHeight: Int?` - The height of the iframe. -
- iframeWidth -	-`var iframeWidth: Int?` - The width of the iframe. -
- location -	-`var location: String?` - A current location URL of the iframe. -
- name -	-`var name: String?` - The name of the iframe. -
- sandbox -	-`var sandbox: Set<Sandbox>?` - A set of Sandbox options. -
- src -	-`var src: String?` - The iframe document address. -
- srcdoc -	-`var srcdoc: String?` - The HTML content of the iframe. -

Inherited Properties

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

- draggable -	-`var draggable: Boolean?` - Determines if the current widget is draggable. -
- eventTarget -	-`var eventTarget: Widget?`
- id -	-`var id: String?` - An ID attribute of generated HTML element. -
- lastLanguage -	-`var lastLanguage: String?`
- parent -	-`open var parent: Container?` - Parent of the current component. -
- role -	-`var role: String?` - A role attribute of generated HTML element. -
- surroundingSpan -	-`var surroundingSpan: Boolean`
- title -	-`var title: String?` - A title attribute of generated HTML element. -
- visible -	-`open var visible: Boolean` - Visibility state of the current component. -

Functions

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

- getIframeWindow -	-`open fun getIframeWindow(): Window` - Returns content window object of the iframe. -
- getSnAttrs -	-`open fun getSnAttrs(): List<StringPair>` - Returns list of element attributes in the form of a List. -
- render -	-`open fun render(): VNode` - Renders current component as a Snabbdom vnode. -

Inherited Functions

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

- addCssClass -	-`open fun addCssClass(css: String): Widget` - Adds given value to the set of CSS classes generated in html code of current component. -
- addSurroundingCssClass -	-`open fun addSurroundingCssClass(css: String): Widget` - Adds given value to the set of CSS classes generated in html code of parent component. -
- afterCreate -	-`open fun afterCreate(node: VNode): Unit` - Method called after creating Snabbdom vnode. -
- afterDestroy -	-`open fun afterDestroy(): Unit` - Method called after destroying Snabbdom vnode. -
- afterInsert -	-`open fun afterInsert(node: VNode): Unit` - Method called after inserting Snabbdom vnode into the DOM. -
- afterPostpatch -	-`open fun afterPostpatch(node: VNode): Unit` - Method called after updating Snabbdom vnode. -
- clearDragDropData -	-`open fun clearDragDropData(): Unit` - Clears D&D data for the current widget. It also makes it not draggable. -
- dispatchEvent -	-`open fun dispatchEvent(type: String, eventInitDict: CustomEventInit): Boolean?`
- getElement -	-`open fun getElement(): Node?` - Returns DOM element bound to the current component. -
- getElementJQuery -	-`open fun getElementJQuery(): JQuery?` - Returns JQuery element bound to the current component. -
- getElementJQueryD -	-`open fun getElementJQueryD(): dynamic` - Returns JQuery element bound to the current component as a dynamic type. -
- getSnClass -	-`open fun getSnClass(): List<StringBoolPair>` - Returns list of CSS class names for current widget in the form of a List. -
- getSnHooks -	-`open fun getSnHooks(): Hooks?` - Returns list of hooks in the form of a Snabbdom Hooks object. -
- getSnOn -	-`open fun getSnOn(): On?` - Returns list of event handlers in the form of a Snabbdom On object. -
- hide -	-`open fun hide(): Widget` - Makes current widget invisible. -
- removeCssClass -	-`open fun removeCssClass(css: String): Widget` - Removes given value from the set of CSS classes generated in html code of current component. -
- removeEventListeners -	-`open fun removeEventListeners(): Widget` - Removes all event listeners from current widget. -
- removeSurroundingCssClass -	-`open fun removeSurroundingCssClass(css: String): Widget` - Removes given value from the set of CSS classes generated in html code of parent component. -
- render -	-`open fun render(elementName: String): VNode` -`open fun render(elementName: String, children: Array<dynamic>): VNode` - Renders current component as a Snabbdom vnode. -
- setContextMenu -	-`open fun setContextMenu(contextMenu: ContextMenu): Widget` - Sets context menu for the current widget. -
- 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 -	-`open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Widget` - Sets an event listener for current widget, keeping the actual type of component. -`open fun setEventListener(block: SnOn<Widget>.() -> Unit): Widget` - Sets an event listener for current widget. -
- show -	-`open fun show(): Widget` - Makes current widget visible. -
- toggleVisible -	-`open fun toggleVisible(): Widget` - Toggles visibility of current widget. -
- translate -	-`fun translate(text: String?): String?`

Companion Object Functions

- - - - - - - -

iframe

fun Container.iframe(src: String? = null, srcdoc: String? = null, name: String? = null, iframeWidth: Int? = null, iframeHeight: Int? = null, sandbox: Set<Sandbox>? = null, classes: Set<String> = setOf(), init: Iframe.() -> Unit = null): Iframe

DSL builder extension function.

- - diff --git a/api/pl.treksoft.kvision.html/-iframe/location.html b/api/pl.treksoft.kvision.html/-iframe/location.html deleted file mode 100644 index 55b5a55b..00000000 --- a/api/pl.treksoft.kvision.html/-iframe/location.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -Iframe.location - kvision - - - -kvision / pl.treksoft.kvision.html / Iframe / location
-
-

location

- -var location: String? -

A current location URL of the iframe.

- - diff --git a/api/pl.treksoft.kvision.html/-iframe/name.html b/api/pl.treksoft.kvision.html/-iframe/name.html deleted file mode 100644 index 94ee6d36..00000000 --- a/api/pl.treksoft.kvision.html/-iframe/name.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -Iframe.name - kvision - - - -kvision / pl.treksoft.kvision.html&nbs