forks
/
dlangui
mirror of https://github.com/buggins/dlangui.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
dlangui/platform.html

291 lines
11 KiB
HTML
Raw Blame History

<!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.platforms.common.platform</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.platforms.common.platform</h1>
<!-- Generated by Ddoc from src\dlangui\platforms\common\platform.d -->
This module contains common Plaform definitions.
<br><br>
Platform is abstraction layer for application.
<br><br>
<br><br>
<b>Synopsis:</b><br>
<pre class="d_code"><font color=blue>import</font> dlangui.platforms.common.<u>platform</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="WindowFlag"></a>enum <u>WindowFlag</u>: uint;
</big></dt>
<dd>window creation flags<br><br>
<dl><dt><big><a name="WindowFlag.Resizable"></a><u>Resizable</u></big></dt>
<dd>window can be resized<br><br>
</dd>
<dt><big><a name="WindowFlag.Fullscreen"></a><u>Fullscreen</u></big></dt>
<dd>window should be shown in fullscreen mode<br><br>
</dd>
<dt><big><a name="WindowFlag.Modal"></a><u>Modal</u></big></dt>
<dd>modal window - grabs input focus<br><br>
</dd>
</dl>
</dd>
<dt><big><a name="Window"></a>abstract class <u>Window</u>;
</big></dt>
<dd><u>Window</u> abstraction layer. Widgets can be shown only inside window.
<br><br>
<dl><dt><big><a name="Window.windowCaption"></a>abstract @property dstring <u>windowCaption</u>();
</big></dt>
<dd>returns window caption<br><br>
</dd>
<dt><big><a name="Window.windowCaption"></a>abstract @property void <u>windowCaption</u>(dstring <i>caption</i>);
</big></dt>
<dd>sets window <i>caption</i><br><br>
</dd>
<dt><big><a name="Window.windowIcon"></a>abstract @property void <u>windowIcon</u>(DrawBufRef <i>icon</i>);
</big></dt>
<dd>sets window <i>icon</i><br><br>
</dd>
<dt><big><a name="Window.requestLayout"></a>void <u>requestLayout</u>();
</big></dt>
<dd>requests layout for main widget and popups<br><br>
</dd>
<dt><big><a name="Window.showPopup"></a>PopupWidget <u>showPopup</u>(Widget <i>content</i>, Widget <i>anchor</i> = null, uint <i>alignment</i> = PopupAlign.Center, int <i>x</i> = 0, int <i>y</i> = 0);
</big></dt>
<dd>show new popup<br><br>
</dd>
<dt><big><a name="Window.removePopup"></a>bool <u>removePopup</u>(PopupWidget <i>popup</i>);
</big></dt>
<dd>remove <i>popup</i><br><br>
</dd>
<dt><big><a name="Window.isChild"></a>bool <u>isChild</u>(Widget <i>w</i>);
</big></dt>
<dd>returns <b>true</b> if widget is child of either main widget or one of popups<br><br>
</dd>
<dt><big><a name="Window.scheduleAnimation"></a>void <u>scheduleAnimation</u>();
</big></dt>
<dd>after drawing, call to schedule redraw if animation is active<br><br>
</dd>
<dt><big><a name="Window.focusedWidget"></a>@property Widget <u>focusedWidget</u>();
</big></dt>
<dd>returns current focused widget<br><br>
</dd>
<dt><big><a name="Window.setFocus"></a>Widget <u>setFocus</u>(Widget <i>newFocus</i>);
</big></dt>
<dd>change focus to widget<br><br>
</dd>
<dt><big><a name="Window.dispatchKeyEvent"></a>bool <u>dispatchKeyEvent</u>(KeyEvent <i>event</i>);
</big></dt>
<dd>dispatch keyboard <i>event</i><br><br>
</dd>
<dt><big><a name="Window._mouseTrackingWidgets"></a>protected Widget[] <u>_mouseTrackingWidgets</u>;
</big></dt>
<dd>widget which tracks Move events<br><br>
</dd>
<dt><big><a name="Window._mouseCaptureWidget"></a>protected Widget <u>_mouseCaptureWidget</u>;
</big></dt>
<dd>widget which tracks all events after processed ButtonDown<br><br>
</dd>
<dt><big><a name="Window._mouseCaptureFocusedOutTrackMovements"></a>protected bool <u>_mouseCaptureFocusedOutTrackMovements</u>;
</big></dt>
<dd>does current capture widget want to receive move events even if pointer left it<br><br>
</dd>
<dt><big><a name="Window.isMouseCaptured"></a>bool <u>isMouseCaptured</u>();
</big></dt>
<dd>returns <b>true</b> if mouse is currently captured<br><br>
</dd>
<dt><big><a name="Window.dispatchMouseEvent"></a>bool <u>dispatchMouseEvent</u>(MouseEvent <i>event</i>);
</big></dt>
<dd>dispatch mouse <i>event</i> to window content widgets<br><br>
</dd>
<dt><big><a name="Window.checkUpdateNeeded"></a>protected void <u>checkUpdateNeeded</u>(Widget <i>root</i>, ref bool <i>needDraw</i>, ref bool <i>needLayout</i>, ref bool <i>animationActive</i>);
</big></dt>
<dd>checks content widgets for necessary redraw and/or layout<br><br>
</dd>
<dt><big><a name="Window.setCursorType"></a>protected void <u>setCursorType</u>(uint <i>cursorType</i>);
</big></dt>
<dd>sets cursor type for window<br><br>
</dd>
<dt><big><a name="Window.checkUpdateNeeded"></a>bool <u>checkUpdateNeeded</u>(ref bool <i>needDraw</i>, ref bool <i>needLayout</i>, ref bool <i>animationActive</i>);
</big></dt>
<dd>checks content widgets for necessary redraw and/or layout<br><br>
</dd>
<dt><big><a name="Window.update"></a>void <u>update</u>(bool <i>force</i> = false);
</big></dt>
<dd>requests <u>update</u> for window (unless <i>force</i> is <b>true</b>, <u>update</u> will be performed only if layout, redraw or animation is required).<br><br>
</dd>
<dt><big><a name="Window.invalidate"></a>abstract void <u>invalidate</u>();
</big></dt>
<dd>request window redraw<br><br>
</dd>
<dt><big><a name="Window.close"></a>abstract void <u>close</u>();
</big></dt>
<dd><u>close</u> window<br><br>
</dd>
</dl>
</dd>
<dt><big><a name="Platform"></a>abstract class <u>Platform</u>;
</big></dt>
<dd><u>Platform</u> abstraction layer.
<br><br>
Represents application.<br><br>
<dl><dt><big><a name="Platform.createWindow"></a>abstract Window <u>createWindow</u>(dstring <i>windowCaption</i>, Window <i>parent</i>, uint <i>flags</i> = WindowFlag.Resizable);
</big></dt>
<dd>create window
<br><br>
<b>Args:</b><br>
<i>windowCaption</i> = window caption text
<i>parent</i> = <i>parent</i> Window, or <b>null</b> if no <i>parent</i>
<i>flags</i> = WindowFlag bit set, combination of Resizable, Modal, Fullscreen
<br><br>
Window w/o Resizable nor Fullscreen will be created with size based on measurement of its content widget<br><br>
</dd>
<dt><big><a name="Platform.closeWindow"></a>abstract void <u>closeWindow</u>(Window <i>w</i>);
</big></dt>
<dd>close window
<br><br>
Closes window earlier created with createWindow()<br><br>
</dd>
<dt><big><a name="Platform.enterMessageLoop"></a>abstract int <u>enterMessageLoop</u>();
</big></dt>
<dd>Starts application message loop.
<br><br>
When returned from this method, application is shutting down.<br><br>
</dd>
<dt><big><a name="Platform.getClipboardText"></a>abstract dstring <u>getClipboardText</u>(bool <i>mouseBuffer</i> = false);
</big></dt>
<dd>retrieves text from clipboard (when <i>mouseBuffer</i> == <b>true</b>, use mouse selection clipboard - under linux)<br><br>
</dd>
<dt><big><a name="Platform.setClipboardText"></a>abstract void <u>setClipboardText</u>(dstring <i>text</i>, bool <i>mouseBuffer</i> = false);
</big></dt>
<dd>sets <i>text</i> to clipboard (when <i>mouseBuffer</i> == <b>true</b>, use mouse selection clipboard - under linux)<br><br>
</dd>
<dt><big><a name="Platform.requestLayout"></a>abstract void <u>requestLayout</u>();
</big></dt>
<dd>calls request layout for all windows<br><br>
</dd>
<dt><big><a name="Platform.uiLanguage"></a>@property string <u>uiLanguage</u>();
</big></dt>
<dd>returns currently selected UI language code<br><br>
</dd>
<dt><big><a name="Platform.uiLanguage"></a>@property Platform <u>uiLanguage</u>(string <i>langCode</i>);
</big></dt>
<dd>set UI language (e.g. "en", "fr", "ru") - will relayout content of all windows if language has been changed<br><br>
</dd>
<dt><big><a name="Platform.uiTheme"></a>@property Platform <u>uiTheme</u>(string <i>themeResourceId</i>);
</big></dt>
<dd>sets application UI theme - will relayout content of all windows if theme has been changed<br><br>
</dd>
<dt><big><a name="Platform.resourceDirs"></a>@property string[] <u>resourceDirs</u>();
</big></dt>
<dd>returns list of resource directories<br><br>
</dd>
<dt><big><a name="Platform.resourceDirs"></a>@property Platform <u>resourceDirs</u>(string[] <i>dirs</i>);
</big></dt>
<dd>set list of directories to load resources from<br><br>
</dd>
</dl>
</dd>
<dt><big><a name="platform"></a>@property Platform <u>platform</u>();
</big></dt>
<dd>get current <u>platform</u> object instance<br><br>
</dd>
<dt><big><a name="APP_ENTRY_POINT"></a>template <u>APP_ENTRY_POINT</u>()</big></dt>
<dd>put "mixin <u>APP_ENTRY_POINT</u>;" to main module of your dlangui based app<br><br>
<dl><dt><big><a name="APP_ENTRY_POINT.WinMain"></a>int <u>WinMain</u>(void* <i>hInstance</i>, void* <i>hPrevInstance</i>, char* <i>lpCmdLine</i>, int <i>nCmdShow</i>);
</big></dt>
<dd>workaround for link issue when <u>WinMain</u> is located in library<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>
Reference in New Issue View Git Blame Copy Permalink