Area

Introduction

An Area represents a canvas which can be used to draw, and respond to mouse and key events.

UI\Area

class UI\Area extends UI\Control {

/* Constants */

const int UI\Area::Ctrl;

const int UI\Area::Alt;

const int UI\Area::Shift;

const int UI\Area::Super;

const int UI\Area::Down;

const int UI\Area::Up;

/* Methods */

protected onDraw(
    UI\Draw\Pen $pen,
    UI\Size $areaSize,
    UI\Point $clipPoint,
    UI\Size $clipSize
)

protected onKey(string $key, int $ext, int $flags)

protected onMouse(UI\Point $areaPoint, UI\Size $areaSize, int $flags)

public redraw()

public scrollTo(UI\Point $point, UI\Size $size)

public setSize(UI\Size $size)

/* Inherited methods */

public UI\Control::destroy()

public UI\Control::disable()

public UI\Control::enable()

public UI\Control UI\Control::getParent()

public int UI\Control::getTopLevel()

public UI\Control::hide()

public bool UI\Control::isEnabled()

public bool UI\Control::isVisible()

public UI\Control::setParent(UI\Control $parent)

public UI\Control::show()

}

UI\Area::Ctrl: Shall be set in the modifiers passed to key and mouse events when the CTRL key is active
UI\Area::Alt: Shall be set in the modifiers passed to key and mouse events when the ALT key is active
UI\Area::Shift: Shall be set in the modifiers passed to key and mouse events when the SHIFT key is active
UI\Area::Super
UI\Area::Down: Shall be set in the modifiers passed to key and mouse events
UI\Area::Up: Shall be set in the modifiers passed to key and mouse events

Table of Contents