mirror of https://github.com/buggins/dlangui.git
266 lines
9.4 KiB
HTML
266 lines
9.4 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
<html>
|
|
<head>
|
|
<meta charset='utf-8'>
|
|
<meta http-equiv="X-UA-Compatible" content="chrome=1">
|
|
<link href='https://fonts.googleapis.com/css?family=Chivo:900' rel='stylesheet' type='text/css'>
|
|
<link rel="stylesheet" type="text/css" href="stylesheets/stylesheet.css" media="screen" />
|
|
<link rel="stylesheet" type="text/css" href="stylesheets/pygment_trac.css" media="screen" />
|
|
<link rel="stylesheet" type="text/css" href="stylesheets/print.css" media="print" />
|
|
<!--[if lt IE 9]>
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
<![endif]-->
|
|
<title>DlangUI - cross platform GUI library for D programming language - dlangui.core.i18n</title>
|
|
</head>
|
|
<body>
|
|
<div id="container">
|
|
<div class="inner">
|
|
<header>
|
|
<h1>DlangUI</h1>
|
|
<h2>Cross Platform GUI for D programming language</h2>
|
|
</header>
|
|
<section id="downloads" class="clearfix">
|
|
<a href="index.html" id="home" class="button"><span>Home</span></a>
|
|
<a href="api.html" id="home" class="button"><span>API Docs</span></a>
|
|
<a href="screenshots.html" id="home" class="button"><span>Screenshots</span></a>
|
|
<a href="https://github.com/buggins/dlangui/zipball/master" id="download-zip" class="button"><span>Download .zip</span></a>
|
|
<!--a href="https://github.com/buggins/dlangui/tarball/master" id="download-tar-gz" class="button"><span>Download .tar.gz</span></a-->
|
|
<a href="https://github.com/buggins/dlangui" id="view-on-github" class="button"><span>View on GitHub</span></a>
|
|
</section>
|
|
|
|
<hr>
|
|
<section id="main_content">
|
|
<h1>dlangui.core.i18n</h1>
|
|
<!-- Generated by Ddoc from src\dlangui\core\i18n.d -->
|
|
This module contains internationalization support implementation.
|
|
<br><br>
|
|
Translation files contain of simple key=value pair lines.
|
|
<br><br>
|
|
|
|
STRING_RESOURCE_ID=Translation text.
|
|
<br><br>
|
|
|
|
Supports fallback to another translation file (e.g. default language).
|
|
<br><br>
|
|
|
|
<br><br>
|
|
|
|
|
|
<br><br>
|
|
<b>Synopsis:</b><br>
|
|
<pre class="d_code"><font color=blue>import</font> dlangui.core.<u>i18n</u>;
|
|
|
|
<font color=green>// use global i18n object to get translation for string ID
|
|
</font>dstring translated = <u>i18n</u>.get(<font color=red>"STR_FILE_OPEN"</font>);
|
|
|
|
<font color=green>// UIString type can hold either string resource id or dstring raw value.
|
|
</font>UIString text;
|
|
|
|
<font color=green>// assign resource id as string
|
|
</font>text = <font color=red>"ID_FILE_EXIT"</font>;
|
|
<font color=green>// or assign raw value as dstring
|
|
</font>text = <font color=red>"some text"d</font>;
|
|
|
|
<font color=green>// i18n.get() will automatically be invoked when getting UIString value (e.g. using alias this).
|
|
</font>dstring translated = text;
|
|
|
|
</pre>
|
|
|
|
<br><br>
|
|
<b>License:</b><br>
|
|
Boost License 1.0
|
|
<br><br>
|
|
<b>Authors:</b><br>
|
|
Vadim Lopatin, coolreader.org@gmail.com<br><br>
|
|
|
|
<dl><dt><big><a name="UIString"></a>struct <u>UIString</u>;
|
|
</big></dt>
|
|
<dd>container for UI string - either raw value or string resource ID<br><br>
|
|
|
|
<dl><dt><big><a name="UIString.this"></a>this(string <i>id</i>);
|
|
</big></dt>
|
|
<dd>create string with i18n resource <i>id</i><br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="UIString.this"></a>this(dstring <i>value</i>);
|
|
</big></dt>
|
|
<dd>create string with raw <i>value</i><br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="UIString.value"></a>const @property dstring <u>value</u>();
|
|
</big></dt>
|
|
<dd>get <u>value</u> (either raw or translated by id)<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="UIString.value"></a>@property void <u>value</u>(dstring <i>newValue</i>);
|
|
</big></dt>
|
|
<dd>set raw <u>value</u><br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="UIString.opAssign"></a>ref UIString <u>opAssign</u>(dstring <i>rawValue</i>);
|
|
</big></dt>
|
|
<dd>assign raw value<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="UIString.opAssign"></a>ref UIString <u>opAssign</u>(string <i>ID</i>);
|
|
</big></dt>
|
|
<dd>assign <i>ID</i><br><br>
|
|
|
|
</dd>
|
|
</dl>
|
|
</dd>
|
|
<dt><big><a name="UIStringCollection"></a>struct <u>UIStringCollection</u>;
|
|
</big></dt>
|
|
<dd>UIString item collection.<br><br>
|
|
|
|
<dl><dt><big><a name="UIStringCollection.length"></a>@property int <u>length</u>();
|
|
</big></dt>
|
|
<dd>returns number of items<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="UIStringCollection.opIndex"></a>UIString[] <u>opIndex</u>();
|
|
</big></dt>
|
|
<dd>slice<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="UIStringCollection.opSlice"></a>UIString[] <u>opSlice</u>();
|
|
</big></dt>
|
|
<dd>slice<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="UIStringCollection.opSlice"></a>UIString[] <u>opSlice</u>(size_t <i>start</i>, size_t <i>end</i>);
|
|
</big></dt>
|
|
<dd>slice<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="UIStringCollection.opIndex"></a>UIString <u>opIndex</u>(size_t <i>index</i>);
|
|
</big></dt>
|
|
<dd>read item by <i>index</i><br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="UIStringCollection.opIndexAssign"></a>UIString <u>opIndexAssign</u>(UIString <i>value</i>, size_t <i>index</i>);
|
|
</big></dt>
|
|
<dd>modify item by <i>index</i><br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="UIStringCollection.get"></a>dstring <u>get</u>(size_t <i>index</i>);
|
|
</big></dt>
|
|
<dd>return unicode string for item by <i>index</i><br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="UIStringCollection.opAssign"></a>void <u>opAssign</u>(ref UIStringCollection <i>items</i>);
|
|
</big></dt>
|
|
<dd>Assign UIStringCollection<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="UIStringCollection.addAll"></a>void <u>addAll</u>(ref UIStringCollection <i>items</i>);
|
|
</big></dt>
|
|
<dd>Append UIStringCollection<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="UIStringCollection.opAssign"></a>void <u>opAssign</u>(string[] <i>items</i>);
|
|
</big></dt>
|
|
<dd>Assign array of string resource IDs<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="UIStringCollection.addAll"></a>void <u>addAll</u>(string[] <i>items</i>);
|
|
</big></dt>
|
|
<dd>Append array of string resource IDs<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="UIStringCollection.opAssign"></a>void <u>opAssign</u>(dstring[] <i>items</i>);
|
|
</big></dt>
|
|
<dd>Assign array of unicode strings<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="UIStringCollection.addAll"></a>void <u>addAll</u>(dstring[] <i>items</i>);
|
|
</big></dt>
|
|
<dd>Append array of unicode strings<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="UIStringCollection.clear"></a>void <u>clear</u>();
|
|
</big></dt>
|
|
<dd>remove all items<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="UIStringCollection.add"></a>void <u>add</u>(string <i>item</i>, int <i>index</i> = -1);
|
|
</big></dt>
|
|
<dd>Insert resource id <i>item</i> into specified position<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="UIStringCollection.add"></a>void <u>add</u>(dstring <i>item</i>, int <i>index</i> = -1);
|
|
</big></dt>
|
|
<dd>Insert unicode string <i>item</i> into specified position<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="UIStringCollection.add"></a>void <u>add</u>(UIString <i>item</i>, int <i>index</i> = -1);
|
|
</big></dt>
|
|
<dd>Insert UIString <i>item</i> into specified position<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="UIStringCollection.remove"></a>void <u>remove</u>(int <i>index</i>);
|
|
</big></dt>
|
|
<dd>Remove item with specified <i>index</i><br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="UIStringCollection.indexOf"></a>int <u>indexOf</u>(dstring <i>str</i>);
|
|
</big></dt>
|
|
<dd>Return index of first item with specified text or -1 if not found.<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="UIStringCollection.indexOf"></a>int <u>indexOf</u>(string <i>strId</i>);
|
|
</big></dt>
|
|
<dd>Return index of first item with specified string resource id or -1 if not found.<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="UIStringCollection.indexOf"></a>int <u>indexOf</u>(UIString <i>str</i>);
|
|
</big></dt>
|
|
<dd>Return index of first item with specified string or -1 if not found.<br><br>
|
|
|
|
</dd>
|
|
</dl>
|
|
</dd>
|
|
<dt><big><a name="UIStringTranslator"></a>class <u>UIStringTranslator</u>;
|
|
</big></dt>
|
|
<dd>UI Strings internationalization translator.<br><br>
|
|
|
|
<dl><dt><big><a name="UIStringTranslator.findTranslationsDir"></a>shared void <u>findTranslationsDir</u>(string[] <i>dirs</i>...);
|
|
</big></dt>
|
|
<dd>looks for i18n directory inside one of passed <i>dirs</i>, and uses first found as directory to read i18n files from<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="UIStringTranslator.convertResourcePaths"></a>shared string[] <u>convertResourcePaths</u>(string <i>filename</i>);
|
|
</big></dt>
|
|
<dd>convert resource path - append resource dir if necessary<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="UIStringTranslator.load"></a>shared bool <u>load</u>(string <i>mainFilename</i>, string <i>fallbackFilename</i> = null);
|
|
</big></dt>
|
|
<dd><u>load</u> translation file(s)<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="UIStringTranslator.get"></a>shared dstring <u>get</u>(string <i>id</i>);
|
|
</big></dt>
|
|
<dd>translate string ID to string (returns "UNTRANSLATED: <i>id</i>" for missing values)<br><br>
|
|
|
|
</dd>
|
|
</dl>
|
|
</dd>
|
|
<dt><big><a name="i18n"></a>UIStringTranslator <u>i18n</u>;
|
|
</big></dt>
|
|
<dd>Global translator object.<br><br>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
</section>
|
|
<footer>
|
|
Dlangui is maintained by <a href="https://github.com/buggins">buggins</a><br>
|
|
This page was generated by <a href="http://pages.github.com">GitHub Pages</a>. Tactile theme by <a href="https://twitter.com/jasonlong">Jason Long</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|