Area

(PHP 7, UI 0.9.9)

Introduction

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

UI\Area extends UI\Control {

/* Constants */

const integer Ctrl ;

const integer Alt ;

const integer Shift ;

const integer Super ;

const integer Down ;

const integer 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 ( void )

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

public setSize ( UI\Size $size )

/* Inherited methods */

public UI\Control::destroy ( void )

public UI\Control::disable ( void )

public UI\Control::enable ( void )

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

public UI\Control::getTopLevel ( void ) : int

public UI\Control::hide ( void )

public UI\Control::isEnabled ( void ) : bool

public UI\Control::isVisible ( void ) : bool

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

public UI\Control::show ( void )

}

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