mirror of https://github.com/buggins/dlangui.git
634 lines
16 KiB
HTML
634 lines
16 KiB
HTML
|
|
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="UTF-8"/><!-- using block title in layout.dt--><!-- using block ddox.defs in ddox.layout.dt--><!-- using block ddox.title in ddox.layout.dt-->
|
|
<title>API documentation</title>
|
|
<link rel="stylesheet" type="text/css" href="./styles/ddox.css"/>
|
|
<link rel="stylesheet" href="./prettify/prettify.css" type="text/css"/>
|
|
<script type="text/javascript" src="./scripts/jquery.js">/**/</script>
|
|
<script type="text/javascript" src="./prettify/prettify.js">/**/</script>
|
|
<script type="text/javascript" src="./scripts/ddox.js">/**/</script>
|
|
</head>
|
|
<body onload="prettyPrint(); setupDdox();">
|
|
<nav id="main-nav"><!-- using block navigation in layout.dt-->
|
|
<ul class="tree-view">
|
|
<li class=" tree-view">
|
|
<a href="#" class="package">dlangui</a>
|
|
<ul class="tree-view">
|
|
<li class="collapsed tree-view">
|
|
<a href="#" class="package">core</a>
|
|
<ul class="tree-view">
|
|
<li>
|
|
<a href="./dlangui/core/collections.html" class=" module">collections</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/core/events.html" class=" module">events</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/core/files.html" class=" module">files</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/core/i18n.html" class=" module">i18n</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/core/linestream.html" class=" module">linestream</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/core/logger.html" class=" module">logger</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/core/signals.html" class=" module">signals</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/core/stdaction.html" class=" module">stdaction</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/core/types.html" class=" module">types</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="collapsed tree-view">
|
|
<a href="#" class="package">dialogs</a>
|
|
<ul class="tree-view">
|
|
<li>
|
|
<a href="./dlangui/dialogs/dialog.html" class=" module">dialog</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/dialogs/filedlg.html" class=" module">filedlg</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/dialogs/msgbox.html" class=" module">msgbox</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="collapsed tree-view">
|
|
<a href="#" class="package">graphics</a>
|
|
<ul class="tree-view">
|
|
<li>
|
|
<a href="./dlangui/graphics/colors.html" class=" module">colors</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/graphics/drawbuf.html" class=" module">drawbuf</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/graphics/fonts.html" class=" module">fonts</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/graphics/ftfonts.html" class=" module">ftfonts</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/graphics/gldrawbuf.html" class=" module">gldrawbuf</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/graphics/glsupport.html" class=" module">glsupport</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/graphics/images.html" class=" module">images</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/graphics/resources.html" class=" module">resources</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="collapsed tree-view">
|
|
<a href="#" class="package">platforms</a>
|
|
<ul class="tree-view">
|
|
<li class="collapsed tree-view">
|
|
<a href="#" class="package">common</a>
|
|
<ul class="tree-view">
|
|
<li>
|
|
<a href="./dlangui/platforms/common/platform.html" class=" module">platform</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="collapsed tree-view">
|
|
<a href="#" class="package">sdl</a>
|
|
<ul class="tree-view">
|
|
<li>
|
|
<a href="./dlangui/platforms/sdl/sdlapp.html" class=" module">sdlapp</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="collapsed tree-view">
|
|
<a href="#" class="package">windows</a>
|
|
<ul class="tree-view">
|
|
<li>
|
|
<a href="./dlangui/platforms/windows/win32drawbuf.html" class=" module">win32drawbuf</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/platforms/windows/win32fonts.html" class=" module">win32fonts</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/platforms/windows/winapp.html" class=" module">winapp</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="collapsed tree-view">
|
|
<a href="#" class="package">widgets</a>
|
|
<ul class="tree-view">
|
|
<li>
|
|
<a href="./dlangui/widgets/appframe.html" class=" module">appframe</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/widgets/combobox.html" class=" module">combobox</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/widgets/controls.html" class=" module">controls</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/widgets/docks.html" class=" module">docks</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/widgets/editors.html" class=" module">editors</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/widgets/grid.html" class=" module">grid</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/widgets/layouts.html" class=" module">layouts</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/widgets/lists.html" class=" module">lists</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/widgets/menu.html" class=" module">menu</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/widgets/popup.html" class=" module">popup</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/widgets/scroll.html" class=" module">scroll</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/widgets/srcedit.html" class=" module">srcedit</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/widgets/statusline.html" class=" module">statusline</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/widgets/styles.html" class=" module">styles</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/widgets/tabs.html" class=" module">tabs</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/widgets/toolbars.html" class=" module">toolbars</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/widgets/tree.html" class=" module">tree</a>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/widgets/widget.html" class=" module">widget</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href="./dlangui/all.html" class=" module">all</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<noscript>
|
|
<p style="color: red">The search functionality needs JavaScript enabled</p>
|
|
</noscript>
|
|
<div id="symbolSearchPane" style="display: none">
|
|
<p>
|
|
<input id="symbolSearch" type="text" placeholder="Search for symbols" onchange="performSymbolSearch(24);" onkeypress="this.onchange();" onpaste="this.onchange();" oninput="this.onchange();"/>
|
|
</p>
|
|
<ul id="symbolSearchResults" style="display: none"></ul>
|
|
<script type="application/javascript" src="./symbols.js"></script>
|
|
<script type="application/javascript">
|
|
var symbolSearchRootDir = "./";
|
|
$('#symbolSearchPane').show();
|
|
</script>
|
|
</div>
|
|
<script type="text/javascript" src="./scripts/mousetrap.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() {
|
|
Mousetrap.bind('s', function(e) {
|
|
$("#symbolSearch").focus();
|
|
return false;
|
|
});
|
|
});
|
|
</script>
|
|
</nav>
|
|
<div id="main-contents">
|
|
<h1>API documentation</h1><!-- using block body in layout.dt--><!-- Default block ddox.description in ddox.layout.dt--><!-- Default block ddox.sections in ddox.layout.dt--><!-- using block ddox.members in ddox.layout.dt-->
|
|
<table>
|
|
<col class="caption"/>
|
|
<tr>
|
|
<th>Module</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/core/collections.html">dlangui.core.collections</a>
|
|
</td>
|
|
<td>
|
|
This module implements object collection.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/core/events.html">dlangui.core.events</a>
|
|
</td>
|
|
<td>
|
|
This module contains dlangui event types declarations.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/core/files.html">dlangui.core.files</a>
|
|
</td>
|
|
<td>
|
|
This module contains cross-platform file access utilities
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/core/i18n.html">dlangui.core.i18n</a>
|
|
</td>
|
|
<td>
|
|
This module contains UI internationalization support implementation.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/core/linestream.html">dlangui.core.linestream</a>
|
|
</td>
|
|
<td>
|
|
This module contains text stream reader implementation
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/core/logger.html">dlangui.core.logger</a>
|
|
</td>
|
|
<td>
|
|
This module provides logging utilities.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/core/signals.html">dlangui.core.signals</a>
|
|
</td>
|
|
<td>
|
|
This module contains definition of signals / listeners.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/core/stdaction.html">dlangui.core.stdaction</a>
|
|
</td>
|
|
<td>
|
|
Definition of standard actions commonly used in dialogs and controls.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/core/types.html">dlangui.core.types</a>
|
|
</td>
|
|
<td>
|
|
This module declares basic data types for usage in dlangui library.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/dialogs/dialog.html">dlangui.dialogs.dialog</a>
|
|
</td>
|
|
<td>
|
|
This module contains common <a href="./dlangui/dialogs/dialog/Dialog.html"><code class="prettyprint lang-d">Dialog</code></a> implementation.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/dialogs/filedlg.html">dlangui.dialogs.filedlg</a>
|
|
</td>
|
|
<td>
|
|
This module contains <a href="./dlangui/dialogs/filedlg/FileDialog.html"><code class="prettyprint lang-d">FileDialog</code></a> implementation.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/dialogs/msgbox.html">dlangui.dialogs.msgbox</a>
|
|
</td>
|
|
<td>
|
|
This module contains common Dialog implementation.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/graphics/colors.html">dlangui.graphics.colors</a>
|
|
</td>
|
|
<td>
|
|
This module contains declaration of useful color related operations.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/graphics/drawbuf.html">dlangui.graphics.drawbuf</a>
|
|
</td>
|
|
<td>
|
|
This module contains drawing buffer implementation.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/graphics/fonts.html">dlangui.graphics.fonts</a>
|
|
</td>
|
|
<td>
|
|
This module contains base fonts access interface and common implementation.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/graphics/ftfonts.html">dlangui.graphics.ftfonts</a>
|
|
</td>
|
|
<td>
|
|
This file contains FontManager implementation based on FreeType library.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/graphics/gldrawbuf.html">dlangui.graphics.gldrawbuf</a>
|
|
</td>
|
|
<td>
|
|
This module contains opengl based drawing buffer implementation.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/graphics/glsupport.html">dlangui.graphics.glsupport</a>
|
|
</td>
|
|
<td>
|
|
This module contains OpenGL access layer.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/graphics/images.html">dlangui.graphics.images</a>
|
|
</td>
|
|
<td>
|
|
This module contains image loading functions.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/graphics/resources.html">dlangui.graphics.resources</a>
|
|
</td>
|
|
<td>
|
|
This module contains resource management and drawables implementation.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/platforms/common/platform.html">dlangui.platforms.common.platform</a>
|
|
</td>
|
|
<td>
|
|
This module contains common Plaform definitions.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/platforms/sdl/sdlapp.html">dlangui.platforms.sdl.sdlapp</a>
|
|
</td>
|
|
<td>
|
|
This module contains implementation of SDL2 based backend for dlang library.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/platforms/windows/win32drawbuf.html">dlangui.platforms.windows.win32drawbuf</a>
|
|
</td>
|
|
<td>
|
|
This module contains drawing buffer implementation for Win32 platform
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/platforms/windows/win32fonts.html">dlangui.platforms.windows.win32fonts</a>
|
|
</td>
|
|
<td>
|
|
This module contains implementation of Win32 fonts support
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/platforms/windows/winapp.html">dlangui.platforms.windows.winapp</a>
|
|
</td>
|
|
<td>
|
|
This module contains implementation of Win32 platform support
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/widgets/appframe.html">dlangui.widgets.appframe</a>
|
|
</td>
|
|
<td>
|
|
This module contains definition for main widget for usual application - with menu and status bar.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/widgets/combobox.html">dlangui.widgets.combobox</a>
|
|
</td>
|
|
<td>
|
|
This module contains Combo Box widgets implementation.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/widgets/controls.html">dlangui.widgets.controls</a>
|
|
</td>
|
|
<td>
|
|
This module contains simple controls widgets implementation.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/widgets/docks.html">dlangui.widgets.docks</a>
|
|
</td>
|
|
<td>
|
|
This module implements dockable windows UI support.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/widgets/editors.html">dlangui.widgets.editors</a>
|
|
</td>
|
|
<td>
|
|
This module contains implementation of editors.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/widgets/grid.html">dlangui.widgets.grid</a>
|
|
</td>
|
|
<td>
|
|
This module contains implementation of grid widgets
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/widgets/layouts.html">dlangui.widgets.layouts</a>
|
|
</td>
|
|
<td>
|
|
This module contains common layouts implementations.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/widgets/lists.html">dlangui.widgets.lists</a>
|
|
</td>
|
|
<td>
|
|
This module contains list widgets implementation.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/widgets/menu.html">dlangui.widgets.menu</a>
|
|
</td>
|
|
<td>
|
|
This module contains menu widgets implementation.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/widgets/popup.html">dlangui.widgets.popup</a>
|
|
</td>
|
|
<td>
|
|
This module contains popup widgets implementation.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/widgets/scroll.html">dlangui.widgets.scroll</a>
|
|
</td>
|
|
<td>
|
|
This module contains base implementation of scrolling capabilities for widgets
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/widgets/srcedit.html">dlangui.widgets.srcedit</a>
|
|
</td>
|
|
<td>
|
|
This module contains implementation of source code editor widget.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/widgets/statusline.html">dlangui.widgets.statusline</a>
|
|
</td>
|
|
<td>
|
|
This module contains definition for status line control.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/widgets/styles.html">dlangui.widgets.styles</a>
|
|
</td>
|
|
<td>
|
|
This module contains declaration of themes and styles implementation.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/widgets/tabs.html">dlangui.widgets.tabs</a>
|
|
</td>
|
|
<td>
|
|
This module contains declaration of tabbed view controls.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/widgets/toolbars.html">dlangui.widgets.toolbars</a>
|
|
</td>
|
|
<td>
|
|
This module implements support of tool bars.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/widgets/tree.html">dlangui.widgets.tree</a>
|
|
</td>
|
|
<td>
|
|
This module contains tree widgets implementation
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/widgets/widget.html">dlangui.widgets.widget</a>
|
|
</td>
|
|
<td>
|
|
This module contains declaration of <a href="./dlangui/widgets/widget/Widget.html"><code class="prettyprint lang-d">Widget</code></a> class - base class for all widgets.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="./dlangui/all.html">dlangui.all</a>
|
|
</td>
|
|
<td>
|
|
This module is just to simplify import of most useful DLANGUI modules.
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<section>
|
|
<h2>Authors</h2><!-- Default block ddox.authors in ddox.layout.dt-->
|
|
</section>
|
|
<section>
|
|
<h2>Copyright</h2><!-- Default block ddox.copyright in ddox.layout.dt-->
|
|
</section>
|
|
<section>
|
|
<h2>License</h2><!-- Default block ddox.license in ddox.layout.dt-->
|
|
</section>
|
|
</div>
|
|
</body>
|
|
</html> |