From fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sat, 26 Oct 2019 00:17:24 +0200 Subject: API documentation for KVision 2.0.0 --- .../-d-e-f-a-u-l-t_-f-i-x-e-d_-p-o-s_-x.html | 14 ++ .../-d-e-f-a-u-l-t_-f-i-x-e-d_-p-o-s_-y.html | 14 ++ .../-context-menu/-init-.html | 23 +++ .../-context-menu/context-menu.html | 16 ++ .../-context-menu/fixed-position.html | 15 ++ .../-context-menu/index.html | 165 +++++++++++++++++++++ .../-context-menu/position-menu.html | 20 +++ 7 files changed, 267 insertions(+) create mode 100644 api1/pl.treksoft.kvision.dropdown/-context-menu/-d-e-f-a-u-l-t_-f-i-x-e-d_-p-o-s_-x.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-context-menu/-d-e-f-a-u-l-t_-f-i-x-e-d_-p-o-s_-y.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-context-menu/-init-.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-context-menu/context-menu.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-context-menu/fixed-position.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-context-menu/index.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-context-menu/position-menu.html (limited to 'api1/pl.treksoft.kvision.dropdown/-context-menu') diff --git a/api1/pl.treksoft.kvision.dropdown/-context-menu/-d-e-f-a-u-l-t_-f-i-x-e-d_-p-o-s_-x.html b/api1/pl.treksoft.kvision.dropdown/-context-menu/-d-e-f-a-u-l-t_-f-i-x-e-d_-p-o-s_-x.html new file mode 100644 index 00000000..afcbe005 --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-context-menu/-d-e-f-a-u-l-t_-f-i-x-e-d_-p-o-s_-x.html @@ -0,0 +1,14 @@ + + + +ContextMenu.DEFAULT_FIXED_POS_X - kvision + + + +kvision / pl.treksoft.kvision.dropdown / ContextMenu / DEFAULT_FIXED_POS_X
+
+

DEFAULT_FIXED_POS_X

+ +const val DEFAULT_FIXED_POS_X: Int + + diff --git a/api1/pl.treksoft.kvision.dropdown/-context-menu/-d-e-f-a-u-l-t_-f-i-x-e-d_-p-o-s_-y.html b/api1/pl.treksoft.kvision.dropdown/-context-menu/-d-e-f-a-u-l-t_-f-i-x-e-d_-p-o-s_-y.html new file mode 100644 index 00000000..dd1cf10f --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-context-menu/-d-e-f-a-u-l-t_-f-i-x-e-d_-p-o-s_-y.html @@ -0,0 +1,14 @@ + + + +ContextMenu.DEFAULT_FIXED_POS_Y - kvision + + + +kvision / pl.treksoft.kvision.dropdown / ContextMenu / DEFAULT_FIXED_POS_Y
+
+

DEFAULT_FIXED_POS_Y

+ +const val DEFAULT_FIXED_POS_Y: Int + + diff --git a/api1/pl.treksoft.kvision.dropdown/-context-menu/-init-.html b/api1/pl.treksoft.kvision.dropdown/-context-menu/-init-.html new file mode 100644 index 00000000..7fd2c64d --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-context-menu/-init-.html @@ -0,0 +1,23 @@ + + + +ContextMenu.<init> - kvision + + + +kvision / pl.treksoft.kvision.dropdown / ContextMenu / <init>
+
+

<init>

+ +

ContextMenu(element: Widget? = null, fixedPosition: Boolean = false, classes: Set<String> = setOf(), init: (ContextMenu.() -> Unit)? = null)

Parameters

+element - an element to bind

+fixedPosition - use fixed positioning

+classes - a set of CSS class names

Constructor
+

+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-context-menu/context-menu.html b/api1/pl.treksoft.kvision.dropdown/-context-menu/context-menu.html new file mode 100644 index 00000000..409d2e1b --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-context-menu/context-menu.html @@ -0,0 +1,16 @@ + + + +ContextMenu.contextMenu - kvision + + + +kvision / pl.treksoft.kvision.dropdown / ContextMenu / contextMenu
+
+

contextMenu

+ +

fun Widget.contextMenu(fixedPosition: Boolean = false, classes: Set<String> = setOf(), init: (ContextMenu.() -> Unit)? = null): ContextMenu

DSL builder extension function.

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

+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-context-menu/fixed-position.html b/api1/pl.treksoft.kvision.dropdown/-context-menu/fixed-position.html new file mode 100644 index 00000000..48564039 --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-context-menu/fixed-position.html @@ -0,0 +1,15 @@ + + + +ContextMenu.fixedPosition - kvision + + + +kvision / pl.treksoft.kvision.dropdown / ContextMenu / fixedPosition
+
+

fixedPosition

+ +protected val fixedPosition: Boolean +

use fixed positioning

+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-context-menu/index.html b/api1/pl.treksoft.kvision.dropdown/-context-menu/index.html new file mode 100644 index 00000000..0f9dc915 --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-context-menu/index.html @@ -0,0 +1,165 @@ + + + +ContextMenu - kvision + + + +kvision / pl.treksoft.kvision.dropdown / ContextMenu
+
+

ContextMenu

+open class ContextMenu : ListTag +

Context menu component.

Constructors

+ + + + + + + +

<init>

ContextMenu(element: Widget? = null, fixedPosition: Boolean = false, classes: Set<String> = setOf(), init: (ContextMenu.() -> Unit)? = null)

Properties

+ + + + + + + +

fixedPosition

+val fixedPosition: Boolean +

use fixed positioning

Inherited Properties

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

+ elements +	+`var elements: List<String>?` + List of elements. +
+ rich +	+`var rich: Boolean` + Determines if elements can contain HTML code. +
+ type +	+`var type: ListType` + List type. +

Functions

+ + + + + + + +

positionMenu

+open fun positionMenu(mouseEvent: MouseEvent): ContextMenu +

Positions and shows a context menu based on a mouse event.

Inherited Functions

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

+ childrenVNodes +	+`open fun childrenVNodes(): Array<VNode>` + Returns the array of the children Snabbdom vnodes. +
+ getSnClass +	+`open fun getSnClass(): List<StringBoolPair>` + Returns list of CSS class names for current widget in the form of a List. +
+ render +	+`open fun render(): VNode` + Renders current component as a Snabbdom vnode. +

Companion Object Properties

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

+ DEFAULT_FIXED_POS_X +	+`const val DEFAULT_FIXED_POS_X: Int`
+ DEFAULT_FIXED_POS_Y +	+`const val DEFAULT_FIXED_POS_Y: Int`

Companion Object Functions

+ + + + + + + +

contextMenu

fun Widget.contextMenu(fixedPosition: Boolean = false, classes: Set<String> = setOf(), init: (ContextMenu.() -> Unit)? = null): ContextMenu

DSL builder extension function.

Extension Functions

+ + + + + + + +

createInstance

+fun <T> Any?.createInstance(vararg args: dynamic): T +

Helper function for creating JavaScript objects from dynamic constructors.

+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-context-menu/position-menu.html b/api1/pl.treksoft.kvision.dropdown/-context-menu/position-menu.html new file mode 100644 index 00000000..ded70c2c --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-context-menu/position-menu.html @@ -0,0 +1,20 @@ + + + +ContextMenu.positionMenu - kvision + + + +kvision / pl.treksoft.kvision.dropdown / ContextMenu / positionMenu
+
+

positionMenu

+ +open fun positionMenu(mouseEvent: MouseEvent): ContextMenu +

Positions and shows a context menu based on a mouse event.

Parameters

+mouseEvent - mouse event

Return
+current context menu

+ + -- cgit