UIElement

addChild void addChild(UIElement element): Add a UIElement as child to another.
animate void animate(double dt, double time): Undocumented in source. Be warned that the author may not have intended to support it.
child UIElement child(int n)
contains bool contains(int x, int y): Check if given point is considered in the widget, for clicks, mouse moves, etc. This function is meant to be overridden.
context UIContext context(): Get the UI context, which is an additional API for widgets to use (though quite a bit of methods are internals there).
cursorWhenDragged MouseCursor cursorWhenDragged()
cursorWhenMouseOver MouseCursor cursorWhenMouseOver()
drawsToPBR bool drawsToPBR(): Widget draws on the PBR layer?
drawsToRaw bool drawsToRaw(): Widget draws on the Raw layer?
getDrawLists void getDrawLists(Vec!UIElement listRaw, Vec!UIElement listPBR): Undocumented in source. Be warned that the author may not have intended to support it.
getElementById UIElement getElementById(const(char)* id): Search subtree for an UIElement with ID id. Undefined Behaviour if ID are not unique.
getId const(char)[] getId(): Get widget ID.
getUserPointer void* getUserPointer(int pointerID): Set/Get a user pointer. This allow dplug:gui extensions.
hasId bool hasId(): Has this widget an identifier?
id void id(const(char)[] identifier): Set widget ID.
id const(char)[] id(): Get widget ID.
isAnimated bool isAnimated(): Is widget animated? (onAnimate called)
isDragged bool isDragged(): Widget dragged by mouse?
isDrawAlonePBR bool isDrawAlonePBR(): Should widget be drawn alone in PBR layer?
isDrawAloneRaw bool isDrawAloneRaw(): Should widget be drawn alone in Raw layer?
isFocused bool isFocused(): Widget has keyboard focused? (last clicked)
isMouseOver bool isMouseOver(): Widget hovered by mouse?
isVisible bool isVisible(): A widget is "visible" when it has a true visibility flag, and its parent is itself visible.
keyDown bool keyDown(Key key): Undocumented in source. Be warned that the author may not have intended to support it.
keyUp bool keyUp(Key key): Undocumented in source. Be warned that the author may not have intended to support it.
mouseClick bool mouseClick(int x, int y, int button, bool isDoubleClick, MouseState mstate): Undocumented in source. Be warned that the author may not have intended to support it.
mouseMove bool mouseMove(int x, int y, int dx, int dy, MouseState mstate, bool alreadyFoundMouseOver): Undocumented in source. Be warned that the author may not have intended to support it.
mouseRelease void mouseRelease(int x, int y, int button, MouseState mstate): Undocumented in source. Be warned that the author may not have intended to support it.
mouseWheel bool mouseWheel(int x, int y, int wheelDeltaX, int wheelDeltaY, MouseState mstate): Undocumented in source. Be warned that the author may not have intended to support it.
onAnimate void onAnimate(double dt, double time): Called periodically for every UIElement that has flagAnimated. Override this to create animations.
onBeginDrag void onBeginDrag(): Called when a drag operation starts or ends. This function is meant to be overridden.
onDrawPBR void onDrawPBR(ImageRef!RGBA diffuse, ImageRef!L16 depth, ImageRef!RGBA material, box2i[] dirtyRects): PBR layer draw method. This function is meant to be overridden.
onDrawRaw void onDrawRaw(ImageRef!RGBA rawMap, box2i[] dirtyRects): Raw layer draw method. This function is meant to be overridden.
onFocusEnter void onFocusEnter(): Called when this widget is clicked and get the "focus" (ie. meaning the keyboard focus). This function is meant to be overridden.
onFocusExit void onFocusExit(): This widget lost the keyboard focus. This function is meant to be overridden.
onKeyDown bool onKeyDown(Key key)
onKeyUp bool onKeyUp(Key key): Called when a key is pressed/released. Functiosn meant to be overridden.
onMouseClick Click onMouseClick(int x, int y, int button, bool isDoubleClick, MouseState mstate): .onMouseClick() is called for every new click.
onMouseDrag void onMouseDrag(int x, int y, int dx, int dy, MouseState mstate): Called when the mouse moves while dragging this widget.
onMouseEnter void onMouseEnter()
onMouseExit void onMouseExit(): Called when mouse enter or exits a widget. This function is meant to be overridden.
onMouseMove void onMouseMove(int x, int y, int dx, int dy, MouseState mstate): Called when the mouse moves over this widget area. This function is meant to be overridden.
onMouseWheel bool onMouseWheel(int x, int y, int wheelDeltaX, int wheelDeltaY, MouseState mstate): Mouse wheel was turned. This function is meant to be overridden.
onStopDrag void onStopDrag(): Called when a drag operation starts or ends. This function is meant to be overridden.
parent UIElement parent(): Get parent widget, if any.
position box2i position(): Get widget position in the window (absolute).
position void position(box2i p)
void position(box2f p): Set widget position in the window (absolute).
reflow void reflow(): The .reflow() callback is called whenver the .position of a widget changes.
removeChild void removeChild(UIElement element): Removes a child from its parent. Useful for creating dynamic UI's.
renderPBR void renderPBR(ImageRef!RGBA diffuse, ImageRef!L16 depth, ImageRef!RGBA material, box2i[] areasToUpdate): Undocumented in source. Be warned that the author may not have intended to support it.
renderRaw void renderRaw(ImageRef!RGBA rawMap, box2i[] areasToUpdate): Undocumented in source. Be warned that the author may not have intended to support it.
setCursorWhenDragged void setCursorWhenDragged(MouseCursor mouseCursor)
setCursorWhenMouseOver void setCursorWhenMouseOver(MouseCursor mouseCursor)
setDirty void setDirty(box2i rect, UILayer layer): Mark a sub-part of the element "dirty".
setDirtyWhole void setDirtyWhole(UILayer layer): Mark this element as "dirty" on its whole position.
setId void setId(const(char)[] identifier): Set widget ID.
setUserPointer void setUserPointer(int pointerID, void* user): Set/Get a user pointer. This allow dplug:gui extensions.
topLevelParent UIElement topLevelParent(): Get top-level parent, if any.
visibility bool visibility(): Get visibility flag of the widget.
visibility void visibility(bool visible): Change visibility flag of the widget. Show or hide all children of this UIElement, regardless of their position on screen, invalidating their graphics if need be (much like a position change).
zOrder int zOrder()
void zOrder(int zOrder): Set/get widget Z-order (default = 0).

Variables

_children Vec!UIElement _children;: Undocumented in source.
_flags immutable(uint) _flags;: Undocumented in source.
_parent UIElement _parent;: Undocumented in source.
_position box2i _position;: Undocumented in source.
_zOrder int _zOrder;: Undocumented in source.

UIElement

Constructors

Destructor

Members

Aliases

Functions

Variables

Meta

Source