Button

Undocumented in source.

Constructors

this
this(string style, string iconsGroup)
Undocumented in source.

Members

Functions

onCreate
void onCreate()
Undocumented in source. Be warned that the author may not have intended to support it.
onProgress
void onProgress(ProgressEvent event)
Undocumented in source. Be warned that the author may not have intended to support it.
updateSize
void updateSize()
Undocumented in source. Be warned that the author may not have intended to support it.

Structs

Measure
struct Measure
Undocumented in source.

Variables

allowCheck
bool allowCheck;
Undocumented in source.
caption
utf32string caption;
Undocumented in source.
icons
Array!string icons;
Undocumented in source.
iconsGroup
string iconsGroup;
Undocumented in source.
measure
Measure measure;
Undocumented in source.
textAlign
Align textAlign;
Undocumented in source.
textVerticalAlign
VerticalAlign textVerticalAlign;
Undocumented in source.
themeLoader
ButtonThemeLoader themeLoader;
Undocumented in source.
uselessIconArea
int uselessIconArea;
Undocumented in source.

Inherited Members

From Widget

SizeType
enum SizeType

Type of sizing for width and height.

field
struct field

Field attribute need to tell RPDL which fields are fill when reading layout file.

isVisible
bool isVisible;
Undocumented in source.
isEnabled
bool isEnabled;
Undocumented in source.
focusable
bool focusable;
Undocumented in source.
finalFocus
bool finalFocus;

If true, then focus navigation by children will be limited inside this widget.

cursor
CursorIcon cursor;

Specifies the type of cursor to be displayed when pointing on an element.

name
string name;
Undocumented in source.
hint
utf32string hint;

Some help information about widget, need to display tooltip.

locationAlign
Align locationAlign;

How to place a widget horizontally.

verticalLocationAlign
VerticalAlign verticalLocationAlign;

How to place a widget vertically.

regionAlign
RegionAlign regionAlign;

If set this option then widget will be pinned to one of the side declared in the basic_types.RegionAlign.

margin
FrameRect margin;

Used to create space around elements, outside of any defined borders.

padding
FrameRect padding;

Used to generate space around an element's content, inside of any defined borders.

position
vec2 position;
Undocumented in source.
size
vec2 size;
Undocumented in source.
widthType
SizeType widthType;

Determine how to set width for widget.

heightType
SizeType heightType;

Determine how to set height for widget.

width
float width [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
width
float width [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
height
float height [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
height
float height [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
left
float left [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
left
float left [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
top
float top [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
top
float top [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
id
size_t id [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
style
string style;

Widget root rpdl node from where the data will be extracted.

parent
Widget parent [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
p_parent
Widget p_parent;
Undocumented in source.
owner
Widget owner;
Undocumented in source.
isFocused
inout(bool) isFocused [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
p_isFocused
bool p_isFocused;
Undocumented in source.
nextWidget
Widget nextWidget [@property getter]

Next widget in parent children after this.

p_nextWidget
Widget p_nextWidget;
Undocumented in source.
prevWidget
Widget prevWidget [@property getter]

Previous widget in parent children before this.

p_prevWidget
Widget p_prevWidget;
Undocumented in source.
lastWidget
Widget lastWidget [@property getter]

Last widget in parent children.

p_lastWidget
Widget p_lastWidget;
Undocumented in source.
firstWidget
Widget firstWidget [@property getter]

First widget in parent children.

p_firstWidget
Widget p_firstWidget;
Undocumented in source.
children
WidgetsContainer children [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
depth
uint depth [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
p_depth
uint p_depth;
Undocumented in source.
resolver
WidgetResolver resolver [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
focusNavigator
FocusNavigator focusNavigator [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
events
WidgetEventsObserver events [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
visibleRules
Array!(bool delegate()) visibleRules;

Additional rules appart from isVisible to set widget visible or not.

enableRules
Array!(bool delegate()) enableRules;

Additional rules appart from enabled to set widget enabled or not.

PartDraws
enum PartDraws

Which part of widget need to render, e.g. if it is a button then PartDraws.left tell that only left side and center will be rendered, this need for grouping rendering of widgets.

partDraws
PartDraws partDraws;
Undocumented in source.
view
View view [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
view_
View view_;
Undocumented in source.
skipFocus
bool skipFocus;

Don't focus this element.

drawChildren
bool drawChildren;
Undocumented in source.
extraInnerOffset
FrameRect extraInnerOffset;

Extra inner offset besides padding.

extraOuterOffset
FrameRect extraOuterOffset;

Extra outer offset besides margin.

overlay
bool overlay;
Undocumented in source.
overSize
vec2 overSize;
Undocumented in source.
overlayRect
Rect overlayRect;
Undocumented in source.
focusOnMousUp
bool focusOnMousUp;
Undocumented in source.
isEnter
bool isEnter;

True if pointed on widget.

overrideIsEnter
bool overrideIsEnter;

Override isEnter state i.e. ignore isEnter value and use overrided value.

isClick
bool isClick;
Undocumented in source.
isMouseDown
bool isMouseDown;
Undocumented in source.
locator
WidgetLocator locator;
Undocumented in source.
renderer
Renderer renderer;
Undocumented in source.
isOver
bool isOver;

When in rect of element but if another element over this isOver will still be true.

absolutePosition
inout(vec2) absolutePosition [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
absolutePosition_
vec2 absolutePosition_;
Undocumented in source.
innerBoundarySizeClamped
vec2 innerBoundarySizeClamped;

Size of boundary over childern clamped to size of widget as minimum boundary size.

innerBoundarySize
vec2 innerBoundarySize;

Size of boundary over childern.

contentOffset
vec2 contentOffset;

Children offset relative their absolute positions.

outerBoundarySize
vec2 outerBoundarySize;

Full region size including inner offsets.

associatedWidget
Widget associatedWidget;
Undocumented in source.
state
inout(State) state [@property getter]

Returns string of state declared in theme.

innerSize
vec2 innerSize [@property getter]

Inner size considering the extra innter offsets and paddings.

innerOffsetSize
vec2 innerOffsetSize [@property getter]

Total inner offset size (width and height) considering the extra inner offsets and paddings.

innerOffset
FrameRect innerOffset [@property getter]

Inner padding plus and extra inner offsets.

extraInnerOffsetSize
vec2 extraInnerOffsetSize [@property getter]

Total size of extra inner offset (width and height).

extraInnerOffsetStart
vec2 extraInnerOffsetStart [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
extraInnerOffsetEnd
vec2 extraInnerOffsetEnd [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
innerOffsetStart
vec2 innerOffsetStart [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
innerOffsetEnd
vec2 innerOffsetEnd [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
outerSize
vec2 outerSize [@property getter]

Outer size considering the extra outer offsets and margins.

outerOffsetSize
vec2 outerOffsetSize [@property getter]

Total outer offset size (width and height) considering the extra outer offsets and margins.

outerOffset
FrameRect outerOffset [@property getter]

Total outer offset - margins plus extra outer offsets.

outerOffsetStart
vec2 outerOffsetStart [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
outerOffsetEnd
vec2 outerOffsetEnd [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
onProgress
void onProgress(ProgressEvent event)
Undocumented in source. Be warned that the author may not have intended to support it.
updateBoundary
void updateBoundary()

Update widget inner bounary and clamped boundary.

checkRules
void checkRules()
Undocumented in source. Be warned that the author may not have intended to support it.
reset
void reset()
Undocumented in source. Be warned that the author may not have intended to support it.
getNonDecoratorParent
Widget getNonDecoratorParent()
Undocumented in source. Be warned that the author may not have intended to support it.
resetChildren
void resetChildren()
Undocumented in source. Be warned that the author may not have intended to support it.
collectOnProgressQueries
void collectOnProgressQueries()
Undocumented in source. Be warned that the author may not have intended to support it.
processPorgress
bool processPorgress()
Undocumented in source. Be warned that the author may not have intended to support it.
onRender
void onRender()

Render widget in camera view.

renderChildren
void renderChildren()
Undocumented in source. Be warned that the author may not have intended to support it.
focus
void focus()

Make focus for widget, and clear focus from focused widget.

blur
void blur()

Clear focus from widget

onCreate
void onCreate()
Undocumented in source. Be warned that the author may not have intended to support it.
onPostCreate
void onPostCreate()
Undocumented in source. Be warned that the author may not have intended to support it.
onMouseMove
void onMouseMove(MouseMoveEvent event)
Undocumented in source. Be warned that the author may not have intended to support it.
onMouseUp
void onMouseUp(MouseUpEvent event)
Undocumented in source. Be warned that the author may not have intended to support it.
onFocus
void onFocus(FocusEvent event)
Undocumented in source. Be warned that the author may not have intended to support it.
onBlur
void onBlur(BlurEvent event)
Undocumented in source. Be warned that the author may not have intended to support it.
onCursor
void onCursor()

Override this method if need change behaviour when system cursor have to be changed.

onResize
void onResize()
Undocumented in source. Be warned that the author may not have intended to support it.
onClickActionInvoked
void onClickActionInvoked()
Undocumented in source. Be warned that the author may not have intended to support it.
pointIsEnter
bool pointIsEnter(vec2i point)

Determine if point is inside widget area.

updateSize
void updateSize()

This method invokes when widget size is updated.

updateAll
void updateAll()

Recalculate size and position of widget and children widgets.

freezeUI
void freezeUI(bool isNestedFreeze)
Undocumented in source. Be warned that the author may not have intended to support it.
unfreezeUI
void unfreezeUI()
Undocumented in source. Be warned that the author may not have intended to support it.
isFrozen
bool isFrozen()
Undocumented in source. Be warned that the author may not have intended to support it.
isFreezingSource
bool isFreezingSource()
Undocumented in source. Be warned that the author may not have intended to support it.

Meta