Book/ui-Phpdoc专题

UI

简介
安装／配置
- 需求
- 安装
UI\Point — Represents a position (x,y)
- UI\Point::at — Size Coercion
- UI\Point::__construct — Construct a new Point
- UI\Point::getX — Retrieves X
- UI\Point::getY — Retrieves Y
- UI\Point::setX — Set X
- UI\Point::setY — Set Y
UI\Size — Represents dimenstions (width, height)
- UI\Size::__construct — Construct a new Size
- UI\Size::getHeight — Retrieves Height
- UI\Size::getWidth — Retrives Width
- UI\Size::of — Point Coercion
- UI\Size::setHeight — Set Height
- UI\Size::setWidth — Set Width
UI\Window — Window
- UI\Window::add — Add a Control
- UI\Window::__construct — Construct a new Window
- UI\Window::error — Show Error Box
- UI\Window::getSize — Get Window Size
- UI\Window::getTitle — Get Title
- UI\Window::hasBorders — Border Detection
- UI\Window::hasMargin — Margin Detection
- UI\Window::isFullScreen — Full Screen Detection
- UI\Window::msg — Show Message Box
- UI\Window::onClosing — Closing Callback
- UI\Window::open — Open Dialog
- UI\Window::save — Save Dialog
- UI\Window::setBorders — Border Use
- UI\Window::setFullScreen — Full Screen Use
- UI\Window::setMargin — Margin Use
- UI\Window::setSize — Set Size
- UI\Window::setTitle — Window Title
UI\Control — Control
- UI\Control::destroy — Destroy Control
- UI\Control::disable — Disable Control
- UI\Control::enable — Enable Control
- UI\Control::getParent — Get Parent Control
- UI\Control::getTopLevel — Get Top Level
- UI\Control::hide — Hide Control
- UI\Control::isEnabled — Determine if Control is enabled
- UI\Control::isVisible — Determine if Control is visible
- UI\Control::setParent — Set Parent Control
- UI\Control::show — Control Show
UI\Menu — Menu
- UI\Menu::append — Append Menu Item
- UI\Menu::appendAbout — Append About Menu Item
- UI\Menu::appendCheck — Append Checkable Menu Item
- UI\Menu::appendPreferences — Append Preferences Menu Item
- UI\Menu::appendQuit — Append Quit Menu Item
- UI\Menu::appendSeparator — Append Menu Item Separator
- UI\Menu::__construct — Construct a new Menu
UI\MenuItem — Menu Item
- UI\MenuItem::disable — Disable Menu Item
- UI\MenuItem::enable — Enable Menu Item
- UI\MenuItem::isChecked — Detect Checked
- UI\MenuItem::onClick — On Click Callback
- UI\MenuItem::setChecked — Set Checked
UI\Area — Area
- UI\Area::onDraw — Draw Callback
- UI\Area::onKey — Key Callback
- UI\Area::onMouse — Mouse Callback
- UI\Area::redraw — Redraw Area
- UI\Area::scrollTo — Area Scroll
- UI\Area::setSize — Set Size
UI\Executor — Execution Scheduler
- UI\Executor::__construct — Construct a new Executor
- UI\Executor::kill — Stop Executor
- UI\Executor::onExecute — Execution Callback
- UI\Executor::setInterval — Interval Manipulation
UI\Controls\Tab — Tab Control
- UI\Controls\Tab::append — Append Page
- UI\Controls\Tab::delete — Delete Page
- UI\Controls\Tab::hasMargin — Margin Detection
- UI\Controls\Tab::insertAt — Insert Page
- UI\Controls\Tab::pages — Page Count
- UI\Controls\Tab::setMargin — Set Margin
UI\Controls\Check — Check Control
- UI\Controls\Check::__construct — Construct a new Check
- UI\Controls\Check::getText — Get Text
- UI\Controls\Check::isChecked — Checked Detection
- UI\Controls\Check::onToggle — Toggle Callback
- UI\Controls\Check::setChecked — Set Checked
- UI\Controls\Check::setText — Set Text
UI\Controls\Button — Button Control
- UI\Controls\Button::__construct — Construct a new Button
- UI\Controls\Button::getText — Get Text
- UI\Controls\Button::onClick — Click Handler
- UI\Controls\Button::setText — Set Text
UI\Controls\ColorButton — ColorButton Control
- UI\Controls\ColorButton::getColor — Get Color
- UI\Controls\ColorButton::onChange — Change Handler
- UI\Controls\ColorButton::setColor — Set Color
UI\Controls\Label — Label Control
- UI\Controls\Label::__construct — Construct a new Label
- UI\Controls\Label::getText — Get Text
- UI\Controls\Label::setText — Set Text
UI\Controls\Entry — Entry Control
- UI\Controls\Entry::__construct — Construct a new Entry
- UI\Controls\Entry::getText — Get Text
- UI\Controls\Entry::isReadOnly — Detect Read Only
- UI\Controls\Entry::onChange — Change Handler
- UI\Controls\Entry::setReadOnly — Set Read Only
- UI\Controls\Entry::setText — Set Text
UI\Controls\MultilineEntry — MultilineEntry Control
- UI\Controls\MultilineEntry::append — Append Text
- UI\Controls\MultilineEntry::__construct — Construct a new Multiline Entry
- UI\Controls\MultilineEntry::getText — Get Text
- UI\Controls\MultilineEntry::isReadOnly — Read Only Detection
- UI\Controls\MultilineEntry::onChange — Change Handler
- UI\Controls\MultilineEntry::setReadOnly — Set Read Only
- UI\Controls\MultilineEntry::setText — Set Text
UI\Controls\Spin — Spin Control
- UI\Controls\Spin::__construct — Construct a new Spin
- UI\Controls\Spin::getValue — Get Value
- UI\Controls\Spin::onChange — Change Handler
- UI\Controls\Spin::setValue — Set Value
UI\Controls\Slider — Slider Control
- UI\Controls\Slider::__construct — Construct a new Slider
- UI\Controls\Slider::getValue — Get Value
- UI\Controls\Slider::onChange — Change Handler
- UI\Controls\Slider::setValue — Set Value
UI\Controls\Progress — Progress Control
- UI\Controls\Progress::getValue — Get Value
- UI\Controls\Progress::setValue — Set Value
UI\Controls\Separator — Control Separator
- UI\Controls\Separator::__construct — Construct a new Separator
UI\Controls\Combo — Combo Control
- UI\Controls\Combo::append — Append Option
- UI\Controls\Combo::getSelected — Get Selected Option
- UI\Controls\Combo::onSelected — Selected Handler
- UI\Controls\Combo::setSelected — Set Selected Option
UI\Controls\EditableCombo — EdiableCombo Control
- UI\Controls\EditableCombo::append — Append Option
- UI\Controls\EditableCombo::getText — Get Text
- UI\Controls\EditableCombo::onChange — Change Handler
- UI\Controls\EditableCombo::setText — Set Text
UI\Controls\Radio — Radio Control
- UI\Controls\Radio::append — Append Option
- UI\Controls\Radio::getSelected — Get Selected Option
- UI\Controls\Radio::onSelected — Selected Handler
- UI\Controls\Radio::setSelected — Set Selected Option
UI\Controls\Picker — Picker Control
- UI\Controls\Picker::__construct — Construct a new Picker
UI\Controls\Form — Control Form (Arrangement)
- UI\Controls\Form::append — Append Control
- UI\Controls\Form::delete — Delete Control
- UI\Controls\Form::isPadded — Padding Detection
- UI\Controls\Form::setPadded — Set Padding
UI\Controls\Grid — Control Grid (Arrangement)
- UI\Controls\Grid::append — Append Control
- UI\Controls\Grid::isPadded — Padding Detection
- UI\Controls\Grid::setPadded — Set Padding
UI\Controls\Group — Control Group (Arrangement)
- UI\Controls\Group::append — Append Control
- UI\Controls\Group::__construct — Construct a new Group
- UI\Controls\Group::getTitle — Get Title
- UI\Controls\Group::hasMargin — Margin Detection
- UI\Controls\Group::setMargin — Set Margin
- UI\Controls\Group::setTitle — Set Title
UI\Controls\Box — Control Box (Arrangement)
- UI\Controls\Box::append — Append Control
- UI\Controls\Box::__construct — Construct a new Box
- UI\Controls\Box::delete — Delete Control
- UI\Controls\Box::getOrientation — Get Orientation
- UI\Controls\Box::isPadded — Padding Detection
- UI\Controls\Box::setPadded — Set Padding
UI\Draw\Pen — Draw Pen
- UI\Draw\Pen::clip — Clip a Path
- UI\Draw\Pen::fill — Fill a Path
- UI\Draw\Pen::restore — Restore
- UI\Draw\Pen::save — Save
- UI\Draw\Pen::stroke — Stroke a Path
- UI\Draw\Pen::transform — Matrix Transform
- UI\Draw\Pen::write — Draw Text at Point
UI\Draw\Path — Draw Path
- UI\Draw\Path::addRectangle — Draw a Rectangle
- UI\Draw\Path::arcTo — Draw an Arc
- UI\Draw\Path::bezierTo — Draw Bezier Curve
- UI\Draw\Path::closeFigure — Close Figure
- UI\Draw\Path::__construct — Construct a new Path
- UI\Draw\Path::end — Finalize Path
- UI\Draw\Path::lineTo — Draw a Line
- UI\Draw\Path::newFigure — Draw Figure
- UI\Draw\Path::newFigureWithArc — Draw Figure with Arc
UI\Draw\Matrix — Draw Matrix
- UI\Draw\Matrix::invert — Invert Matrix
- UI\Draw\Matrix::isInvertible — Invertible Detection
- UI\Draw\Matrix::multiply — Multiply Matrix
- UI\Draw\Matrix::rotate — Rotate Matrix
- UI\Draw\Matrix::scale — Scale Matrix
- UI\Draw\Matrix::skew — Skew Matrix
- UI\Draw\Matrix::translate — Translate Matrix
UI\Draw\Color — Color Representation
- UI\Draw\Color::__construct — Construct new Color
- UI\Draw\Color::getChannel — Color Manipulation
- UI\Draw\Color::setChannel — Color Manipulation
UI\Draw\Stroke — Draw Stroke
- UI\Draw\Stroke::__construct — Construct a new Stroke
- UI\Draw\Stroke::getCap — Get Line Cap
- UI\Draw\Stroke::getJoin — Get Line Join
- UI\Draw\Stroke::getMiterLimit — Get Miter Limit
- UI\Draw\Stroke::getThickness — Get Thickness
- UI\Draw\Stroke::setCap — Set Line Cap
- UI\Draw\Stroke::setJoin — Set Line Join
- UI\Draw\Stroke::setMiterLimit — Set Miter Limit
- UI\Draw\Stroke::setThickness — Set Thickness
UI\Draw\Brush — Brushes
- UI\Draw\Brush::__construct — Construct a new Brush
- UI\Draw\Brush::getColor — Get Color
- UI\Draw\Brush::setColor — Set Color
UI\Draw\Brush\Gradient — Gradient Brushes
- UI\Draw\Brush\Gradient::addStop — Stop Manipulation
- UI\Draw\Brush\Gradient::delStop — Stop Manipulation
- UI\Draw\Brush\Gradient::setStop — Stop Manipulation
UI\Draw\Brush\LinearGradient — Linear Gradient
- UI\Draw\Brush\LinearGradient::__construct — Construct a Linear Gradient
UI\Draw\Brush\RadialGradient — Radial Gradient
- UI\Draw\Brush\RadialGradient::__construct — Construct a new Radial Gradient
UI\Draw\Text\Layout — Represents Text Layout
- UI\Draw\Text\Layout::__construct — Construct a new Text Layout
- UI\Draw\Text\Layout::setColor — Set Color
- UI\Draw\Text\Layout::setWidth — Set Width
UI\Draw\Text\Font — Represents a Font
- UI\Draw\Text\Font::__construct — Construct a new Font
- UI\Draw\Text\Font::getAscent — Font Metrics
- UI\Draw\Text\Font::getDescent — Font Metrics
- UI\Draw\Text\Font::getLeading — Font Metrics
- UI\Draw\Text\Font::getUnderlinePosition — Font Metrics
- UI\Draw\Text\Font::getUnderlineThickness — Font Metrics
UI\Draw\Text\Font\Descriptor — Font Descriptor
- UI\Draw\Text\Font\Descriptor::__construct — Construct a new Font Descriptor
- UI\Draw\Text\Font\Descriptor::getFamily — Get Font Family
- UI\Draw\Text\Font\Descriptor::getItalic — Style Detection
- UI\Draw\Text\Font\Descriptor::getSize — Size Detection
- UI\Draw\Text\Font\Descriptor::getStretch — Style Detection
- UI\Draw\Text\Font\Descriptor::getWeight — Weight Detection
UI 函数
- UI\Draw\Text\Font\fontFamilies — Retrieve Font Families
- UI\quit — Quit UI Loop
- UI\run — Enter UI Loop
UI\Draw\Text\Font\Weight — Font Weight Settings
UI\Draw\Text\Font\Italic — Italic Font Settings
UI\Draw\Text\Font\Stretch — Font Stretch Settings
UI\Draw\Line\Cap — Line Cap Settings
UI\Draw\Line\Join — Line Join Settings
UI\Key — Key Identifiers
UI\Exception\InvalidArgumentException — InvalidArgumentException
UI\Exception\RuntimeException — RuntimeException

简介

Points are used throughout UI to represent co-ordinates on a screen, control, or area.

类摘要

UI\Point

final class UI\Point {

/* 属性 */

public $x ;

public $y ;

/* Constructor */

public __construct ( float $x , float $y )

/* 方法 */

public static UI\Point at ( float $point )

public static UI\Point at ( UI\Size $size )

public float getX ( void )

public float getY ( void )

public setX ( float $point )

public setY ( float $point )

}

属性

x
Holds the X co-ordinate, can be read/written directly

y
Holds the Y co-ordinate, can be read/written directly

UI\Point::at

Size Coercion

说明

public static UI\Point UI\Point::at ( float $point )

public static UI\Point UI\Point::at ( UI\Size $size )

Shall return a UI\Point object where x and y are equal to those supplied, either in float or UI\Size form

参数

point
The value for x and y

size
The Size to convert

返回值

The resulting Point

UI\Point::__construct

Construct a new Point

说明

public UI\Point::__construct ( float $x , float $y )

Construct a new Point using new co-ordinates

参数

x
The new X co-ordinate

y
The new Y co-ordinate

UI\Point::getX

Retrieves X

说明

public float UI\Point::getX ( void )

Retrieves the X co-ordinate

参数

此函数没有参数。

返回值

The current X co-ordinate

UI\Point::getY

Retrieves Y

说明

public float UI\Point::getY ( void )

Retrieves the Y co-ordinate

参数

此函数没有参数。

返回值

The current Y co-ordinate

UI\Point::setX

Set X

说明

public UI\Point::setX ( float $point )

Set the X co-ordinate

参数

point
The new X co-ordinate

返回值

UI\Point::setY

Set Y

说明

public UI\Point::setY ( float $point )

Set the Y co-ordinate

参数

point
The new Y co-ordinate

返回值

简介

Sizes are used throughout UI to represent the size of a screen, control, or area.

类摘要

UI\Size

final class UI\Size {

/* 属性 */

public $width ;

public $height ;

/* Constructor */

public __construct ( float $width , float $height )

/* 方法 */

public float getHeight ( void )

public float getWidth ( void )

public static UI\Size of ( float $size )

public static UI\Size of ( UI\Point $point )

public setHeight ( float $size )

public setWidth ( float $size )

}

属性

width
Holds the width, can be read/written directly

height
Holds the height, can be read/written directly

UI\Size::__construct

Construct a new Size

说明

public UI\Size::__construct ( float $width , float $height )

Construct a new Size using new width and height

参数

width
The new width

height
The new height

UI\Size::getHeight

Retrieves Height

说明

public float UI\Size::getHeight ( void )

Retrieves the Height

参数

此函数没有参数。

返回值

The current Height

UI\Size::getWidth

Retrives Width

说明

public float UI\Size::getWidth ( void )

Retrieves the Width

参数

此函数没有参数。

返回值

The current Width

UI\Size::of

Point Coercion

说明

public static UI\Size UI\Size::of ( float $size )

public static UI\Size UI\Size::of ( UI\Point $point )

Shall return a UI\Size object where width and height are equal to those supplied, either in float or UI\Point form

参数

size
The value for width and height

point
The Point to convert

返回值

The resulting Size

UI\Size::setHeight

Set Height

说明

public UI\Size::setHeight ( float $size )

Set new Height

参数

size
The new Height

返回值

UI\Size::setWidth

Set Width

说明

public UI\Size::setWidth ( float $size )

Set new Width

参数

size
The new Width

返回值

简介

Represents a UI Window

类摘要

UI\Window

class UI\Window extends UI\Control {

/* 属性 */

protected $controls ;

/* Constructor */

public __construct ( string $title , Size $size [, bool $menu = false ] )

/* 方法 */

public add ( UI\Control $control )

public error ( string $title , string $msg )

public UI\Size getSize ( void )

public string getTitle ( void )

public bool hasBorders ( void )

public bool hasMargin ( void )

public bool isFullScreen ( void )

public msg ( string $title , string $msg )

protected int onClosing ( void )

public string open ( void )

public string save ( void )

public setBorders ( bool $borders )

public setFullScreen ( bool $full )

public setMargin ( bool $margin )

public setSize ( UI\Size $size )

public setTitle ( string $title )

/* 继承的方法 */

public UI\Control::destroy ( void )

public UI\Control::disable ( void )

public UI\Control::enable ( void )

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

public int UI\Control::getTopLevel ( void )

public UI\Control::hide ( void )

public bool UI\Control::isEnabled ( void )

public bool UI\Control::isVisible ( void )

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

public UI\Control::show ( void )

}

属性

controls
Contains controls, should not be manipulated directly

UI\Window::add

Add a Control

说明

public UI\Window::add ( UI\Control $control )

Shall add a Control to this Window

参数

control
The Control to add

返回值

UI\Window::__construct

Construct a new Window

说明

public UI\Window::__construct ( string $title , Size $size [, bool $menu = false ] )

Shall construct a new Window

参数

title
The title of the Window

size
The size of the Window

menu
Menu switch

UI\Window::error

Show Error Box

说明

public UI\Window::error ( string $title , string $msg )

Shall show an error box

参数

title
The title of the error box

msg
The message for the error box

UI\Window::getSize

Get Window Size

说明

public UI\Size UI\Window::getSize ( void )

Shall return the size of this Window

参数

此函数没有参数。

返回值

UI\Window::getTitle

Get Title

说明

public string UI\Window::getTitle ( void )

Shall retrieve the title of this Window

参数

此函数没有参数。

返回值

UI\Window::hasBorders

Border Detection

说明

public bool UI\Window::hasBorders ( void )

Shall detect if borders are used on this Window

参数

此函数没有参数。

返回值

UI\Window::hasMargin

Margin Detection

说明

public bool UI\Window::hasMargin ( void )

Shall detect if margins are used on this Window

参数

此函数没有参数。

返回值

UI\Window::isFullScreen

Full Screen Detection

说明

public bool UI\Window::isFullScreen ( void )

Shall detect if this Window us using the whole screen

参数

此函数没有参数。

返回值

UI\Window::msg

Show Message Box

说明

public UI\Window::msg ( string $title , string $msg )

Shall show a message box

参数

title
The title of the message box

msg
The message

UI\Window::onClosing

Closing Callback

说明

protected int UI\Window::onClosing ( void )

Should gracefully destroy this Window

参数

此函数没有参数。

返回值

UI\Window::open

Open Dialog

说明

public string UI\Window::open ( void )

Shall show an open file dialog

参数

此函数没有参数。

返回值

Returns the name of the file selected for opening

UI\Window::save

Save Dialog

说明

public string UI\Window::save ( void )

Shall show a save dialog

参数

此函数没有参数。

返回值

Returns the file name selecting for saving

UI\Window::setBorders

Border Use

说明

public UI\Window::setBorders ( bool $borders )

Shall enable or disable the use of borders on this Window

参数

borders

UI\Window::setFullScreen

Full Screen Use

说明

public UI\Window::setFullScreen ( bool $full )

Shall enable or disable the use of the full screen for this Window

Warning

本函数还未编写文档，仅有参数列表。

参数

full

UI\Window::setMargin

Margin Use

说明

public UI\Window::setMargin ( bool $margin )

Shall enable or disable the use of margins for this Window

参数

margin

UI\Window::setSize

Set Size

说明

public UI\Window::setSize ( UI\Size $size )

Shall set the size of this Window

参数

size

返回值

UI\Window::setTitle

Window Title

说明

public UI\Window::setTitle ( string $title )

Shall set the title for this Window

参数

title
The new title

简介

This is the closed base class for all UI Controls.

类摘要

UI\Control

final class UI\Control {

/* 方法 */

public destroy ( void )

public disable ( void )

public enable ( void )

public UI\Control getParent ( void )

public int getTopLevel ( void )

public hide ( void )

public bool isEnabled ( void )

public bool isVisible ( void )

public setParent ( UI\Control $parent )

public show ( void )

}

UI\Control::destroy

Destroy Control

说明

public UI\Control::destroy ( void )

Shall destroy this Control

参数

此函数没有参数。

返回值

UI\Control::disable

Disable Control

说明

public UI\Control::disable ( void )

Shall disable this Control

参数

此函数没有参数。

返回值

UI\Control::enable

Enable Control

说明

public UI\Control::enable ( void )

Shall enable this Control

参数

此函数没有参数。

返回值

UI\Control::getParent

Get Parent Control

说明

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

Shall return the parent Control

参数

此函数没有参数。

返回值

UI\Control::getTopLevel

Get Top Level

说明

public int UI\Control::getTopLevel ( void )

Warning

本函数还未编写文档，仅有参数列表。

参数

此函数没有参数。

返回值

UI\Control::hide

Hide Control

说明

public UI\Control::hide ( void )

Shall hide this Control

参数

此函数没有参数。

返回值

UI\Control::isEnabled

Determine if Control is enabled

说明

public bool UI\Control::isEnabled ( void )

Shall detect if this Control is enabled

参数

此函数没有参数。

返回值

UI\Control::isVisible

Determine if Control is visible

说明

public bool UI\Control::isVisible ( void )

Shall detect if this Control is visible

参数

此函数没有参数。

返回值

UI\Control::setParent

Set Parent Control

说明

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

Shall set the parent Control of this Control

参数

parent
The parent Control

返回值

UI\Control::show

Control Show

说明

public UI\Control::show ( void )

Shall show this Control

参数

此函数没有参数。

返回值

简介

Menus must be constructed before the first Window, and can be shown on any Window

类摘要

UI\Menu

class UI\Menu {

/* Constructor */

public __construct ( string $name )

/* 方法 */

public UI\MenuItem append ( string $name [, string $type = UI\MenuItem::class ] )

public UI\MenuItem appendAbout ([ string $type = UI\MenuItem::class ] )

public UI\MenuItem appendCheck ( string $name [, string $type = UI\MenuItem::class ] )

public UI\MenuItem appendPreferences ([ string $type = UI\MenuItem::class ] )

public UI\MenuItem appendQuit ([ string $type = UI\MenuItem::class ] )

public appendSeparator ( void )

}

UI\Menu::append

Append Menu Item

说明

public UI\MenuItem UI\Menu::append ( string $name [, string $type = UI\MenuItem::class ] )

Shall append a new Menu Item

参数

name
The name (text) for the new item

type
The type for the new item

返回值

A constructed object of the given type

UI\Menu::appendAbout

Append About Menu Item

说明

public UI\MenuItem UI\Menu::appendAbout ([ string $type = UI\MenuItem::class ] )

Shall append an About menu item

参数

type
The type for the new item

返回值

A constructed About menu item of the given type

UI\Menu::appendCheck

Append Checkable Menu Item

说明

public UI\MenuItem UI\Menu::appendCheck ( string $name [, string $type = UI\MenuItem::class ] )

Shall append a checkable menu item

参数

name
The name (text) for the new item

type
The type for the new item

返回值

A constructed checkable menu item of the given type

UI\Menu::appendPreferences

Append Preferences Menu Item

说明

public UI\MenuItem UI\Menu::appendPreferences ([ string $type = UI\MenuItem::class ] )

Shall append a Preferences menu item

参数

type
The type for the new item

返回值

A constructed Preferences menu item of the given type

UI\Menu::appendQuit

Append Quit Menu Item

说明

public UI\MenuItem UI\Menu::appendQuit ([ string $type = UI\MenuItem::class ] )

Shall append a Quit menu item

参数

type
The type for the new item

返回值

A constructed Quit menu item of the given type

UI\Menu::appendSeparator

Append Menu Item Separator

说明

public UI\Menu::appendSeparator ( void )

Shall append a separator

参数

此函数没有参数。

UI\Menu::__construct

Construct a new Menu

说明

public UI\Menu::__construct ( string $name )

Shall construct a new Menu

参数

name
The name (text) for the menu

简介

Menu Items should only be created by the Menu

类摘要

UI\MenuItem

class UI\MenuItem {

/* 方法 */

public disable ( void )

public enable ( void )

public bool isChecked ( void )

protected onClick ( void )

public setChecked ( bool $checked )

}

UI\MenuItem::disable

Disable Menu Item

说明

public UI\MenuItem::disable ( void )

Shall disable this Menu Item

参数

此函数没有参数。

UI\MenuItem::enable

Enable Menu Item

说明

public UI\MenuItem::enable ( void )

Shall enable this Menu Item

参数

此函数没有参数。

UI\MenuItem::isChecked

Detect Checked

说明

public bool UI\MenuItem::isChecked ( void )

Shall detect if this Menu Item is checked

参数

此函数没有参数。

UI\MenuItem::onClick

On Click Callback

说明

protected UI\MenuItem::onClick ( void )

Shall be executed when this Menu Item is clicked

参数

此函数没有参数。

UI\MenuItem::setChecked

Set Checked

说明

public UI\MenuItem::setChecked ( bool $checked )

Shall set the checked status of this Menu Item

参数

checked
The new status

简介

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 ;

/* 方法 */

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 )

/* 继承的方法 */

public UI\Control::destroy ( void )

public UI\Control::disable ( void )

public UI\Control::enable ( void )

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

public int UI\Control::getTopLevel ( void )

public UI\Control::hide ( void )

public bool UI\Control::isEnabled ( void )

public bool UI\Control::isVisible ( void )

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

UI\Area::onDraw

Draw Callback

说明

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

Shall be invoked when this Area requires redrawing

参数

pen
A Pen suitable for drawing in this Area

areaSize
The size of the Area

clipPoint
The clip point of the Area

clipSize
The clip size of the Area

UI\Area::onKey

Key Callback

说明

protected UI\Area::onKey ( string $key , int $ext , int $flags )

Shall be executed on key events

参数

key
The key pressed

ext
The extended key pressed

flags
Event modifiers

返回值

UI\Area::onMouse

Mouse Callback

说明

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

Shall be executed on mouse events

参数

areaPoint
The co-ordinates of the event

areaSize
The size of the area of the event

flags
Event modifiers

UI\Area::redraw

Redraw Area

说明

public UI\Area::redraw ( void )

Requests that this Area is redrawn

参数

此函数没有参数。

返回值

UI\Area::scrollTo

Area Scroll

说明

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

Scroll this Area

参数

point
The point to scroll to

size
The size of the scroll pane

UI\Area::setSize

Set Size

说明

public UI\Area::setSize ( UI\Size $size )

Sets the size of this Area

参数

size
The new size

简介

This facility schedules repetitive execution of a callback, useful for animations and other such activities.

类摘要

UI\Executor

abstract class UI\Executor {

/* Constructor */

public __construct ( void )

public __construct ( int $microseconds )

public __construct ( int $seconds , int $microseconds )

/* 方法 */

public void kill ( void )

abstract protected void onExecute ( void )

public bool setInterval ( int $microseconds )

public bool setInterval ( int $seconds , int $microseconds )

}

UI\Executor::__construct

Construct a new Executor

说明

public UI\Executor::__construct ( void )

public UI\Executor::__construct ( int $microseconds )

public UI\Executor::__construct ( int $seconds , int $microseconds )

Shall construct an executor with the given interval, will not start executing until main loop is entered

参数

seconds
Seconds between executions

microseconds
Microseconds between executions

UI\Executor::kill

Stop Executor

说明

public void UI\Executor::kill ( void )

Shall stop an executor, the executor cannot be restarted

参数

此函数没有参数。

返回值

UI\Executor::onExecute

Execution Callback

说明

abstract protected void UI\Executor::onExecute ( void )

Shall be repetitively queued for execution in the main thread

参数

此函数没有参数。

返回值

UI\Executor::setInterval

Interval Manipulation

说明

public bool UI\Executor::setInterval ( int $microseconds )

public bool UI\Executor::setInterval ( int $seconds , int $microseconds )

Shall set the new interval. An interval of 0 will pause the executor until a new interval has been set

参数

seconds

microseconds

返回值

Indication of success

简介

A Tab can contain many pages of Controls, each with a title, each selectable by the user.

类摘要

UI\Controls\Tab

class UI\Controls\Tab extends UI\Control {

/* 属性 */

protected $controls ;

/* 方法 */

public int append ( string $name , UI\Control $control )

public bool delete ( int $index )

public bool hasMargin ( int $page )

public insertAt ( string $name , int $page , UI\Control $control )

public int pages ( void )

public setMargin ( int $page , bool $margin )

/* 继承的方法 */

public UI\Control::destroy ( void )

public UI\Control::disable ( void )

public UI\Control::enable ( void )

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

public int UI\Control::getTopLevel ( void )

public UI\Control::hide ( void )

public bool UI\Control::isEnabled ( void )

public bool UI\Control::isVisible ( void )

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

public UI\Control::show ( void )

}

属性

controls
Contains controls, should not be manipulated directly

UI\Controls\Tab::append

Append Page

说明

public int UI\Controls\Tab::append ( string $name , UI\Control $control )

Append a new page to this Tab

参数

name
The name for the new page

control
The control for the new page

返回值

Shall return the index of the appended control, may be 0

UI\Controls\Tab::delete

Delete Page

说明

public bool UI\Controls\Tab::delete ( int $index )

Shall remove the selected page from this Tab

参数

index
The index of the page to remove

返回值

Indication of success

UI\Controls\Tab::hasMargin

Margin Detection

说明

public bool UI\Controls\Tab::hasMargin ( int $page )

Shall detect if the given page has a margin.

参数

page
The index of the page

返回值

UI\Controls\Tab::insertAt

Insert Page

说明

public UI\Controls\Tab::insertAt ( string $name , int $page , UI\Control $control )

Shall insert a new page into this Tab

参数

name
The name for the new page

page
The index to perform the insertion before

control
The control for the new page

UI\Controls\Tab::pages

Page Count

说明

public int UI\Controls\Tab::pages ( void )

Shall return the number of pages in this Tab

参数

此函数没有参数。

返回值

The number of pages in this Tab

UI\Controls\Tab::setMargin

Set Margin

说明

public UI\Controls\Tab::setMargin ( int $page , bool $margin )

Shall enable or disable margins on the selected page

参数

page
The page to select

margin
Margin switch

简介

A Check is a labelled checkable box

类摘要

UI\Controls\Check

class UI\Controls\Check extends UI\Control {

/* Constructor */

public __construct ( string $text )

/* 方法 */

public string getText ( void )

public bool isChecked ( void )

protected onToggle ( void )

public setChecked ( bool $checked )

public setText ( string $text )

/* 继承的方法 */

public UI\Control::destroy ( void )

public UI\Control::disable ( void )

public UI\Control::enable ( void )

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

public int UI\Control::getTopLevel ( void )

public UI\Control::hide ( void )

public bool UI\Control::isEnabled ( void )

public bool UI\Control::isVisible ( void )

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

public UI\Control::show ( void )

}

UI\Controls\Check::__construct

Construct a new Check

说明

public UI\Controls\Check::__construct ( string $text )

Shall construct a new Check

参数

text
The text (label) for the Check box

UI\Controls\Check::getText

Get Text

说明

public string UI\Controls\Check::getText ( void )

Shall return the text (label) for this Check

参数

此函数没有参数。

返回值

The current text (label)

UI\Controls\Check::isChecked

Checked Detection

说明

public bool UI\Controls\Check::isChecked ( void )

Shall detect the status of this Check

参数

此函数没有参数。

UI\Controls\Check::onToggle

Toggle Callback

说明

protected UI\Controls\Check::onToggle ( void )

Shall be executed when the status of this Check is changed

参数

此函数没有参数。

UI\Controls\Check::setChecked

Set Checked

说明

public UI\Controls\Check::setChecked ( bool $checked )

Shall change the status of this Check

参数

checked
The new status

UI\Controls\Check::setText

Set Text

说明

public UI\Controls\Check::setText ( string $text )

Shall set the text (label) for this Check

参数

text
The new text (label)

简介

Represents a labelled clickable button

类摘要

UI\Controls\Button

class UI\Controls\Button extends UI\Control {

/* Constructor */

public __construct ( string $text )

/* 方法 */

public string getText ( void )

protected onClick ( void )

public setText ( string $text )

/* 继承的方法 */

public UI\Control::destroy ( void )

public UI\Control::disable ( void )

public UI\Control::enable ( void )

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

public int UI\Control::getTopLevel ( void )

public UI\Control::hide ( void )

public bool UI\Control::isEnabled ( void )

public bool UI\Control::isVisible ( void )

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

public UI\Control::show ( void )

}

UI\Controls\Button::__construct

Construct a new Button

说明

public UI\Controls\Button::__construct ( string $text )

Shall construct a new Button

参数

text
The text (label) for this Button

UI\Controls\Button::getText

Get Text

说明

public string UI\Controls\Button::getText ( void )

Shall retrieve the text (label) for this Button

参数

此函数没有参数。

返回值

The current text (label)

UI\Controls\Button::onClick

Click Handler

说明

protected UI\Controls\Button::onClick ( void )

Shall be executed when this Button is clicked

参数

此函数没有参数。

UI\Controls\Button::setText

Set Text

说明

public UI\Controls\Button::setText ( string $text )

Shall set the text (label) for this Button

参数

text
The new text (label)

简介

A Color Button is a button which displays a color picker when clicked

类摘要

UI\Controls\ColorButton

class UI\Controls\ColorButton extends UI\Control {

/* 方法 */

public UI\Color getColor ( void )

protected onChange ( void )

public setColor ( UI\Draw\Color $color )

public setColor ( int $color )

/* 继承的方法 */

public UI\Control::destroy ( void )

public UI\Control::disable ( void )

public UI\Control::enable ( void )

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

public int UI\Control::getTopLevel ( void )

public UI\Control::hide ( void )

public bool UI\Control::isEnabled ( void )

public bool UI\Control::isVisible ( void )

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

public UI\Control::show ( void )

}

UI\Controls\ColorButton::getColor

Get Color

说明

public UI\Color UI\Controls\ColorButton::getColor ( void )

Shall retrieve the currently selected Color

参数

此函数没有参数。

返回值

UI\Controls\ColorButton::onChange

Change Handler

说明

protected UI\Controls\ColorButton::onChange ( void )

Shall be executed when the selected Color is changed

参数

此函数没有参数。

UI\Controls\ColorButton::setColor

Set Color

说明

public UI\Controls\ColorButton::setColor ( UI\Draw\Color $color )

public UI\Controls\ColorButton::setColor ( int $color )

Shall set the currently selected Color

参数

color
The new color

简介

A Label is a single line of text, meant to identify, for the user, some element of the interface.

类摘要

UI\Controls\Label

class UI\Controls\Label extends UI\Control {

/* Constructor */

public __construct ( string $text )

/* 方法 */

public string getText ( void )

public setText ( string $text )

/* 继承的方法 */

public UI\Control::destroy ( void )

public UI\Control::disable ( void )

public UI\Control::enable ( void )

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

public int UI\Control::getTopLevel ( void )

public UI\Control::hide ( void )

public bool UI\Control::isEnabled ( void )

public bool UI\Control::isVisible ( void )

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

public UI\Control::show ( void )

}

UI\Controls\Label::__construct

Construct a new Label

说明

public UI\Controls\Label::__construct ( string $text )

Shall construct a new Label

参数

text
The text for this label

UI\Controls\Label::getText

Get Text

说明

public string UI\Controls\Label::getText ( void )

Shall return the current text for this Label

Warning

本函数还未编写文档，仅有参数列表。

参数

此函数没有参数。

返回值

UI\Controls\Label::setText

Set Text

说明

public UI\Controls\Label::setText ( string $text )

Shall set the text for this Label

参数

text
The new text

简介

An Entry is a text entry control, suitable for entering plain text, passwords, or search terms.

类摘要

UI\Controls\Entry

class UI\Controls\Entry extends UI\Control {

/* Constants */

const int UI\Controls\Entry::Normal ;

const int UI\Controls\Entry::Password ;

const int UI\Controls\Entry::Search ;

/* Constructor */

public __construct ([ int $type = UI\Controls\Entry::Normal ] )

/* 方法 */

public string getText ( void )

public bool isReadOnly ( void )

protected onChange ( void )

public setReadOnly ( bool $readOnly )

public setText ( string $text )

/* 继承的方法 */

public UI\Control::destroy ( void )

public UI\Control::disable ( void )

public UI\Control::enable ( void )

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

public int UI\Control::getTopLevel ( void )

public UI\Control::hide ( void )

public bool UI\Control::isEnabled ( void )

public bool UI\Control::isVisible ( void )

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

public UI\Control::show ( void )

}

预定义常量

UI\Controls\Entry::Normal
A normal single line entry

UI\Controls\Entry::Password
A password entry

UI\Controls\Entry::Search
A search entry

UI\Controls\Entry::__construct

Construct a new Entry

说明

public UI\Controls\Entry::__construct ([ int $type = UI\Controls\Entry::Normal ] )

Construct a new entry of the given type

参数

type
Entry::Normal, Entry::Password, or Entry::Search

UI\Controls\Entry::getText

Get Text

说明

public string UI\Controls\Entry::getText ( void )

Shall return the current text from this Entry

参数

此函数没有参数。

返回值

The current text

UI\Controls\Entry::isReadOnly

Detect Read Only

说明

public bool UI\Controls\Entry::isReadOnly ( void )

Shall detect if this Entry is read only

参数

此函数没有参数。

返回值

UI\Controls\Entry::onChange

Change Handler

说明

protected UI\Controls\Entry::onChange ( void )

Shall be executed when the text in this Entry changes

参数

此函数没有参数。

UI\Controls\Entry::setReadOnly

Set Read Only

说明

public UI\Controls\Entry::setReadOnly ( bool $readOnly )

Shall enable or disable read only for this Entry

参数

readOnly

UI\Controls\Entry::setText

Set Text

说明

public UI\Controls\Entry::setText ( string $text )

Shall set the text for this Entry

参数

text
The new text

简介

A Multiline Entry is a text entry control able to hold multiple lines of text, with or without wrapping.

类摘要

UI\Controls\MultilineEntry

class UI\Controls\MultilineEntry extends UI\Control {

/* Constants */

const int UI\Controls\MultilineEntry::Wrap ;

const int UI\Controls\MultilineEntry::NoWrap ;

/* Constructor */

public __construct ([ int $type ] )

/* 方法 */

public append ( string $text )

public string getText ( void )

public bool isReadOnly ( void )

protected onChange ( void )

public setReadOnly ( bool $readOnly )

public setText ( string $text )

/* 继承的方法 */

public UI\Control::destroy ( void )

public UI\Control::disable ( void )

public UI\Control::enable ( void )

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

public int UI\Control::getTopLevel ( void )

public UI\Control::hide ( void )

public bool UI\Control::isEnabled ( void )

public bool UI\Control::isVisible ( void )

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

public UI\Control::show ( void )

}

预定义常量

UI\Controls\MultilineEntry::Wrap
Allow lines to wrap

UI\Controls\MultilineEntry::NoWrap
Do not allow lines to wrap

UI\Controls\MultilineEntry::append

Append Text

说明

public UI\Controls\MultilineEntry::append ( string $text )

Shall append the given text to the text in this Multiline Entry

参数

text
The text to append

UI\Controls\MultilineEntry::__construct

Construct a new Multiline Entry

说明

public UI\Controls\MultilineEntry::__construct ([ int $type ] )

Shall construct a new Multiline Entry of the given type

参数

type
MultilineEntry::Wrap or MultilineEntry::NoWrap

UI\Controls\MultilineEntry::getText

Get Text

说明

public string UI\Controls\MultilineEntry::getText ( void )

Shall return the text in this Multiline Entry

参数

此函数没有参数。

UI\Controls\MultilineEntry::isReadOnly

Read Only Detection

说明

public bool UI\Controls\MultilineEntry::isReadOnly ( void )

Shall detect if this Multiline Entry is read only

参数

此函数没有参数。

UI\Controls\MultilineEntry::onChange

Change Handler

说明

protected UI\Controls\MultilineEntry::onChange ( void )

Shall be executed when the text in this Multiline Entry is changed

参数

此函数没有参数。

UI\Controls\MultilineEntry::setReadOnly

Set Read Only

说明

public UI\Controls\MultilineEntry::setReadOnly ( bool $readOnly )

Shall enable or disable read only on this Multiline Entry

参数

readOnly

UI\Controls\MultilineEntry::setText

Set Text

说明

public UI\Controls\MultilineEntry::setText ( string $text )

Shall set the text in this Multiline Entry

参数

text
The new text

简介

A Spin box is a text box with an up-down control which changes the integer value in the box, within a defined range

类摘要

UI\Controls\Spin

class UI\Controls\Spin extends UI\Control {

/* Constructor */

public __construct ( int $min , int $max )

/* 方法 */

public int getValue ( void )

protected onChange ( void )

public setValue ( int $value )

/* 继承的方法 */

public UI\Control::destroy ( void )

public UI\Control::disable ( void )

public UI\Control::enable ( void )

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

public int UI\Control::getTopLevel ( void )

public UI\Control::hide ( void )

public bool UI\Control::isEnabled ( void )

public bool UI\Control::isVisible ( void )

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

public UI\Control::show ( void )

}

UI\Controls\Spin::__construct

Construct a new Spin

说明

public UI\Controls\Spin::__construct ( int $min , int $max )

Constructs a new Spin with the given range

参数

min
The minimum value allowed

max
The maximum value allowed

UI\Controls\Spin::getValue

Get Value

说明

public int UI\Controls\Spin::getValue ( void )

Get the value in this Spin

参数

此函数没有参数。

UI\Controls\Spin::onChange

Change Handler

说明

protected UI\Controls\Spin::onChange ( void )

Shall be executed when the value in this Spin changes

参数

此函数没有参数。

UI\Controls\Spin::setValue

Set Value

说明

public UI\Controls\Spin::setValue ( int $value )

Set the value in this Spin

参数

value
The new value

简介

A Slider is a control which represents a range, and a current value in the range. The sliding element of the control (sometimes called the "thumb") reflects the value, and can be adjusted within the range.

类摘要

UI\Controls\Slider

class UI\Controls\Slider extends UI\Control {

/* Constructor */

public __construct ( int $min , int $max )

/* 方法 */

public int getValue ( void )

protected onChange ( void )

public setValue ( int $value )

/* 继承的方法 */

public UI\Control::destroy ( void )

public UI\Control::disable ( void )

public UI\Control::enable ( void )

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

public int UI\Control::getTopLevel ( void )

public UI\Control::hide ( void )

public bool UI\Control::isEnabled ( void )

public bool UI\Control::isVisible ( void )

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

public UI\Control::show ( void )

}

UI\Controls\Slider::__construct

Construct a new Slider

说明

public UI\Controls\Slider::__construct ( int $min , int $max )

Construct a new Slider with the given range

参数

min
The minimum allowed value

max
The maximum allowed value

UI\Controls\Slider::getValue

Get Value

说明

public int UI\Controls\Slider::getValue ( void )

Get the value from this Slider

参数

此函数没有参数。

UI\Controls\Slider::onChange

Change Handler

说明

protected UI\Controls\Slider::onChange ( void )

Shall be executed when the value of this Slider changes

参数

此函数没有参数。

UI\Controls\Slider::setValue

Set Value

说明

public UI\Controls\Slider::setValue ( int $value )

Shall set the value for this Slider

参数

value
The new value

简介

A Progress control is a familiar Progress bar: It represents progress as a percentage, with a possible range of 0 to 100 (inclusive).

类摘要

UI\Controls\Progress

class UI\Controls\Progress extends UI\Control {

/* 方法 */

public int getValue ( void )

public setValue ( int $value )

/* 继承的方法 */

public UI\Control::destroy ( void )

public UI\Control::disable ( void )

public UI\Control::enable ( void )

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

public int UI\Control::getTopLevel ( void )

public UI\Control::hide ( void )

public bool UI\Control::isEnabled ( void )

public bool UI\Control::isVisible ( void )

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

public UI\Control::show ( void )

}

UI\Controls\Progress::getValue

Get Value

说明

public int UI\Controls\Progress::getValue ( void )

Shall retrieve the current value of this Progress bar

参数

此函数没有参数。

UI\Controls\Progress::setValue

Set Value

说明

public UI\Controls\Progress::setValue ( int $value )

Shall set the value for this Progress bar

参数

value
An integer between 0 and 100 (inclusive)

简介

A Separator represents a control separator, it has no other function.

类摘要

UI\Controls\Separator

class UI\Controls\Separator extends UI\Control {

/* Constants */

const int UI\Controls\Separator::Horizontal ;

const int UI\Controls\Separator::Vertical ;

/* Constructor */

public __construct ([ int $type = UI\Controls\Separator::Horizontal ] )

/* 继承的方法 */

public UI\Control::destroy ( void )

public UI\Control::disable ( void )

public UI\Control::enable ( void )

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

public int UI\Control::getTopLevel ( void )

public UI\Control::hide ( void )

public bool UI\Control::isEnabled ( void )

public bool UI\Control::isVisible ( void )

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

public UI\Control::show ( void )

}

预定义常量

UI\Controls\Separator::Horizontal
A Horizontal Separator

UI\Controls\Separator::Vertical
A Vertical Separator

UI\Controls\Separator::__construct

Construct a new Separator

说明

public UI\Controls\Separator::__construct ([ int $type = UI\Controls\Separator::Horizontal ] )

Shall construct a new Separator of the given type

参数

type
Separator::Horizonal or Separator::Vertical

简介

A Combo control represents a list of options, like the familiar select HTML element.

类摘要

UI\Controls\Combo

class UI\Controls\Combo extends UI\Control {

/* 方法 */

public append ( string $text )

public int getSelected ( void )

protected onSelected ( void )

public setSelected ( int $index )

/* 继承的方法 */

public UI\Control::destroy ( void )

public UI\Control::disable ( void )

public UI\Control::enable ( void )

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

public int UI\Control::getTopLevel ( void )

public UI\Control::hide ( void )

public bool UI\Control::isEnabled ( void )

public bool UI\Control::isVisible ( void )

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

public UI\Control::show ( void )

}

UI\Controls\Combo::append

Append Option

说明

public UI\Controls\Combo::append ( string $text )

Append an option to this Combo

参数

text
The text for the new option

UI\Controls\Combo::getSelected

Get Selected Option

说明

public int UI\Controls\Combo::getSelected ( void )

Shall retrieve the index of the option selected in this Combo

参数

此函数没有参数。

UI\Controls\Combo::onSelected

Selected Handler

说明

protected UI\Controls\Combo::onSelected ( void )

Shall be executed when an option is selected in this Combo

参数

此函数没有参数。

UI\Controls\Combo::setSelected

Set Selected Option

说明

public UI\Controls\Combo::setSelected ( int $index )

Shall set the currently selected option in this Combo

参数

index
The index of the option to select

简介

An Editable Combo is a Combo which allows the user to enter custom options

类摘要

UI\Controls\EditableCombo

class UI\Controls\EditableCombo extends UI\Control {

/* 方法 */

public append ( string $text )

public string getText ( void )

protected onChange ( void )

public setText ( string $text )

/* 继承的方法 */

public UI\Control::destroy ( void )

public UI\Control::disable ( void )

public UI\Control::enable ( void )

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

public int UI\Control::getTopLevel ( void )

public UI\Control::hide ( void )

public bool UI\Control::isEnabled ( void )

public bool UI\Control::isVisible ( void )

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

public UI\Control::show ( void )

}

UI\Controls\EditableCombo::append

Append Option

说明

public UI\Controls\EditableCombo::append ( string $text )

Shall append a new option to this Editable Combo

参数

text
The text for the new option

UI\Controls\EditableCombo::getText

Get Text

说明

public string UI\Controls\EditableCombo::getText ( void )

Get the value of the currently selected option in this Editable Combo

参数

此函数没有参数。

UI\Controls\EditableCombo::onChange

Change Handler

说明

protected UI\Controls\EditableCombo::onChange ( void )

Shall be executed when the value of this Editable Combobox changes

参数

此函数没有参数。

UI\Controls\EditableCombo::setText

Set Text

说明

public UI\Controls\EditableCombo::setText ( string $text )

Shall set the text of the currently selected option in this Editable Combo

参数

text
The new text

简介

A Radio is similar to the radio input type familiar from HTML

类摘要

UI\Controls\Radio

class UI\Controls\Radio extends UI\Control {

/* 方法 */

public append ( string $text )

public int getSelected ( void )

protected onSelected ( void )

public setSelected ( int $index )

/* 继承的方法 */

public UI\Control::destroy ( void )

public UI\Control::disable ( void )

public UI\Control::enable ( void )

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

public int UI\Control::getTopLevel ( void )

public UI\Control::hide ( void )

public bool UI\Control::isEnabled ( void )

public bool UI\Control::isVisible ( void )

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

public UI\Control::show ( void )

}

UI\Controls\Radio::append

Append Option

说明

public UI\Controls\Radio::append ( string $text )

Shall append a new option to this Radio

参数

text
The text (label) for the option

UI\Controls\Radio::getSelected

Get Selected Option

说明

public int UI\Controls\Radio::getSelected ( void )

Shall retrieve the index of the currently selected option in this Radio

参数

此函数没有参数。

UI\Controls\Radio::onSelected

Selected Handler

说明

protected UI\Controls\Radio::onSelected ( void )

Shall be executed when the option selected in this Radio changes

参数

此函数没有参数。

UI\Controls\Radio::setSelected

Set Selected Option

说明

public UI\Controls\Radio::setSelected ( int $index )

Shall set the currently selected option in this Radio

参数

index
The index of the option to select

简介

A Picker represents a button which when clicked presents a native Date/Time/DateTime Picker interface to the user.

类摘要

UI\Controls\Picker

class UI\Controls\Picker extends UI\Control {

/* Constants */

const int UI\Controls\Picker::Date ;

const int UI\Controls\Picker::Time ;

const int UI\Controls\Picker::DateTime ;

/* Constructor */

public __construct ([ int $type = UI\Controls\Picker::Date ] )

/* 继承的方法 */

public UI\Control::destroy ( void )

public UI\Control::disable ( void )

public UI\Control::enable ( void )

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

public int UI\Control::getTopLevel ( void )

public UI\Control::hide ( void )

public bool UI\Control::isEnabled ( void )

public bool UI\Control::isVisible ( void )

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

public UI\Control::show ( void )

}

预定义常量

UI\Controls\Picker::Date
A Date Picker

UI\Controls\Picker::Time
A Time Picker

UI\Controls\Picker::DateTime
A Date and Time Picker

UI\Controls\Picker::__construct

Construct a new Picker

说明

public UI\Controls\Picker::__construct ([ int $type = UI\Controls\Picker::Date ] )

Construct a new Picker of the given type

参数

type
Picker::Date, Picker::Time, or Picker::DateTime

简介

A Form is a control which allows the arrangement of other controls into a familiar layout (the form).

类摘要

UI\Controls\Form

class UI\Controls\Form extends UI\Control {

/* 属性 */

protected $controls ;

/* 方法 */

public int append ( string $label , UI\Control $control [, bool $stretchy = false ] )

public bool delete ( int $index )

public bool isPadded ( void )

public setPadded ( bool $padded )

/* 继承的方法 */

public UI\Control::destroy ( void )

public UI\Control::disable ( void )

public UI\Control::enable ( void )

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

public int UI\Control::getTopLevel ( void )

public UI\Control::hide ( void )

public bool UI\Control::isEnabled ( void )

public bool UI\Control::isVisible ( void )

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

public UI\Control::show ( void )

}

属性

controls
Contains controls, should not be manipulated directly

UI\Controls\Form::append

Append Control

说明

public int UI\Controls\Form::append ( string $label , UI\Control $control [, bool $stretchy = false ] )

Shall append the control to the form, and set the label

参数

label
The text for the label

control
A control

stretchy
Should be set true to stretch the control

返回值

Shall return the index of the appended control, may be 0

UI\Controls\Form::delete

Delete Control

说明

public bool UI\Controls\Form::delete ( int $index )

Shall delete the control at the given index in this Form

参数

index
The index of the control to remove

返回值

Indication of succcess

UI\Controls\Form::isPadded

Padding Detection

说明

public bool UI\Controls\Form::isPadded ( void )

Shall detect if padding is enabled on this Form

参数

此函数没有参数。

UI\Controls\Form::setPadded

Set Padding

说明

public UI\Controls\Form::setPadded ( bool $padded )

Shall enable or disable padding on this Form

参数

padded

简介

A Grid is a control which is allows the arrangement of children into a grid

类摘要

UI\Controls\Grid

class UI\Controls\Grid extends UI\Control {

/* Constants */

const int UI\Controls\Grid::Fill ;

const int UI\Controls\Grid::Start ;

const int UI\Controls\Grid::Center ;

const int UI\Controls\Grid::End ;

const int UI\Controls\Grid::Leading ;

const int UI\Controls\Grid::Top ;

const int UI\Controls\Grid::Trailing ;

const int UI\Controls\Grid::Bottom ;

/* 属性 */

protected $controls ;

/* 方法 */

public append ( UI\Control $control , int $left , int $top , int $xspan , int $yspan , bool $hexpand , int $halign , bool $vexpand , int $valign )

public bool isPadded ( void )

public setPadded ( bool $padding )

/* 继承的方法 */

public UI\Control::destroy ( void )

public UI\Control::disable ( void )

public UI\Control::enable ( void )

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

public int UI\Control::getTopLevel ( void )

public UI\Control::hide ( void )

public bool UI\Control::isEnabled ( void )

public bool UI\Control::isVisible ( void )

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

public UI\Control::show ( void )

}

预定义常量

UI\Controls\Grid::Fill

UI\Controls\Grid::Start

UI\Controls\Grid::Center

UI\Controls\Grid::End

UI\Controls\Grid::Leading

UI\Controls\Grid::Top

UI\Controls\Grid::Trailing

UI\Controls\Grid::Bottom

属性

controls
Contains controls, should not be manipulated directly

UI\Controls\Grid::append

Append Control

说明

public UI\Controls\Grid::append ( UI\Control $control , int $left , int $top , int $xspan , int $yspan , bool $hexpand , int $halign , bool $vexpand , int $valign )

Warning

本函数还未编写文档，仅有参数列表。

参数

control
The Control to append

left

top

xspan

yspan

hexpand

halign

vexpand

valign

返回值

UI\Controls\Grid::isPadded

Padding Detection

说明

public bool UI\Controls\Grid::isPadded ( void )

Shall detect if padding is enabled on this Grid

参数

此函数没有参数。

UI\Controls\Grid::setPadded

Set Padding

说明

public UI\Controls\Grid::setPadded ( bool $padding )

Shall enable or disable padding for this Grid

参数

padding

简介

A Group is a titled container for child controls

类摘要

UI\Controls\Group

class UI\Controls\Group extends UI\Control {

/* 属性 */

protected $controls ;

/* Constructor */

public __construct ( string $title )

/* 方法 */

public append ( UI\Control $control )

public string getTitle ( void )

public bool hasMargin ( void )

public setMargin ( bool $margin )

public setTitle ( string $title )

/* 继承的方法 */

public UI\Control::destroy ( void )

public UI\Control::disable ( void )

public UI\Control::enable ( void )

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

public int UI\Control::getTopLevel ( void )

public UI\Control::hide ( void )

public bool UI\Control::isEnabled ( void )

public bool UI\Control::isVisible ( void )

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

public UI\Control::show ( void )

}

属性

controls
Contains controls, should not be manipulated directly

UI\Controls\Group::append

Append Control

说明

public UI\Controls\Group::append ( UI\Control $control )

Shall append a control to this Group

参数

control
The control to append

UI\Controls\Group::__construct

Construct a new Group

说明

public UI\Controls\Group::__construct ( string $title )

Shall construct a new Group with the given title

参数

title
The text for the title label

UI\Controls\Group::getTitle

Get Title

说明

public string UI\Controls\Group::getTitle ( void )

Shall return the current title for this Group

参数

此函数没有参数。

返回值

The current title

UI\Controls\Group::hasMargin

Margin Detection

说明

public bool UI\Controls\Group::hasMargin ( void )

Shall detect if this Group has a margin

参数

此函数没有参数。

UI\Controls\Group::setMargin

Set Margin

说明

public UI\Controls\Group::setMargin ( bool $margin )

Shall enable or disable margins for this Group

参数

margin

UI\Controls\Group::setTitle

Set Title

说明

public UI\Controls\Group::setTitle ( string $title )

Shall set the title for this Group

参数

title
The text for the new title

简介

A Box allows the arrangement of other controls

类摘要

UI\Controls\Box

class UI\Controls\Box extends UI\Control {

/* Constants */

const int UI\Controls\Box::Vertical ;

const int UI\Controls\Box::Horizontal ;

/* 属性 */

protected $controls ;

/* Constructor */

public __construct ([ int $orientation = UI\Controls\Box::Horizontal ] )

/* 方法 */

public int append ( Control $control [, bool $stretchy = false ] )

public bool delete ( int $index )

public int getOrientation ( void )

public bool isPadded ( void )

public setPadded ( bool $padded )

/* 继承的方法 */

public UI\Control::destroy ( void )

public UI\Control::disable ( void )

public UI\Control::enable ( void )

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

public int UI\Control::getTopLevel ( void )

public UI\Control::hide ( void )

public bool UI\Control::isEnabled ( void )

public bool UI\Control::isVisible ( void )

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

public UI\Control::show ( void )

}

属性

controls
Contains controls, should not be manipulated directly

预定义常量

UI\Controls\Box::Vertical

UI\Controls\Box::Horizontal

UI\Controls\Box::append

Append Control

说明

public int UI\Controls\Box::append ( Control $control [, bool $stretchy = false ] )

Shall append the given control to this Box

参数

control
The control to append

stretchy
Set true to stretch the control

返回值

Shall return the index of the appended control, may be 0

UI\Controls\Box::__construct

Construct a new Box

说明

public UI\Controls\Box::__construct ([ int $orientation = UI\Controls\Box::Horizontal ] )

Shall construct a new box

参数

orientation
Box::Horizontal or Box::Vertical

UI\Controls\Box::delete

Delete Control

说明

public bool UI\Controls\Box::delete ( int $index )

Shall delete the control at the given index from this Box

参数

index
The index of the control to delete

返回值

Indication of success

UI\Controls\Box::getOrientation

Get Orientation

说明

public int UI\Controls\Box::getOrientation ( void )

Shall retrieve the orientation of this Box

参数

此函数没有参数。

UI\Controls\Box::isPadded

Padding Detection

说明

public bool UI\Controls\Box::isPadded ( void )

Shall detect if padding is enabled on this Box

参数

此函数没有参数。

UI\Controls\Box::setPadded

Set Padding

说明

public UI\Controls\Box::setPadded ( bool $padded )

Shall enable or disable padding on this Box

参数

padded

简介

The Pen is passed to the Area Draw event handler, it is used for clipping, filling, stroking, and writing to Draw Paths.

类摘要

UI\Draw\Pen

final class UI\Draw\Pen {

/* 方法 */

public clip ( UI\Draw\Path $path )

public fill ( UI\Draw\Path $path , UI\Draw\Brush $with )

public fill ( UI\Draw\Path $path , UI\Draw\Color $with )

public fill ( UI\Draw\Path $path , int $with )

public restore ( void )

public save ( void )

public stroke ( UI\Draw\Path $path , UI\Draw\Brush $with , UI\Draw\Stroke $stroke )

public stroke ( UI\Draw\Path $path , UI\Draw\Color $with , UI\Draw\Stroke $stroke )

public stroke ( UI\Draw\Path $path , int $with , UI\Draw\Stroke $stroke )

public transform ( UI\Draw\Matrix $matrix )

public write ( UI\Point $point , UI\Draw\Text\Layout $layout )

}

UI\Draw\Pen::clip

Clip a Path

说明

public UI\Draw\Pen::clip ( UI\Draw\Path $path )

Shall clip the given Path

参数

path
The path to clip

UI\Draw\Pen::fill

Fill a Path

说明

public UI\Draw\Pen::fill ( UI\Draw\Path $path , UI\Draw\Brush $with )

public UI\Draw\Pen::fill ( UI\Draw\Path $path , UI\Draw\Color $with )

public UI\Draw\Pen::fill ( UI\Draw\Path $path , int $with )

Shall fill the given path

参数

path
The path to fill

with
The color or brush to fill with

UI\Draw\Pen::restore

Restore

说明

public UI\Draw\Pen::restore ( void )

Shall restore a previously saved Pen

参数

此函数没有参数。

UI\Draw\Pen::save

Save

说明

public UI\Draw\Pen::save ( void )

Shall save the Pen

参数

此函数没有参数。

UI\Draw\Pen::stroke

Stroke a Path

说明

public UI\Draw\Pen::stroke ( UI\Draw\Path $path , UI\Draw\Brush $with , UI\Draw\Stroke $stroke )

public UI\Draw\Pen::stroke ( UI\Draw\Path $path , UI\Draw\Color $with , UI\Draw\Stroke $stroke )

public UI\Draw\Pen::stroke ( UI\Draw\Path $path , int $with , UI\Draw\Stroke $stroke )

Shall stroke the given path

参数

path
The path to stroke

with
The color or brush to stroke with

stroke
The configuration of the stroke

UI\Draw\Pen::transform

Matrix Transform

说明

public UI\Draw\Pen::transform ( UI\Draw\Matrix $matrix )

Shall perform matrix transformation

参数

matrix
The matrix to use

UI\Draw\Pen::write

Draw Text at Point

说明

public UI\Draw\Pen::write ( UI\Point $point , UI\Draw\Text\Layout $layout )

Shall draw the given text layout at the given point

参数

point
The point to perform the drawing

layout
The layout of the text to draw

简介

A Draw Path guides a Draw Pen, telling the Pen where to draw on an Area.

类摘要

UI\Draw\Path

class UI\Draw\Path {

/* Constants */

const int UI\Draw\Path::Winding ;

const int UI\Draw\Path::Alternate ;

/* Constructor */

public __construct ([ int $mode = UI\Draw\Path::Winding ] )

/* 方法 */

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

public arcTo ( UI\Point $point , float $radius , float $angle , float $sweep , float $negative )

public bezierTo ( UI\Point $point , float $radius , float $angle , float $sweep , float $negative )

public closeFigure ( void )

public end ( void )

public lineTo ( UI\Point $point , float $radius , float $angle , float $sweep , float $negative )

public newFigure ( UI\Point $point )

public newFigureWithArc ( UI\Point $point , float $radius , float $angle , float $sweep , float $negative )

}

预定义常量

UI\Draw\Path::Winding
This is the default draw path mode

UI\Draw\Path::Alternate
This is the alternate draw path mode

UI\Draw\Path::addRectangle

Draw a Rectangle

说明

public UI\Draw\Path::addRectangle ( UI\Point $point , UI\Size $size )

Shall map the path of a rectangle of the given size, at the given point

参数

point
The point to begin the shape

size
The size of the rectangle

UI\Draw\Path::arcTo

Draw an Arc

说明

public UI\Draw\Path::arcTo ( UI\Point $point , float $radius , float $angle , float $sweep , float $negative )

Shall map the path for an arc

参数

point
The point to begin mapping

radius
The radius of the arc

angle
The angle of the arc

sweep
The sweep of the arc

negative

返回值

UI\Draw\Path::bezierTo

Draw Bezier Curve

说明

public UI\Draw\Path::bezierTo ( UI\Point $point , float $radius , float $angle , float $sweep , float $negative )

Shall draw a bezier curve

参数

point
The point at which to begin mapping

radius
The radius of the curve

angle
The angle of the curve

sweep
The sweep of the curve

negative

UI\Draw\Path::closeFigure

Close Figure

说明

public UI\Draw\Path::closeFigure ( void )

Shall close the current figure

参数

此函数没有参数。

UI\Draw\Path::__construct

Construct a new Path

说明

public UI\Draw\Path::__construct ([ int $mode = UI\Draw\Path::Winding ] )

Shall construct a new path in the given mode

参数

mode
Path::Winding or Path::Alternate

UI\Draw\Path::end

Finalize Path

说明

public UI\Draw\Path::end ( void )

Shall finalize this Path

参数

此函数没有参数。

UI\Draw\Path::lineTo

Draw a Line

说明

public UI\Draw\Path::lineTo ( UI\Point $point , float $radius , float $angle , float $sweep , float $negative )

Shall map the path for a line

参数

point
The point to begin mapping

radius

angle

sweep

negative

返回值

UI\Draw\Path::newFigure

Draw Figure

说明

public UI\Draw\Path::newFigure ( UI\Point $point )

Shall map a new figure at the given point

参数

point
The point to begin mapping

UI\Draw\Path::newFigureWithArc

Draw Figure with Arc

说明

public UI\Draw\Path::newFigureWithArc ( UI\Point $point , float $radius , float $angle , float $sweep , float $negative )

参数

point

radius

angle

sweep

negative

返回值

简介

类摘要

UI\Draw\Matrix

class UI\Draw\Matrix {

/* 方法 */

public invert ( void )

public bool isInvertible ( void )

public UI\Draw\Matrix multiply ( UI\Draw\Matrix $matrix )

public rotate ( UI\Point $point , float $amount )

public scale ( UI\Point $center , UI\Point $point )

public skew ( UI\Point $point , UI\Point $amount )

public translate ( UI\Point $point )

}

UI\Draw\Matrix::invert

Invert Matrix

说明

public UI\Draw\Matrix::invert ( void )

Shall invert this matrix

参数

此函数没有参数。

UI\Draw\Matrix::isInvertible

Invertible Detection

说明

public bool UI\Draw\Matrix::isInvertible ( void )

Shall detect if this Matrix may be inverted

参数

此函数没有参数。

UI\Draw\Matrix::multiply

Multiply Matrix

说明

public UI\Draw\Matrix UI\Draw\Matrix::multiply ( UI\Draw\Matrix $matrix )

Shall multiply this matrix with the given matrix

参数

此函数没有参数。

返回值

The new Matrix

UI\Draw\Matrix::rotate

Rotate Matrix

说明

public UI\Draw\Matrix::rotate ( UI\Point $point , float $amount )

Shall rotate this Matrix

参数

point

amount

UI\Draw\Matrix::scale

Scale Matrix

说明

public UI\Draw\Matrix::scale ( UI\Point $center , UI\Point $point )

Shall scale this Matrix

参数

center

point

UI\Draw\Matrix::skew

Skew Matrix

说明

public UI\Draw\Matrix::skew ( UI\Point $point , UI\Point $amount )

Shall skew this Matrix

参数

point

amount

UI\Draw\Matrix::translate

Translate Matrix

说明

public UI\Draw\Matrix::translate ( UI\Point $point )

Shall translate this Matrix

参数

point

简介

Represents RGBA colours, individual channels are accessible via public properties.

类摘要

UI\Draw\Color

class UI\Draw\Color {

/* Constants */

const int UI\Draw\Color::Red ;

const int UI\Draw\Color::Green ;

const int UI\Draw\Color::Blue ;

const int UI\Draw\Color::Alpha ;

/* 属性 */

public $r ;

public $g ;

public $b ;

public $a ;

/* Constructor */

public __construct ([ UI\Draw\Color $color ] )

public __construct ([ int $color ] )

/* 方法 */

public float getChannel ( int $channel )

public void setChannel ( int $channel , float $value )

}

属性

r
Provides access to the red channel

g
Provides access to the green channel

b
Provides access to the blue channel

a
Provides access to the alpha channel

预定义常量

UI\Draw\Color::Red
Identifies the red channel

UI\Draw\Color::Green
Identifies the green channel

UI\Draw\Color::Blue
Identifies the blue channel

UI\Draw\Color::Alpha
Identifies the alpha channel

UI\Draw\Color::__construct

Construct new Color

说明

public UI\Draw\Color::__construct ([ UI\Draw\Color $color ] )

public UI\Draw\Color::__construct ([ int $color ] )

Shall construct a new color

参数

color
May be UI\Draw\Color or RRGGBBAA

UI\Draw\Color::getChannel

Color Manipulation

说明

public float UI\Draw\Color::getChannel ( int $channel )

Shall retrieve the value for a channel

参数

channel
Constant channel identity

返回值

The current value of the requested channel

UI\Draw\Color::setChannel

Color Manipulation

说明

public void UI\Draw\Color::setChannel ( int $channel , float $value )

Shall set the selected channel to the given value

参数

channel
Constant channel identity

value
The new value for the selected channel

返回值

简介

Holds the configuration for the Pen to perform a stroke

类摘要

UI\Draw\Stroke

class UI\Draw\Stroke {

/* Constructor */

public __construct ([ int $cap = UI\Draw\Line\Cap::Flat [, int $join = UI\Draw\Line\Join::Miter [, float $thickness = 1 [, float $miterLimit = 10 ]]]] )

/* 方法 */

public int getCap ( void )

public int getJoin ( void )

public float getMiterLimit ( void )

public float getThickness ( void )

public setCap ( int $cap )

public setJoin ( int $join )

public setMiterLimit ( float $limit )

public setThickness ( float $thickness )

}

UI\Draw\Stroke::__construct

Construct a new Stroke

说明

public UI\Draw\Stroke::__construct ([ int $cap = UI\Draw\Line\Cap::Flat [, int $join = UI\Draw\Line\Join::Miter [, float $thickness = 1 [, float $miterLimit = 10 ]]]] )

Shall construct a new Stroke

参数

cap
UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, or UI\Draw\Line\Cap::Square

join
UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round, or UI\Draw\Line\Join::Bevel

thickness
The thickness of the stroke

miterLimit
Miter limit (default is sensible for all supported platforms)

UI\Draw\Stroke::getCap

Get Line Cap

说明

public int UI\Draw\Stroke::getCap ( void )

Shall retrieve the line cap setting of this Stroke

参数

此函数没有参数。

返回值

UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, or UI\Draw\Line\Cap::Square

UI\Draw\Stroke::getJoin

Get Line Join

说明

public int UI\Draw\Stroke::getJoin ( void )

Shall retrieve the line join setting of this Stroke

参数

此函数没有参数。

返回值

UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round, or UI\Draw\Line\Join::Bevel

UI\Draw\Stroke::getMiterLimit

Get Miter Limit

说明

public float UI\Draw\Stroke::getMiterLimit ( void )

Shall retrieve the miter limit of this Stroke

参数

此函数没有参数。

返回值

The current miter limit

UI\Draw\Stroke::getThickness

Get Thickness

说明

public float UI\Draw\Stroke::getThickness ( void )

Shall retrieve the thickness of this Stroke

参数

此函数没有参数。

返回值

The current thickness

UI\Draw\Stroke::setCap

Set Line Cap

说明

public UI\Draw\Stroke::setCap ( int $cap )

Shall set the line cap setting for this Stroke

参数

cap
UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, or UI\Draw\Line\Cap::Square

UI\Draw\Stroke::setJoin

Set Line Join

说明

public UI\Draw\Stroke::setJoin ( int $join )

Shall set the line join setting for this Stroke

参数

join
UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round, or UI\Draw\Line\Join::Bevel

返回值

UI\Draw\Stroke::setMiterLimit

Set Miter Limit

说明

public UI\Draw\Stroke::setMiterLimit ( float $limit )

Set the miter limit for this Stroke

参数

limit
The new limit

UI\Draw\Stroke::setThickness

Set Thickness

说明

public UI\Draw\Stroke::setThickness ( float $thickness )

Shall set the thickness for this Stroke

参数

thickness
The new thickness

简介

Represents a solid color brush

类摘要

UI\Draw\Brush

class UI\Draw\Brush {

/* Constructor */

public __construct ( UI\Draw\Color $color )

public __construct ( int $color )

/* 方法 */

public UI\Draw\Color getColor ( void )

public void setColor ( UI\Draw\Color $color )

public void setColor ( int $color )

}

UI\Draw\Brush::__construct

Construct a new Brush

说明

public UI\Draw\Brush::__construct ( UI\Draw\Color $color )

public UI\Draw\Brush::__construct ( int $color )

Shall construct a solid brush using the given color

参数

color
Can be a UI\Draw\Color or RRGGBBAA

UI\Draw\Brush::getColor

Get Color

说明

public UI\Draw\Color UI\Draw\Brush::getColor ( void )

Shall return a UI\Draw\Color for this brush

参数

此函数没有参数。

返回值

The current color of the brush

UI\Draw\Brush::setColor

Set Color

说明

public void UI\Draw\Brush::setColor ( UI\Draw\Color $color )

public void UI\Draw\Brush::setColor ( int $color )

Shall set the color of this brush to the color provided

参数

color
Can be a UI\Draw\Color or RRGGBBAA

返回值

简介

Abstract for gradient brushes

类摘要

UI\Draw\Brush\Gradient

abstract class UI\Draw\Brush\Gradient extends UI\Draw\Brush {

/* 方法 */

public int addStop ( float $position , UI\Draw\Color $color )

public int addStop ( float $position , int $color )

public int delStop ( int $index )

public bool setStop ( int $index , float $position , UI\Draw\Color $color )

public bool setStop ( int $index , float $position , int $color )

/* 继承的方法 */

public UI\Draw\Color UI\Draw\Brush::getColor ( void )

public void UI\Draw\Brush::setColor ( UI\Draw\Color $color )

public void UI\Draw\Brush::setColor ( int $color )

}

UI\Draw\Brush\Gradient::addStop

Stop Manipulation

说明

public int UI\Draw\Brush\Gradient::addStop ( float $position , UI\Draw\Color $color )

public int UI\Draw\Brush\Gradient::addStop ( float $position , int $color )

Shall at a stop of the given color at the given position

参数

position
The position for the new stop

color
The color for the new stop, may be UI\Draw\Color or RRGGBBAA

返回值

Total number of stops

UI\Draw\Brush\Gradient::delStop

Stop Manipulation

说明

public int UI\Draw\Brush\Gradient::delStop ( int $index )

Warning

本函数还未编写文档，仅有参数列表。

参数

index

返回值

Total number of stops

UI\Draw\Brush\Gradient::setStop

Stop Manipulation

说明

public bool UI\Draw\Brush\Gradient::setStop ( int $index , float $position , UI\Draw\Color $color )

public bool UI\Draw\Brush\Gradient::setStop ( int $index , float $position , int $color )

参数

index
The index of the stop to set

position
The position for the stop

color
The color for the stop, may be UI\Draw\Color or RRGGBBAA

返回值

Indication of success

简介

类摘要

UI\Draw\Brush\LinearGradient

class UI\Draw\Brush\LinearGradient extends UI\Draw\Brush\Gradient {

/* Constructor */

public __construct ( UI\Point $start , UI\Point $end )

/* 继承的方法 */

public int UI\Draw\Brush\Gradient::addStop ( float $position , UI\Draw\Color $color )

public int UI\Draw\Brush\Gradient::addStop ( float $position , int $color )

public int UI\Draw\Brush\Gradient::delStop ( int $index )

public bool UI\Draw\Brush\Gradient::setStop ( int $index , float $position , UI\Draw\Color $color )

public bool UI\Draw\Brush\Gradient::setStop ( int $index , float $position , int $color )

}

UI\Draw\Brush\LinearGradient::__construct

Construct a Linear Gradient

说明

public UI\Draw\Brush\LinearGradient::__construct ( UI\Point $start , UI\Point $end )

Shall construct a new linear gradient

参数

start

end

简介

类摘要

UI\Draw\Brush\RadialGradient

class UI\Draw\Brush\RadialGradient extends UI\Draw\Brush\Gradient {

/* Constructor */

public __construct ( UI\Point $start , UI\Point $outer , float $radius )

/* 继承的方法 */

public int UI\Draw\Brush\Gradient::addStop ( float $position , UI\Draw\Color $color )

public int UI\Draw\Brush\Gradient::addStop ( float $position , int $color )

public int UI\Draw\Brush\Gradient::delStop ( int $index )

public bool UI\Draw\Brush\Gradient::setStop ( int $index , float $position , UI\Draw\Color $color )

public bool UI\Draw\Brush\Gradient::setStop ( int $index , float $position , int $color )

}

UI\Draw\Brush\RadialGradient::__construct

Construct a new Radial Gradient

说明

public UI\Draw\Brush\RadialGradient::__construct ( UI\Point $start , UI\Point $outer , float $radius )

Shall construct a new radial gradient

参数

start

outer

radius

简介

A Text Layout represents the layout of text which will be drawn by the Pen

类摘要

UI\Draw\Text\Layout

class UI\Draw\Text\Layout {

/* Constructor */

public __construct ( string $text , UI\Draw\Text\Font $font , float $width )

/* 方法 */

public setColor ( UI\Draw\Color $color [, int $start = 0 [, int $end ]] )

public setColor ( int $color [, int $start = 0 [, int $end ]] )

public setWidth ( float $width )

}

UI\Draw\Text\Layout::__construct

Construct a new Text Layout

说明

public UI\Draw\Text\Layout::__construct ( string $text , UI\Draw\Text\Font $font , float $width )

Shall construct a new Text Layout

参数

text
The text for the layout

font
The font to use for writing

width
The width of the layout

UI\Draw\Text\Layout::setColor

Set Color

说明

public UI\Draw\Text\Layout::setColor ( UI\Draw\Color $color [, int $start = 0 [, int $end ]] )

public UI\Draw\Text\Layout::setColor ( int $color [, int $start = 0 [, int $end ]] )

Shall set the Color for all of, or a range of the text in the Layout

参数

color
The color to use

start
The starting character

end
The ending character, by default the end of the string

UI\Draw\Text\Layout::setWidth

Set Width

说明

public UI\Draw\Text\Layout::setWidth ( float $width )

Shall set the width of this Text Layout

参数

width
The new width

简介

Loads a described font

类摘要

UI\Draw\Text\Font

class UI\Draw\Text\Font {

/* Constructor */

public __construct ( UI\Draw\Text\Font\Descriptor $descriptor )

/* 方法 */

public float getAscent ( void )

public float getDescent ( void )

public float getLeading ( void )

public float getUnderlinePosition ( void )

public float getUnderlineThickness ( void )

}

UI\Draw\Text\Font::__construct

Construct a new Font

说明

public UI\Draw\Text\Font::__construct ( UI\Draw\Text\Font\Descriptor $descriptor )

Shall construct a new Font using the given descriptor

参数

descriptor
The descriptor for the Font

UI\Draw\Text\Font::getAscent

Font Metrics

说明

public float UI\Draw\Text\Font::getAscent ( void )

参数

此函数没有参数。

返回值

UI\Draw\Text\Font::getDescent

Font Metrics

说明

public float UI\Draw\Text\Font::getDescent ( void )

参数

此函数没有参数。

返回值

UI\Draw\Text\Font::getLeading

Font Metrics

说明

public float UI\Draw\Text\Font::getLeading ( void )

参数

此函数没有参数。

返回值

UI\Draw\Text\Font::getUnderlinePosition

Font Metrics

说明

public float UI\Draw\Text\Font::getUnderlinePosition ( void )

参数

此函数没有参数。

返回值

UI\Draw\Text\Font::getUnderlineThickness

Font Metrics

说明

public float UI\Draw\Text\Font::getUnderlineThickness ( void )

参数

此函数没有参数。

返回值

简介

Describes a font

类摘要

UI\Draw\Text\Font\Descriptor

class UI\Draw\Text\Font\Descriptor {

/* Constructor */

public __construct ( string $family , float $size [, int $weight = UI\Draw\Text\Font\Weight::Normal [, int $italic = UI\Draw\Text\Font\Italic::Normal [, int $stretch = UI\Draw\Text\Font\Stretch::Normal ]]] )

/* 方法 */

public string getFamily ( void )

public int getItalic ( void )

public float getSize ( void )

public int getStretch ( void )

public int getWeight ( void )

}

UI\Draw\Text\Font\Descriptor::__construct

Construct a new Font Descriptor

说明

public UI\Draw\Text\Font\Descriptor::__construct ( string $family , float $size [, int $weight = UI\Draw\Text\Font\Weight::Normal [, int $italic = UI\Draw\Text\Font\Italic::Normal [, int $stretch = UI\Draw\Text\Font\Stretch::Normal ]]] )

Shall construct a new Font Descriptor

参数

family
The name of a valid family of fonts

size
The preferred size

weight
UI\Draw\Text\Font\Weight constant

italic
UI\Draw\Text\Font\Italic constant

stretch
UI\Draw\Text\Font\Stretch constant

UI\Draw\Text\Font\Descriptor::getFamily

Get Font Family

说明

public string UI\Draw\Text\Font\Descriptor::getFamily ( void )

Shall return the requested font family

参数

此函数没有参数。

返回值

UI\Draw\Text\Font\Descriptor::getItalic

Style Detection

说明

public int UI\Draw\Text\Font\Descriptor::getItalic ( void )

Shall return constant setting

参数

此函数没有参数。

返回值

UI\Draw\Text\Font\Descriptor::getSize

Size Detection

说明

public float UI\Draw\Text\Font\Descriptor::getSize ( void )

Shall return the requested size

参数

此函数没有参数。

返回值

UI\Draw\Text\Font\Descriptor::getStretch

Style Detection

说明

public int UI\Draw\Text\Font\Descriptor::getStretch ( void )

Shall return requested stretch

参数

此函数没有参数。

返回值

UI\Draw\Text\Font\Descriptor::getWeight

Weight Detection

说明

public int UI\Draw\Text\Font\Descriptor::getWeight ( void )

Shall return requested weight

参数

此函数没有参数。

返回值

简介

类摘要

UI\Draw\Text\Font\Weight

final class UI\Draw\Text\Font\Weight {

/* Constants */

const int UI\Draw\Text\Font\Weight::Thin ;

const int UI\Draw\Text\Font\Weight::UltraLight ;

const int UI\Draw\Text\Font\Weight::Light ;

const int UI\Draw\Text\Font\Weight::Book ;

const int UI\Draw\Text\Font\Weight::Normal ;

const int UI\Draw\Text\Font\Weight::Medium ;

const int UI\Draw\Text\Font\Weight::SemiBold ;

const int UI\Draw\Text\Font\Weight::Bold ;

const int UI\Draw\Text\Font\Weight::UltraBold ;

const int UI\Draw\Text\Font\Weight::Heavy ;

const int UI\Draw\Text\Font\Weight::UltraHeavy ;

}

简介

类摘要

UI\Draw\Text\Font\Italic

final class UI\Draw\Text\Font\Italic {

/* Constants */

const int UI\Draw\Text\Font\Italic::Normal = 0 ;

const int UI\Draw\Text\Font\Italic::Oblique = 1 ;

const int UI\Draw\Text\Font\Italic::Italic = 2 ;

}

简介

类摘要

UI\Draw\Text\Font\Stretch

final class UI\Draw\Text\Font\Stretch {

/* Constants */

const int UI\Draw\Text\Font\Stretch::UltraCondensed = 0 ;

const int UI\Draw\Text\Font\Stretch::ExtraCondensed = 1 ;

const int UI\Draw\Text\Font\Stretch::Condensed = 2 ;

const int UI\Draw\Text\Font\Stretch::SemiCondensed = 3 ;

const int UI\Draw\Text\Font\Stretch::Normal = 4 ;

const int UI\Draw\Text\Font\Stretch::SemiExpanded = 5 ;

const int UI\Draw\Text\Font\Stretch::Expanded = 6 ;

const int UI\Draw\Text\Font\Stretch::ExtraExpanded = 7 ;

const int UI\Draw\Text\Font\Stretch::UltraExpanded = 8 ;

}

简介

类摘要

UI\Draw\Line\Cap

final class UI\Draw\Line\Cap {

/* Constants */

const int UI\Draw\Line\Cap::Flat ;

const int UI\Draw\Line\Cap::Round ;

const int UI\Draw\Line\Cap::Square ;

}

简介

类摘要

UI\Draw\Line\Join

final class UI\Draw\Line\Join {

/* Constants */

const int UI\Draw\Line\Join::Miter ;

const int UI\Draw\Line\Join::Round ;

const int UI\Draw\Line\Join::Bevel ;

}

简介

类摘要

UI\Key

final class UI\Key {

/* Constants */

const int UI\Key::Escape ;

const int UI\Key::Insert ;

const int UI\Key::Delete ;

const int UI\Key::Home ;

const int UI\Key::End ;

const int UI\Key::PageUp ;

const int UI\Key::PageDown ;

const int UI\Key::Up ;

const int UI\Key::Down ;

const int UI\Key::Left ;

const int UI\Key::Right ;

const int UI\Key::F1 ;

const int UI\Key::F2 ;

const int UI\Key::F3 ;

const int UI\Key::F4 ;

const int UI\Key::F5 ;

const int UI\Key::F6 ;

const int UI\Key::F7 ;

const int UI\Key::F8 ;

const int UI\Key::F9 ;

const int UI\Key::F10 ;

const int UI\Key::F11 ;

const int UI\Key::F12 ;

const int UI\Key::N0 ;

const int UI\Key::N1 ;

const int UI\Key::N2 ;

const int UI\Key::N3 ;

const int UI\Key::N4 ;

const int UI\Key::N5 ;

const int UI\Key::N6 ;

const int UI\Key::N7 ;

const int UI\Key::N8 ;

const int UI\Key::N9 ;

const int UI\Key::NDot ;

const int UI\Key::NEnter ;

const int UI\Key::NAdd ;

const int UI\Key::NSubtract ;

const int UI\Key::NMultiply ;

const int UI\Key::NDivide ;

}

简介

类摘要

UI\Exception\InvalidArgumentException

class UI\Exception\InvalidArgumentException extends InvalidArgumentException implements Throwable {

/* 继承的属性 */

protected string $message ;

protected int $code ;

protected string $file ;

protected int $line ;

/* 继承的方法 */

final public string Exception::getMessage ( void )

final public Throwable Exception::getPrevious ( void )

final public mixed Exception::getCode ( void )

final public string Exception::getFile ( void )

final public int Exception::getLine ( void )

final public array Exception::getTrace ( void )

final public string Exception::getTraceAsString ( void )

public string Exception::__toString ( void )

final private void Exception::__clone ( void )

}

简介

类摘要

UI\Exception\RuntimeException

class UI\Exception\RuntimeException extends RuntimeException implements Throwable {

/* 继承的属性 */

protected string $message ;

protected int $code ;

protected string $file ;

protected int $line ;

/* 继承的方法 */

final public string Exception::getMessage ( void )

final public Throwable Exception::getPrevious ( void )

final public mixed Exception::getCode ( void )

final public string Exception::getFile ( void )

final public int Exception::getLine ( void )

final public array Exception::getTrace ( void )

final public string Exception::getTraceAsString ( void )

public string Exception::__toString ( void )

final private void Exception::__clone ( void )

}