From 4d7811f249ba37578cef841c8da41b1ad921efa0 Mon Sep 17 00:00:00 2001 From: Vadim Lopatin Date: Mon, 15 Dec 2014 17:48:25 +0300 Subject: [PATCH] update docs --- all.html | 2 +- api.html | 7 +- collections.html | 45 +-- combobox.html | 90 ++++++ controls.html | 34 +- dialog.html | 16 +- drawbuf.html | 36 ++- editors.html | 54 ++-- events.html | 90 +++--- filedlg.html | 10 +- fonts.html | 29 +- ftfonts.html | 8 +- gldrawbuf.html | 105 +------ glsupport.html | 23 +- i18n.html | 139 +++++++- images.html | 2 +- index.html | 45 ++- layouts.html | 35 ++- linestream.html | 2 +- lists.html | 86 ++++- logger.html | 2 +- menu.html | 10 +- platform.html | 19 +- popup.html | 29 +- resources.html | 20 +- screenshots.html | 2 +- scroll.html | 91 ++++++ sdlapp.html | 6 +- signals.html | 40 +-- stdaction.html | 2 +- styles.html | 8 +- tabs.html | 10 +- tree.html | 177 +++++++++++ types.html | 164 +++++++++- widget.html | 786 +++++++++++++++++++++++++++++++++++++++++++++- win32drawbuf.html | 52 ++- win32fonts.html | 132 +++++++- winapp.html | 60 +++- x11app.html | 52 ++- 39 files changed, 2090 insertions(+), 430 deletions(-) create mode 100644 combobox.html create mode 100644 scroll.html create mode 100644 tree.html diff --git a/all.html b/all.html index 2425a5ef..60a0826a 100644 --- a/all.html +++ b/all.html @@ -31,7 +31,7 @@

dlangui.all

- + This module is just to simplify import of most useful DLANGUI modules.

Synopsis:
diff --git a/api.html b/api.html index b08dc677..c5b3a650 100644 --- a/api.html +++ b/api.html @@ -31,7 +31,7 @@

api

- + @@ -69,6 +69,11 @@
  • menu
  • popup
  • tabs
    • +
  • tree
    • +
  • scroll
    • +
  • grid
    • +
  • tree
    • +
  • combobox
  • dlangui.dialogs
      diff --git a/collections.html b/collections.html index 01c47ab6..25dda8f4 100644 --- a/collections.html +++ b/collections.html @@ -31,7 +31,7 @@

      dlangui.core.collections

      - + This module implements array based collection.

      Synopsis:
      @@ -68,104 +68,105 @@ Vadim Lopatin, coolreader.org@gmail.com

      struct Collection(T, bool ownItems = false);
      array based collection of items - retains item order when during add/remove operations

      +

      +retains item order when during add/remove operations

      -
      bool empty(); +
      @property bool empty();
      returns true if there are no items in collection

      -
      size_t length(); +
      @property size_t length();
      returns number of items in collection

      -
      size_t size(); +
      @property size_t size();
      returns currently allocated capacity (may be more than length)

      -
      void size(size_t newSize); +
      @property void size(size_t newSize);
      change capacity (e.g. to reserve big space to avoid multiple reallocations)

      -
      void length(size_t newSize); +
      @property void length(size_t newSize);
      returns number of items in collection

      -
      T opIndex(size_t index); +
      ref T opIndex(size_t index);
      access item by index

      -
      void add(T item, size_t index = size_t.max); +
      void add(T item, size_t index = size_t.max);
      insert new item in specified position

      -
      void addAll(ref Collection!(T, ownItems) v); +
      void addAll(ref Collection!(T, ownItems) v);
      add all items from other collection

      -
      Collection opOpAssign(string op)(T item); +
      ref Collection opOpAssign(string op)(T item);
      support for appending (~=, +=) and removing by value (-=)

      -
      size_t indexOf(T item); +
      size_t indexOf(T item);
      returns index of first occurence of item, size_t.max if not found

      -
      T remove(size_t index); +
      T remove(size_t index);
      remove single item, returning removed item

      -
      bool removeValue(T value); +
      bool removeValue(T value);
      remove single item by value - if present in collection, returning true if item was found and removed

      -
      int opApply(int delegate(ref T param) op); +
      int opApply(int delegate(ref T param) op);
      support of foreach with reference

      -
      void clear(); +
      void clear();
      remove all items

      -
      T popFront(); +
      @property T popFront();
      remove first item

      -
      void pushFront(T item); +
      void pushFront(T item);
      insert item at beginning of collection

      -
      T popBack(); +
      @property T popBack();
      remove last item

      -
      void pushBack(T item); +
      void pushBack(T item);
      insert item at end of collection

      -
      T front(); +
      @property T front();
      peek first item

      -
      T back(); +
      @property T back();
      peek last item

      diff --git a/combobox.html b/combobox.html new file mode 100644 index 00000000..cc4651cd --- /dev/null +++ b/combobox.html @@ -0,0 +1,90 @@ + + + + + + + + + + + DlangUI - cross platform GUI library for D programming language - dlangui.widgets.combobox + + +
      +
      +
      +

      DlangUI

      +

      Cross Platform GUI for D programming language

      +
      +
      + Home + API Docs + Screenshots + Download .zip + + View on GitHub +
      + +
      +
      +

      dlangui.widgets.combobox

      + +This module contains Combo Box widgets implementation. +

      +Synopsis:
      +
      import dlangui.widgets.combobox;
+
+// creation of simple strings list
+ComboBox box = new ComboBox("combo1", ["value 1"d, "value 2"d, "value 3"d]);
+
+// select first item
+box.selectedItemIndex = 0;
+
+// get selected item text
+println(box.text);
+
+
      + +

      +License:
      +Boost License 1.0 +

      +Authors:
      +Vadim Lopatin, coolreader.org@gmail.com

      + +
      class ComboBoxBase: dlangui.widgets.layouts.HorizontalLayout, dlangui.widgets.widget.OnClickHandler; +
      +
      Abstract ComboBox.

      + +
      Signal!OnItemSelectedHandler onItemClickListener; +
      +
      Handle item click.

      + +
      +
      @property int selectedItemIndex(); +
      +
      Selected item index.

      + +
      +
      +
      +
      class ComboBox: dlangui.widgets.combobox.ComboBoxBase; +
      +
      ComboBox with list of strings.

      + +
      +
      + +
      + + +
      +
      + + diff --git a/controls.html b/controls.html index 32abe284..fdc87da9 100644 --- a/controls.html +++ b/controls.html @@ -31,7 +31,7 @@

      dlangui.widgets.controls

      - + This module contains simple controls widgets implementation.

      TextWidget @@ -63,17 +63,17 @@ Boost License 1.0 Authors:
      Vadim Lopatin, coolreader.org@gmail.com

      -
      class VSpacer: dlangui.widgets.widget.Widget; +
      class VSpacer: dlangui.widgets.widget.Widget;
      vertical spacer to fill empty space in vertical layouts

      -
      class HSpacer: dlangui.widgets.widget.Widget; +
      class HSpacer: dlangui.widgets.widget.Widget;
      horizontal spacer to fill empty space in horizontal layouts

      -
      class TextWidget: dlangui.widgets.widget.Widget; +
      class TextWidget: dlangui.widgets.widget.Widget;
      static text widget

      @@ -99,7 +99,7 @@ Vadim Lopatin, coolreader.org@gmail.com

      -
      class ImageWidget: dlangui.widgets.widget.Widget; +
      class ImageWidget: dlangui.widgets.widget.Widget;
      static image widget

      @@ -122,30 +122,35 @@ Vadim Lopatin, coolreader.org@gmail.com

      set custom drawable (not one from resources)

      +
      +
      @property ImageWidget drawable(string drawableId); +
      +
      set custom drawable (not one from resources)

      +
      -
      class ImageButton: dlangui.widgets.controls.ImageWidget; +
      class ImageButton: dlangui.widgets.controls.ImageWidget;
      button with image only

      -
      class ImageTextButton: dlangui.widgets.layouts.HorizontalLayout; +
      class ImageTextButton: dlangui.widgets.layouts.HorizontalLayout;
      button with image and text

      -
      class CheckBox: dlangui.widgets.controls.ImageTextButton; +
      class CheckBox: dlangui.widgets.controls.ImageTextButton;
      checkbox

      -
      class RadioButton: dlangui.widgets.controls.ImageTextButton; +
      class RadioButton: dlangui.widgets.controls.ImageTextButton;
      radio button

      -
      class Button: dlangui.widgets.widget.Widget; +
      class Button: dlangui.widgets.widget.Widget;
      Text only button

      @@ -161,7 +166,7 @@ Vadim Lopatin, coolreader.org@gmail.com

      -
      class AbstractSlider: dlangui.widgets.widget.WidgetGroup; +
      class AbstractSlider: dlangui.widgets.widget.WidgetGroup;
      base class for widgets like scrollbars and sliders

      @@ -207,7 +212,7 @@ Vadim Lopatin, coolreader.org@gmail.com

      -
      class ScrollBar: dlangui.widgets.controls.AbstractSlider, dlangui.widgets.widget.OnClickHandler; +
      class ScrollBar: dlangui.widgets.controls.AbstractSlider, dlangui.widgets.widget.OnClickHandler;
      scroll bar - either vertical or horizontal

      @@ -220,6 +225,11 @@ Vadim Lopatin, coolreader.org@gmail.com
      sets scrollbar orientation

      +
      +
      protected void updateState(); +
      +
      hide controls when scroll is not possible

      +
      bool onMouseEvent(MouseEvent event);
      diff --git a/dialog.html b/dialog.html index 93511c0e..71c828b2 100644 --- a/dialog.html +++ b/dialog.html @@ -31,7 +31,7 @@

      dlangui.dialogs.dialog

      - + This module contains common Dialog implementation.

      Synopsis:
      @@ -60,11 +60,21 @@ Vadim Lopatin, coolreader.org@gmail.com

      -
      class Dialog: dlangui.widgets.layouts.VerticalLayout; +
      class Dialog: dlangui.widgets.layouts.VerticalLayout;
      base for all dialogs

      -
      void show(); +
      Widget createButtonsPanel(const Action[] actions, int defaultActionIndex, int splitBeforeIndex); +
      +
      create panel with buttons based on list of actions

      + +
      +
      void init(); +
      +
      override to implement creation of dialog controls

      + +
      +
      void show();
      shows dialog

      diff --git a/drawbuf.html b/drawbuf.html index 1c6af425..348d1957 100644 --- a/drawbuf.html +++ b/drawbuf.html @@ -31,7 +31,7 @@

      dlangui.graphics.drawbuf

      - + This module contains drawing buffer implementation.

      Synopsis:
      @@ -83,7 +83,7 @@ Vadim Lopatin, coolreader.org@gmail.com

      -
      abstract class DrawBuf: dlangui.core.types.RefCountedObject; +
      abstract class DrawBuf: dlangui.core.types.RefCountedObject;
      drawing buffer - image container which allows to perform some drawing operations

      @@ -106,11 +106,6 @@ Vadim Lopatin, coolreader.org@gmail.com
      applies current drawbuf alpha to argb color value

      -
      -
      @property uint id(); -
      -
      unique ID of drawbug instance, for using with hardware accelerated rendering for caching

      -
      const @property const(NinePatch)* ninePatch();
      @@ -141,25 +136,32 @@ Vadim Lopatin, coolreader.org@gmail.com
      returns current height

      +
      +
      void resetClipping(); +
      +
      init clip rectangle to full buffer size

      +
      @property ref Rect clipRect();
      returns clipping rectangle, when clipRect.isEmpty == true -- means no clipping.

      -
      -
      @property Rect clipOrFullRect(); -
      -
      returns clipping rectangle, or (0,0,dx,dy) when no clipping.

      -
      @property void clipRect(ref const Rect rect);
      -
      sets new clipping rectangle, when clipRect.isEmpty == true -- means no clipping.

      +
      returns clipping rectangle, or (0,0,dx,dy) when no clipping. +

      +sets new clipping rectangle, when clipRect.isEmpty == true -- means no clipping.

      @property void intersectClipRect(ref const Rect rect);
      -
      sets new clipping rectangle, when clipRect.isEmpty == true -- means no clipping.

      +
      sets new clipping rectangle, intersect with previous one.

      + +
      +
      @property bool isClippedOut(ref const Rect rect); +
      +
      returns true if rectangle is completely clipped out and cannot be drawn.

      bool applyClipping(ref Rect rc); @@ -238,6 +240,12 @@ Vadim Lopatin, coolreader.org@gmail.com

      RAII setting/restoring of clip rectangle

      +
      this(DrawBuf buf, ref Rect newClipRect, uint newAlpha = 0); +
      +
      apply (intersect) new clip rectangle and alpha to draw buf; restore

      + +
      +
      diff --git a/editors.html b/editors.html index a252c8d0..99930ed4 100644 --- a/editors.html +++ b/editors.html @@ -31,7 +31,7 @@

      dlangui.widgets.editors

      - + This module contains implementation of editors.

      EditLine - single line editor. @@ -327,8 +327,11 @@ Vadim Lopatin, coolreader.org@gmail.com

      Replace
      insert content into specified position (range.start) - delete content in range - replace range content with new content

      +

      +delete content in range +

      + +replace range content with new content

      @@ -536,7 +539,7 @@ Vadim Lopatin, coolreader.org@gmail.com

      -
      abstract class EditWidgetBase: dlangui.widgets.widget.WidgetGroup, dlangui.widgets.editors.EditableContentListener, dlangui.widgets.menu.MenuItemActionHandler; +
      abstract class EditWidgetBase: dlangui.widgets.scroll.ScrollWidgetBase, dlangui.widgets.editors.EditableContentListener, dlangui.widgets.menu.MenuItemActionHandler;
      base for all editor widgets

      @@ -653,11 +656,6 @@ Vadim Lopatin, coolreader.org@gmail.com
      draws caret

      -
      -
      protected void updateScrollbars(); -
      -
      override to update scrollbars - if necessary

      -
      protected void correctCaretPos();
      @@ -701,7 +699,7 @@ Vadim Lopatin, coolreader.org@gmail.com

      -
      class EditLine: dlangui.widgets.editors.EditWidgetBase; +
      class EditLine: dlangui.widgets.editors.EditWidgetBase;
      single line editor

      @@ -737,34 +735,44 @@ Vadim Lopatin, coolreader.org@gmail.com

      -
      class EditBox: dlangui.widgets.editors.EditWidgetBase, dlangui.widgets.controls.OnScrollHandler; +
      class EditBox: dlangui.widgets.editors.EditWidgetBase;
      single line editor

      -
      bool onScrollEvent(AbstractSlider source, ScrollEvent event); +
      protected void updateHScrollBar();
      -
      handle scroll event

      +
      update horizontal scrollbar widget position

      + +
      +
      protected void updateVScrollBar(); +
      +
      update verticat scrollbar widget position

      + +
      +
      bool onHScroll(ScrollEvent event); +
      +
      process horizontal scrollbar event

      + +
      +
      bool onVScroll(ScrollEvent event); +
      +
      process vertical scrollbar event

      + +
      +
      Point fullContentSize(); +
      +
      calculate full content size in pixels

      void measure(int parentWidth, int parentHeight);
      measure

      -
      -
      void layout(Rect rc); -
      -
      Set widget rectangle to specified value and layout widget contents. (Step 2 of two phase layout).

      -
      protected void drawLineBackground(DrawBuf buf, int lineIndex, Rect lineRect, Rect visibleRect);
      override to custom highlight of line background

      -
      -
      void onDraw(DrawBuf buf); -
      -
      draw content

      -
      diff --git a/events.html b/events.html index b4e01fe5..f95400de 100644 --- a/events.html +++ b/events.html @@ -31,7 +31,7 @@

      dlangui.core.events

      - + This module contains dlangui event types declarations.

      Synopsis:
      @@ -76,7 +76,7 @@ Vadim Lopatin, coolreader.org@gmail.com

      additional custom (Object) parameter

      -
      this(Action a); +
      this(Action a);
      deep copy constructor

      @@ -86,17 +86,17 @@ Vadim Lopatin, coolreader.org@gmail.com

      deep copy

      -
      this(int id); +
      this(int id);
      create action only with ID

      -
      this(int id, uint keyCode, uint keyFlags = 0); +
      this(int id, uint keyCode, uint keyFlags = 0);
      action with accelerator, w/o label

      -
      this(int id, dstring label, string iconResourceId = null, uint keyCode = 0, uint keyFlags = 0); +
      this(int id, dstring label, string iconResourceId = null, uint keyCode = 0, uint keyFlags = 0);
      action with label, icon, and accelerator

      @@ -160,11 +160,7 @@ Vadim Lopatin, coolreader.org@gmail.com
      mouse flag bits

      -
      Control
      -
      Ctrl key is down

      - -
      -
      LButton
      +
      LButton
      Left mouse button is down

      @@ -175,10 +171,6 @@ Vadim Lopatin, coolreader.org@gmail.com

      RButton
      Right mouse button is down

      -
      -
      Shift
      -
      Shift key is down

      -
      XButton1
      X1 mouse button is down

      @@ -187,10 +179,48 @@ Vadim Lopatin, coolreader.org@gmail.com

      XButton2
      X2 mouse button is down

      +
      +
      Control
      +
      Ctrl key is down

      + +
      +
      Shift
      +
      Shift key is down

      +
      Alt
      Alt key is down

      +
      +
      +
      +
      enum MouseButton: ubyte; +
      +
      mouse button

      + +
      None
      +
      no button

      + +
      +
      Left
      +
      left mouse button

      + +
      +
      Right
      +
      right mouse button

      + +
      +
      Middle
      +
      right mouse button

      + +
      +
      XButton1
      +
      additional mouse button 1

      + +
      +
      XButton2
      +
      additional mouse button 2

      +
      @@ -237,36 +267,6 @@ Vadim Lopatin, coolreader.org@gmail.com
      returns button down state duration in hnsecs (1/10000 of second).

      -
      - - -
      enum MouseButton: ubyte; -
      -
      mouse button

      - -
      None
      -
      no button

      - -
      -
      Left
      -
      left mouse button

      - -
      -
      Right
      -
      right mouse button

      - -
      -
      Middle
      -
      right mouse button

      - -
      -
      XButton1
      -
      additional mouse button 1

      - -
      -
      XButton2
      -
      additional mouse button 2

      -
      @@ -409,7 +409,7 @@ Vadim Lopatin, coolreader.org@gmail.com

      entered text, for Text action

      -
      this(KeyAction action, uint keyCode, uint flags, dstring text = null); +
      this(KeyAction action, uint keyCode, uint flags, dstring text = null);
      create key event

      diff --git a/filedlg.html b/filedlg.html index fd394aae..1e0deef4 100644 --- a/filedlg.html +++ b/filedlg.html @@ -31,7 +31,7 @@

      dlangui.dialogs.filedlg

      - + This module contains FileDialog implementation.

      Can show dialog for open / save. @@ -77,10 +77,16 @@ Vadim Lopatin, coolreader.org@gmail.com

      -
      class FileDialog: dlangui.dialogs.dialog.Dialog; +
      class FileDialog: dlangui.dialogs.dialog.Dialog;
      file open / save dialog

      +
      void init(); +
      +
      override to implement creation of dialog controls

      + +
      +
      diff --git a/fonts.html b/fonts.html index 4b88c1d7..f12e1d2b 100644 --- a/fonts.html +++ b/fonts.html @@ -31,7 +31,7 @@

      dlangui.graphics.fonts

      - + This module contains base fonts access interface and common implementation.

      Font - base class for fonts. @@ -128,38 +128,13 @@ Vadim Lopatin, coolreader.org@gmail.com

      - -
      @property void function(uint id) glyphDestroyCallback(); -
      -
      get glyph destroy callback (to cleanup OpenGL caches) -

      -Used for resource management. Usually you don't have to call it manually.

      - -
      -
      @property void glyphDestroyCallback(void function(uint id) callback); -
      -
      Set glyph destroy callback (to cleanup OpenGL caches) - This callback is used to tell OpenGL glyph cache that glyph is not more used - to let OpenGL glyph cache delete texture if all glyphs in it are no longer used. -

      -Used for resource management. Usually you don't have to call it manually.

      - -
      -
      uint nextGlyphId(); -
      -
      ID generator for glyphs -

      -Generates next glyph ID. Unique IDs are being used to control OpenGL glyph cache items lifetime. -

      - - Used for resource management. Usually you don't have to call it manually.

      -
      immutable int MAX_WIDTH_UNSPECIFIED;
      constant for measureText maxWidth paramenter - to tell that all characters of text string should be measured.

      -
      abstract class Font: dlangui.core.types.RefCountedObject; +
      abstract class Font: dlangui.core.types.RefCountedObject;
      Instance of font with specific size, weight, face, etc.

      diff --git a/ftfonts.html b/ftfonts.html index 54d49cc9..4aa660ac 100644 --- a/ftfonts.html +++ b/ftfonts.html @@ -31,7 +31,7 @@

      dlangui.graphics.ftfonts

      - + This file contains FontManager implementation based on FreeType library.

      License:
      @@ -40,11 +40,11 @@ Boost License 1.0 Authors:
      Vadim Lopatin, coolreader.org@gmail.com

      -
      class FreeTypeFont: dlangui.graphics.fonts.Font; +
      class FreeTypeFont: dlangui.graphics.fonts.Font;
      Font implementation based on Win32 API system fonts.

      -
      this(FontFileItem item, int size); +
      this(FontFileItem item, int size);
      need to call create() after construction to initialize font

      @@ -76,7 +76,7 @@ Vadim Lopatin, coolreader.org@gmail.com

      -
      class FreeTypeFontManager: dlangui.graphics.fonts.FontManager; +
      class FreeTypeFontManager: dlangui.graphics.fonts.FontManager;
      FreeType based font manager.

      diff --git a/gldrawbuf.html b/gldrawbuf.html index 553ecfe2..f7c44349 100644 --- a/gldrawbuf.html +++ b/gldrawbuf.html @@ -31,7 +31,7 @@

      dlangui.graphics.gldrawbuf

      - + This module contains opengl based drawing buffer implementation.

      To enable OpenGL support, build with version(USE_OPENGL); @@ -49,109 +49,6 @@ Boost License 1.0 Authors:
      Vadim Lopatin, coolreader.org@gmail.com

      -
      class GLDrawBuf: dlangui.graphics.drawbuf.DrawBuf; -
      -
      drawing buffer - image container which allows to perform some drawing operations

      - -
      @property Scene scene(); -
      -
      get current scene (exists only between beforeDrawing() and afterDrawing() calls)

      - -
      -
      @property int width(); -
      -
      returns current width

      - -
      -
      @property int height(); -
      -
      returns current height

      - -
      -
      void beforeDrawing(); -
      -
      reserved for hardware-accelerated drawing - begins drawing batch

      - -
      -
      void afterDrawing(); -
      -
      reserved for hardware-accelerated drawing - ends drawing batch

      - -
      -
      void resize(int width, int height); -
      -
      resize buffer

      - -
      -
      void fill(uint color); -
      -
      fill the whole buffer with solid color (no clipping applied)

      - -
      -
      void fillRect(Rect rc, uint color); -
      -
      fill rectangle with solid color (clipping is applied)

      - -
      -
      void drawGlyph(int x, int y, Glyph* glyph, uint color); -
      -
      draw 8bit alpha image - usually font glyph using specified color (clipping is applied)

      - -
      -
      void drawFragment(int x, int y, DrawBuf src, Rect srcrect); -
      -
      draw source buffer rectangle contents to destination buffer

      - -
      -
      void drawRescaled(Rect dstrect, DrawBuf src, Rect srcrect); -
      -
      draw source buffer rectangle contents to destination buffer rectangle applying rescaling

      - -
      -
      void clear(); -
      -
      cleanup resources

      - -
      -
      -
      -
      abstract class SceneItem; -
      -
      base class for all drawing scene items.

      - -
      -
      class Scene; -
      -
      Drawing scene (operations sheduled for drawing)

      - -
      void add(SceneItem item); -
      -
      add new scene item to scene

      - -
      -
      void draw(); -
      -
      draws all scene items and removes them from list

      - -
      -
      void reset(); -
      -
      resets scene for new drawing - deletes all items

      - -
      -
      -
      -
      void onObjectDestroyedCallback(uint pobject); -
      -
      object deletion listener callback function type

      - -
      -
      void onGlyphDestroyedCallback(uint pobject); -
      -
      object deletion listener callback function type

      - -
      -
      diff --git a/glsupport.html b/glsupport.html index bc9b943e..228875a3 100644 --- a/glsupport.html +++ b/glsupport.html @@ -31,7 +31,7 @@

      dlangui.graphics.glsupport

      - + This module contains OpenGL access layer.

      To enable OpenGL support, build with version(USE_OPENGL); @@ -49,27 +49,6 @@ Boost License 1.0 Authors:
      Vadim Lopatin, coolreader.org@gmail.com

      -
      uint genTexture(); -
      -
      generate new texture ID

      - -
      -
      void deleteTexture(ref uint textureId); -
      -
      delete OpenGL texture

      - -
      -
      void flushGL(); -
      -
      call glFlush

      - -
      -
      bool createFramebuffer(ref uint textureId, ref uint framebufferId, int dx, int dy); -
      -
      returns texture ID for buffer, 0 if failed

      - -
      -
      diff --git a/i18n.html b/i18n.html index 6c750908..b8f9f335 100644 --- a/i18n.html +++ b/i18n.html @@ -31,7 +31,7 @@

      dlangui.core.i18n

      - + This module contains internationalization support implementation.

      Translation files contain of simple key=value pair lines. @@ -77,12 +77,12 @@ Vadim Lopatin, coolreader.org@gmail.com

      container for UI string - either raw value or string resource ID

      -
      this(string id); +
      this(string id);
      create string with i18n resource id

      -
      this(dstring value); +
      this(dstring value);
      create string with raw value

      @@ -109,36 +109,147 @@ Vadim Lopatin, coolreader.org@gmail.com

      -
      class UIStringList; +
      struct UIStringCollection;
      -
      UI string translator

      +
      UIString item collection.

      -
      void clear(); +
      @property int length(); +
      +
      returns number of items

      + +
      +
      UIString[] opIndex(); +
      +
      slice

      + +
      +
      UIString[] opSlice(); +
      +
      slice

      + +
      +
      UIString[] opSlice(size_t start, size_t end); +
      +
      slice

      + +
      +
      UIString opIndex(size_t index); +
      +
      read item by index

      + +
      +
      UIString opIndexAssign(UIString value, size_t index); +
      +
      modify item by index

      + +
      +
      dstring get(size_t index); +
      +
      return unicode string for item by index

      + +
      +
      void opAssign(ref UIStringCollection items); +
      +
      Assign UIStringCollection

      + +
      +
      void addAll(ref UIStringCollection items); +
      +
      Append UIStringCollection

      + +
      +
      void opAssign(string[] items); +
      +
      Assign array of string resource IDs

      + +
      +
      void addAll(string[] items); +
      +
      Append array of string resource IDs

      + +
      +
      void opAssign(dstring[] items); +
      +
      Assign array of unicode strings

      + +
      +
      void addAll(dstring[] items); +
      +
      Append array of unicode strings

      + +
      +
      void clear();
      remove all items

      -
      void set(string id, dstring value); +
      void add(string item, int index = -1);
      -
      set item value

      +
      Insert resource id item into specified position

      -
      const dstring get(string id); +
      void add(dstring item, int index = -1);
      -
      get item value, null if translation is not found for id

      +
      Insert unicode string item into specified position

      -
      bool load(std.stream.InputStream stream); +
      void add(UIString item, int index = -1);
      -
      load strings from stream

      +
      Insert UIString item into specified position

      -
      bool load(string[] filenames); +
      void remove(int index);
      -
      load strings from file (utf8, id=value lines)

      +
      Remove item with specified index

      + +
      +
      int indexOf(dstring str); +
      +
      Return index of first item with specified text or -1 if not found.

      + +
      +
      int indexOf(string strId); +
      +
      Return index of first item with specified string resource id or -1 if not found.

      + +
      +
      int indexOf(UIString str); +
      +
      Return index of first item with specified string or -1 if not found.

      +
      +
      class UIStringTranslator; +
      +
      UI Strings internationalization translator.

      + +
      shared void findTranslationsDir(string[] dirs...); +
      +
      looks for i18n directory inside one of passed dirs, and uses first found as directory to read i18n files from

      + +
      +
      shared string[] convertResourcePaths(string filename); +
      +
      convert resource path - append resource dir if necessary

      + +
      +
      shared bool load(string mainFilename, string fallbackFilename = null); +
      +
      load translation file(s)

      + +
      +
      shared dstring get(string id); +
      +
      translate string ID to string (returns "UNTRANSLATED: id" for missing values)

      + +
      +
      +
      +
      UIStringTranslator i18n; +
      +
      Global translator object.

      +
      diff --git a/images.html b/images.html index 9f4d2503..78994101 100644 --- a/images.html +++ b/images.html @@ -31,7 +31,7 @@

      dlangui.graphics.images

      - + This module contains image loading functions.

      Currently uses FreeImage. diff --git a/index.html b/index.html index 46de6b02..337c9ce4 100644 --- a/index.html +++ b/index.html @@ -31,7 +31,7 @@

      index

      - +

      @@ -76,6 +76,10 @@
    • TabControl - tabs widget, allows to select one of tabs
    • TabHost - container for pages controlled by TabControl
    • TabWidget - combination of TabControl and TabHost
      • +
    • GridWidgetBase - abstract Grid widget
      • +
    • StringGrid - grid view with strings content
      • +
    • TreeWidget - tree view
      • +
    • ComboBox - combo box with text items

    Layouts

    @@ -141,7 +145,7 @@ standard values are used.
    • dub run dlangui:example1 -

    To develop using Visual-D, download sources for dlangui and dependencies into some directory:

    +

    To develop using Visual-D, download sources for dlabgui and dependencies into some directory:

        git clone https://github.com/buggins/dlangui.git
     git clone https://github.com/DerelictOrg/DerelictUtil.git
@@ -224,6 +228,8 @@ standard values are used.
 
    
 Hello World
    
 
+Sample code:
+
 
    // main.d
 import dlangui.all;
 mixin DLANGUI_ENTRY_POINT;
@@ -254,6 +260,41 @@ standard values are used.
 }
 
    
 
+Sample dub.json:
+
    {
+    "name": "myproject",
+    "description": "sample DLangUI project",
+    "homepage": "https://github.com/buggins/dlangui",
+    "license": "Boost",
+    "authors": ["Vadim Lopatin"],
+
+    "targetName": "example",
+    "targetPath": "bin",
+    "targetType": "executable",
+
+    "sourcePaths": ["src"],
+
+    "sourceFiles": [
+         "src/app.d"
+    ],
+
+    "copyFiles-windows": [
+        "lib/FreeImage.dll"
+    ],
+
+    "copyFiles": [
+        "res"
+    ],
+
+    "dependencies": {
+        "dlangui:dlanguilib": "~master"
+    }
+}
+
    
+
+There is sample project which is using DLangUI.
+
+https://github.com/buggins/dlangide