dlangui/popup.html

174 lines
6.3 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.popup</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.popup</h1>
<!-- Generated by Ddoc from src\dlangui\widgets\popup.d -->
This module contains <u>popup</u> widgets implementation.
<br><br>
Popups appear above other widgets inside window.
<br><br>
Useful for <u>popup</u> menus, notification popups, etc.
<br><br>
<b>Synopsis:</b><br>
<pre class="d_code"><font color=blue>import</font> dlangui.widgets.<u>popup</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="PopupAlign"></a>enum <u>PopupAlign</u>: uint;
</big></dt>
<dd>popup alignment option flags<br><br>
<dl><dt><big><a name="PopupAlign.Center"></a><u>Center</u></big></dt>
<dd>center popup around anchor widget center<br><br>
</dd>
<dt><big><a name="PopupAlign.Below"></a><u>Below</u></big></dt>
<dd>place popup below anchor widget close to lower bound<br><br>
</dd>
<dt><big><a name="PopupAlign.Right"></a><u>Right</u></big></dt>
<dd>place popup below anchor widget close to right bound (when no space enough, align near left bound)<br><br>
</dd>
<dt><big><a name="PopupAlign.Point"></a><u>Point</u></big></dt>
<dd>align to specified point<br><br>
</dd>
<dt><big><a name="PopupAlign.FitAnchorSize"></a><u>FitAnchorSize</u></big></dt>
<dd>if popup content size is less than anchor's size, increase it to anchor size<br><br>
</dd>
</dl>
</dd>
<dt><big><a name="PopupFlags"></a>enum <u>PopupFlags</u>: uint;
</big></dt>
<dd>popup behavior flags - for PopupWidget.flags property<br><br>
<dl><dt><big><a name="PopupFlags.CloseOnClickOutside"></a><u>CloseOnClickOutside</u></big></dt>
<dd>close popup when mouse button clicked outside of its bounds<br><br>
</dd>
</dl>
</dd>
<dt><big><a name="OnPopupCloseHandler"></a>interface <u>OnPopupCloseHandler</u>;
</big></dt>
<dd>interface - slot for onPopupCloseListener<br><br>
</dd>
<dt><big><a name="PopupWidget"></a>class <u>PopupWidget</u>: <u>dlangui.widgets.layouts.LinearLayout</u>;
</big></dt>
<dd>popup widget container<br><br>
<dl><dt><big><a name="PopupWidget.onPopupCloseListener"></a>Signal!OnPopupCloseHandler <u>onPopupCloseListener</u>;
</big></dt>
<dd>popup close signal<br><br>
</dd>
<dt><big><a name="PopupWidget.flags"></a>@property uint <u>flags</u>();
</big></dt>
<dd>popup close listener (called right before closing)
<br><br>
set popup close listener (to call right before closing)
<br><br>
returns popup behavior <u>flags</u> (combination of PopupFlags)<br><br>
</dd>
<dt><big><a name="PopupWidget.flags"></a>@property PopupWidget <u>flags</u>(uint <u>flags</u>);
</big></dt>
<dd>set popup behavior <u>flags</u> (combination of PopupFlags)<br><br>
</dd>
<dt><big><a name="PopupWidget.anchor"></a>@property ref PopupAnchor <u>anchor</u>();
</big></dt>
<dd>access to popup <u>anchor</u><br><br>
</dd>
<dt><big><a name="PopupWidget.modal"></a>bool <u>modal</u>();
</big></dt>
<dd>returns <b>true</b> if popup is <u>modal</u><br><br>
</dd>
<dt><big><a name="PopupWidget.modal"></a>PopupWidget <u>modal</u>(bool <u>modal</u>);
</big></dt>
<dd>set modality flag<br><br>
</dd>
<dt><big><a name="PopupWidget.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="PopupWidget.close"></a>void <u>close</u>();
</big></dt>
<dd><u>close</u> and destroy popup<br><br>
</dd>
<dt><big><a name="PopupWidget.onClose"></a>void <u>onClose</u>();
</big></dt>
<dd>just call on close listener<br><br>
</dd>
<dt><big><a name="PopupWidget.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="PopupWidget.onMouseEventOutside"></a>bool <u>onMouseEventOutside</u>(MouseEvent <i>event</i>);
</big></dt>
<dd>called for mouse activity outside shown popup bounds<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>