dlangui/tabs.html

268 lines
9.9 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.widgets.tabs</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.widgets.tabs</h1>
<!-- Generated by Ddoc from src\dlangui\widgets\tabs.d -->
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>: <u>dlangui.widgets.layouts.HorizontalLayout</u>;
</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>: <u>dlangui.widgets.widget.WidgetGroup</u>;
</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>: <u>dlangui.widgets.layouts.FrameLayout</u>, <u>dlangui.widgets.tabs.TabHandler</u>;
</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>: <u>dlangui.widgets.layouts.VerticalLayout</u>, <u>dlangui.widgets.tabs.TabHandler</u>;
</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>
</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>