forks
/
dlangui
mirror of https://github.com/buggins/dlangui.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update documentation

This commit is contained in:
Vadim Lopatin 2014-05-20 08:57:00 +04:00
parent c95a45083b
commit f6d7350e77
2 changed files with 56 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
docs/platform.html
View File

@ -49,12 +49,12 @@ Vadim Lopatin, coolreader.org@gmail.com<br><br>
<dd><u>Window</u> abstraction layer. Widgets can be shown only inside window.
<br><br>
<dl><dt><big><a name="Window.windowCaption"></a>abstract @property string <u>windowCaption</u>();
<dl><dt><big><a name="Window.windowCaption"></a>abstract @property dstring <u>windowCaption</u>();
</big></dt>
<dd>returns window caption<br><br>
</dd>
<dt><big><a name="Window.windowCaption"></a>abstract @property void <u>windowCaption</u>(string <i>caption</i>);
<dt><big><a name="Window.windowCaption"></a>abstract @property void <u>windowCaption</u>(dstring <i>caption</i>);
</big></dt>
<dd>sets window <i>caption</i><br><br>
@ -157,14 +157,31 @@ Vadim Lopatin, coolreader.org@gmail.com<br><br>
<br><br>
Represents application.<br><br>
<dl><dt><big><a name="Platform.createWindow"></a>abstract Window <u>createWindow</u>(string <i>windowCaption</i>, Window <i>parent</i>, uint <i>flags</i> = WindowFlag.Resizable);
<dl><dt><big><a name="Platform.createWindow"></a>abstract Window <u>createWindow</u>(dstring <i>windowCaption</i>, Window <i>parent</i>, uint <i>flags</i> = WindowFlag.Resizable);
</big></dt>
<dd>create window<br><br>
<dd>create window
<br><br>
<b>Args:</b><br>
<i>windowCaption</i> = window caption text
<i>parent</i> = <i>parent</i> Window, or <b>null</b> if no <i>parent</i>
<i>flags</i> = WindowFlag bit set, combination of Resizable, Modal, Fullscreen
<br><br>
Window w/o Resizable nor Fullscreen will be created with size based on measurement of its content widget<br><br>
</dd>
<dt><big><a name="Platform.closeWindow"></a>abstract void <u>closeWindow</u>(Window <i>w</i>);
</big></dt>
<dd>close window<br><br>
<dd>close window
<br><br>
Closes window earlier created with createWindow()<br><br>
</dd>
<dt><big><a name="Platform.enterMessageLoop"></a>abstract int <u>enterMessageLoop</u>();
</big></dt>
<dd>Starts application message loop.
<br><br>
When returned from this method, application is shutting down.<br><br>
</dd>
<dt><big><a name="Platform.getClipboardText"></a>abstract dstring <u>getClipboardText</u>(bool <i>mouseBuffer</i> = false);
@ -189,12 +206,12 @@ Represents application.<br><br>
</dd>
<dt><big><a name="Platform.uiLanguage"></a>@property Platform <u>uiLanguage</u>(string <i>langCode</i>);
</big></dt>
<dd>set UI language (e.g. "en", "fr", "ru")<br><br>
<dd>set UI language (e.g. "en", "fr", "ru") - will relayout content of all windows if language has been changed<br><br>
</dd>
<dt><big><a name="Platform.uiTheme"></a>@property Platform <u>uiTheme</u>(string <i>themeResourceId</i>);
</big></dt>
<dd>sets application UI theme<br><br>
<dd>sets application UI theme - will relayout content of all windows if theme has been changed<br><br>
</dd>
<dt><big><a name="Platform.resourceDirs"></a>@property string[] <u>resourceDirs</u>();

34
docs/tabs.html
View File

@ -79,7 +79,12 @@ Vadim Lopatin, coolreader.org@gmail.com<br><br>
</big></dt>
<dd>tab header - tab labels, with optional More button<br><br>
<dl><dt><big><a name="TabControl.tabCount"></a>const @property int <u>tabCount</u>();
<dl><dt><big><a name="TabControl.onTabChangedListener"></a>Signal!TabHandler <u>onTabChangedListener</u>;
</big></dt>
<dd>signal of tab change (e.g. by clicking on tab header)<br><br>
</dd>
<dt><big><a name="TabControl.tabCount"></a>const @property int <u>tabCount</u>();
</big></dt>
<dd>returns tab count<br><br>
@ -149,6 +154,11 @@ Vadim Lopatin, coolreader.org@gmail.com<br><br>
</big></dt>
<dd>set new control widget<br><br>
</dd>
<dt><big><a name="TabHost.onTabChangedListener"></a>Signal!TabHandler <u>onTabChangedListener</u>;
</big></dt>
<dd>signal of tab change (e.g. by clicking on tab header)<br><br>
</dd>
<dt><big><a name="TabHost.removeTab"></a>TabHost <u>removeTab</u>(string <i>id</i>);
</big></dt>
@ -176,7 +186,12 @@ Vadim Lopatin, coolreader.org@gmail.com<br><br>
</big></dt>
<dd>compound widget - contains from TabControl widget (tabs header) and TabHost (content pages)<br><br>
<dl><dt><big><a name="TabWidget.addTab"></a>TabWidget <u>addTab</u>(Widget <i>widget</i>, string <i>labelResourceId</i>, string <i>iconId</i> = null, bool <i>enableCloseButton</i> = false);
<dl><dt><big><a name="TabWidget.onTabChangedListener"></a>Signal!TabHandler <u>onTabChangedListener</u>;
</big></dt>
<dd>signal of tab change (e.g. by clicking on tab header)<br><br>
</dd>
<dt><big><a name="TabWidget.addTab"></a>TabWidget <u>addTab</u>(Widget <i>widget</i>, string <i>labelResourceId</i>, string <i>iconId</i> = null, bool <i>enableCloseButton</i> = false);
</big></dt>
<dd>add new tab by id and label string resource id<br><br>
@ -195,6 +210,21 @@ Vadim Lopatin, coolreader.org@gmail.com<br><br>
</big></dt>
<dd>select tab<br><br>
</dd>
<dt><big><a name="TabWidget.tab"></a>TabItem <u>tab</u>(int <i>index</i>);
</big></dt>
<dd>returns <u>tab</u> item by id (<b>null</b> if <i>index</i> out of range)<br><br>
</dd>
<dt><big><a name="TabWidget.tab"></a>TabItem <u>tab</u>(string <i>id</i>);
</big></dt>
<dd>returns <u>tab</u> item by <i>id</i> (<b>null</b> if not found)<br><br>
</dd>
<dt><big><a name="TabWidget.tabIndex"></a>int <u>tabIndex</u>(string <i>id</i>);
</big></dt>
<dd>get tab index by tab <i>id</i> (-1 if not found)<br><br>
</dd>
</dl>
</dd>