mirror of https://github.com/buggins/dlangui.git
236 lines
7.9 KiB
HTML
236 lines
7.9 KiB
HTML
<html><head>
|
|
<META http-equiv="content-type" content="text/html; charset=utf-8">
|
|
<title>dlangui.widgets.tabs</title>
|
|
</head><body>
|
|
<h1>dlangui.widgets.tabs</h1>
|
|
<!-- Generated by Ddoc from src/dlangui/widgets/tabs.d -->
|
|
DLANGUI library.
|
|
<br><br>
|
|
This module contains declaration of tabbed view controls.
|
|
<br><br>
|
|
|
|
TabItemWidget - single tab header in tab control
|
|
TabWidget
|
|
TabHost
|
|
TabControl
|
|
<br><br>
|
|
|
|
|
|
<br><br>
|
|
<b>Synopsis:</b><br>
|
|
<pre class="d_code"><font color=blue>import</font> dlangui.widgets.<u>tabs</u>;
|
|
|
|
</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="TabItem"></a>class <u>TabItem</u>;
|
|
</big></dt>
|
|
<dd>tab item metadata<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="TabItemWidget"></a>class <u>TabItemWidget</u>: dlangui.widgets.layouts.HorizontalLayout;
|
|
</big></dt>
|
|
<dd>tab item widget - to show tab header<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="TabItemList"></a>class <u>TabItemList</u>;
|
|
</big></dt>
|
|
<dd>tab item list helper class<br><br>
|
|
|
|
<dl><dt><big><a name="TabItemList.get"></a>TabItem <u>get</u>(int <i>index</i>);
|
|
</big></dt>
|
|
<dd><u>get</u> item by <i>index</i><br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="TabItemList.get"></a>TabItem <u>get</u>(string <i>id</i>);
|
|
</big></dt>
|
|
<dd><u>get</u> item by <i>id</i><br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="TabItemList.add"></a>TabItemList <u>add</u>(TabItem <i>item</i>);
|
|
</big></dt>
|
|
<dd>append new <i>item</i><br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="TabItemList.insert"></a>TabItemList <u>insert</u>(TabItem <i>item</i>, int <i>index</i>);
|
|
</big></dt>
|
|
<dd><u>insert</u> new <i>item</i> to specified position<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="TabItemList.remove"></a>TabItem <u>remove</u>(int <i>index</i>);
|
|
</big></dt>
|
|
<dd><u>remove</u> item by <i>index</i><br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="TabItemList.indexById"></a>int <u>indexById</u>(string <i>id</i>);
|
|
</big></dt>
|
|
<dd>find tab index by <i>id</i><br><br>
|
|
|
|
</dd>
|
|
</dl>
|
|
</dd>
|
|
<dt><big><a name="TabControl"></a>class <u>TabControl</u>: dlangui.widgets.widget.WidgetGroup;
|
|
</big></dt>
|
|
<dd>tab header - tab labels, with optional More button<br><br>
|
|
|
|
<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>
|
|
|
|
</dd>
|
|
<dt><big><a name="TabControl.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="TabControl.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="TabControl.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>
|
|
<dt><big><a name="TabControl.removeTab"></a>TabControl <u>removeTab</u>(string <i>id</i>);
|
|
</big></dt>
|
|
<dd>remove tab<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="TabControl.addTab"></a>TabControl <u>addTab</u>(TabItem <i>item</i>, int <i>index</i> = -1, bool <i>enableCloseButton</i> = false);
|
|
</big></dt>
|
|
<dd>add new tab<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="TabControl.addTab"></a>TabControl <u>addTab</u>(string <i>id</i>, dstring <i>label</i>, string <i>iconId</i> = null, bool <i>enableCloseButton</i> = false);
|
|
</big></dt>
|
|
<dd>add new tab by <i>id</i> and <i>label</i> string<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="TabControl.addTab"></a>TabControl <u>addTab</u>(string <i>id</i>, string <i>labelResourceId</i>, string <i>iconId</i> = null, bool <i>enableCloseButton</i> = false);
|
|
</big></dt>
|
|
<dd>add new tab by <i>id</i> and label string resource <i>id</i><br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="TabControl.measure"></a>void <u>measure</u>(int <i>parentWidth</i>, int <i>parentHeight</i>);
|
|
</big></dt>
|
|
<dd>Measure widget according to desired width and height constraints. (Step 1 of two phase layout).<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="TabControl.layout"></a>void <u>layout</u>(Rect <i>rc</i>);
|
|
</big></dt>
|
|
<dd>Set widget rectangle to specified value and <u>layout</u> widget contents. (Step 2 of two phase <u>layout</u>).<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="TabControl.onDraw"></a>void <u>onDraw</u>(DrawBuf <i>buf</i>);
|
|
</big></dt>
|
|
<dd>Draw widget at its position to buffer<br><br>
|
|
|
|
</dd>
|
|
</dl>
|
|
</dd>
|
|
<dt><big><a name="TabHost"></a>class <u>TabHost</u>: dlangui.widgets.layouts.FrameLayout, dlangui.widgets.tabs.TabHandler;
|
|
</big></dt>
|
|
<dd>container for widgets controlled by TabControl<br><br>
|
|
|
|
<dl><dt><big><a name="TabHost.tabControl"></a>@property TabControl <u>tabControl</u>();
|
|
</big></dt>
|
|
<dd>get currently set control widget<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="TabHost.tabControl"></a>@property TabHost <u>tabControl</u>(TabControl <i>newWidget</i>);
|
|
</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>
|
|
<dd>remove tab<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="TabHost.addTab"></a>TabHost <u>addTab</u>(Widget <i>widget</i>, dstring <i>label</i>, string <i>iconId</i> = null, bool <i>enableCloseButton</i> = false);
|
|
</big></dt>
|
|
<dd>add new tab by id and <i>label</i> string<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="TabHost.addTab"></a>TabHost <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>
|
|
|
|
</dd>
|
|
<dt><big><a name="TabHost.selectTab"></a>void <u>selectTab</u>(string <i>ID</i>);
|
|
</big></dt>
|
|
<dd>select tab<br><br>
|
|
|
|
</dd>
|
|
</dl>
|
|
</dd>
|
|
<dt><big><a name="TabWidget"></a>class <u>TabWidget</u>: dlangui.widgets.layouts.VerticalLayout, dlangui.widgets.tabs.TabHandler;
|
|
</big></dt>
|
|
<dd>compound widget - contains from TabControl widget (tabs header) and TabHost (content pages)<br><br>
|
|
|
|
<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>
|
|
|
|
</dd>
|
|
<dt><big><a name="TabWidget.addTab"></a>TabWidget <u>addTab</u>(Widget <i>widget</i>, dstring <i>label</i>, string <i>iconId</i> = null, bool <i>enableCloseButton</i> = false);
|
|
</big></dt>
|
|
<dd>add new tab by id and <i>label</i> (raw value)<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="TabWidget.removeTab"></a>TabWidget <u>removeTab</u>(string <i>id</i>);
|
|
</big></dt>
|
|
<dd>remove tab by <i>id</i><br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="TabWidget.selectTab"></a>void <u>selectTab</u>(string <i>ID</i>);
|
|
</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>
|
|
</dl>
|
|
|
|
<hr><small>Page generated by <a href="http://dlang.org/ddoc.html">Ddoc</a>. Vadim Lopatin, 2014
|
|
</small>
|
|
</body></html>
|