summaryrefslogtreecommitdiff
path: root/api/pl.treksoft.kvision.utils/index.html
blob: 32a9480264bdaac70abff63173308132d931d979 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>pl.treksoft.kvision.utils - kvision</title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">kvision</a>&nbsp;/&nbsp;<a href="./index.html">pl.treksoft.kvision.utils</a><br/>
<br/>
<h2>Package pl.treksoft.kvision.utils</h2>
<p>Interfaces and helper functions for Snabbdom virtual dom implementation and a few useful extension functions.</p>
<h3>Types</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="-j-s-o-n/index.html">JSON</a></p>
</td>
<td>
<code><span class="keyword">object </span><span class="identifier">JSON</span></code>
<p>JSON utility functions</p>
</td>
</tr>
<tr>
<td>
<p><a href="-kv-event/index.html">KvEvent</a></p>
</td>
<td>
<code><span class="keyword">class </span><span class="identifier">KvEvent</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom/-custom-event/index.html"><span class="identifier">CustomEvent</span></a></code>
<p>Helper class for defining custom events.</p>
</td>
</tr>
<tr>
<td>
<p><a href="-object/index.html">Object</a></p>
</td>
<td>
<code><span class="keyword">external</span> <span class="keyword">class </span><span class="identifier">Object</span></code>
<p>JavaScript Object type</p>
</td>
</tr>
</tbody>
</table>
<h3>Extensions for External Classes</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="kotlin.-any/index.html">kotlin.Any</a></p>
</td>
<td>
</td>
</tr>
<tr>
<td>
<p><a href="kotlin.collections.-mutable-list/index.html">kotlin.collections.MutableList</a></p>
</td>
<td>
</td>
</tr>
<tr>
<td>
<p><a href="kotlin.-int/index.html">kotlin.Int</a></p>
</td>
<td>
</td>
</tr>
<tr>
<td>
<p><a href="kotlin.-pair/index.html">kotlin.Pair</a></p>
</td>
<td>
</td>
</tr>
<tr>
<td>
<p><a href="org.w3c.files.-file/index.html">org.w3c.files.File</a></p>
</td>
<td>
</td>
</tr>
</tbody>
</table>
<h3>Properties</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="auto.html">auto</a></p>
</td>
<td>
<code><span class="keyword">val </span><span class="identifier">auto</span><span class="symbol">: </span><a href="../pl.treksoft.kvision.core/-css-size.html"><span class="identifier">CssSize</span></a></code>
<p>Helper property to describe CSS auto value.</p>
</td>
</tr>
<tr>
<td>
<p><a href="-e-n-t-e-r_-k-e-y.html">ENTER_KEY</a></p>
</td>
<td>
<code><span class="keyword">const</span> <span class="keyword">val </span><span class="identifier">ENTER_KEY</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a></code>
<p>Keycode of the ENTER key.</p>
</td>
</tr>
<tr>
<td>
<p><a href="-e-s-c_-k-e-y.html">ESC_KEY</a></p>
</td>
<td>
<code><span class="keyword">const</span> <span class="keyword">val </span><span class="identifier">ESC_KEY</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a></code>
<p>Keycode of the ESC key.</p>
</td>
</tr>
<tr>
<td>
<p><a href="normal.html">normal</a></p>
</td>
<td>
<code><span class="keyword">val </span><span class="identifier">normal</span><span class="symbol">: </span><a href="../pl.treksoft.kvision.core/-css-size.html"><span class="identifier">CssSize</span></a></code>
<p>Helper property to describe CSS normal value.</p>
</td>
</tr>
</tbody>
</table>
<h3>Functions</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="get-data-with-file-content.html">getDataWithFileContent</a></p>
</td>
<td>
<code><span class="keyword">suspend</span> <span class="keyword">fun </span><span class="symbol">&lt;</span><span class="identifier">K</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html"><span class="identifier">Any</span></a><span class="symbol">&gt;</span> <a href="../pl.treksoft.kvision.form/-form/index.html"><span class="identifier">Form</span></a><span class="symbol">&lt;</span><a href="get-data-with-file-content.html#K"><span class="identifier">K</span></a><span class="symbol">&gt;</span><span class="symbol">.</span><span class="identifier">getDataWithFileContent</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="get-data-with-file-content.html#K"><span class="identifier">K</span></a></code><br/>
<code><span class="keyword">suspend</span> <span class="keyword">fun </span><span class="symbol">&lt;</span><span class="identifier">K</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html"><span class="identifier">Any</span></a><span class="symbol">&gt;</span> <a href="../pl.treksoft.kvision.form/-form-panel/index.html"><span class="identifier">FormPanel</span></a><span class="symbol">&lt;</span><a href="get-data-with-file-content.html#K"><span class="identifier">K</span></a><span class="symbol">&gt;</span><span class="symbol">.</span><span class="identifier">getDataWithFileContent</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="get-data-with-file-content.html#K"><span class="identifier">K</span></a></code>
<p>Returns current data model with file content read for all KFiles controls.</p>
</td>
</tr>
<tr>
<td>
<p><a href="is-i-e11.html">isIE11</a></p>
</td>
<td>
<code><span class="keyword">fun </span><span class="identifier">isIE11</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a></code>
<p>Utility function to detect Internet Explorer 11.</p>
</td>
</tr>
<tr>
<td>
<p><a href="obj.html">obj</a></p>
</td>
<td>
<code><span class="keyword">fun </span><span class="identifier">obj</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.utils$obj(kotlin.Function1((kotlin.Any, kotlin.Unit)))/init">init</span><span class="symbol">:</span>&nbsp;<span class="keyword">dynamic</span><span class="symbol">.</span><span class="symbol">(</span><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="keyword">dynamic</span></code>
<p>Helper function for creating JavaScript objects.</p>
</td>
</tr>
<tr>
<td>
<p><a href="sn-attrs.html">snAttrs</a></p>
</td>
<td>
<code><span class="keyword">fun </span><span class="identifier">snAttrs</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.utils$snAttrs(kotlin.collections.List((kotlin.Pair((kotlin.String, )))))/pairs">pairs</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol">&lt;</span><a href="../pl.treksoft.kvision.core/-string-pair.html"><span class="identifier">StringPair</span></a><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Attrs</span></code>
<p>Helper function for creating attributes parameters for Snabbdom.</p>
</td>
</tr>
<tr>
<td>
<p><a href="sn-classes.html">snClasses</a></p>
</td>
<td>
<code><span class="keyword">fun </span><span class="identifier">snClasses</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.utils$snClasses(kotlin.collections.List((kotlin.Pair((kotlin.String, kotlin.Boolean)))))/pairs">pairs</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol">&lt;</span><a href="../pl.treksoft.kvision.core/-string-bool-pair.html"><span class="identifier">StringBoolPair</span></a><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Classes</span></code>
<p>Helper function for creating classes parameters for Snabbdom.</p>
</td>
</tr>
<tr>
<td>
<p><a href="sn-opt.html">snOpt</a></p>
</td>
<td>
<code><span class="keyword">fun </span><span class="identifier">snOpt</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.utils$snOpt(kotlin.Function1((com.github.snabbdom.VNodeData, kotlin.Unit)))/block">block</span><span class="symbol">:</span>&nbsp;<span class="identifier">VNodeData</span><span class="symbol">.</span><span class="symbol">(</span><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">VNodeData</span></code>
<p>Helper function for creating object parameters for Snabbdom.</p>
</td>
</tr>
<tr>
<td>
<p><a href="sn-props.html">snProps</a></p>
</td>
<td>
<code><span class="keyword">fun </span><span class="identifier">snProps</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.utils$snProps(kotlin.collections.List((kotlin.Pair((kotlin.String, )))))/pairs">pairs</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol">&lt;</span><a href="../pl.treksoft.kvision.core/-string-pair.html"><span class="identifier">StringPair</span></a><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Props</span></code>
<p>Helper function for creating properties parameters for Snabbdom.</p>
</td>
</tr>
<tr>
<td>
<p><a href="sn-style.html">snStyle</a></p>
</td>
<td>
<code><span class="keyword">fun </span><span class="identifier">snStyle</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.utils$snStyle(kotlin.collections.List((kotlin.Pair((kotlin.String, )))))/pairs">pairs</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol">&lt;</span><a href="../pl.treksoft.kvision.core/-string-pair.html"><span class="identifier">StringPair</span></a><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">VNodeStyle</span></code>
<p>Helper function for creating style parameters for Snabbdom.</p>
</td>
</tr>
</tbody>
</table>
</BODY>
</HTML>