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

improve ddoc generation

This commit is contained in:
Vadim Lopatin 2014-05-22 14:14:55 +04:00
parent d4cf9722f3
commit 2b45ea504c
36 changed files with 365 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored
View File

@ -1,6 +1,7 @@
Debug
Release
Unittest
docs
ui.log
obj
*.suo
@ -8,3 +9,4 @@ Thumbs.db
.dub
bin
*.obj
*.~*

4
dlangui-monod-lib.dproj
View File

@ -45,6 +45,8 @@
<String>USE_OPENGL</String>
</VersionIds>
</VersionIds>
<ExtraCompilerArguments>project.ddoc -c -Dddocs</ExtraCompilerArguments>
<DDocDirectory>docs</DDocDirectory>
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
<OutputPath>bin\Release</OutputPath>
@ -97,5 +99,7 @@
<Compile Include="src\dlangui\core\stdaction.d" />
<Compile Include="src\dlangui\dialogs\dialog.d" />
<Compile Include="src\dlangui\dialogs\filedlg.d" />
<Compile Include="src\index.d" />
<Compile Include="src\api.d" />
</ItemGroup>
</Project>

4
dub.json
View File

@ -22,6 +22,10 @@
"targetPath": "lib",
"targetType": "staticLibrary",
"sourceFiles": [
"project.ddoc"
],
"sourceFiles-windows": [
"3rdparty/win32/basetsd.d",
"3rdparty/win32/basetyps.d",

15
examples/example1/src/main.d
View File

@ -1,3 +1,18 @@
// Written in the D programming language.
/**
This app is a demo for most of DlangUI library features.
Synopsis:
----
dub run dlangui:example1
----
Copyright: Vadim Lopatin, 2014
License: Boost License 1.0
Authors: Vadim Lopatin, coolreader.org@gmail.com
*/
module main;
import dlangui.all;

94
project.ddoc Normal file
View File

@ -0,0 +1,94 @@
PROJECT = dlangui
DDOC = <!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 - $(TITLE)</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="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>$(TITLE)</h1>
$(BODY)
</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>
MODULE_TREE = <ul>
<li>dlangui.core</li>
<ul>
<li><a href="types.html">types</a></li>
<li><a href="events.html">events</a></li>
<li><a href="i18n.html">i18n</a></li>
<li><a href="logger.html">logger</a></li>
<li><a href="signals.html">signals</a></li>
<li><a href="stdaction.html">stdaction</a></li>
<li><a href="collections.html">collections</a></li>
<li><a href="linestream.html">linestream</a></li>
</ul>
<li>dlangui.graphics</li>
<ul>
<li><a href="drawbuf.html">drawbuf</a></li>
<li><a href="fonts.html">fonts</a></li>
<li><a href="images.html">images</a></li>
<li><a href="resources.html">resources</a></li>
<li><a href="ftfonts.html">ftfonts</a></li>
<li><a href="gldrawbuf.html">gldrawbuf</a></li>
<li><a href="glsupport.html">glsupport</a></li>
</ul>
<li>dlangui.widgets</li>
<ul>
<li><a href="widget.html">widget</a></li>
<li><a href="styles.html">styles</a></li>
<li><a href="controls.html">controls</a></li>
<li><a href="layouts.html">layouts</a></li>
<li><a href="lists.html">lists</a></li>
<li><a href="editors.html">editors</a></li>
<li><a href="menu.html">menu</a></li>
<li><a href="popup.html">popup</a></li>
<li><a href="tabs.html">tabs</a></li>
</ul>
<li>dlangui.dialogs</li>
<ul>
<li><a href="dialog.html">dialog</a></li>
<li><a href="filedlg.html">filedlg</a></li>
</ul>
<li>dlangui.platforms.common</li>
<ul>
<li><a href="platform.html">platform</a></li>
</ul>
<li>dlangui</li>
<ul>
<li><a href="all.html">all</a></li>
</ul>

10
src/api.d Normal file
View File

@ -0,0 +1,10 @@
Ddoc
<h1>
<a name="dlang-ui" class="anchor" href="#dlang-ui"><span class="octicon octicon-link"></span></a>Dlang UI API reference</h1>
<h2>By Modules</h2>
$(MODULE_TREE)

11
src/dlangui/all.d
View File

@ -1,8 +1,6 @@
// Written in the D programming language.
/**
DLANGUI library.
This module is just to simplify import of most useful DLANGUI modules.
Synopsis:
@ -23,12 +21,11 @@ extern (C) int UIAppMain(string[] args) {
];
// setup resource directories - will use only existing directories
drawableCache.setResourcePaths(resourceDirs);
// setup i18n - look for i18n directory inside one of passed directories
i18n.findTranslationsDir(resourceDirs);
Platform.instance.resourceDirs = resourceDirs;
// select translation file - for english language
i18n.load("en.ini"); //"ru.ini", "en.ini"
Platform.instance.uiLanguage = "en";
// load theme from file "theme_default.xml"
Platform.instance.uiTheme = "theme_default";
// create window
Window window = Platform.instance.createWindow("My Window", null);

2
src/dlangui/core/collections.d
View File

@ -1,8 +1,6 @@
// Written in the D programming language.
/**
DLANGUI library.
This module implements array based collection.
Synopsis:

2
src/dlangui/core/events.d
View File

@ -1,8 +1,6 @@
// Written in the D programming language.
/**
DLANGUI library.
This module contains dlangui event types declarations.

2
src/dlangui/core/i18n.d
View File

@ -1,8 +1,6 @@
// Written in the D programming language.
/**
DLANGUI library.
This module contains internationalization support implementation.
Translation files contain of simple key=value pair lines.

2
src/dlangui/core/linestream.d
View File

@ -1,8 +1,6 @@
// Written in the D programming language.
/**
DLANGUI library.
This module contains text file reader implementation.
Support utf8, utf16, utf32 be and le encodings, and line endings - according to D language source file specification.

2
src/dlangui/core/logger.d
View File

@ -1,8 +1,6 @@
// Written in the D programming language.
/**
DLANGUI library.
This module contains logger implementation.

2
src/dlangui/core/signals.d
View File

@ -1,8 +1,6 @@
// Written in the D programming language.
/**
DLANGUI library.
This module contains definition of signals / listeners.
Similar to std.signals.

2
src/dlangui/core/stdaction.d
View File

@ -1,8 +1,6 @@
// Written in the D programming language.
/**
DLANGUI library.
Definition of standard actions commonly used in dialogs and controls.
Synopsis:

2
src/dlangui/core/types.d
View File

@ -1,8 +1,6 @@
// Written in the D programming language.
/**
DLANGUI library.
This module declares basic data types for usage in dlangui library.
Synopsis:

2
src/dlangui/dialogs/dialog.d
View File

@ -1,8 +1,6 @@
// Written in the D programming language.
/**
DLANGUI library.
This module contains common Dialog implementation.

2
src/dlangui/dialogs/filedlg.d
View File

@ -1,8 +1,6 @@
// Written in the D programming language.
/**
DLANGUI library.
This module contains FileDialog implementation.
Can show dialog for open / save.

2
src/dlangui/graphics/drawbuf.d
View File

@ -1,8 +1,6 @@
// Written in the D programming language.
/**
DLANGUI library.
This module contains drawing buffer implementation.

2
src/dlangui/graphics/fonts.d
View File

@ -1,8 +1,6 @@
// Written in the D programming language.
/**
DLANGUI library.
This module contains base fonts access interface and common implementation.
Font - base class for fonts.

5
src/dlangui/graphics/ftfonts.d
View File

@ -1,13 +1,8 @@
// Written in the D programming language.
/**
DLANGUI library.
This file contains FontManager implementation based on FreeType library.
Copyright: Vadim Lopatin, 2014
License: Boost License 1.0
Authors: Vadim Lopatin, coolreader.org@gmail.com

2
src/dlangui/graphics/gldrawbuf.d
View File

@ -1,8 +1,6 @@
// Written in the D programming language.
/**
DLANGUI library.
This module contains opengl based drawing buffer implementation.
To enable OpenGL support, build with version(USE_OPENGL);

2
src/dlangui/graphics/glsupport.d
View File

@ -1,8 +1,6 @@
// Written in the D programming language.
/**
DLANGUI library.
This module contains OpenGL access layer.
To enable OpenGL support, build with version(USE_OPENGL);

2
src/dlangui/graphics/images.d
View File

@ -1,8 +1,6 @@
// Written in the D programming language.
/**
DLANGUI library.
This module contains image loading functions.
Currently uses FreeImage.

2
src/dlangui/graphics/resources.d
View File

@ -1,8 +1,6 @@
// Written in the D programming language.
/**
DLANGUI library.
This module contains resource management and drawables implementation.
imageCache is RAM cache of decoded images (as DrawBuf).

2
src/dlangui/platforms/common/platform.d
View File

@ -1,8 +1,6 @@
// Written in the D programming language.
/**
DLANGUI library.
This module contains common Plaform definitions.
Platform is abstraction layer for application.

2
src/dlangui/platforms/sdl/sdlapp.d
View File

@ -1,8 +1,6 @@
// Written in the D programming language.
/**
DLANGUI library.
This module contains implementation of SDL2 based backend for dlang library.

2
src/dlangui/widgets/controls.d
View File

@ -1,8 +1,6 @@
// Written in the D programming language.
/**
DLANGUI library.
This module contains simple controls widgets implementation.
TextWidget

2
src/dlangui/widgets/editors.d
View File

@ -1,8 +1,6 @@
// Written in the D programming language.
/**
DLANGUI library.
This module contains implementation of editors.

2
src/dlangui/widgets/layouts.d
View File

@ -1,8 +1,6 @@
// Written in the D programming language.
/**
DLANGUI library.
This module contains common layouts implementations.
Layouts are similar to the same in Android.

2
src/dlangui/widgets/lists.d
View File

@ -1,8 +1,6 @@
// Written in the D programming language.
/**
DLANGUI library.
This module contains list widgets implementation.
Similar to lists implementation in Android UI API.

2
src/dlangui/widgets/menu.d
View File

@ -1,8 +1,6 @@
// Written in the D programming language.
/**
DLANGUI library.
This module contains menu widgets implementation.
MenuItem - menu item properties container - to hold hierarchy of menu.

2
src/dlangui/widgets/popup.d
View File

@ -1,8 +1,6 @@
// Written in the D programming language.
/**
DLANGUI library.
This module contains popup widgets implementation.
Popups appear above other widgets inside window.

2
src/dlangui/widgets/styles.d
View File

@ -1,8 +1,6 @@
// Written in the D programming language.
/**
DLANGUI library.
This module contains declaration of themes and styles implementation.
Style - style container

2
src/dlangui/widgets/tabs.d
View File

@ -1,8 +1,6 @@
// Written in the D programming language.
/**
DLANGUI library.
This module contains declaration of tabbed view controls.
TabItemWidget - single tab header in tab control

2
src/dlangui/widgets/widget.d
View File

@ -1,8 +1,6 @@
// Written in the D programming language.
/**
DLANGUI library.
This module contains declaration of Widget class - base class for all widgets.
Widgets are styleable. Use styleId property to set style to use from current Theme.

232
src/index.d Normal file
View File

@ -0,0 +1,232 @@
Ddoc
<h1>
<a name="dlang-ui" class="anchor" href="#dlang-ui"><span class="octicon octicon-link"></span></a>Dlang UI</h1>
<p>GUI for D programming language, written in D.</p>
Alpha stage of development.
<ul>
<li>Crossplatform (Win32 and Linux are supported in current version); can use SDL2 as a backend.</li>
<li>Mostly inspired by Android UI API (layouts, styles, two phase layout, ...)</li>
<li>Supports highly customizable UI themes and styles</li>
<li>Supports internationalization</li>
<li>Hardware acceleration using OpenGL (when built with version USE_OPENGL)</li>
<li>Fallback to Win32 API / XCB when OpenGL is not available</li>
<li>Actually it's a port (with major refactoring) of GUI library for cross platform OpenGL based implementation of Cool Reader app project from C++.</li>
<li>Almost ready for 2D games development</li>
<li>Goal: provide set of widgets suitable for building of IDE.</li>
<li>Non thread safe</li>
</ul>
<h2><a name="widgets" class="anchor" href="#widgets"><span class="octicon octicon-link"></span></a>Widgets</h2>
<ul>
<li>Widget - base class for all widgets and widget containers, similar to Android's View</li>
</ul><p>Currently implemented widgets:</p>
<ul>
<li>TextWidget - simple static text (TODO: implement multiline formatting)</li>
<li>ImageWidget - static image</li>
<li>Button - simple button with text label</li>
<li>ImageButton - image only button</li>
<li>TextImageButton - button with icon and label</li>
<li>CheckBox - check button with label</li>
<li>RadioButton - radio button with label</li>
<li>EditLine - single line edit</li>
<li>EditBox - multiline editor</li>
<li>VSpacer - vertical spacer - just an empty widget with layoutHeight == FILL_PARENT, to fill vertical space in layouts</li>
<li>HSpacer - horizontal spacer - just an empty widget with layoutWidth == FILL_PARENT, to fill horizontal space in layouts</li>
<li>ScrollBar - scroll bar</li>
<li>TabControl - tabs widget, allows to select one of tabs</li>
<li>TabHost - container for pages controlled by TabControl</li>
<li>TabWidget - combination of TabControl and TabHost</li>
</ul>
<h2><a name="layouts" class="anchor" href="#layouts"><span class="octicon octicon-link"></span></a>Layouts</h2>
Similar to layouts in Android
<ul>
<li>LinearLayout - layout children horizontally or vertically depending on orientation</li>
<li>VerticalLayout - just a LinearLayout with vertical orientation</li>
<li>HorizontalLayout - just a LinearLayout with vertical orientation</li>
<li>FrameLayout - all children occupy the same place; usually onle one of them is visible</li>
<li>TableLayout - children are aligned into rows and columns of table</li>
</ul><h2>
<a name="list-views" class="anchor" href="#list-views"><span class="octicon octicon-link"></span></a>List Views</h2>
<p>Lists are implemented similar to Android UI API.</p>
<ul>
<li>ListWidget - layout dynamic items horizontally or vertically (one in row/column) with automatic scrollbar; can reuse widgets for similar items</li>
<li>ListAdapter - interface to provide data and widgets for ListWidget</li>
<li>WidgetListAdapter - simple implementation of ListAdapter interface - just a list of widgets (one per list item) to show</li>
</ul><p>TODOs:</p>
<ul>
<li>Multicolumn lists</li>
<li>Tree view</li>
</ul><h2>
<a name="resources" class="anchor" href="#resources"><span class="octicon octicon-link"></span></a>Resources</h2>
<p>Resources like fonts and images use reference counting. For proper resource freeing, always destroy widgets implicitly.</p>
<ul>
<li>FontManager: provides access to fonts</li>
<li>Images: .png or .jpg images; if filename ends with .9.png, it's autodetected as nine-patch image (see Android drawables description)</li>
<li>StateDrawables: .xml file can describe list of other drawables to choose based on widget's State (.xml files from android themes can be used directly)</li>
<li>imageCache allows to cache unpacked images</li>
<li>drawableCache provides access by resource id (string, usually filename w/o extension) to drawables located in specified list of resource directories.</li>
</ul><h2>
<a name="styles-and-themes" class="anchor" href="#styles-and-themes"><span class="octicon octicon-link"></span></a>Styles and Themes</h2>
<p>Styles and themes are a bit similar to ones in Android API.</p>
<ul>
<li>Theme is a container for styles. Can be load from XML theme resource file.</li>
<li>Styles are accessible in theme by string ID.</li>
<li>Styles can be nested to form hiararchy - when some attribute is missing in style, value from base style will be used.</li>
<li>State substyles are supported: allow to change widget appearance dynamically based on its state.</li>
<li>Widgets use style attributes directly from assigned style. When some attribute is being changed in widget, it creates its own copy of base style,
which allows to modify some of attributes, while getting base style attributes if they are not changed in widget. This trick can minimize memory usage for widget attributes when
standard values are used.</li>
</ul><h2>
<a name="win32-builds" class="anchor" href="#win32-builds"><span class="octicon octicon-link"></span></a>Win32 builds</h2>
<ul>
<li>Under windows, uses SDL2 or Win32 API as backend.</li>
<li>Optionally, may use OpenGL acceleration via DerelictGL3/WGL.</li>
<li>Uses Win32 API for font rendering.</li>
<li>Optinally can use FreeType for font rendering.</li>
</ul><p>Build and run using DUB:</p>
-----------------------
git clone https://github.com/buggins/dlangui.git
cd dlangui
dub run dlangui:example1
-----------------------
<p>To develop using Visual-D, download sources for dlabgui and dependencies into some directory:</p>
-----------------------
git clone https://github.com/buggins/dlangui.git
git clone https://github.com/DerelictOrg/DerelictUtil.git
git clone https://github.com/DerelictOrg/DerelictGL3.git
git clone https://github.com/DerelictOrg/DerelictFI.git
git clone https://github.com/DerelictOrg/DerelictFT.git
git clone https://github.com/DerelictOrg/DerelictSDL2.git
-----------------------
<p>Then open .sln using Visual D.</p>
<h2>
<a name="linux-builds" class="anchor" href="#linux-builds"><span class="octicon octicon-link"></span></a>Linux builds</h2>
<ul>
<li>Uses SDL2 or XCB as a backend (SDL2 is recommended, since has better support now).</li>
<li>Uses shared memory images for faster drawing.</li>
<li>Uses FreeType for font rendering.</li>
<li>TODO: Use FontConfig to get font list.</li>
<li>OpenGL is now working under SDL2 only.</li>
<li>Entering of unicode characters is now working under SDL2 only.</li>
</ul><p>For linux build with SDL2 backend, following libraries are required:</p>
-----------------------
libsdl2
-----------------------
<p>To build dlangui apps with XCB backend, development packages for following libraries required for XCB backend build:</p>
-----------------------
xcb, xcb-util, xcb-shm, xcb-image, xcb-keysyms, X11-xcb, X11
-----------------------
<p>E.g. in Ubuntu, you can use following command to enable SDL2 backend builds:</p>
-----------------------
sudo apt-get install libsdl2-dev
-----------------------
<p>or (for XCB backend)</p>
-----------------------
sudo apt-get install libxcb-image0-dev libxcb-shm0-dev libxcb-keysyms1-dev libfreeimage-dev
-----------------------
<p>In runtime, .so for following libraries are being loaded (binary packages required):</p>
-----------------------
freetype, opengl, freeimage
-----------------------
<p>Build and run on Linux using DUB:</p>
-----------------------
dub run dlangui:example1
-----------------------
<p>Development using Mono-D: </p>
<ul>
<li>open solution dlangui/dlanguimonod.sln </li>
<li>build and run project example1</li>
</ul><p>You need fresh version of MonoDevelop to use Mono-D. It can be installed from PPA repository.</p>
-----------------------
sudo add-apt-repository ppa:ermshiperete/monodevelop
sudo apt-get update
sudo apt-get install monodevelop-current
-----------------------
<h2>
<a name="other-platforms" class="anchor" href="#other-platforms"><span class="octicon octicon-link"></span></a>Other platforms</h2>
<ul>
<li>Other platforms support may be added easy</li>
</ul><h2>
<a name="third-party-components-used" class="anchor" href="#third-party-components-used"><span class="octicon octicon-link"></span></a>Third party components used</h2>
<ul>
<li>DerelictGL3 - for OpenGL support</li>
<li>DerelictFT + FreeType library support under linux and optionally under Windows.</li>
<li>DerelictFI + FreeImage library support for decoding of images</li>
<li>DerelictSDL2 + SDL2 for cross platform support</li>
<li>WindowsAPI bindings from <a href="http://www.dsource.org/projects/bindings/wiki/WindowsApi">http://www.dsource.org/projects/bindings/wiki/WindowsApi</a> (patched)</li>
<li>XCB and X11 bindings (patched) when SDL2 is not used; TODO: provide links</li>
</ul><h2>
<a name="hello-world" class="anchor" href="#hello-world"><span class="octicon octicon-link"></span></a>Hello World</h2>
------------------------------------------
// main.d
import dlangui.all;
mixin DLANGUI_ENTRY_POINT;
/// entry point for dlangui based application
extern (C) int UIAppMain(string[] args) {
// resource directory search paths
string[] resourceDirs = [
appendPath(exePath, "../res/"), // for Visual D and DUB builds
appendPath(exePath, "../../res/") // for Mono-D builds
];
// setup resource directories - will use only existing directories
Platform.instance.resourceDirs = resourceDirs;
// select translation file - for english language
Platform.instance.uiLanguage = "en";
// load theme from file "theme_default.xml"
Platform.instance.uiTheme = "theme_default";
// create window
Window window = Platform.instance.createWindow("My Window", null);
// create some widget to show in window
window.mainWidget = (new Button()).text("Hello world"d).textColor(0xFF0000); // red text
// show window
window.show();
// run message loop
return Platform.instance.enterMessageLoop();
}
--------------------------------