diff options
author | Robert Jaros <rjaros@finn.pl> | 2018-08-22 15:34:00 +0200 |
---|---|---|
committer | Robert Jaros <rjaros@finn.pl> | 2018-08-22 15:34:00 +0200 |
commit | 63503bd4517d87c34498002c820aefaef22c501e (patch) | |
tree | 4b00f1d2524ad14b7e5d361dbff6a1dd162294bf /api/pl.treksoft.kvision.i18n/-i18n | |
parent | fa6b3a63a27b948ffeebfdd510ca289f019901a0 (diff) | |
download | kvision-63503bd4517d87c34498002c820aefaef22c501e.tar.gz kvision-63503bd4517d87c34498002c820aefaef22c501e.tar.bz2 kvision-63503bd4517d87c34498002c820aefaef22c501e.zip |
API documentation for 0.0.17
Diffstat (limited to 'api/pl.treksoft.kvision.i18n/-i18n')
-rw-r--r-- | api/pl.treksoft.kvision.i18n/-i18n/gettext.html | 20 | ||||
-rw-r--r-- | api/pl.treksoft.kvision.i18n/-i18n/index.html | 89 | ||||
-rw-r--r-- | api/pl.treksoft.kvision.i18n/-i18n/init.html | 21 | ||||
-rw-r--r-- | api/pl.treksoft.kvision.i18n/-i18n/language.html | 15 | ||||
-rw-r--r-- | api/pl.treksoft.kvision.i18n/-i18n/ngettext.html | 24 | ||||
-rw-r--r-- | api/pl.treksoft.kvision.i18n/-i18n/ntr.html | 24 | ||||
-rw-r--r-- | api/pl.treksoft.kvision.i18n/-i18n/tr.html | 20 | ||||
-rw-r--r-- | api/pl.treksoft.kvision.i18n/-i18n/trans.html | 22 |
8 files changed, 235 insertions, 0 deletions
diff --git a/api/pl.treksoft.kvision.i18n/-i18n/gettext.html b/api/pl.treksoft.kvision.i18n/-i18n/gettext.html new file mode 100644 index 00000000..63ab9b2b --- /dev/null +++ b/api/pl.treksoft.kvision.i18n/-i18n/gettext.html @@ -0,0 +1,20 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>I18n.gettext - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.i18n</a> / <a href="index.html">I18n</a> / <a href="./gettext.html">gettext</a><br/> +<br/> +<h1>gettext</h1> +<a name="pl.treksoft.kvision.i18n.I18n$gettext(kotlin.String)"></a> +<code><span class="keyword">fun </span><span class="identifier">gettext</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.i18n.I18n$gettext(kotlin.String)/key">key</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code> +<p>A static translation function for a singular form.</p> +<h3>Parameters</h3> +<p><a name="key"></a> +<code>key</code> - a translation key.</p> +<p><strong>Return</strong><br/> +translated text.</p> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision.i18n/-i18n/index.html b/api/pl.treksoft.kvision.i18n/-i18n/index.html new file mode 100644 index 00000000..a6f2f17e --- /dev/null +++ b/api/pl.treksoft.kvision.i18n/-i18n/index.html @@ -0,0 +1,89 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>I18n - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.i18n</a> / <a href="./index.html">I18n</a><br/> +<br/> +<h1>I18n</h1> +<code><span class="keyword">object </span><span class="identifier">I18n</span></code> +<p>A singleton object used for translations.</p> +<h3>Properties</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="language.html">language</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">language</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code> +<p>Main language of the application.</p> +</td> +</tr> +</tbody> +</table> +<h3>Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="gettext.html">gettext</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="identifier">gettext</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.i18n.I18n$gettext(kotlin.String)/key">key</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code> +<p>A static translation function for a singular form.</p> +</td> +</tr> +<tr> +<td> +<p><a href="init.html">init</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="identifier">init</span><span class="symbol">(</span><span class="keyword">vararg</span> <span class="identifier" id="pl.treksoft.kvision.i18n.I18n$init(kotlin.Array((kotlin.String)), kotlin.Function0((kotlin.Unit)))/languages">languages</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.i18n.I18n$init(kotlin.Array((kotlin.String)), kotlin.Function0((kotlin.Unit)))/initCallback">initCallback</span><span class="symbol">:</span> <span class="symbol">(</span><span class="symbol">)</span> <span class="symbol">-></span> <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><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code> +<p>I18n initialization function. +Should be called in the main function of the application.</p> +</td> +</tr> +<tr> +<td> +<p><a href="ngettext.html">ngettext</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="identifier">ngettext</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.i18n.I18n$ngettext(kotlin.String, kotlin.String, kotlin.Int)/singularKey">singularKey</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.i18n.I18n$ngettext(kotlin.String, kotlin.String, kotlin.Int)/pluralKey">pluralKey</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.i18n.I18n$ngettext(kotlin.String, kotlin.String, kotlin.Int)/value">value</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code> +<p>A static translation function for a plural form.</p> +</td> +</tr> +<tr> +<td> +<p><a href="ntr.html">ntr</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="identifier">ntr</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.i18n.I18n$ntr(kotlin.String, kotlin.String, kotlin.Int)/singularKey">singularKey</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.i18n.I18n$ntr(kotlin.String, kotlin.String, kotlin.Int)/pluralKey">pluralKey</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.i18n.I18n$ntr(kotlin.String, kotlin.String, kotlin.Int)/value">value</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code> +<p>A dynamic translation function for a plural form.</p> +</td> +</tr> +<tr> +<td> +<p><a href="tr.html">tr</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="identifier">tr</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.i18n.I18n$tr(kotlin.String)/key">key</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code> +<p>A dynamic translation function for a singular form.</p> +</td> +</tr> +<tr> +<td> +<p><a href="trans.html">trans</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="identifier">trans</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.i18n.I18n$trans(kotlin.String)/text">text</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code><br/> +<code><span class="keyword">fun </span><span class="identifier">trans</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.i18n.I18n$trans(kotlin.String)/text">text</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span></code> +<p>A dynamic translation function.</p> +</td> +</tr> +</tbody> +</table> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision.i18n/-i18n/init.html b/api/pl.treksoft.kvision.i18n/-i18n/init.html new file mode 100644 index 00000000..6e460023 --- /dev/null +++ b/api/pl.treksoft.kvision.i18n/-i18n/init.html @@ -0,0 +1,21 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>I18n.init - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.i18n</a> / <a href="index.html">I18n</a> / <a href="./init.html">init</a><br/> +<br/> +<h1>init</h1> +<a name="pl.treksoft.kvision.i18n.I18n$init(kotlin.Array((kotlin.String)), kotlin.Function0((kotlin.Unit)))"></a> +<code><span class="keyword">fun </span><span class="identifier">init</span><span class="symbol">(</span><span class="keyword">vararg</span> <span class="identifier" id="pl.treksoft.kvision.i18n.I18n$init(kotlin.Array((kotlin.String)), kotlin.Function0((kotlin.Unit)))/languages">languages</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.i18n.I18n$init(kotlin.Array((kotlin.String)), kotlin.Function0((kotlin.Unit)))/initCallback">initCallback</span><span class="symbol">:</span> <span class="symbol">(</span><span class="symbol">)</span> <span class="symbol">-></span> <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><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code> +<p>I18n initialization function. +Should be called in the main function of the application.</p> +<h3>Parameters</h3> +<p><a name="languages"></a> +<code>languages</code> - a list of supported languages.</p> +<p><a name="initCallback"></a> +<code>initCallback</code> - a code to run after the initialization process is complete.</p> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision.i18n/-i18n/language.html b/api/pl.treksoft.kvision.i18n/-i18n/language.html new file mode 100644 index 00000000..e72498f5 --- /dev/null +++ b/api/pl.treksoft.kvision.i18n/-i18n/language.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>I18n.language - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.i18n</a> / <a href="index.html">I18n</a> / <a href="./language.html">language</a><br/> +<br/> +<h1>language</h1> +<a name="pl.treksoft.kvision.i18n.I18n$language"></a> +<code><span class="keyword">var </span><span class="identifier">language</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code> +<p>Main language of the application.</p> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision.i18n/-i18n/ngettext.html b/api/pl.treksoft.kvision.i18n/-i18n/ngettext.html new file mode 100644 index 00000000..091efe53 --- /dev/null +++ b/api/pl.treksoft.kvision.i18n/-i18n/ngettext.html @@ -0,0 +1,24 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>I18n.ngettext - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.i18n</a> / <a href="index.html">I18n</a> / <a href="./ngettext.html">ngettext</a><br/> +<br/> +<h1>ngettext</h1> +<a name="pl.treksoft.kvision.i18n.I18n$ngettext(kotlin.String, kotlin.String, kotlin.Int)"></a> +<code><span class="keyword">fun </span><span class="identifier">ngettext</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.i18n.I18n$ngettext(kotlin.String, kotlin.String, kotlin.Int)/singularKey">singularKey</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.i18n.I18n$ngettext(kotlin.String, kotlin.String, kotlin.Int)/pluralKey">pluralKey</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.i18n.I18n$ngettext(kotlin.String, kotlin.String, kotlin.Int)/value">value</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code> +<p>A static translation function for a plural form.</p> +<h3>Parameters</h3> +<p><a name="singularKey"></a> +<code>singularKey</code> - a translation key for a singular form.</p> +<p><a name="pluralKey"></a> +<code>pluralKey</code> - a translation key for a plural form.</p> +<p><a name="value"></a> +<code>value</code> - a count value.</p> +<p><strong>Return</strong><br/> +translated text.</p> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision.i18n/-i18n/ntr.html b/api/pl.treksoft.kvision.i18n/-i18n/ntr.html new file mode 100644 index 00000000..958d3c0d --- /dev/null +++ b/api/pl.treksoft.kvision.i18n/-i18n/ntr.html @@ -0,0 +1,24 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>I18n.ntr - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.i18n</a> / <a href="index.html">I18n</a> / <a href="./ntr.html">ntr</a><br/> +<br/> +<h1>ntr</h1> +<a name="pl.treksoft.kvision.i18n.I18n$ntr(kotlin.String, kotlin.String, kotlin.Int)"></a> +<code><span class="keyword">fun </span><span class="identifier">ntr</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.i18n.I18n$ntr(kotlin.String, kotlin.String, kotlin.Int)/singularKey">singularKey</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.i18n.I18n$ntr(kotlin.String, kotlin.String, kotlin.Int)/pluralKey">pluralKey</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.i18n.I18n$ntr(kotlin.String, kotlin.String, kotlin.Int)/value">value</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code> +<p>A dynamic translation function for a plural form.</p> +<h3>Parameters</h3> +<p><a name="singularKey"></a> +<code>singularKey</code> - a translation key for a singular form.</p> +<p><a name="pluralKey"></a> +<code>pluralKey</code> - a translation key for a plural form.</p> +<p><a name="value"></a> +<code>value</code> - a count value.</p> +<p><strong>Return</strong><br/> +text marked for a dynamic translation.</p> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision.i18n/-i18n/tr.html b/api/pl.treksoft.kvision.i18n/-i18n/tr.html new file mode 100644 index 00000000..f419b8b9 --- /dev/null +++ b/api/pl.treksoft.kvision.i18n/-i18n/tr.html @@ -0,0 +1,20 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>I18n.tr - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.i18n</a> / <a href="index.html">I18n</a> / <a href="./tr.html">tr</a><br/> +<br/> +<h1>tr</h1> +<a name="pl.treksoft.kvision.i18n.I18n$tr(kotlin.String)"></a> +<code><span class="keyword">fun </span><span class="identifier">tr</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.i18n.I18n$tr(kotlin.String)/key">key</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code> +<p>A dynamic translation function for a singular form.</p> +<h3>Parameters</h3> +<p><a name="key"></a> +<code>key</code> - a translation key.</p> +<p><strong>Return</strong><br/> +text marked for a dynamic translation.</p> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision.i18n/-i18n/trans.html b/api/pl.treksoft.kvision.i18n/-i18n/trans.html new file mode 100644 index 00000000..f7fdb811 --- /dev/null +++ b/api/pl.treksoft.kvision.i18n/-i18n/trans.html @@ -0,0 +1,22 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>I18n.trans - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.i18n</a> / <a href="index.html">I18n</a> / <a href="./trans.html">trans</a><br/> +<br/> +<h1>trans</h1> +<a name="pl.treksoft.kvision.i18n.I18n$trans(kotlin.String)"></a> +<code><span class="keyword">fun </span><span class="identifier">trans</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.i18n.I18n$trans(kotlin.String)/text">text</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code><br/> +<a name="pl.treksoft.kvision.i18n.I18n$trans(kotlin.String)"></a> +<code><span class="keyword">fun </span><span class="identifier">trans</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.i18n.I18n$trans(kotlin.String)/text">text</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span></code> +<p>A dynamic translation function.</p> +<h3>Parameters</h3> +<p><a name="text"></a> +<code>text</code> - text marked for a dynamic translation.</p> +<p><strong>Return</strong><br/> +translated text.</p> +</BODY> +</HTML> |