UI framework documentation

[T3sT3ro]

UI: container for single UIWidget, handles events propagation to widget, drawing restrictions etc. UIWidget: toplevel class for widget UIButton: inherits from UIWidget UIFrame: inherits from UIWidget

Methods in cursive should be overriden only if you really know what you are doing! Methods in bold should be overriden for custom logic

UI:

• constructor(x, y, width, height) - defines available box to draw inside window
• update(dt) - updates UI
• draw() - draws UI accor
• getHandlers() - returns event handlers which should be connected to environment callbacks
• getRawCursor

  UIWidget:

• constructor(style, flags)
• style {} - table defining display. Changes to origin, size, margin and simmilar trigger layoutReload
• flags {} - table defining behaviour
• addWidget(widget) - adds widget as a child, will be displayed in ascending z-index
• updater(self, dt, ...) - defines how widget (only self) is updated
• renderer(self, ...) - defines how widget (only self) is rendered
• update(dt, ...) - defines how the widget and subtree is updated.
• draw(...) - defines how this subtree is drawn.
• getHovered() - returns topmost hovered widget
• reloadLayoutSelf() - reloads and recalculates self
• reloadLayout(doReload) - recalculates sizes etc. of the subtree
• reload() - reloads widget to default state (drop focus, clear buffers, reset scroll etc.)
• removeWidget() - removes from self
• getUI() - returns parent UI of the widget
• get*AABB - returns corresponding bounding boxes (available, visible, requested etc.)
• getOrigin() - returns real on screen origin of the element
• getHeight/Width() - returns requested size
• getCursor() - returns current cursor relative to requested upper-left corner
• setCursor(x, y) - sets cursor to the place where widget want's to render (upper-left corner of AABB)
• get/setRawCursor() - same as cursor but absoulte window position
• set[Visible]AvailAABB() - sets the widgets available [available visible] space for drawing
• isFocused() - true iff holds focus
• dropFocus() - called by self to drop focus
• requestFocus() - requests UI for focus
• requestDropFocus() - called by other widgets as "please, drop your focus mister". True on success drop
• mouseIn() - true if mouse is over self real visible AABB
• isHovered() - iff item is hovered and non other solid child is hovered
• getWidgetAt(x,y,solid) - returns deepest child with passThru=false at absolute x,y
• getWidgetByID(id) - self explainatory
• getRelativeMouse() - returns current mouse posistion relative to this element's origin

  events:

• mouseEntered() - event when mouse entered real visible AABB
• mouseExited() - same, but when it exits
• mousePressed(x,y,button) - when mouse pressed on this element
• mouseReleased(x,y,button) - when mouse released over this element
• wheelMoved(x, y) - when mouse wheel moved over this element
• keyPressed(key,scancode,isRepeat) - when keyboard pressed while focused
• keyReleased(key,scancode,isRepeat) - when keyboard released while focused
• ktextInput(text) - when love.keyboard.getTextInput and text is pressed
• file/diretoryDropped(file/path) - when file/directory dropped over this widget