Area

    (UI 0.9.9)

    Introduction

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

    Class synopsis

    classUI\AreaextendsUI\Control {
    constintCtrl;
    constintAlt;
    constintShift;
    constintSuper;
    constintDown;
    constintUp;
    protectedonDraw(
        UI\Draw\Pen$pen,
        UI\Size$areaSize,
        UI\Point$clipPoint,
        UI\Size$clipSize
    )
    protectedonKey(string$key, int$ext, int$flags)
    protectedonMouse(UI\Point$areaPoint, UI\Size$areaSize, int$flags)
    publicredraw()
    publicscrollTo(UI\Point$point, UI\Size$size)
    publicsetSize(UI\Size$size)
    publicUI\Control::destroy()
    publicUI\Control::disable()
    publicUI\Control::enable()
    publicUI\Control::getParent(): UI\Control
    publicUI\Control::getTopLevel(): int
    publicUI\Control::hide()
    publicUI\Control::isEnabled(): bool
    publicUI\Control::isVisible(): bool
    publicUI\Control::setParent(UI\Control$parent)
    publicUI\Control::show()
    }

    Predefined Constants

    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

    To Top