From a70acf853de62d0754ca95aa4103712b82afdef8 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Wed, 17 Oct 2018 18:40:15 +0200 Subject: API Documentation for KVision 0.0.18 --- .../-default-i18n-manager/-init-.html | 14 ++++ .../-default-i18n-manager/gettext.html | 21 +++++ .../-default-i18n-manager/index.html | 80 +++++++++++++++++++ .../-default-i18n-manager/ngettext.html | 25 ++++++ .../-i18n-manager/gettext.html | 20 +++++ .../-i18n-manager/index.html | 92 ++++++++++++++++++++++ .../-i18n-manager/ngettext.html | 24 ++++++ .../-i18n-manager/ntr.html | 24 ++++++ api/pl.treksoft.kvision.i18n/-i18n-manager/tr.html | 20 +++++ .../-i18n-manager/trans.html | 22 ++++++ api/pl.treksoft.kvision.i18n/-i18n/gettext.html | 1 + api/pl.treksoft.kvision.i18n/-i18n/index.html | 37 ++++----- api/pl.treksoft.kvision.i18n/-i18n/init.html | 21 ----- api/pl.treksoft.kvision.i18n/-i18n/manager.html | 14 ++++ api/pl.treksoft.kvision.i18n/-i18n/ngettext.html | 1 + api/pl.treksoft.kvision.i18n/-i18n/ntr.html | 24 ------ api/pl.treksoft.kvision.i18n/-i18n/tr.html | 20 ----- api/pl.treksoft.kvision.i18n/-i18n/trans.html | 22 ------ .../-simple-i18n-manager/-init-.html | 14 ++++ .../-simple-i18n-manager/gettext.html | 21 +++++ .../-simple-i18n-manager/index.html | 80 +++++++++++++++++++ .../-simple-i18n-manager/ngettext.html | 25 ++++++ api/pl.treksoft.kvision.i18n/index.html | 23 +++++- 23 files changed, 539 insertions(+), 106 deletions(-) create mode 100644 api/pl.treksoft.kvision.i18n/-default-i18n-manager/-init-.html create mode 100644 api/pl.treksoft.kvision.i18n/-default-i18n-manager/gettext.html create mode 100644 api/pl.treksoft.kvision.i18n/-default-i18n-manager/index.html create mode 100644 api/pl.treksoft.kvision.i18n/-default-i18n-manager/ngettext.html create mode 100644 api/pl.treksoft.kvision.i18n/-i18n-manager/gettext.html create mode 100644 api/pl.treksoft.kvision.i18n/-i18n-manager/index.html create mode 100644 api/pl.treksoft.kvision.i18n/-i18n-manager/ngettext.html create mode 100644 api/pl.treksoft.kvision.i18n/-i18n-manager/ntr.html create mode 100644 api/pl.treksoft.kvision.i18n/-i18n-manager/tr.html create mode 100644 api/pl.treksoft.kvision.i18n/-i18n-manager/trans.html delete mode 100644 api/pl.treksoft.kvision.i18n/-i18n/init.html create mode 100644 api/pl.treksoft.kvision.i18n/-i18n/manager.html delete mode 100644 api/pl.treksoft.kvision.i18n/-i18n/ntr.html delete mode 100644 api/pl.treksoft.kvision.i18n/-i18n/tr.html delete mode 100644 api/pl.treksoft.kvision.i18n/-i18n/trans.html create mode 100644 api/pl.treksoft.kvision.i18n/-simple-i18n-manager/-init-.html create mode 100644 api/pl.treksoft.kvision.i18n/-simple-i18n-manager/gettext.html create mode 100644 api/pl.treksoft.kvision.i18n/-simple-i18n-manager/index.html create mode 100644 api/pl.treksoft.kvision.i18n/-simple-i18n-manager/ngettext.html (limited to 'api/pl.treksoft.kvision.i18n') diff --git a/api/pl.treksoft.kvision.i18n/-default-i18n-manager/-init-.html b/api/pl.treksoft.kvision.i18n/-default-i18n-manager/-init-.html new file mode 100644 index 00000000..d69fe835 --- /dev/null +++ b/api/pl.treksoft.kvision.i18n/-default-i18n-manager/-init-.html @@ -0,0 +1,14 @@ + + + +DefaultI18nManager.<init> - kvision + + + +kvision / pl.treksoft.kvision.i18n / DefaultI18nManager / <init>
+
+

<init>

+ +DefaultI18nManager(translations: Map<String, dynamic>) + + diff --git a/api/pl.treksoft.kvision.i18n/-default-i18n-manager/gettext.html b/api/pl.treksoft.kvision.i18n/-default-i18n-manager/gettext.html new file mode 100644 index 00000000..4f46bc62 --- /dev/null +++ b/api/pl.treksoft.kvision.i18n/-default-i18n-manager/gettext.html @@ -0,0 +1,21 @@ + + + +DefaultI18nManager.gettext - kvision + + + +kvision / pl.treksoft.kvision.i18n / DefaultI18nManager / gettext
+
+

gettext

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

Overrides I18nManager.gettext

A static translation function for a singular form.

Parameters

+key - a translation key.

Return
+translated text.

+ + diff --git a/api/pl.treksoft.kvision.i18n/-default-i18n-manager/index.html b/api/pl.treksoft.kvision.i18n/-default-i18n-manager/index.html new file mode 100644 index 00000000..7f745051 --- /dev/null +++ b/api/pl.treksoft.kvision.i18n/-default-i18n-manager/index.html @@ -0,0 +1,80 @@ + + + +DefaultI18nManager - kvision + + + +kvision / pl.treksoft.kvision.i18n / DefaultI18nManager
+
+

DefaultI18nManager

+class DefaultI18nManager : I18nManager +

Constructors

+ + + + + + + +

<init>

+DefaultI18nManager(translations: Map<String, dynamic>)

Functions

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

+ gettext +	+`fun gettext(key: String): String` + A static translation function for a singular form. +
+ ngettext +	+`fun ngettext(singularKey: String, pluralKey: String, value: Int): String` + A static translation function for a plural form. +

Inherited Functions

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

+ 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?` + A dynamic translation function. +

+ + diff --git a/api/pl.treksoft.kvision.i18n/-default-i18n-manager/ngettext.html b/api/pl.treksoft.kvision.i18n/-default-i18n-manager/ngettext.html new file mode 100644 index 00000000..7ed9874a --- /dev/null +++ b/api/pl.treksoft.kvision.i18n/-default-i18n-manager/ngettext.html @@ -0,0 +1,25 @@ + + + +DefaultI18nManager.ngettext - kvision + + + +kvision / pl.treksoft.kvision.i18n / DefaultI18nManager / ngettext
+
+

ngettext

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

Overrides I18nManager.ngettext

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/api/pl.treksoft.kvision.i18n/-i18n-manager/gettext.html b/api/pl.treksoft.kvision.i18n/-i18n-manager/gettext.html new file mode 100644 index 00000000..b88061f0 --- /dev/null +++ b/api/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/api/pl.treksoft.kvision.i18n/-i18n-manager/index.html b/api/pl.treksoft.kvision.i18n/-i18n-manager/index.html new file mode 100644 index 00000000..c03904cc --- /dev/null +++ b/api/pl.treksoft.kvision.i18n/-i18n-manager/index.html @@ -0,0 +1,92 @@ + + + +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. +

Inheritors

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

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

+ + diff --git a/api/pl.treksoft.kvision.i18n/-i18n-manager/ngettext.html b/api/pl.treksoft.kvision.i18n/-i18n-manager/ngettext.html new file mode 100644 index 00000000..9859f066 --- /dev/null +++ b/api/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/api/pl.treksoft.kvision.i18n/-i18n-manager/ntr.html b/api/pl.treksoft.kvision.i18n/-i18n-manager/ntr.html new file mode 100644 index 00000000..c532274d --- /dev/null +++ b/api/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/api/pl.treksoft.kvision.i18n/-i18n-manager/tr.html b/api/pl.treksoft.kvision.i18n/-i18n-manager/tr.html new file mode 100644 index 00000000..94a15887 --- /dev/null +++ b/api/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/api/pl.treksoft.kvision.i18n/-i18n-manager/trans.html b/api/pl.treksoft.kvision.i18n/-i18n-manager/trans.html new file mode 100644 index 00000000..a863ae83 --- /dev/null +++ b/api/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.

+ + diff --git a/api/pl.treksoft.kvision.i18n/-i18n/gettext.html b/api/pl.treksoft.kvision.i18n/-i18n/gettext.html index 63ab9b2b..7c2fe669 100644 --- a/api/pl.treksoft.kvision.i18n/-i18n/gettext.html +++ b/api/pl.treksoft.kvision.i18n/-i18n/gettext.html @@ -10,6 +10,7 @@

gettext

fun gettext(key: String): String +

Overrides I18nManager.gettext

A static translation function for a singular form.

Parameters

diff --git a/api/pl.treksoft.kvision.i18n/-i18n/index.html b/api/pl.treksoft.kvision.i18n/-i18n/index.html index a6f2f17e..731610c8 100644 --- a/api/pl.treksoft.kvision.i18n/-i18n/index.html +++ b/api/pl.treksoft.kvision.i18n/-i18n/index.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.i18n / I18n

I18n

-object I18n +object I18n : I18nManager

A singleton object used for translations.

Properties

@@ -22,6 +22,13 @@

Main language of the application.

+ + + +

manager

+var manager: I18nManager

Functions

@@ -38,16 +45,6 @@ -

init

- - -fun init(vararg languages: String, initCallback: () -> Unit): Unit -

I18n initialization function. -Should be called in the main function of the application.

- - - -

ngettext

@@ -55,31 +52,35 @@ Should be called in the main function of the application.

A static translation function for a plural form.

+ + +

Inherited Functions

+ + diff --git a/api/pl.treksoft.kvision.i18n/-i18n/init.html b/api/pl.treksoft.kvision.i18n/-i18n/init.html deleted file mode 100644 index 6e460023..00000000 --- a/api/pl.treksoft.kvision.i18n/-i18n/init.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -I18n.init - kvision - - - -kvision / pl.treksoft.kvision.i18n / I18n / init
-
-

init

- -fun init(vararg languages: String, initCallback: () -> Unit): Unit -

I18n initialization function. -Should be called in the main function of the application.

Parameters

-languages - a list of supported languages.

-initCallback - a code to run after the initialization process is complete.

- - diff --git a/api/pl.treksoft.kvision.i18n/-i18n/manager.html b/api/pl.treksoft.kvision.i18n/-i18n/manager.html new file mode 100644 index 00000000..e5426015 --- /dev/null +++ b/api/pl.treksoft.kvision.i18n/-i18n/manager.html @@ -0,0 +1,14 @@ + + + +I18n.manager - kvision + + + +kvision / pl.treksoft.kvision.i18n / I18n / manager
+
+

manager

+ +var manager: I18nManager + + diff --git a/api/pl.treksoft.kvision.i18n/-i18n/ngettext.html b/api/pl.treksoft.kvision.i18n/-i18n/ngettext.html index 091efe53..8ad75407 100644 --- a/api/pl.treksoft.kvision.i18n/-i18n/ngettext.html +++ b/api/pl.treksoft.kvision.i18n/-i18n/ngettext.html @@ -10,6 +10,7 @@

ngettext

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

Overrides I18nManager.ngettext

A static translation function for a plural form.

Parameters

diff --git a/api/pl.treksoft.kvision.i18n/-i18n/ntr.html b/api/pl.treksoft.kvision.i18n/-i18n/ntr.html deleted file mode 100644 index 958d3c0d..00000000 --- a/api/pl.treksoft.kvision.i18n/-i18n/ntr.html +++ /dev/null @@ -1,24 +0,0 @@ - - - -I18n.ntr - kvision - - - -kvision / pl.treksoft.kvision.i18n / I18n / ntr
-
-

ntr

- -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/api/pl.treksoft.kvision.i18n/-i18n/tr.html b/api/pl.treksoft.kvision.i18n/-i18n/tr.html deleted file mode 100644 index f419b8b9..00000000 --- a/api/pl.treksoft.kvision.i18n/-i18n/tr.html +++ /dev/null @@ -1,20 +0,0 @@ - - - -I18n.tr - kvision - - - -kvision / pl.treksoft.kvision.i18n / I18n / tr
-
-

tr

- -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/api/pl.treksoft.kvision.i18n/-i18n/trans.html b/api/pl.treksoft.kvision.i18n/-i18n/trans.html deleted file mode 100644 index f7fdb811..00000000 --- a/api/pl.treksoft.kvision.i18n/-i18n/trans.html +++ /dev/null @@ -1,22 +0,0 @@ - - - -I18n.trans - kvision - - - -kvision / pl.treksoft.kvision.i18n / I18n / trans
-
-

trans

- -fun trans(text: String): String
- -fun trans(text: String?): String? -

A dynamic translation function.

Parameters

-text - text marked for a dynamic translation.

Return
-translated text.

- - diff --git a/api/pl.treksoft.kvision.i18n/-simple-i18n-manager/-init-.html b/api/pl.treksoft.kvision.i18n/-simple-i18n-manager/-init-.html new file mode 100644 index 00000000..5a837b88 --- /dev/null +++ b/api/pl.treksoft.kvision.i18n/-simple-i18n-manager/-init-.html @@ -0,0 +1,14 @@ + + + +SimpleI18nManager.<init> - kvision + + + +kvision / pl.treksoft.kvision.i18n / SimpleI18nManager / <init>
+
+

<init>

+ +SimpleI18nManager() + + diff --git a/api/pl.treksoft.kvision.i18n/-simple-i18n-manager/gettext.html b/api/pl.treksoft.kvision.i18n/-simple-i18n-manager/gettext.html new file mode 100644 index 00000000..f7f488ef --- /dev/null +++ b/api/pl.treksoft.kvision.i18n/-simple-i18n-manager/gettext.html @@ -0,0 +1,21 @@ + + + +SimpleI18nManager.gettext - kvision + + + +kvision / pl.treksoft.kvision.i18n / SimpleI18nManager / gettext
+
+

gettext

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

Overrides I18nManager.gettext

A static translation function for a singular form.

Parameters

+key - a translation key.

Return
+translated text.

+ + diff --git a/api/pl.treksoft.kvision.i18n/-simple-i18n-manager/index.html b/api/pl.treksoft.kvision.i18n/-simple-i18n-manager/index.html new file mode 100644 index 00000000..1c3adcd2 --- /dev/null +++ b/api/pl.treksoft.kvision.i18n/-simple-i18n-manager/index.html @@ -0,0 +1,80 @@ + + + +SimpleI18nManager - kvision + + + +kvision / pl.treksoft.kvision.i18n / SimpleI18nManager
+
+

SimpleI18nManager

+class SimpleI18nManager : I18nManager +

Constructors

ntr

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

A dynamic translation function for a plural form.

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

A dynamic translation function for a singular form.

trans

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

A dynamic translation function.

+ + + + + + +

<init>

+SimpleI18nManager()

Functions

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

+ gettext +	+`fun gettext(key: String): String` + A static translation function for a singular form. +
+ ngettext +	+`fun ngettext(singularKey: String, pluralKey: String, value: Int): String` + A static translation function for a plural form. +

Inherited Functions

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

+ 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?` + A dynamic translation function. +

+ + diff --git a/api/pl.treksoft.kvision.i18n/-simple-i18n-manager/ngettext.html b/api/pl.treksoft.kvision.i18n/-simple-i18n-manager/ngettext.html new file mode 100644 index 00000000..4349c98a --- /dev/null +++ b/api/pl.treksoft.kvision.i18n/-simple-i18n-manager/ngettext.html @@ -0,0 +1,25 @@ + + + +SimpleI18nManager.ngettext - kvision + + + +kvision / pl.treksoft.kvision.i18n / SimpleI18nManager / ngettext
+
+

ngettext

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

Overrides I18nManager.ngettext

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/api/pl.treksoft.kvision.i18n/index.html b/api/pl.treksoft.kvision.i18n/index.html index 82da92d3..2f901c4d 100644 --- a/api/pl.treksoft.kvision.i18n/index.html +++ b/api/pl.treksoft.kvision.i18n/index.html @@ -14,20 +14,41 @@ +

DefaultI18nManager

+ + +class DefaultI18nManager : I18nManager + + +

I18n

-object I18n +object I18n : I18nManager

A singleton object used for translations.

I18nManager

+ + +interface I18nManager + + +

Jed

external class Jed + + +

SimpleI18nManager

+ + +class SimpleI18nManager : I18nManager + -- cgit