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 --- .../-i18n-manager/gettext.html | 20 ++++ .../-i18n-manager/index.html | 106 +++++++++++++++++++++ .../-i18n-manager/ngettext.html | 24 +++++ .../-i18n-manager/ntr.html | 24 +++++ .../pl.treksoft.kvision.i18n/-i18n-manager/tr.html | 20 ++++ .../-i18n-manager/trans.html | 22 +++++ 6 files changed, 216 insertions(+) create mode 100644 api1/pl.treksoft.kvision.i18n/-i18n-manager/gettext.html create mode 100644 api1/pl.treksoft.kvision.i18n/-i18n-manager/index.html create mode 100644 api1/pl.treksoft.kvision.i18n/-i18n-manager/ngettext.html create mode 100644 api1/pl.treksoft.kvision.i18n/-i18n-manager/ntr.html create mode 100644 api1/pl.treksoft.kvision.i18n/-i18n-manager/tr.html create mode 100644 api1/pl.treksoft.kvision.i18n/-i18n-manager/trans.html (limited to 'api1/pl.treksoft.kvision.i18n/-i18n-manager') diff --git a/api1/pl.treksoft.kvision.i18n/-i18n-manager/gettext.html b/api1/pl.treksoft.kvision.i18n/-i18n-manager/gettext.html new file mode 100644 index 00000000..b88061f0 --- /dev/null +++ b/api1/pl.treksoft.kvision.i18n/-i18n-manager/gettext.html @@ -0,0 +1,20 @@ + + + +I18nManager.gettext - kvision + + + +kvision / pl.treksoft.kvision.i18n / I18nManager / gettext
+
+

gettext

+ +abstract fun gettext(key: String): String +

A static translation function for a singular form.

Parameters

+key - a translation key.

Return
+translated text.

+ + diff --git a/api1/pl.treksoft.kvision.i18n/-i18n-manager/index.html b/api1/pl.treksoft.kvision.i18n/-i18n-manager/index.html new file mode 100644 index 00000000..c717708d --- /dev/null +++ b/api1/pl.treksoft.kvision.i18n/-i18n-manager/index.html @@ -0,0 +1,106 @@ + + + +I18nManager - kvision + + + +kvision / pl.treksoft.kvision.i18n / I18nManager
+
+

I18nManager

+interface I18nManager +

Functions

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

+ gettext +	+`abstract fun gettext(key: String): String` + A static translation function for a singular form. +
+ ngettext +	+`abstract fun ngettext(singularKey: String, pluralKey: String, value: Int): String` + A static translation function for a plural form. +
+ ntr +	+`open fun ntr(singularKey: String, pluralKey: String, value: Int): String` + A dynamic translation function for a plural form. +
+ tr +	+`open fun tr(key: String): String` + A dynamic translation function for a singular form. +
+ trans +	+`open fun trans(text: String): String` +`open fun trans(text: String?): String?` + A dynamic translation function. +

Extension Functions

+ + + + + + + +

createInstance

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

Helper function for creating JavaScript objects from dynamic constructors.

Inheritors

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

+ DefaultI18nManager +	+`class DefaultI18nManager : I18nManager`
+ I18n +	+`object I18n : I18nManager` + A singleton object used for translations. +
+ SimpleI18nManager +	+`class SimpleI18nManager : I18nManager`

+ + diff --git a/api1/pl.treksoft.kvision.i18n/-i18n-manager/ngettext.html b/api1/pl.treksoft.kvision.i18n/-i18n-manager/ngettext.html new file mode 100644 index 00000000..9859f066 --- /dev/null +++ b/api1/pl.treksoft.kvision.i18n/-i18n-manager/ngettext.html @@ -0,0 +1,24 @@ + + + +I18nManager.ngettext - kvision + + + +kvision / pl.treksoft.kvision.i18n / I18nManager / ngettext
+
+

ngettext

+ +abstract fun ngettext(singularKey: String, pluralKey: String, value: Int): String +

A static translation function for a plural form.

Parameters

+singularKey - a translation key for a singular form.

+pluralKey - a translation key for a plural form.

+value - a count value.

Return
+translated text.

+ + diff --git a/api1/pl.treksoft.kvision.i18n/-i18n-manager/ntr.html b/api1/pl.treksoft.kvision.i18n/-i18n-manager/ntr.html new file mode 100644 index 00000000..c532274d --- /dev/null +++ b/api1/pl.treksoft.kvision.i18n/-i18n-manager/ntr.html @@ -0,0 +1,24 @@ + + + +I18nManager.ntr - kvision + + + +kvision / pl.treksoft.kvision.i18n / I18nManager / ntr
+
+

ntr

+ +open fun ntr(singularKey: String, pluralKey: String, value: Int): String +

A dynamic translation function for a plural form.

Parameters

+singularKey - a translation key for a singular form.

+pluralKey - a translation key for a plural form.

+value - a count value.

Return
+text marked for a dynamic translation.

+ + diff --git a/api1/pl.treksoft.kvision.i18n/-i18n-manager/tr.html b/api1/pl.treksoft.kvision.i18n/-i18n-manager/tr.html new file mode 100644 index 00000000..94a15887 --- /dev/null +++ b/api1/pl.treksoft.kvision.i18n/-i18n-manager/tr.html @@ -0,0 +1,20 @@ + + + +I18nManager.tr - kvision + + + +kvision / pl.treksoft.kvision.i18n / I18nManager / tr
+
+

tr

+ +open fun tr(key: String): String +

A dynamic translation function for a singular form.

Parameters

+key - a translation key.

Return
+text marked for a dynamic translation.

+ + diff --git a/api1/pl.treksoft.kvision.i18n/-i18n-manager/trans.html b/api1/pl.treksoft.kvision.i18n/-i18n-manager/trans.html new file mode 100644 index 00000000..a863ae83 --- /dev/null +++ b/api1/pl.treksoft.kvision.i18n/-i18n-manager/trans.html @@ -0,0 +1,22 @@ + + + +I18nManager.trans - kvision + + + +kvision / pl.treksoft.kvision.i18n / I18nManager / trans
+
+

trans

+ +open fun trans(text: String): String
+ +open fun trans(text: String?): String? +

A dynamic translation function.

Parameters

+text - text marked for a dynamic translation.

Return
+translated text.

+ + -- cgit