mirror of https://github.com/buggins/dlangui.git
update docs
This commit is contained in:
Vadim Lopatin
parent
1c7bff281f
commit
574e83291e
|
|
@ -62,7 +62,7 @@ Vadim Lopatin, coolreader.org@gmail.com<br><br>
|
|||
<dd>set <u>text</u> to show<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big><a name="TextWidget.text"></a>@property Widget <u>text</u>(ref UIString <i>s</i>);
|
||||
<dt><big><a name="TextWidget.text"></a>@property Widget <u>text</u>(UIString <i>s</i>);
|
||||
</big></dt>
|
||||
<dd>set <u>text</u> to show<br><br>
|
||||
|
||||
|
|
|
|||
|
|
@ -616,7 +616,7 @@ Vadim Lopatin, coolreader.org@gmail.com<br><br>
|
|||
<dd>set <u>text</u><br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big><a name="EditWidgetBase.text"></a>@property Widget <u>text</u>(ref UIString <i>s</i>);
|
||||
<dt><big><a name="EditWidgetBase.text"></a>@property Widget <u>text</u>(UIString <i>s</i>);
|
||||
</big></dt>
|
||||
<dd>set <u>text</u><br><br>
|
||||
|
||||
|
|
|
|||
|
|
@ -26,11 +26,57 @@ Boost License 1.0
|
|||
<b>Authors:</b><br>
|
||||
Vadim Lopatin, coolreader.org@gmail.com<br><br>
|
||||
|
||||
<dl><dt><big><a name="MenuItem"></a>class <u>MenuItem</u>;
|
||||
<dl><dt><big><a name="MenuItemType"></a>enum <u>MenuItemType</u>: int;
|
||||
</big></dt>
|
||||
<dd>menu item type<br><br>
|
||||
|
||||
<dl><dt><big><a name="MenuItemType.Normal"></a><u>Normal</u></big></dt>
|
||||
<dd>normal menu item<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big><a name="MenuItemType.Check"></a><u>Check</u></big></dt>
|
||||
<dd>menu item - checkbox<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big><a name="MenuItemType.Radio"></a><u>Radio</u></big></dt>
|
||||
<dd>menu item - radio button<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big><a name="MenuItemType.Separator"></a><u>Separator</u></big></dt>
|
||||
<dd>menu separator (horizontal line)<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big><a name="MenuItemType.Submenu"></a><u>Submenu</u></big></dt>
|
||||
<dd>submenu - contains child items<br><br>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt><big><a name="MenuItemClickHandler"></a>interface <u>MenuItemClickHandler</u>;
|
||||
</big></dt>
|
||||
<dd>interface to handle menu item click<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big><a name="MenuItemActionHandler"></a>interface <u>MenuItemActionHandler</u>;
|
||||
</big></dt>
|
||||
<dd>interface to handle menu item action<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big><a name="MenuItem"></a>class <u>MenuItem</u>;
|
||||
</big></dt>
|
||||
<dd>menu item properties<br><br>
|
||||
|
||||
<dl><dt><big><a name="MenuItem.id"></a>@property int <u>id</u>();
|
||||
<dl><dt><big><a name="MenuItem.onMenuItemClick"></a>Signal!MenuItemClickHandler <u>onMenuItemClick</u>;
|
||||
</big></dt>
|
||||
<dd>handle menu item click (parameter is MenuItem)<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big><a name="MenuItem.onMenuItemAction"></a>Signal!MenuItemActionHandler <u>onMenuItemAction</u>;
|
||||
</big></dt>
|
||||
<dd>handle menu item click action (parameter is Action)<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big><a name="MenuItem.id"></a>@property int <u>id</u>();
|
||||
</big></dt>
|
||||
<dd>item action <u>id</u>, 0 if no action<br><br>
|
||||
|
||||
|
|
@ -39,11 +85,36 @@ Vadim Lopatin, coolreader.org@gmail.com<br><br>
|
|||
</big></dt>
|
||||
<dd>returns count of submenu items<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big><a name="MenuItem.subitemIndex"></a>@property int <u>subitemIndex</u>(MenuItem <i>item</i>);
|
||||
</big></dt>
|
||||
<dd>returns subitem index for <i>item</i>, -1 if <i>item</i> is not direct subitem of this<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big><a name="MenuItem.subitem"></a>MenuItem <u>subitem</u>(int <i>index</i>);
|
||||
</big></dt>
|
||||
<dd>returns submenu item by <i>index</i><br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big><a name="MenuItem.type"></a>@property MenuItem <u>type</u>(MenuItemType <u>type</u>);
|
||||
</big></dt>
|
||||
<dd>set new MenuItemType<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big><a name="MenuItem.checked"></a>@property bool <u>checked</u>();
|
||||
</big></dt>
|
||||
<dd>get check for checkbox or radio button item<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big><a name="MenuItem.checkRadioButton"></a>protected void <u>checkRadioButton</u>(int <i>index</i>);
|
||||
</big></dt>
|
||||
<dd>check radio button with specified <i>index</i>, uncheck other radio buttons in group (group consists of sequence of radio button items; other item type - end of group)<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big><a name="MenuItem.checked"></a>@property MenuItem <u>checked</u>(bool <i>flg</i>);
|
||||
</big></dt>
|
||||
<dd>set check for checkbox or radio button item<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big><a name="MenuItem.getHotkey"></a>dchar <u>getHotkey</u>();
|
||||
</big></dt>
|
||||
|
|
|
|||
|
|
@ -26,7 +26,157 @@ Boost License 1.0
|
|||
<b>Authors:</b><br>
|
||||
Vadim Lopatin, coolreader.org@gmail.com<br><br>
|
||||
|
||||
<dl><dt><big><a name="platform"></a>@property Platform <u>platform</u>();
|
||||
<dl><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 string <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>(string <i>caption</i>);
|
||||
</big></dt>
|
||||
<dd>sets window <i>caption</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.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>
|
||||
</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.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")<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<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>
|
||||
|
||||
|
|
|
|||
|
|
@ -388,7 +388,7 @@ Vadim Lopatin, coolreader.org@gmail.com<br><br>
|
|||
</dd>
|
||||
<dt><big><a name="Theme.createSubstyle"></a>Style <u>createSubstyle</u>(string <i>id</i>);
|
||||
</big></dt>
|
||||
<dd>create new named style<br><br>
|
||||
<dd>create new named style or get existing<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big><a name="Theme.get"></a>@property Style <u>get</u>(string <i>id</i>);
|
||||
|
|
@ -412,6 +412,62 @@ Vadim Lopatin, coolreader.org@gmail.com<br><br>
|
|||
</big></dt>
|
||||
<dd>set new current <i>theme</i><br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big><a name="decodeRect"></a>Rect <u>decodeRect</u>(string <i>s</i>);
|
||||
</big></dt>
|
||||
<dd>decode comma delimited dimension list or single value - and put to Rect<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big><a name="decodeAlignment"></a>ubyte <u>decodeAlignment</u>(string <i>s</i>);
|
||||
</big></dt>
|
||||
<dd>parses string like "Left|VCenter" to bit set of Align flags<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big><a name="decodeTextFlags"></a>uint <u>decodeTextFlags</u>(string <i>s</i>);
|
||||
</big></dt>
|
||||
<dd>parses string like "HotKeys|UnderlineHotKeysWhenAltPressed" to bit set of TextFlag flags<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big><a name="decodeFontFamily"></a>FontFamily <u>decodeFontFamily</u>(string <i>s</i>);
|
||||
</big></dt>
|
||||
<dd>decode FontFamily item name to value<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big><a name="decodeLayoutDimension"></a>int <u>decodeLayoutDimension</u>(string <i>s</i>);
|
||||
</big></dt>
|
||||
<dd>decode layout dimension (FILL_PARENT, WRAP_CONTENT, or just size)<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big><a name="loadStyleAttributes"></a>bool <u>loadStyleAttributes</u>(Style <i>style</i>, Element <i>elem</i>, bool <i>allowStates</i>);
|
||||
</big></dt>
|
||||
<dd>load <i>style</i> attributes from XML element<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big><a name="loadTheme"></a>bool <u>loadTheme</u>(Theme <i>theme</i>, Element <i>doc</i>, int <i>level</i> = 0);
|
||||
</big></dt>
|
||||
<dd>load <i>theme</i> from XML document
|
||||
<br><br>
|
||||
<b>Sample:</b><br>
|
||||
<pre class="d_code"><?xml <font color=blue>version</font>=<font color=red>"1.0"</font> encoding=<font color=red>"utf-8"</font>?>
|
||||
<<i>theme</i> id=<font color=red>"theme_custom"</font> parent=<font color=red>"theme_default"</font>>
|
||||
<style id=<font color=red>"BUTTON"</font>
|
||||
backgroundImageId=<font color=red>"btn_default_small"</font>
|
||||
>
|
||||
</style>
|
||||
</<i>theme</i>>
|
||||
</pre>
|
||||
<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big><a name="loadTheme"></a>bool <u>loadTheme</u>(Theme <i>theme</i>, string <i>resourceId</i>, int <i>level</i> = 0);
|
||||
</big></dt>
|
||||
<dd>load <i>theme</i> from file<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big><a name="loadTheme"></a>Theme <u>loadTheme</u>(string <i>resourceId</i>);
|
||||
</big></dt>
|
||||
<dd>load theme from XML file (<b>null</b> if failed)<br><br>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue