dlangui/ddox/index.html

994 lines
24 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8"/>
<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="./scripts/ddox.js">/**/</script>
</head>
<body onload="setupDdox();">
<nav id="main-nav">
<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/asyncsocket.html" class=" module">asyncsocket</a>
</li>
<li>
<a href="./dlangui/core/collections.html" class=" module">collections</a>
</li>
<li>
<a href="./dlangui/core/config.html" class=" module">config</a>
</li>
<li>
<a href="./dlangui/core/css.html" class=" module">css</a>
</li>
<li>
<a href="./dlangui/core/cssparser.html" class=" module">cssparser</a>
</li>
<li>
<a href="./dlangui/core/dom.html" class=" module">dom</a>
</li>
<li>
<a href="./dlangui/core/editable.html" class=" module">editable</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/math3d.html" class=" module">math3d</a>
</li>
<li>
<a href="./dlangui/core/queue.html" class=" module">queue</a>
</li>
<li>
<a href="./dlangui/core/settings.html" class=" module">settings</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/streams.html" class=" module">streams</a>
</li>
<li>
<a href="./dlangui/core/textsource.html" class=" module">textsource</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/inputbox.html" class=" module">inputbox</a>
</li>
<li>
<a href="./dlangui/dialogs/msgbox.html" class=" module">msgbox</a>
</li>
<li>
<a href="./dlangui/dialogs/settingsdialog.html" class=" module">settingsdialog</a>
</li>
</ul>
</li>
<li class="collapsed tree-view">
<a href="#" class="package">dml</a>
<ul class="tree-view">
<li>
<a href="./dlangui/dml/annotations.html" class=" module">annotations</a>
</li>
<li>
<a href="./dlangui/dml/dmlhighlight.html" class=" module">dmlhighlight</a>
</li>
<li>
<a href="./dlangui/dml/parser.html" class=" module">parser</a>
</li>
</ul>
</li>
<li class="collapsed tree-view">
<a href="#" class="package">graphics</a>
<ul class="tree-view">
<li class="collapsed tree-view">
<a href="#" class="package">scene</a>
<ul class="tree-view">
<li>
<a href="./dlangui/graphics/scene/camera.html" class=" module">camera</a>
</li>
<li>
<a href="./dlangui/graphics/scene/material.html" class=" module">material</a>
</li>
<li>
<a href="./dlangui/graphics/scene/mesh.html" class=" module">mesh</a>
</li>
<li>
<a href="./dlangui/graphics/scene/node.html" class=" module">node</a>
</li>
<li>
<a href="./dlangui/graphics/scene/scene3d.html" class=" module">scene3d</a>
</li>
<li>
<a href="./dlangui/graphics/scene/transform.html" class=" module">transform</a>
</li>
</ul>
</li>
<li class="collapsed tree-view">
<a href="#" class="package">xpm</a>
<ul class="tree-view">
<li>
<a href="./dlangui/graphics/xpm/colors.html" class=" module">colors</a>
</li>
<li>
<a href="./dlangui/graphics/xpm/reader.html" class=" module">reader</a>
</li>
</ul>
</li>
<li>
<a href="./dlangui/graphics/colors.html" class=" module">colors</a>
</li>
<li>
<a href="./dlangui/graphics/domrender.html" class=" module">domrender</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>
<li>
<a href="./dlangui/platforms/common/startup.html" class=" module">startup</a>
</li>
</ul>
</li>
<li class="collapsed tree-view">
<a href="#" class="package">dsfml</a>
<ul class="tree-view">
<li>
<a href="./dlangui/platforms/dsfml/dsfmlapp.html" class=" module">dsfmlapp</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>
<li class="collapsed tree-view">
<a href="#" class="package">x11</a>
<ul class="tree-view">
<li>
<a href="./dlangui/platforms/x11/x11app.html" class=" module">x11app</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/metadata.html" class=" module">metadata</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>
<li>
<a href="./dlangui/widgets/winframe.html" class=" module">winframe</a>
</li>
</ul>
</li>
</ul>
</li>
<li>
<a href="./dlangui.html" class=" module">dlangui</a>
</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>
<table>
<col class="caption"/>
<tr>
<th>Module</th>
<th>Description</th>
</tr>
<tr>
<td>
<a href="./dlangui/core/asyncsocket.html">dlangui.core.asyncsocket</a>
</td>
<td>
</td>
</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/config.html">dlangui.core.config</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
<a href="./dlangui/core/css.html">dlangui.core.css</a>
</td>
<td>
This module contains implementation of CSS support - Cascading Style Sheets.
</td>
</tr>
<tr>
<td>
<a href="./dlangui/core/cssparser.html">dlangui.core.cssparser</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
<a href="./dlangui/core/dom.html">dlangui.core.dom</a>
</td>
<td>
This module contains implementation DOM - document object model.
</td>
</tr>
<tr>
<td>
<a href="./dlangui/core/editable.html">dlangui.core.editable</a>
</td>
<td>
This module contains implementation of editable text content.
</td>
</tr>
<tr>
<td>
<a href="./dlangui/core/events.html">dlangui.core.events</a>
</td>
<td>
This module contains <a href="./dlangui.html"><code class="lang-d"><span class="pln">dlangui</span></code></a> 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/math3d.html">dlangui.core.math3d</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
<a href="./dlangui/core/queue.html">dlangui.core.queue</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
<a href="./dlangui/core/settings.html">dlangui.core.settings</a>
</td>
<td>
This module contains implementation of settings container.
</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/streams.html">dlangui.core.streams</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
<a href="./dlangui/core/textsource.html">dlangui.core.textsource</a>
</td>
<td>
</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 <a href="./dlangui.html"><code class="lang-d"><span class="pln">dlangui</span></code></a> 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="lang-d"><span class="typ">Dialog</span></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="lang-d"><span class="typ">FileDialog</span></code></a> implementation.
</td>
</tr>
<tr>
<td>
<a href="./dlangui/dialogs/inputbox.html">dlangui.dialogs.inputbox</a>
</td>
<td>
</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/dialogs/settingsdialog.html">dlangui.dialogs.settingsdialog</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
<a href="./dlangui/dml/annotations.html">dlangui.dml.annotations</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
<a href="./dlangui/dml/dmlhighlight.html">dlangui.dml.dmlhighlight</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
<a href="./dlangui/dml/parser.html">dlangui.dml.parser</a>
</td>
<td>
This module is DML (DlangUI Markup Language) parser - similar to QML in QtQuick
</td>
</tr>
<tr>
<td>
<a href="./dlangui/graphics/scene/camera.html">dlangui.graphics.scene.camera</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
<a href="./dlangui/graphics/scene/material.html">dlangui.graphics.scene.material</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
<a href="./dlangui/graphics/scene/mesh.html">dlangui.graphics.scene.mesh</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
<a href="./dlangui/graphics/scene/node.html">dlangui.graphics.scene.node</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
<a href="./dlangui/graphics/scene/scene3d.html">dlangui.graphics.scene.scene3d</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
<a href="./dlangui/graphics/scene/transform.html">dlangui.graphics.scene.transform</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
<a href="./dlangui/graphics/xpm/colors.html">dlangui.graphics.xpm.colors</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
<a href="./dlangui/graphics/xpm/reader.html">dlangui.graphics.xpm.reader</a>
</td>
<td>
</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/domrender.html">dlangui.graphics.domrender</a>
</td>
<td>
This module contains implementation of DOM rendering.
</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/common/startup.html">dlangui.platforms.common.startup</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
<a href="./dlangui/platforms/dsfml/dsfmlapp.html">dlangui.platforms.dsfml.dsfmlapp</a>
</td>
<td>
</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/platforms/x11/x11app.html">dlangui.platforms.x11.x11app</a>
</td>
<td>
</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/metadata.html">dlangui.widgets.metadata</a>
</td>
<td>
</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="lang-d"><span class="typ">Widget</span></code></a> class - base class for all widgets.
</td>
</tr>
<tr>
<td>
<a href="./dlangui/widgets/winframe.html">dlangui.widgets.winframe</a>
</td>
<td>
This module implements window frame widget.
</td>
</tr>
<tr>
<td>
<a href="./dlangui.html">dlangui</a>
</td>
<td>
This module is just to simplify import of most useful DLANGUI modules.
</td>
</tr>
</table>
<section>
<h2>Authors</h2>
</section>
<section>
<h2>Copyright</h2>
</section>
<section>
<h2>License</h2>
</section>
</div>
</body>
</html>