mirror of https://github.com/buggins/dlangui.git
216 lines
6.3 KiB
HTML
216 lines
6.3 KiB
HTML
<html><head>
|
|
<META http-equiv="content-type" content="text/html; charset=utf-8">
|
|
<title>dlangui.widgets.controls</title>
|
|
</head><body>
|
|
<h1>dlangui.widgets.controls</h1>
|
|
<!-- Generated by Ddoc from src/dlangui/widgets/controls.d -->
|
|
DLANGUI library.
|
|
<br><br>
|
|
This module contains simple <u>controls</u> widgets implementation.
|
|
<br><br>
|
|
|
|
TextWidget
|
|
<br><br>
|
|
|
|
ImageWidget
|
|
<br><br>
|
|
|
|
Button
|
|
<br><br>
|
|
|
|
ImageButton
|
|
<br><br>
|
|
|
|
ScrollBar
|
|
<br><br>
|
|
|
|
|
|
<br><br>
|
|
<b>Synopsis:</b><br>
|
|
<pre class="d_code"><font color=blue>import</font> dlangui.widgets.<u>controls</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="VSpacer"></a>class <u>VSpacer</u>: dlangui.widgets.widget.Widget;
|
|
</big></dt>
|
|
<dd>vertical spacer to fill empty space in vertical layouts<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="HSpacer"></a>class <u>HSpacer</u>: dlangui.widgets.widget.Widget;
|
|
</big></dt>
|
|
<dd>horizontal spacer to fill empty space in horizontal layouts<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="TextWidget"></a>class <u>TextWidget</u>: dlangui.widgets.widget.Widget;
|
|
</big></dt>
|
|
<dd>static text widget<br><br>
|
|
|
|
<dl><dt><big><a name="TextWidget.text"></a>@property dstring <u>text</u>();
|
|
</big></dt>
|
|
<dd>get widget <u>text</u><br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="TextWidget.text"></a>@property Widget <u>text</u>(dstring <i>s</i>);
|
|
</big></dt>
|
|
<dd>set <u>text</u> to show<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="TextWidget.text"></a>@property Widget <u>text</u>(UIString <i>s</i>);
|
|
</big></dt>
|
|
<dd>set <u>text</u> to show<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="TextWidget.textResource"></a>@property Widget <u>textResource</u>(string <i>s</i>);
|
|
</big></dt>
|
|
<dd>set text resource ID to show<br><br>
|
|
|
|
</dd>
|
|
</dl>
|
|
</dd>
|
|
<dt><big><a name="ImageWidget"></a>class <u>ImageWidget</u>: dlangui.widgets.widget.Widget;
|
|
</big></dt>
|
|
<dd>static image widget<br><br>
|
|
|
|
<dl><dt><big><a name="ImageWidget.drawableId"></a>@property string <u>drawableId</u>();
|
|
</big></dt>
|
|
<dd>get drawable image id<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="ImageWidget.drawableId"></a>@property ImageWidget <u>drawableId</u>(string <i>id</i>);
|
|
</big></dt>
|
|
<dd>set drawable image <i>id</i><br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="ImageWidget.drawable"></a>@property ref DrawableRef <u>drawable</u>();
|
|
</big></dt>
|
|
<dd>get <u>drawable</u><br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="ImageWidget.drawable"></a>@property ImageWidget <u>drawable</u>(DrawableRef <i>img</i>);
|
|
</big></dt>
|
|
<dd>set custom <u>drawable</u> (not one from resources)<br><br>
|
|
|
|
</dd>
|
|
</dl>
|
|
</dd>
|
|
<dt><big><a name="ImageButton"></a>class <u>ImageButton</u>: dlangui.widgets.controls.ImageWidget;
|
|
</big></dt>
|
|
<dd>button with image only<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="ImageTextButton"></a>class <u>ImageTextButton</u>: dlangui.widgets.layouts.HorizontalLayout;
|
|
</big></dt>
|
|
<dd>button with image and text<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="CheckBox"></a>class <u>CheckBox</u>: dlangui.widgets.controls.ImageTextButton;
|
|
</big></dt>
|
|
<dd>checkbox<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="RadioButton"></a>class <u>RadioButton</u>: dlangui.widgets.controls.ImageTextButton;
|
|
</big></dt>
|
|
<dd>radio button<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="Button"></a>class <u>Button</u>: dlangui.widgets.widget.Widget;
|
|
</big></dt>
|
|
<dd>Text only button<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="OnScrollHandler"></a>interface <u>OnScrollHandler</u>;
|
|
</big></dt>
|
|
<dd>scroll event handler interface<br><br>
|
|
|
|
<dl><dt><big><a name="OnScrollHandler.onScrollEvent"></a>abstract bool <u>onScrollEvent</u>(AbstractSlider <i>source</i>, ScrollEvent <i>event</i>);
|
|
</big></dt>
|
|
<dd>handle scroll <i>event</i><br><br>
|
|
|
|
</dd>
|
|
</dl>
|
|
</dd>
|
|
<dt><big><a name="AbstractSlider"></a>class <u>AbstractSlider</u>: dlangui.widgets.widget.WidgetGroup;
|
|
</big></dt>
|
|
<dd>base class for widgets like scrollbars and sliders<br><br>
|
|
|
|
<dl><dt><big><a name="AbstractSlider.onScrollEventListener"></a>Signal!OnScrollHandler <u>onScrollEventListener</u>;
|
|
</big></dt>
|
|
<dd>scroll event listeners<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="AbstractSlider.position"></a>const @property int <u>position</u>();
|
|
</big></dt>
|
|
<dd>returns slider <u>position</u><br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="AbstractSlider.position"></a>@property AbstractSlider <u>position</u>(int <i>newPosition</i>);
|
|
</big></dt>
|
|
<dd>sets new slider <u>position</u><br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="AbstractSlider.minValue"></a>const @property int <u>minValue</u>();
|
|
</big></dt>
|
|
<dd>returns slider range min value<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="AbstractSlider.maxValue"></a>const @property int <u>maxValue</u>();
|
|
</big></dt>
|
|
<dd>returns slider range max value<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="AbstractSlider.pageSize"></a>const @property int <u>pageSize</u>();
|
|
</big></dt>
|
|
<dd>page size (visible area size)<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="AbstractSlider.pageSize"></a>@property AbstractSlider <u>pageSize</u>(int <i>size</i>);
|
|
</big></dt>
|
|
<dd>set page <i>size</i> (visible area <i>size</i>)<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="AbstractSlider.setRange"></a>AbstractSlider <u>setRange</u>(int <i>min</i>, int <i>max</i>);
|
|
</big></dt>
|
|
<dd>set new range (<i>min</i> and <i>max</i> values for slider)<br><br>
|
|
|
|
</dd>
|
|
</dl>
|
|
</dd>
|
|
<dt><big><a name="ScrollBar"></a>class <u>ScrollBar</u>: dlangui.widgets.controls.AbstractSlider, dlangui.widgets.widget.OnClickHandler;
|
|
</big></dt>
|
|
<dd>scroll bar - either vertical or horizontal<br><br>
|
|
|
|
<dl><dt><big><a name="ScrollBar.orientation"></a>@property Orientation <u>orientation</u>();
|
|
</big></dt>
|
|
<dd>returns scrollbar <u>orientation</u> (Vertical, Horizontal)<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="ScrollBar.orientation"></a>@property ScrollBar <u>orientation</u>(Orientation <i>value</i>);
|
|
</big></dt>
|
|
<dd>sets scrollbar <u>orientation</u><br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="ScrollBar.onMouseEvent"></a>bool <u>onMouseEvent</u>(MouseEvent <i>event</i>);
|
|
</big></dt>
|
|
<dd>handle mouse wheel events<br><br>
|
|
|
|
</dd>
|
|
<dt><big><a name="ScrollBar.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>
|
|
</dl>
|
|
|
|
<hr><small>Page generated by <a href="http://dlang.org/ddoc.html">Ddoc</a>. Vadim Lopatin, 2014
|
|
</small>
|
|
</body></html>
|