mirror of https://github.com/buggins/dlangui.git
188 lines
6.7 KiB
HTML
188 lines
6.7 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.collections</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.collections</h1>
|
|
<!-- Generated by Ddoc from src\dlangui\core\collections.d -->
|
|
This module implements array based collection.
|
|
<br><br>
|
|
<b>Synopsis:</b><br>
|
|
<pre class="d_code"><font color=blue>import</font> dlangui.core.<u>collections</u>;
|
|
|
|
<font color=green>// add
|
|
</font>Collection!Widget widgets;
|
|
widgets ~= <font color=blue>new</font> Widget(<font color=red>"id1"</font>);
|
|
widgets ~= <font color=blue>new</font> Widget(<font color=red>"id2"</font>);
|
|
Widget w3 = <font color=blue>new</font> Widget(<font color=red>"id3"</font>);
|
|
widgets ~= w3;
|
|
|
|
<font color=green>// remove by index
|
|
</font>widgets.remove(1);
|
|
|
|
<font color=green>// foreach
|
|
</font><font color=blue>foreach</font>(w; widgets)
|
|
writeln(<font color=red>"widget: "</font>, w.id);
|
|
|
|
<font color=green>// remove by value
|
|
</font>widgets -= w3;
|
|
writeln(widgets[0].id);
|
|
|
|
|
|
</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="Collection"></a>struct <u>Collection</u>(T, bool ownItems = false);
|
|
</big></dt>
|
|
<dd>array based collection of items
|
|
<br><br>
|
|
retains item order when during add/remove operations<br><br>
|
|
|
|
<dl><dt><big><a name="Collection.empty"></a>@property bool <u>empty</u>();
|
|
</big></dt>
|
|
<dd>returns <b>true</b> if there are no items in collection<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="Collection.length"></a>@property size_t <u>length</u>();
|
|
</big></dt>
|
|
<dd>returns number of items in collection<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="Collection.size"></a>@property size_t <u>size</u>();
|
|
</big></dt>
|
|
<dd>returns currently allocated capacity (may be more than length)<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="Collection.size"></a>@property void <u>size</u>(size_t <i>newSize</i>);
|
|
</big></dt>
|
|
<dd>change capacity (e.g. to reserve big space to avoid multiple reallocations)<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="Collection.length"></a>@property void <u>length</u>(size_t <i>newSize</i>);
|
|
</big></dt>
|
|
<dd>returns number of items in collection<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="Collection.opIndex"></a>ref T <u>opIndex</u>(size_t <i>index</i>);
|
|
</big></dt>
|
|
<dd>access item by <i>index</i><br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="Collection.add"></a>void <u>add</u>(T <i>item</i>, size_t <i>index</i> = size_t.max);
|
|
</big></dt>
|
|
<dd>insert new <i>item</i> in specified position<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="Collection.addAll"></a>void <u>addAll</u>(ref Collection!(T, ownItems) <i>v</i>);
|
|
</big></dt>
|
|
<dd>add all items from other collection<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="Collection.opOpAssign"></a>ref Collection <u>opOpAssign</u>(string op)(T <i>item</i>);
|
|
</big></dt>
|
|
<dd>support for appending (~=, +=) and removing by value (-=)<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="Collection.indexOf"></a>size_t <u>indexOf</u>(T <i>item</i>);
|
|
</big></dt>
|
|
<dd>returns index of first occurence of <i>item</i>, size_t.max if not found<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="Collection.remove"></a>T <u>remove</u>(size_t <i>index</i>);
|
|
</big></dt>
|
|
<dd><u>remove</u> single item, returning removed item<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="Collection.removeValue"></a>bool <u>removeValue</u>(T <i>value</i>);
|
|
</big></dt>
|
|
<dd>remove single item by <i>value</i> - if present in collection, returning <b>true</b> if item was found and removed<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="Collection.opApply"></a>int <u>opApply</u>(int delegate(ref T param) <i>op</i>);
|
|
</big></dt>
|
|
<dd>support of foreach with reference<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="Collection.clear"></a>void <u>clear</u>();
|
|
</big></dt>
|
|
<dd>remove all items<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="Collection.popFront"></a>@property T <u>popFront</u>();
|
|
</big></dt>
|
|
<dd>remove first item<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="Collection.pushFront"></a>void <u>pushFront</u>(T <i>item</i>);
|
|
</big></dt>
|
|
<dd>insert <i>item</i> at beginning of collection<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="Collection.popBack"></a>@property T <u>popBack</u>();
|
|
</big></dt>
|
|
<dd>remove last item<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="Collection.pushBack"></a>void <u>pushBack</u>(T <i>item</i>);
|
|
</big></dt>
|
|
<dd>insert <i>item</i> at end of collection<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="Collection.front"></a>@property T <u>front</u>();
|
|
</big></dt>
|
|
<dd>peek first item<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="Collection.back"></a>@property T <u>back</u>();
|
|
</big></dt>
|
|
<dd>peek last item<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>
|