XU XUv0.13.1
EN

#ui/phone

导入方式: #ui/phone

公开 API: 39 函数, 154 方法, 14 类型, 52 常量, 0 方法集

移动界面

#ui/phone 使用 #ui/draw 的帧协议。用 available() 判断移动宿主是否可用,用 platform() 区分 iOS 和 Android。host_insets() 以逻辑单位报告安全区和键盘边距,可直接传给 scaffold_with。

打包应用和配置平台工具链的步骤见移动应用指南。

const NONE

XuAPI
pub const NONE = 0

用途

常量 NONE,定义了相关的协议或算法配置参数。

const IOS

XuAPI
pub const IOS = 1

用途

常量 IOS,定义了相关的协议或算法配置参数。

const ANDROID

XuAPI
pub const ANDROID = 2

用途

常量 ANDROID,定义了相关的协议或算法配置参数。

const HAPTIC_SELECTION

XuAPI
pub const HAPTIC_SELECTION = 1

用途

常量 HAPTIC_SELECTION,定义了相关的协议或算法配置参数。

const HAPTIC_IMPACT

XuAPI
pub const HAPTIC_IMPACT = 2

用途

常量 HAPTIC_IMPACT,定义了相关的协议或算法配置参数。

const HAPTIC_SUCCESS

XuAPI
pub const HAPTIC_SUCCESS = 3

用途

常量 HAPTIC_SUCCESS,定义了相关的协议或算法配置参数。

const HAPTIC_ERROR

XuAPI
pub const HAPTIC_ERROR = 4

用途

常量 HAPTIC_ERROR,定义了相关的协议或算法配置参数。

platform

XuAPI
pub fn platform() int

用途

执行 platform 处理。

参数

无需传入参数。

返回值

int — 该类型的值

available

XuAPI
pub fn available() bool

用途

剩余空间。

参数

无需传入参数。

返回值

bool — 是否成立

set_back_enabled

XuAPI
pub fn set_back_enabled(enabled bool) int

用途

设置 back enabled。失败时抛出错误,调用方需处理或继续传播。

参数

enabled bool
enabled(bool)

返回值

int — 该类型的值

set_dark_appearance

XuAPI
pub fn set_dark_appearance(dark bool) int

用途

设置 dark appearance。失败时抛出错误,调用方需处理或继续传播。

参数

dark bool
dark(bool)

返回值

int — 该类型的值

set_overlay

XuAPI
pub fn set_overlay(visible bool) int

用途

设置 overlay。失败时抛出错误,调用方需处理或继续传播。

参数

visible bool
visible(bool)

返回值

int — 该类型的值

haptic

XuAPI
pub fn haptic(kind int)

用途

执行 haptic 处理。

参数

kind int
类型标签(int)

返回值

不返回值。

struct Canvas

XuAPI
pub struct Canvas {
    pub frame draw.Frame
}

用途

承载 frame 等属性的结构体。

公开字段

frame draw.Frame
字段(draw.Frame)

canvas

XuAPI
pub fn canvas(context &draw.Context) Canvas

用途

执行 canvas 处理。

参数

context &draw.Context
context(只读借用,调用方仍持有原值;类型 &draw.Context)

返回值

Canvas — 该类型的值

canvas_with_identity

XuAPI
pub fn canvas_with_identity(context &draw.Context,identity &ui.CanvasEvent) Canvas

用途

执行 canvas with identity 操作。

参数

context &draw.Context
context(只读借用,调用方仍持有原值;类型 &draw.Context)
identity &ui.CanvasEvent
identity(只读借用,调用方仍持有原值;类型 &ui.CanvasEvent)

返回值

Canvas — 该类型的值

($&Canvas) set_identity

XuAPI
pub fn (c $&Canvas) set_identity(identity &ui.CanvasEvent)

用途

$&Canvas 上的操作:设置 identity。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
identity &ui.CanvasEvent
identity(只读借用,调用方仍持有原值;类型 &ui.CanvasEvent)

返回值

不返回值。

($&Canvas) set_locale

XuAPI
pub fn (c $&Canvas) set_locale(locale int)

用途

$&Canvas 上的操作:设置 locale。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
locale int
locale(int)

返回值

不返回值。

($&Canvas) set_text_selectable

XuAPI
pub fn (c $&Canvas) set_text_selectable(id int,selectable bool)

用途

$&Canvas 上的操作:设置 text selectable。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
id int
id(int)
selectable bool
selectable(bool)

返回值

不返回值。

(&Canvas) is_text_selectable

XuAPI
pub fn (c &Canvas) is_text_selectable(id int) bool

用途

&Canvas 上的操作:判断是否 text selectable。

参数

c &Canvas
本次调用使用的 Canvas 实例;以只读借用传入,调用方仍持有实例。
id int
id(int)

返回值

bool — 是否成立

(&Canvas) selected_text

XuAPI
pub fn (c &Canvas) selected_text(id int) string

用途

&Canvas 上的操作:执行 selected text 操作。

参数

c &Canvas
本次调用使用的 Canvas 实例;以只读借用传入,调用方仍持有实例。
id int
id(int)

返回值

string — 结果字符串

($&Canvas) set_font_stack

XuAPI
pub fn (c $&Canvas) set_font_stack(stack font.FontStack)

用途

$&Canvas 上的操作:设置 font stack。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
stack font.FontStack
stack(font.FontStack)

返回值

不返回值。

($&Canvas) add_ttf_bytes

XuAPI
pub fn (c $&Canvas) add_ttf_bytes(ttf_bytes &[]u8,font_index int,face_id int) int

用途

$&Canvas 上的操作:执行 add ttf bytes 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
ttf_bytes &[]u8
ttf_bytes(只读借用,调用方仍持有原值;类型 &[]u8)
font_index int
font_index(int)
face_id int
face_id(int)

返回值

int — 该类型的值

($&Canvas) begin

XuAPI
pub fn (c $&Canvas) begin(theme &Theme) int

用途

在 $&Canvas 上执行 begin 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
theme &Theme
theme(只读借用,调用方仍持有原值;类型 &Theme)

返回值

int — 该类型的值

($&Canvas) present

XuAPI
pub fn (c $&Canvas) present() int

用途

在 $&Canvas 上执行 present 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

int — 该类型的值

($&Canvas) export_xdf

XuAPI
pub fn (c $&Canvas) export_xdf() string

用途

$&Canvas 上的操作:执行 export xdf 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

string — 结果字符串

($&Canvas) dispose

XuAPI
pub fn (c $&Canvas) dispose()

用途

释放并清理对象所持有的系统原生资源与底层句柄。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

不返回值。

($&Canvas) shape_text

XuAPI
pub fn (c $&Canvas) shape_text(value &string,size f64,weight int,line_height f64,width f64,align int) draw.TextLayout

用途

$&Canvas 上的操作:执行 shape text 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
value &string
value(只读借用,调用方仍持有原值;类型 &string)
size f64
size(f64)
weight int
weight(int)
line_height f64
line_height(f64)
width f64
width(f64)
align int
align(int)

返回值

draw.TextLayout — 该类型的值

($&Canvas) put_text

XuAPI
pub fn (c $&Canvas) put_text(text draw.TextLayout,x f64,y f64,color draw.Color) int

用途

$&Canvas 上的操作:执行 put text 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
text draw.TextLayout
文本(draw.TextLayout)
x f64
值(f64)
y f64
值(f64)
color draw.Color
color(draw.Color)

返回值

int — 该类型的值

($&Canvas) label

XuAPI
pub fn (c $&Canvas) label(bounds layout.Rect,value string,size f64,weight int,color draw.Color,align int) int

用途

在 $&Canvas 上执行 label 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
bounds layout.Rect
bounds(layout.Rect)
value string
value(string)
size f64
size(f64)
weight int
weight(int)
color draw.Color
color(draw.Color)
align int
align(int)

返回值

int — 该类型的值

($&Canvas) measure_paragraph

XuAPI
pub fn (c $&Canvas) measure_paragraph(value &string,size f64,weight int,line_height f64,width f64) f64

用途

$&Canvas 上的操作:执行 measure paragraph 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
value &string
value(只读借用,调用方仍持有原值;类型 &string)
size f64
size(f64)
weight int
weight(int)
line_height f64
line_height(f64)
width f64
width(f64)

返回值

f64 — 该类型的值

($&Canvas) paragraph

XuAPI
pub fn (c $&Canvas) paragraph(bounds layout.Rect,value string,size f64,weight int,line_height f64,color draw.Color,align int) f64

用途

在 $&Canvas 上执行 paragraph 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
bounds layout.Rect
bounds(layout.Rect)
value string
value(string)
size f64
size(f64)
weight int
weight(int)
line_height f64
line_height(f64)
color draw.Color
color(draw.Color)
align int
align(int)

返回值

f64 — 该类型的值

($&Canvas) selectable_label

XuAPI
pub fn (c $&Canvas) selectable_label(t $&Touch,id int,bounds layout.Rect,value string,size f64,weight int,color draw.Color,align int,clip &layout.Rect,theme &Theme) int

用途

$&Canvas 上的操作:执行 selectable label 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
t $&Touch
t(独占借用,可修改原值;类型 $&Touch)
id int
id(int)
bounds layout.Rect
bounds(layout.Rect)
value string
value(string)
size f64
size(f64)
weight int
weight(int)
color draw.Color
color(draw.Color)
align int
align(int)
clip &layout.Rect
clip(只读借用,调用方仍持有原值;类型 &layout.Rect)
theme &Theme
theme(只读借用,调用方仍持有原值;类型 &Theme)

返回值

int — 该类型的值

($&Canvas) selectable_paragraph

XuAPI
pub fn (c $&Canvas) selectable_paragraph(t $&Touch,id int,bounds layout.Rect,value string,size f64,weight int,line_height f64,color draw.Color,align int,clip &layout.Rect,theme &Theme) f64

用途

$&Canvas 上的操作:执行 selectable paragraph 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
t $&Touch
t(独占借用,可修改原值;类型 $&Touch)
id int
id(int)
bounds layout.Rect
bounds(layout.Rect)
value string
value(string)
size f64
size(f64)
weight int
weight(int)
line_height f64
line_height(f64)
color draw.Color
color(draw.Color)
align int
align(int)
clip &layout.Rect
clip(只读借用,调用方仍持有原值;类型 &layout.Rect)
theme &Theme
theme(只读借用,调用方仍持有原值;类型 &Theme)

返回值

f64 — 该类型的值

($&Canvas) draw_selectable

XuAPI
pub fn (c $&Canvas) draw_selectable(state $&SelectableText,t $&Touch,bounds layout.Rect,clip &layout.Rect,theme &Theme,color draw.Color) f64

用途

$&Canvas 上的操作:执行 draw selectable 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
state $&SelectableText
state(独占借用,可修改原值;类型 $&SelectableText)
t $&Touch
t(独占借用,可修改原值;类型 $&Touch)
bounds layout.Rect
bounds(layout.Rect)
clip &layout.Rect
clip(只读借用,调用方仍持有原值;类型 &layout.Rect)
theme &Theme
theme(只读借用,调用方仍持有原值;类型 &Theme)
color draw.Color
color(draw.Color)

返回值

f64 — 该类型的值

($&Canvas) handle_text_selection

XuAPI
pub fn (c $&Canvas) handle_text_selection(event &ui.Event,touches &Touch,action int) SelectableTextResult

用途

$&Canvas 上的操作:执行 handle text selection 操作。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
event &ui.Event
event(只读借用,调用方仍持有原值;类型 &ui.Event)
touches &Touch
touches(只读借用,调用方仍持有原值;类型 &Touch)
action int
action(int)

返回值

SelectableTextResult — 该类型的值

($&Canvas) card

XuAPI
pub fn (c $&Canvas) card(bounds layout.Rect,theme &Theme) int

用途

在 $&Canvas 上执行 card 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
bounds layout.Rect
bounds(layout.Rect)
theme &Theme
theme(只读借用,调用方仍持有原值;类型 &Theme)

返回值

int — 该类型的值

const ICON_HOME

XuAPI
pub const ICON_HOME = 1

用途

常量 ICON_HOME,定义了相关的协议或算法配置参数。

const ICON_HISTORY

XuAPI
pub const ICON_HISTORY = 2

用途

常量 ICON_HISTORY,定义了相关的协议或算法配置参数。

const ICON_SETTINGS

XuAPI
pub const ICON_SETTINGS = 3

用途

常量 ICON_SETTINGS,定义了相关的协议或算法配置参数。

const ICON_PLUS

XuAPI
pub const ICON_PLUS = 4

用途

常量 ICON_PLUS,定义了相关的协议或算法配置参数。

const ICON_CHEVRON

XuAPI
pub const ICON_CHEVRON = 5

用途

常量 ICON_CHEVRON,定义了相关的协议或算法配置参数。

const ICON_CLOSE

XuAPI
pub const ICON_CLOSE = 6

用途

常量 ICON_CLOSE,定义了相关的协议或算法配置参数。

const ICON_CHECK

XuAPI
pub const ICON_CHECK = 7

用途

常量 ICON_CHECK,定义了相关的协议或算法配置参数。

const ICON_FOCUS

XuAPI
pub const ICON_FOCUS = 8

用途

常量 ICON_FOCUS,定义了相关的协议或算法配置参数。

const ICON_BOOK

XuAPI
pub const ICON_BOOK = 9

用途

常量 ICON_BOOK,定义了相关的协议或算法配置参数。

const ICON_ACTIVITY

XuAPI
pub const ICON_ACTIVITY = 10

用途

常量 ICON_ACTIVITY,定义了相关的协议或算法配置参数。

const ICON_BACK

XuAPI
pub const ICON_BACK = 11

用途

常量 ICON_BACK,定义了相关的协议或算法配置参数。

const ICON_REFRESH

XuAPI
pub const ICON_REFRESH = 12

用途

常量 ICON_REFRESH,定义了相关的协议或算法配置参数。

const ICON_COPY

XuAPI
pub const ICON_COPY = 13

用途

常量 ICON_COPY,定义了相关的协议或算法配置参数。

const TONE_SECONDARY

XuAPI
pub const TONE_SECONDARY = 0

用途

常量 TONE_SECONDARY,定义了相关的协议或算法配置参数。

const TONE_PRIMARY

XuAPI
pub const TONE_PRIMARY = 1

用途

常量 TONE_PRIMARY,定义了相关的协议或算法配置参数。

const TONE_DANGER

XuAPI
pub const TONE_DANGER = 2

用途

常量 TONE_DANGER,定义了相关的协议或算法配置参数。

($&Canvas) icon

XuAPI
pub fn (c $&Canvas) icon(bounds layout.Rect,kind int,color draw.Color) int

用途

在 $&Canvas 上执行 icon 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
bounds layout.Rect
bounds(layout.Rect)
kind int
类型标签(int)
color draw.Color
color(draw.Color)

返回值

int — 该类型的值

($&Canvas) button_tone

XuAPI
pub fn (c $&Canvas) button_tone(bounds layout.Rect,theme &Theme,label string,tone int,pressed bool) int

用途

$&Canvas 上的操作:执行 button tone 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
bounds layout.Rect
bounds(layout.Rect)
theme &Theme
theme(只读借用,调用方仍持有原值;类型 &Theme)
label string
label(string)
tone int
tone(int)
pressed bool
pressed(bool)

返回值

int — 该类型的值

($&Canvas) button

XuAPI
pub fn (c $&Canvas) button(bounds layout.Rect,theme &Theme,label string,primary bool,pressed bool) int

用途

在 $&Canvas 上执行 button 操作。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
bounds layout.Rect
bounds(layout.Rect)
theme &Theme
theme(只读借用,调用方仍持有原值;类型 &Theme)
label string
label(string)
primary bool
primary(bool)
pressed bool
pressed(bool)

返回值

int — 该类型的值

($&Canvas) chip

XuAPI
pub fn (c $&Canvas) chip(bounds layout.Rect,theme &Theme,label string,selected bool,pressed bool) int

用途

在 $&Canvas 上执行 chip 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
bounds layout.Rect
bounds(layout.Rect)
theme &Theme
theme(只读借用,调用方仍持有原值;类型 &Theme)
label string
label(string)
selected bool
selected(bool)
pressed bool
pressed(bool)

返回值

int — 该类型的值

($&Canvas) navigation

XuAPI
pub fn (c $&Canvas) navigation(shell &Scaffold,theme &Theme,selected int,touches &Touch) int

用途

在 $&Canvas 上执行 navigation 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
shell &Scaffold
shell(只读借用,调用方仍持有原值;类型 &Scaffold)
theme &Theme
theme(只读借用,调用方仍持有原值;类型 &Theme)
selected int
selected(int)
touches &Touch
touches(只读借用,调用方仍持有原值;类型 &Touch)

返回值

int — 该类型的值

($&Canvas) scrollbar

XuAPI
pub fn (c $&Canvas) scrollbar(bounds &layout.Rect,theme &Theme,scroll f64,maximum f64,content_height f64) int

用途

在 $&Canvas 上执行 scrollbar 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
bounds &layout.Rect
bounds(只读借用,调用方仍持有原值;类型 &layout.Rect)
theme &Theme
theme(只读借用,调用方仍持有原值;类型 &Theme)
scroll f64
scroll(f64)
maximum f64
maximum(f64)
content_height f64
content_height(f64)

返回值

int — 该类型的值

snackbar_action_bounds

XuAPI
pub fn snackbar_action_bounds(bounds &layout.Rect,has_action bool) layout.Rect

用途

执行 snackbar action bounds 操作。

参数

bounds &layout.Rect
bounds(只读借用,调用方仍持有原值;类型 &layout.Rect)
has_action bool
has_action(bool)

返回值

layout.Rect — 该类型的值

($&Canvas) refresh_indicator

XuAPI
pub fn (c $&Canvas) refresh_indicator(bounds layout.Rect,theme &Theme,pull f64,ready bool,reduced bool) int

用途

$&Canvas 上的操作:执行 refresh indicator 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
bounds layout.Rect
bounds(layout.Rect)
theme &Theme
theme(只读借用,调用方仍持有原值;类型 &Theme)
pull f64
pull(f64)
ready bool
ready(bool)
reduced bool
reduced(bool)

返回值

int — 该类型的值

($&Canvas) snackbar

XuAPI
pub fn (c $&Canvas) snackbar(bounds &layout.Rect,theme &Theme,message string,action_label string,action_pressed bool) int

用途

在 $&Canvas 上执行 snackbar 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
bounds &layout.Rect
bounds(只读借用,调用方仍持有原值;类型 &layout.Rect)
theme &Theme
theme(只读借用,调用方仍持有原值;类型 &Theme)
message string
message(string)
action_label string
action_label(string)
action_pressed bool
action_pressed(bool)

返回值

int — 该类型的值

($&Canvas) row

XuAPI
pub fn (c $&Canvas) row(bounds layout.Rect,theme &Theme,title string,detail string,kind int,pressed bool) int

用途

在 $&Canvas 上执行 row 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
bounds layout.Rect
bounds(layout.Rect)
theme &Theme
theme(只读借用,调用方仍持有原值;类型 &Theme)
title string
title(string)
detail string
detail(string)
kind int
类型标签(int)
pressed bool
pressed(bool)

返回值

int — 该类型的值

($&Canvas) sheet

XuAPI
pub fn (c $&Canvas) sheet(shell &Scaffold,theme &Theme,bounds layout.Rect,title string) int

用途

在 $&Canvas 上执行 sheet 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
shell &Scaffold
shell(只读借用,调用方仍持有原值;类型 &Scaffold)
theme &Theme
theme(只读借用,调用方仍持有原值;类型 &Theme)
bounds layout.Rect
bounds(layout.Rect)
title string
title(string)

返回值

int — 该类型的值

($&Canvas) fill_round_rect

XuAPI
pub fn (c $&Canvas) fill_round_rect(x f64,y f64,width f64,height f64,radius f64,color draw.Color) int

用途

$&Canvas 上的操作:执行 fill round rect 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
x f64
值(f64)
y f64
值(f64)
width f64
width(f64)
height f64
height(f64)
radius f64
radius(f64)
color draw.Color
color(draw.Color)

返回值

int — 该类型的值

($&Canvas) fill_rect

XuAPI
pub fn (c $&Canvas) fill_rect(x f64,y f64,width f64,height f64,color draw.Color) int

用途

$&Canvas 上的操作:执行 fill rect 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
x f64
值(f64)
y f64
值(f64)
width f64
width(f64)
height f64
height(f64)
color draw.Color
color(draw.Color)

返回值

int — 该类型的值

($&Canvas) line

XuAPI
pub fn (c $&Canvas) line(x1 f64,y1 f64,x2 f64,y2 f64,color draw.Color,width f64) int

用途

在 $&Canvas 上执行 line 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
x1 f64
x1(f64)
y1 f64
y1(f64)
x2 f64
x2(f64)
y2 f64
y2(f64)
color draw.Color
color(draw.Color)
width f64
width(f64)

返回值

int — 该类型的值

($&Canvas) fill_circle

XuAPI
pub fn (c $&Canvas) fill_circle(x f64,y f64,radius f64,color draw.Color) int

用途

$&Canvas 上的操作:执行 fill circle 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
x f64
值(f64)
y f64
值(f64)
radius f64
radius(f64)
color draw.Color
color(draw.Color)

返回值

int — 该类型的值

($&Canvas) stroke_circle

XuAPI
pub fn (c $&Canvas) stroke_circle(x f64,y f64,radius f64,color draw.Color,width f64) int

用途

$&Canvas 上的操作:执行 stroke circle 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
x f64
值(f64)
y f64
值(f64)
radius f64
radius(f64)
color draw.Color
color(draw.Color)
width f64
width(f64)

返回值

int — 该类型的值

($&Canvas) stroke_round_rect

XuAPI
pub fn (c $&Canvas) stroke_round_rect(x f64,y f64,width f64,height f64,radius f64,color draw.Color,line_width f64) int

用途

$&Canvas 上的操作:执行 stroke round rect 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
x f64
值(f64)
y f64
值(f64)
width f64
width(f64)
height f64
height(f64)
radius f64
radius(f64)
color draw.Color
color(draw.Color)
line_width f64
line_width(f64)

返回值

int — 该类型的值

($&Canvas) clip_rect

XuAPI
pub fn (c $&Canvas) clip_rect(x f64,y f64,width f64,height f64) int

用途

$&Canvas 上的操作:执行 clip rect 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
x f64
值(f64)
y f64
值(f64)
width f64
width(f64)
height f64
height(f64)

返回值

int — 该类型的值

($&Canvas) push

XuAPI
pub fn (c $&Canvas) push() int

用途

$&Canvas 上的操作:压入。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

int — 该类型的值

($&Canvas) pop

XuAPI
pub fn (c $&Canvas) pop() int

用途

$&Canvas 上的操作:弹出。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

int — 该类型的值

($&Canvas) scrim

XuAPI
pub fn (c $&Canvas) scrim(width f64,height f64,theme &Theme) int

用途

在 $&Canvas 上执行 scrim 操作。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
width f64
width(f64)
height f64
height(f64)
theme &Theme
theme(只读借用,调用方仍持有原值;类型 &Theme)

返回值

int — 该类型的值

($&Canvas) divider

XuAPI
pub fn (c $&Canvas) divider(bounds layout.Rect,theme &Theme) int

用途

在 $&Canvas 上执行 divider 操作。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
bounds layout.Rect
bounds(layout.Rect)
theme &Theme
theme(只读借用,调用方仍持有原值;类型 &Theme)

返回值

int — 该类型的值

($&Canvas) toggle_switch

XuAPI
pub fn (c $&Canvas) toggle_switch(bounds layout.Rect,theme &Theme,checked bool,pressed bool,enabled bool) int

用途

$&Canvas 上的操作:执行 toggle switch 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
bounds layout.Rect
bounds(layout.Rect)
theme &Theme
theme(只读借用,调用方仍持有原值;类型 &Theme)
checked bool
checked(bool)
pressed bool
pressed(bool)
enabled bool
enabled(bool)

返回值

int — 该类型的值

($&Canvas) switch_row

XuAPI
pub fn (c $&Canvas) switch_row(bounds layout.Rect,theme &Theme,title string,detail string,checked bool,pressed bool,enabled bool) int

用途

$&Canvas 上的操作:执行 switch row 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
bounds layout.Rect
bounds(layout.Rect)
theme &Theme
theme(只读借用,调用方仍持有原值;类型 &Theme)
title string
title(string)
detail string
detail(string)
checked bool
checked(bool)
pressed bool
pressed(bool)
enabled bool
enabled(bool)

返回值

int — 该类型的值

($&Canvas) check_row

XuAPI
pub fn (c $&Canvas) check_row(bounds layout.Rect,theme &Theme,title string,detail string,checked bool,pressed bool,enabled bool) int

用途

$&Canvas 上的操作:执行 check row 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
bounds layout.Rect
bounds(layout.Rect)
theme &Theme
theme(只读借用,调用方仍持有原值;类型 &Theme)
title string
title(string)
detail string
detail(string)
checked bool
checked(bool)
pressed bool
pressed(bool)
enabled bool
enabled(bool)

返回值

int — 该类型的值

($&Canvas) radio_row

XuAPI
pub fn (c $&Canvas) radio_row(bounds layout.Rect,theme &Theme,title string,detail string,selected bool,pressed bool,enabled bool) int

用途

$&Canvas 上的操作:执行 radio row 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
bounds layout.Rect
bounds(layout.Rect)
theme &Theme
theme(只读借用,调用方仍持有原值;类型 &Theme)
title string
title(string)
detail string
detail(string)
selected bool
selected(bool)
pressed bool
pressed(bool)
enabled bool
enabled(bool)

返回值

int — 该类型的值

($&Canvas) progress_bar

XuAPI
pub fn (c $&Canvas) progress_bar(bounds layout.Rect,theme &Theme,value f64,tone int) int

用途

$&Canvas 上的操作:执行 progress bar 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
bounds layout.Rect
bounds(layout.Rect)
theme &Theme
theme(只读借用,调用方仍持有原值;类型 &Theme)
value f64
value(f64)
tone int
tone(int)

返回值

int — 该类型的值

($&Canvas) badge

XuAPI
pub fn (c $&Canvas) badge(bounds layout.Rect,theme &Theme,text string,tone int) int

用途

在 $&Canvas 上执行 badge 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
bounds layout.Rect
bounds(layout.Rect)
theme &Theme
theme(只读借用,调用方仍持有原值;类型 &Theme)
text string
文本(string)
tone int
tone(int)

返回值

int — 该类型的值

($&Canvas) badge_count

XuAPI
pub fn (c $&Canvas) badge_count(bounds layout.Rect,theme &Theme,count int) int

用途

$&Canvas 上的操作:执行 badge count 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
bounds layout.Rect
bounds(layout.Rect)
theme &Theme
theme(只读借用,调用方仍持有原值;类型 &Theme)
count int
count(int)

返回值

int — 该类型的值

($&Canvas) empty_state

XuAPI
pub fn (c $&Canvas) empty_state(bounds layout.Rect,theme &Theme,icon_kind int,title string,body string) int

用途

$&Canvas 上的操作:执行 empty state 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
bounds layout.Rect
bounds(layout.Rect)
theme &Theme
theme(只读借用,调用方仍持有原值;类型 &Theme)
icon_kind int
icon_kind(int)
title string
title(string)
body string
正文(string)

返回值

int — 该类型的值

($&Canvas) segmented

XuAPI
pub fn (c $&Canvas) segmented(bounds layout.Rect,theme &Theme,labels &[]string,selected int,pressed_index int) int

用途

在 $&Canvas 上执行 segmented 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
bounds layout.Rect
bounds(layout.Rect)
theme &Theme
theme(只读借用,调用方仍持有原值;类型 &Theme)
labels &[]string
labels(只读借用,调用方仍持有原值;类型 &[]string)
selected int
selected(int)
pressed_index int
pressed_index(int)

返回值

int — 该类型的值

($&Canvas) slider

XuAPI
pub fn (c $&Canvas) slider(bounds layout.Rect,theme &Theme,value f64,min_val f64,max_val f64,pressed bool,enabled bool) int

用途

在 $&Canvas 上执行 slider 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
bounds layout.Rect
bounds(layout.Rect)
theme &Theme
theme(只读借用,调用方仍持有原值;类型 &Theme)
value f64
value(f64)
min_val f64
min_val(f64)
max_val f64
max_val(f64)
pressed bool
pressed(bool)
enabled bool
enabled(bool)

返回值

int — 该类型的值

($&Canvas) confirm_dialog

XuAPI
pub fn (c $&Canvas) confirm_dialog(bounds layout.Rect,theme &Theme,title string,body string,cancel_label string,confirm_label string,danger bool,cancel_pressed bool,confirm_pressed bool) int

用途

$&Canvas 上的操作:执行 confirm dialog 操作。失败时抛出错误,调用方需处理或继续传播。

参数

c $&Canvas
本次调用使用的 Canvas 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
bounds layout.Rect
bounds(layout.Rect)
theme &Theme
theme(只读借用,调用方仍持有原值;类型 &Theme)
title string
title(string)
body string
正文(string)
cancel_label string
cancel_label(string)
confirm_label string
confirm_label(string)
danger bool
danger(bool)
cancel_pressed bool
cancel_pressed(bool)
confirm_pressed bool
confirm_pressed(bool)

返回值

int — 该类型的值

const TOUCH_SIZE

XuAPI
pub const TOUCH_SIZE = 48

用途

常量 TOUCH_SIZE,定义了相关的协议或算法配置参数。

const PAGE_PADDING

XuAPI
pub const PAGE_PADDING = 20

用途

常量 PAGE_PADDING,定义了相关的协议或算法配置参数。

const ROW_HEIGHT

XuAPI
pub const ROW_HEIGHT = 72

用途

常量 ROW_HEIGHT,定义了相关的协议或算法配置参数。

const REFRESH_THRESHOLD

XuAPI
pub const REFRESH_THRESHOLD = 64

用途

常量 REFRESH_THRESHOLD,定义了相关的协议或算法配置参数。

const TAB_HOME

XuAPI
pub const TAB_HOME = 1

用途

常量 TAB_HOME,定义了相关的协议或算法配置参数。

const TAB_HISTORY

XuAPI
pub const TAB_HISTORY = 2

用途

常量 TAB_HISTORY,定义了相关的协议或算法配置参数。

const TAB_SETTINGS

XuAPI
pub const TAB_SETTINGS = 3

用途

常量 TAB_SETTINGS,定义了相关的协议或算法配置参数。

const BADGE_NEUTRAL

XuAPI
pub const BADGE_NEUTRAL = 0

用途

常量 BADGE_NEUTRAL,定义了相关的协议或算法配置参数。

const BADGE_INFO

XuAPI
pub const BADGE_INFO = 1

用途

常量 BADGE_INFO,定义了相关的协议或算法配置参数。

const BADGE_POSITIVE

XuAPI
pub const BADGE_POSITIVE = 2

用途

常量 BADGE_POSITIVE,定义了相关的协议或算法配置参数。

const BADGE_WARNING

XuAPI
pub const BADGE_WARNING = 3

用途

常量 BADGE_WARNING,定义了相关的协议或算法配置参数。

const BADGE_DANGER

XuAPI
pub const BADGE_DANGER = 4

用途

常量 BADGE_DANGER,定义了相关的协议或算法配置参数。

const SWITCH_WIDTH

XuAPI
pub const SWITCH_WIDTH = 44

用途

常量 SWITCH_WIDTH,定义了相关的协议或算法配置参数。

const SWITCH_HEIGHT

XuAPI
pub const SWITCH_HEIGHT = 24

用途

常量 SWITCH_HEIGHT,定义了相关的协议或算法配置参数。

const SLIDER_THUMB

XuAPI
pub const SLIDER_THUMB = 24

用途

常量 SLIDER_THUMB,定义了相关的协议或算法配置参数。

const PROGRESS_HEIGHT

XuAPI
pub const PROGRESS_HEIGHT = 6

用途

常量 PROGRESS_HEIGHT,定义了相关的协议或算法配置参数。

const DIALOG_RADIUS

XuAPI
pub const DIALOG_RADIUS = 16

用途

常量 DIALOG_RADIUS,定义了相关的协议或算法配置参数。

refresh_threshold

XuAPI
pub fn refresh_threshold() f64

用途

执行 refresh threshold 操作。

参数

无需传入参数。

返回值

f64 — 该类型的值

switch_width

XuAPI
pub fn switch_width() f64

用途

执行 switch width 操作。

参数

无需传入参数。

返回值

f64 — 该类型的值

switch_height

XuAPI
pub fn switch_height() f64

用途

执行 switch height 操作。

参数

无需传入参数。

返回值

f64 — 该类型的值

slider_thumb

XuAPI
pub fn slider_thumb() f64

用途

执行 slider thumb 操作。

参数

无需传入参数。

返回值

f64 — 该类型的值

progress_height

XuAPI
pub fn progress_height() f64

用途

执行 progress height 操作。

参数

无需传入参数。

返回值

f64 — 该类型的值

dialog_radius

XuAPI
pub fn dialog_radius() f64

用途

执行 dialog radius 操作。

参数

无需传入参数。

返回值

f64 — 该类型的值

struct Theme

XuAPI
pub struct Theme {
    pub dark bool
    pub background draw.Color
    pub surface draw.Color
    pub elevated draw.Color
    pub subtle draw.Color
    pub subtle_pressed draw.Color
    pub ink draw.Color
    pub muted draw.Color
    pub border draw.Color
    pub control_border draw.Color
    pub accent draw.Color
    pub accent_hover draw.Color
    pub accent_pressed draw.Color
    pub accent_tint draw.Color
    pub on_accent draw.Color
    pub positive draw.Color
    pub positive_soft draw.Color
    pub warning draw.Color
    pub warning_soft draw.Color
    pub danger draw.Color
    pub danger_soft draw.Color
    pub info draw.Color
    pub info_soft draw.Color
    pub focus draw.Color
    pub scrim draw.Color
}

用途

承载 dark、background、surface、elevated、subtle 等属性的结构体。

公开字段

dark bool
字段(bool)
background draw.Color
字段(draw.Color)
surface draw.Color
字段(draw.Color)
elevated draw.Color
字段(draw.Color)
subtle draw.Color
字段(draw.Color)
subtle_pressed draw.Color
字段(draw.Color)
ink draw.Color
字段(draw.Color)
muted draw.Color
字段(draw.Color)
border draw.Color
字段(draw.Color)
control_border draw.Color
字段(draw.Color)
accent draw.Color
字段(draw.Color)
accent_hover draw.Color
字段(draw.Color)
accent_pressed draw.Color
字段(draw.Color)
accent_tint draw.Color
字段(draw.Color)
on_accent draw.Color
字段(draw.Color)
positive draw.Color
字段(draw.Color)
positive_soft draw.Color
字段(draw.Color)
warning draw.Color
字段(draw.Color)
warning_soft draw.Color
字段(draw.Color)
danger draw.Color
字段(draw.Color)
danger_soft draw.Color
字段(draw.Color)
info draw.Color
字段(draw.Color)
info_soft draw.Color
字段(draw.Color)
focus draw.Color
字段(draw.Color)
scrim draw.Color
字段(draw.Color)

light_theme

XuAPI
pub fn light_theme() Theme

用途

执行 light theme 操作。

参数

无需传入参数。

返回值

Theme — 该类型的值

dark_theme

XuAPI
pub fn dark_theme() Theme

用途

执行 dark theme 操作。

参数

无需传入参数。

返回值

Theme — 该类型的值

rect

XuAPI
pub fn rect(x f64,y f64,width f64,height f64) layout.Rect

用途

矩形。

参数

x f64
值(f64)
y f64
值(f64)
width f64
width(f64)
height f64
height(f64)

返回值

layout.Rect — 该类型的值

struct Scaffold

XuAPI
pub struct Scaffold {
    pub width f64
    pub height f64
    pub wide bool
    pub safe Insets
    pub header layout.Rect
    pub body layout.Rect
    pub navigation layout.Rect
    pub action layout.Rect
}

用途

承载 width、height、wide、safe、header 等属性的结构体。

公开字段

width f64
字段(f64)
height f64
字段(f64)
wide bool
字段(bool)
safe Insets
字段(Insets)
header layout.Rect
字段(layout.Rect)
body layout.Rect
正文
navigation layout.Rect
字段(layout.Rect)
action layout.Rect
字段(layout.Rect)

scaffold_with

XuAPI
pub fn scaffold_with(width f64,height f64,safe Insets) Scaffold

用途

执行 scaffold with 操作。失败时抛出错误,调用方需处理或继续传播。

参数

width f64
width(f64)
height f64
height(f64)
safe Insets
safe(Insets)

返回值

Scaffold — 该类型的值

scaffold

XuAPI
pub fn scaffold(width f64,height f64) Scaffold

用途

执行 scaffold 处理。

参数

width f64
width(f64)
height f64
height(f64)

返回值

Scaffold — 该类型的值

tab_bounds

XuAPI
pub fn tab_bounds(shell &Scaffold,index int) layout.Rect

用途

执行 tab bounds 操作。

参数

shell &Scaffold
shell(只读借用,调用方仍持有原值;类型 &Scaffold)
index int
index(int)

返回值

layout.Rect — 该类型的值

sheet_bounds

XuAPI
pub fn sheet_bounds(width f64,height f64,preferred_height f64) layout.Rect

用途

执行 sheet bounds 操作。

参数

width f64
width(f64)
height f64
height(f64)
preferred_height f64
preferred_height(f64)

返回值

layout.Rect — 该类型的值

sheet_bounds_with

XuAPI
pub fn sheet_bounds_with(shell &Scaffold,preferred_height f64) layout.Rect

用途

执行 sheet bounds with 操作。

参数

shell &Scaffold
shell(只读借用,调用方仍持有原值;类型 &Scaffold)
preferred_height f64
preferred_height(f64)

返回值

layout.Rect — 该类型的值

snackbar_bounds

XuAPI
pub fn snackbar_bounds(shell &Scaffold) layout.Rect

用途

执行 snackbar bounds 操作。

参数

shell &Scaffold
shell(只读借用,调用方仍持有原值;类型 &Scaffold)

返回值

layout.Rect — 该类型的值

intersection

XuAPI
pub fn intersection(a &layout.Rect,b &layout.Rect) layout.Rect

用途

执行 intersection 处理。

参数

a &layout.Rect
值(只读借用,调用方仍持有原值;类型 &layout.Rect)
b &layout.Rect
b(只读借用,调用方仍持有原值;类型 &layout.Rect)

返回值

layout.Rect — 该类型的值

dialog_bounds

XuAPI
pub fn dialog_bounds(width f64,height f64,safe Insets,ime_bottom f64,dialog_height f64) layout.Rect

用途

执行 dialog bounds 操作。

参数

width f64
width(f64)
height f64
height(f64)
safe Insets
safe(Insets)
ime_bottom f64
ime_bottom(f64)
dialog_height f64
dialog_height(f64)

返回值

layout.Rect — 该类型的值

dialog_button_bounds

XuAPI
pub fn dialog_button_bounds(dialog &layout.Rect,which int) layout.Rect

用途

执行 dialog button bounds 操作。

参数

dialog &layout.Rect
dialog(只读借用,调用方仍持有原值;类型 &layout.Rect)
which int
which(int)

返回值

layout.Rect — 该类型的值

segmented_item_bounds

XuAPI
pub fn segmented_item_bounds(bounds &layout.Rect,count int,index int) layout.Rect

用途

执行 segmented item bounds 操作。

参数

bounds &layout.Rect
bounds(只读借用,调用方仍持有原值;类型 &layout.Rect)
count int
count(int)
index int
index(int)

返回值

layout.Rect — 该类型的值

slider_value_at

XuAPI
pub fn slider_value_at(bounds &layout.Rect,x f64,min_val f64,max_val f64,step f64) f64

用途

执行 slider value at 操作。

参数

bounds &layout.Rect
bounds(只读借用,调用方仍持有原值;类型 &layout.Rect)
x f64
值(f64)
min_val f64
min_val(f64)
max_val f64
max_val(f64)
step f64
step(f64)

返回值

f64 — 该类型的值

const DRAG_NONE

XuAPI
pub const DRAG_NONE = 0

用途

常量 DRAG_NONE,定义了相关的协议或算法配置参数。

const DRAG_VERTICAL

XuAPI
pub const DRAG_VERTICAL = 1

用途

常量 DRAG_VERTICAL,定义了相关的协议或算法配置参数。

const DRAG_HORIZONTAL

XuAPI
pub const DRAG_HORIZONTAL = 2

用途

常量 DRAG_HORIZONTAL,定义了相关的协议或算法配置参数。

struct Touch

XuAPI
pub struct Touch {

}

用途

Touch 上下文或状态结构体。

公开字段

此类型没有公开字段。

touch

XuAPI
pub fn touch(identity &ui.CanvasEvent) Touch

用途

执行 touch 处理。

参数

identity &ui.CanvasEvent
identity(只读借用,调用方仍持有原值;类型 &ui.CanvasEvent)

返回值

Touch — 该类型的值

($&Touch) set_bouncing

XuAPI
pub fn (t $&Touch) set_bouncing(enabled bool)

用途

$&Touch 上的操作:设置 bouncing。

参数

t $&Touch
本次调用使用的 Touch 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
enabled bool
enabled(bool)

返回值

不返回值。

($&Touch) set_edge_back

XuAPI
pub fn (t $&Touch) set_edge_back(enabled bool,safe_left f64)

用途

$&Touch 上的操作:设置 edge back。

参数

t $&Touch
本次调用使用的 Touch 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
enabled bool
enabled(bool)
safe_left f64
safe_left(f64)

返回值

不返回值。

($&Touch) set_refresh_enabled

XuAPI
pub fn (t $&Touch) set_refresh_enabled(enabled bool)

用途

$&Touch 上的操作:设置 refresh enabled。

参数

t $&Touch
本次调用使用的 Touch 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
enabled bool
enabled(bool)

返回值

不返回值。

(&Touch) refresh_pull

XuAPI
pub fn (t &Touch) refresh_pull() f64

用途

&Touch 上的操作:执行 refresh pull 操作。

参数

t &Touch
本次调用使用的 Touch 实例;以只读借用传入,调用方仍持有实例。

返回值

f64 — 该类型的值

(&Touch) refresh_progress

XuAPI
pub fn (t &Touch) refresh_progress() f64

用途

&Touch 上的操作:执行 refresh progress 操作。

参数

t &Touch
本次调用使用的 Touch 实例;以只读借用传入,调用方仍持有实例。

返回值

f64 — 该类型的值

(&Touch) refresh_ready

XuAPI
pub fn (t &Touch) refresh_ready() bool

用途

&Touch 上的操作:执行 refresh ready 操作。

参数

t &Touch
本次调用使用的 Touch 实例;以只读借用传入,调用方仍持有实例。

返回值

bool — 是否成立

($&Touch) take_refresh

XuAPI
pub fn (t $&Touch) take_refresh() bool

用途

$&Touch 上的操作:执行 take refresh 操作。

参数

t $&Touch
本次调用使用的 Touch 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

bool — 是否成立

($&Touch) take_refresh_haptic

XuAPI
pub fn (t $&Touch) take_refresh_haptic() bool

用途

$&Touch 上的操作:执行 take refresh haptic 操作。

参数

t $&Touch
本次调用使用的 Touch 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

bool — 是否成立

($&Touch) begin

XuAPI
pub fn (t $&Touch) begin()

用途

在 $&Touch 上执行 begin 操作。

参数

t $&Touch
本次调用使用的 Touch 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

不返回值。

($&Touch) selection_region

XuAPI
pub fn (t $&Touch) selection_region(bounds layout.Rect,active bool)

用途

$&Touch 上的操作:执行 selection region 操作。

参数

t $&Touch
本次调用使用的 Touch 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
bounds layout.Rect
bounds(layout.Rect)
active bool
active(bool)

返回值

不返回值。

($&Touch) target

XuAPI
pub fn (t $&Touch) target(id int,bounds layout.Rect) int

用途

在 $&Touch 上执行 target 操作。失败时抛出错误,调用方需处理或继续传播。

参数

t $&Touch
本次调用使用的 Touch 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
id int
id(int)
bounds layout.Rect
bounds(layout.Rect)

返回值

int — 该类型的值

(&Touch) pressed

XuAPI
pub fn (t &Touch) pressed(id int) bool

用途

在 &Touch 上执行 pressed 操作。

参数

t &Touch
本次调用使用的 Touch 实例;以只读借用传入,调用方仍持有实例。
id int
id(int)

返回值

bool — 是否成立

(&Touch) offset

XuAPI
pub fn (t &Touch) offset() f64

用途

在 &Touch 上执行 offset 操作。

参数

t &Touch
本次调用使用的 Touch 实例;以只读借用传入,调用方仍持有实例。

返回值

f64 — 该类型的值

(&Touch) scroll_offset

XuAPI
pub fn (t &Touch) scroll_offset() f64

用途

&Touch 上的操作:执行 scroll offset 操作。

参数

t &Touch
本次调用使用的 Touch 实例;以只读借用传入,调用方仍持有实例。

返回值

f64 — 该类型的值

(&Touch) scroll_maximum

XuAPI
pub fn (t &Touch) scroll_maximum() f64

用途

&Touch 上的操作:执行 scroll maximum 操作。

参数

t &Touch
本次调用使用的 Touch 实例;以只读借用传入,调用方仍持有实例。

返回值

f64 — 该类型的值

(&Touch) tap_x

XuAPI
pub fn (t &Touch) tap_x() f64

用途

&Touch 上的操作:执行 tap x 操作。

参数

t &Touch
本次调用使用的 Touch 实例;以只读借用传入,调用方仍持有实例。

返回值

f64 — 该类型的值

(&Touch) tap_y

XuAPI
pub fn (t &Touch) tap_y() f64

用途

&Touch 上的操作:执行 tap y 操作。

参数

t &Touch
本次调用使用的 Touch 实例;以只读借用传入,调用方仍持有实例。

返回值

f64 — 该类型的值

(&Touch) was_dragged

XuAPI
pub fn (t &Touch) was_dragged() bool

用途

&Touch 上的操作:执行 was dragged 操作。

参数

t &Touch
本次调用使用的 Touch 实例;以只读借用传入,调用方仍持有实例。

返回值

bool — 是否成立

(&Touch) click_count

XuAPI
pub fn (t &Touch) click_count() int

用途

&Touch 上的操作:执行 click count 操作。

参数

t &Touch
本次调用使用的 Touch 实例;以只读借用传入,调用方仍持有实例。

返回值

int — 该类型的值

(&Touch) pointer_down

XuAPI
pub fn (t &Touch) pointer_down() bool

用途

&Touch 上的操作:执行 pointer down 操作。

参数

t &Touch
本次调用使用的 Touch 实例;以只读借用传入,调用方仍持有实例。

返回值

bool — 是否成立

(&Touch) is_selection_drag

XuAPI
pub fn (t &Touch) is_selection_drag() bool

用途

&Touch 上的操作:判断是否 selection drag。

参数

t &Touch
本次调用使用的 Touch 实例;以只读借用传入,调用方仍持有实例。

返回值

bool — 是否成立

($&Touch) set_selection_drag

XuAPI
pub fn (t $&Touch) set_selection_drag(active bool)

用途

$&Touch 上的操作:设置 selection drag。

参数

t $&Touch
本次调用使用的 Touch 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
active bool
active(bool)

返回值

不返回值。

(&Touch) is_waiting_long_press

XuAPI
pub fn (t &Touch) is_waiting_long_press() bool

用途

&Touch 上的操作:判断是否 waiting long press。

参数

t &Touch
本次调用使用的 Touch 实例;以只读借用传入,调用方仍持有实例。

返回值

bool — 是否成立

(&Touch) is_long_pressed

XuAPI
pub fn (t &Touch) is_long_pressed() bool

用途

&Touch 上的操作:判断是否 long pressed。

参数

t &Touch
本次调用使用的 Touch 实例;以只读借用传入,调用方仍持有实例。

返回值

bool — 是否成立

($&Touch) poll_long_press_at

XuAPI
pub fn (t $&Touch) poll_long_press_at(now_ns int) bool

用途

$&Touch 上的操作:执行 poll long press at 操作。

参数

t $&Touch
本次调用使用的 Touch 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
now_ns int
now_ns(int)

返回值

bool — 是否成立

($&Touch) poll_long_press

XuAPI
pub fn (t $&Touch) poll_long_press() bool

用途

$&Touch 上的操作:执行 poll long press 操作。

参数

t $&Touch
本次调用使用的 Touch 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

bool — 是否成立

($&Touch) take_long_press

XuAPI
pub fn (t $&Touch) take_long_press() int

用途

$&Touch 上的操作:执行 take long press 操作。

参数

t $&Touch
本次调用使用的 Touch 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

int — 该类型的值

($&Touch) ensure_visible

XuAPI
pub fn (t $&Touch) ensure_visible(content_top f64,content_height f64)

用途

$&Touch 上的操作:执行 ensure visible 操作。

参数

t $&Touch
本次调用使用的 Touch 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
content_top f64
content_top(f64)
content_height f64
content_height(f64)

返回值

不返回值。

(&Touch) animating

XuAPI
pub fn (t &Touch) animating() bool

用途

在 &Touch 上执行 animating 操作。

参数

t &Touch
本次调用使用的 Touch 实例;以只读借用传入,调用方仍持有实例。

返回值

bool — 是否成立

(&Touch) edge_swipe_progress

XuAPI
pub fn (t &Touch) edge_swipe_progress(width f64) f64

用途

&Touch 上的操作:执行 edge swipe progress 操作。

参数

t &Touch
本次调用使用的 Touch 实例;以只读借用传入,调用方仍持有实例。
width f64
width(f64)

返回值

f64 — 该类型的值

($&Touch) block_scroll

XuAPI
pub fn (t $&Touch) block_scroll()

用途

$&Touch 上的操作:执行 block scroll 操作。

参数

t $&Touch
本次调用使用的 Touch 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

不返回值。

($&Touch) cancel

XuAPI
pub fn (t $&Touch) cancel()

用途

$&Touch 上的操作:取消。

参数

t $&Touch
本次调用使用的 Touch 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

不返回值。

($&Touch) reset_scroll

XuAPI
pub fn (t $&Touch) reset_scroll()

用途

$&Touch 上的操作:执行 reset scroll 操作。

参数

t $&Touch
本次调用使用的 Touch 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

不返回值。

($&Touch) scroll_region

XuAPI
pub fn (t $&Touch) scroll_region(bounds layout.Rect,content_height f64) int

用途

$&Touch 上的操作:执行 scroll region 操作。失败时抛出错误,调用方需处理或继续传播。

参数

t $&Touch
本次调用使用的 Touch 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
bounds layout.Rect
bounds(layout.Rect)
content_height f64
content_height(f64)

返回值

int — 该类型的值

($&Touch) step_at

XuAPI
pub fn (t $&Touch) step_at(now_ns int) bool

用途

$&Touch 上的操作:执行 step at 操作。

参数

t $&Touch
本次调用使用的 Touch 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
now_ns int
now_ns(int)

返回值

bool — 是否成立

($&Touch) step

XuAPI
pub fn (t $&Touch) step() bool

用途

在 $&Touch 上执行 step 操作。

参数

t $&Touch
本次调用使用的 Touch 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

bool — 是否成立

($&Touch) event

XuAPI
pub fn (t $&Touch) event(event &ui.Event) int

用途

处理并响应窗口与系统的交互及生命周期事件。失败时抛出错误,调用方需处理或继续传播。

参数

t $&Touch
本次调用使用的 Touch 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
event &ui.Event
event(只读借用,调用方仍持有原值;类型 &ui.Event)

返回值

int — 该类型的值

(&Touch) swipe_back

XuAPI
pub fn (t &Touch) swipe_back(event &ui.Event,width f64) bool

用途

&Touch 上的操作:执行 swipe back 操作。

参数

t &Touch
本次调用使用的 Touch 实例;以只读借用传入,调用方仍持有实例。
event &ui.Event
event(只读借用,调用方仍持有原值;类型 &ui.Event)
width f64
width(f64)

返回值

bool — 是否成立

(&Touch) swipe_down

XuAPI
pub fn (t &Touch) swipe_down(event &ui.Event,area layout.Rect) bool

用途

&Touch 上的操作:执行 swipe down 操作。

参数

t &Touch
本次调用使用的 Touch 实例;以只读借用传入,调用方仍持有实例。
event &ui.Event
event(只读借用,调用方仍持有原值;类型 &ui.Event)
area layout.Rect
area(layout.Rect)

返回值

bool — 是否成立

struct Insets

XuAPI
pub struct Insets {
    pub top f64
    pub bottom f64
    pub left f64
    pub right f64
    pub ime_bottom f64
}

用途

承载 top、bottom、left、right、ime_bottom 等属性的结构体。

公开字段

top f64
字段(f64)
bottom f64
字段(f64)
left f64
字段(f64)
right f64
字段(f64)
ime_bottom f64
字段(f64)

insets_zero

XuAPI
pub fn insets_zero() Insets

用途

执行 insets zero 操作。

参数

无需传入参数。

返回值

Insets — 该类型的值

(Insets) with_ime

XuAPI
pub fn (i Insets) with_ime(ime f64) Insets

用途

Insets 上的操作:派生一个带 ime 的新值。

参数

i Insets
本次调用使用的 Insets 实例;按值接收。
ime f64
ime(f64)

返回值

Insets — 该类型的值

(Insets) view_padding_bottom

XuAPI
pub fn (i Insets) view_padding_bottom() f64

用途

Insets 上的操作:执行 view padding bottom 操作。

参数

i Insets
本次调用使用的 Insets 实例;按值接收。

返回值

f64 — 该类型的值

(Insets) bottom_clearance

XuAPI
pub fn (i Insets) bottom_clearance() f64

用途

Insets 上的操作:执行 bottom clearance 操作。

参数

i Insets
本次调用使用的 Insets 实例;按值接收。

返回值

f64 — 该类型的值

parse_insets

XuAPI
pub fn parse_insets(raw &string) Insets

用途

解析为 insets。

参数

raw &string
raw(只读借用,调用方仍持有原值;类型 &string)

返回值

Insets — 该类型的值

host_insets

XuAPI
pub fn host_insets() Insets

用途

执行 host insets 操作。

参数

无需传入参数。

返回值

Insets — 该类型的值

reduced_motion

XuAPI
pub fn reduced_motion() bool

用途

执行 reduced motion 操作。

参数

无需传入参数。

返回值

bool — 是否成立

const MAX_ROUTE_DEPTH

XuAPI
pub const MAX_ROUTE_DEPTH = 16

用途

常量 MAX_ROUTE_DEPTH,定义了相关的协议或算法配置参数。

struct Route

XuAPI
pub struct Route {
    pub id int
    pub arg int
    pub title string
}

用途

承载 id、arg、title 等属性的结构体。

公开字段

id int
字段(int)
arg int
字段(int)
title string
字段(string)

struct RouteStack

XuAPI
pub struct RouteStack {
    pub drag_progress f64
    pub edge_swiping bool
}

用途

承载 drag_progress、edge_swiping 等属性的结构体。

公开字段

drag_progress f64
字段(f64)
edge_swiping bool
字段(bool)

route_stack

XuAPI
pub fn route_stack(root_id int,root_title string) RouteStack

用途

执行 route stack 操作。

参数

root_id int
root_id(int)
root_title string
root_title(string)

返回值

RouteStack — 该类型的值

(&RouteStack) depth

XuAPI
pub fn (s &RouteStack) depth() int

用途

在 &RouteStack 上执行 depth 操作。

参数

s &RouteStack
本次调用使用的 RouteStack 实例;以只读借用传入,调用方仍持有实例。

返回值

int — 该类型的值

(&RouteStack) can_pop

XuAPI
pub fn (s &RouteStack) can_pop() bool

用途

&RouteStack 上的操作:执行 can pop 操作。

参数

s &RouteStack
本次调用使用的 RouteStack 实例;以只读借用传入,调用方仍持有实例。

返回值

bool — 是否成立

(&RouteStack) top

XuAPI
pub fn (s &RouteStack) top() Route

用途

在 &RouteStack 上执行 top 操作。

参数

s &RouteStack
本次调用使用的 RouteStack 实例;以只读借用传入,调用方仍持有实例。

返回值

Route — 该类型的值

(&RouteStack) previous

XuAPI
pub fn (s &RouteStack) previous() Route

用途

在 &RouteStack 上执行 previous 操作。

参数

s &RouteStack
本次调用使用的 RouteStack 实例;以只读借用传入,调用方仍持有实例。

返回值

Route — 该类型的值

($&RouteStack) reset

XuAPI
pub fn (s $&RouteStack) reset(root_id int,root_title string)

用途

$&RouteStack 上的操作:清空内部状态,可再写入或读取。

参数

s $&RouteStack
本次调用使用的 RouteStack 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
root_id int
root_id(int)
root_title string
root_title(string)

返回值

不返回值。

($&RouteStack) push

XuAPI
pub fn (s $&RouteStack) push(id int,arg int,title string) bool

用途

$&RouteStack 上的操作:压入。

参数

s $&RouteStack
本次调用使用的 RouteStack 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
id int
id(int)
arg int
arg(int)
title string
title(string)

返回值

bool — 是否成立

($&RouteStack) pop

XuAPI
pub fn (s $&RouteStack) pop() bool

用途

$&RouteStack 上的操作:弹出。

参数

s $&RouteStack
本次调用使用的 RouteStack 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

bool — 是否成立

($&RouteStack) pop_to_root

XuAPI
pub fn (s $&RouteStack) pop_to_root() int

用途

$&RouteStack 上的操作:执行 pop to root 操作。

参数

s $&RouteStack
本次调用使用的 RouteStack 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

int — 该类型的值

($&RouteStack) set_drag

XuAPI
pub fn (s $&RouteStack) set_drag(progress f64,active bool)

用途

$&RouteStack 上的操作:设置 drag。

参数

s $&RouteStack
本次调用使用的 RouteStack 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
progress f64
progress(f64)
active bool
active(bool)

返回值

不返回值。

struct Snackbar

XuAPI
pub struct Snackbar {
    pub active bool
    pub message string
    pub action_label string
    pub action_id int
    pub deadline_ns int
}

用途

承载 active、message、action_label、action_id、deadline_ns 等属性的结构体。

公开字段

active bool
字段(bool)
message string
字段(string)
action_label string
字段(string)
action_id int
字段(int)
deadline_ns int
字段(int)

snackbar_empty

XuAPI
pub fn snackbar_empty() Snackbar

用途

执行 snackbar empty 操作。

参数

无需传入参数。

返回值

Snackbar — 该类型的值

($&Snackbar) show_at

XuAPI
pub fn (b $&Snackbar) show_at(message string,action_id int,action_label string,duration_ms int,now_ns int)

用途

$&Snackbar 上的操作:执行 show at 操作。

参数

b $&Snackbar
本次调用使用的 Snackbar 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
message string
message(string)
action_id int
action_id(int)
action_label string
action_label(string)
duration_ms int
duration_ms(int)
now_ns int
now_ns(int)

返回值

不返回值。

($&Snackbar) show

XuAPI
pub fn (b $&Snackbar) show(message string,action_id int,action_label string,duration_ms int)

用途

在 $&Snackbar 上执行 show 操作。

参数

b $&Snackbar
本次调用使用的 Snackbar 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
message string
message(string)
action_id int
action_id(int)
action_label string
action_label(string)
duration_ms int
duration_ms(int)

返回值

不返回值。

($&Snackbar) dismiss

XuAPI
pub fn (b $&Snackbar) dismiss()

用途

在 $&Snackbar 上执行 dismiss 操作。

参数

b $&Snackbar
本次调用使用的 Snackbar 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

不返回值。

(&Snackbar) remaining_ms

XuAPI
pub fn (b &Snackbar) remaining_ms(now_ns int) int

用途

&Snackbar 上的操作:执行 remaining ms 操作。

参数

b &Snackbar
本次调用使用的 Snackbar 实例;以只读借用传入,调用方仍持有实例。
now_ns int
now_ns(int)

返回值

int — 该类型的值

($&Snackbar) tick

XuAPI
pub fn (b $&Snackbar) tick(now_ns int) bool

用途

推进动画时间戳与状态过渡动画步进。

参数

b $&Snackbar
本次调用使用的 Snackbar 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
now_ns int
now_ns(int)

返回值

bool — 是否成立

const LOCALE_EN

XuAPI
pub const LOCALE_EN = 0

用途

常量 LOCALE_EN,定义了相关的协议或算法配置参数。

const LOCALE_ZH_CN

XuAPI
pub const LOCALE_ZH_CN = 1

用途

常量 LOCALE_ZH_CN,定义了相关的协议或算法配置参数。

const ACTION_BAR_NONE

XuAPI
pub const ACTION_BAR_NONE = 0

用途

常量 ACTION_BAR_NONE,定义了相关的协议或算法配置参数。

const ACTION_BAR_COPY

XuAPI
pub const ACTION_BAR_COPY = 1

用途

常量 ACTION_BAR_COPY,定义了相关的协议或算法配置参数。

const ACTION_BAR_CUT

XuAPI
pub const ACTION_BAR_CUT = 2

用途

常量 ACTION_BAR_CUT,定义了相关的协议或算法配置参数。

const ACTION_BAR_PASTE

XuAPI
pub const ACTION_BAR_PASTE = 3

用途

常量 ACTION_BAR_PASTE,定义了相关的协议或算法配置参数。

const ACTION_BAR_SELECT_ALL

XuAPI
pub const ACTION_BAR_SELECT_ALL = 4

用途

常量 ACTION_BAR_SELECT_ALL,定义了相关的协议或算法配置参数。

struct PhoneActionBarItem

XuAPI
pub struct PhoneActionBarItem {
    pub cmd int
    pub rect layout.Rect
    pub label string
    pub enabled bool
}

用途

承载 cmd、rect、label、enabled 等属性的结构体。

公开字段

cmd int
字段(int)
rect layout.Rect
字段(layout.Rect)
label string
字段(string)
enabled bool
字段(bool)

struct PhoneActionBar

XuAPI
pub struct PhoneActionBar {
    pub bounds layout.Rect
    pub items []PhoneActionBarItem
}

用途

承载 bounds、items 等属性的结构体。

公开字段

bounds layout.Rect
字段(layout.Rect)
items []PhoneActionBarItem
元素列表

struct SelectableTextResult

XuAPI
pub struct SelectableTextResult {
    pub changed bool
    pub copied bool
    pub focused bool
    pub blurred bool
    pub needs_paint bool
    pub consumed bool
}

用途

承载 changed、copied、focused、blurred、needs_paint 等属性的结构体。

公开字段

changed bool
字段(bool)
copied bool
字段(bool)
focused bool
字段(bool)
blurred bool
字段(bool)
needs_paint bool
字段(bool)
consumed bool
字段(bool)

struct SelectableText

XuAPI
pub struct SelectableText {
    pub id int
    pub identity ui.CanvasEvent
    pub bounds layout.Rect
    pub value string
    pub size f64
    pub weight int
    pub line_height f64
    pub align int
    pub multiline bool
    pub selectable bool
    pub focused bool
    pub anchor int
    pub focus int
    pub locale int
}

用途

承载 id、identity、bounds、value、size 等属性的结构体。

公开字段

id int
字段(int)
identity ui.CanvasEvent
字段(ui.CanvasEvent)
bounds layout.Rect
字段(layout.Rect)
value string
字段(string)
size f64
字段(f64)
weight int
字段(int)
line_height f64
字段(f64)
align int
字段(int)
multiline bool
字段(bool)
selectable bool
字段(bool)
focused bool
字段(bool)
anchor int
字段(int)
focus int
字段(int)
locale int
字段(int)

selectable_text

XuAPI
pub fn selectable_text(context &draw.Context,identity &ui.CanvasEvent,id int,value string,size f64,multiline bool) SelectableText

用途

执行 selectable text 操作。

参数

context &draw.Context
context(只读借用,调用方仍持有原值;类型 &draw.Context)
identity &ui.CanvasEvent
identity(只读借用,调用方仍持有原值;类型 &ui.CanvasEvent)
id int
id(int)
value string
value(string)
size f64
size(f64)
multiline bool
multiline(bool)

返回值

SelectableText — 该类型的值

($&SelectableText) set_value

XuAPI
pub fn (s $&SelectableText) set_value(value string) int

用途

$&SelectableText 上的操作:设置 value。失败时抛出错误,调用方需处理或继续传播。

参数

s $&SelectableText
本次调用使用的 SelectableText 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
value string
value(string)

返回值

int — 该类型的值

($&SelectableText) set_style

XuAPI
pub fn (s $&SelectableText) set_style(weight int,line_height f64,align int)

用途

$&SelectableText 上的操作:设置 style。

参数

s $&SelectableText
本次调用使用的 SelectableText 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
weight int
weight(int)
line_height f64
line_height(f64)
align int
align(int)

返回值

不返回值。

($&SelectableText) set_locale

XuAPI
pub fn (s $&SelectableText) set_locale(locale int)

用途

$&SelectableText 上的操作:设置 locale。

参数

s $&SelectableText
本次调用使用的 SelectableText 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
locale int
locale(int)

返回值

不返回值。

($&SelectableText) set_selectable

XuAPI
pub fn (s $&SelectableText) set_selectable(selectable bool)

用途

$&SelectableText 上的操作:设置 selectable。

参数

s $&SelectableText
本次调用使用的 SelectableText 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
selectable bool
selectable(bool)

返回值

不返回值。

(&SelectableText) is_selectable

XuAPI
pub fn (s &SelectableText) is_selectable() bool

用途

&SelectableText 上的操作:判断是否 selectable。

参数

s &SelectableText
本次调用使用的 SelectableText 实例;以只读借用传入,调用方仍持有实例。

返回值

bool — 是否成立

(&SelectableText) has_selection

XuAPI
pub fn (s &SelectableText) has_selection() bool

用途

&SelectableText 上的操作:判断是否具有 selection。

参数

s &SelectableText
本次调用使用的 SelectableText 实例;以只读借用传入,调用方仍持有实例。

返回值

bool — 是否成立

(&SelectableText) selected_text

XuAPI
pub fn (s &SelectableText) selected_text() string

用途

&SelectableText 上的操作:执行 selected text 操作。

参数

s &SelectableText
本次调用使用的 SelectableText 实例;以只读借用传入,调用方仍持有实例。

返回值

string — 结果字符串

($&SelectableText) select_all

XuAPI
pub fn (s $&SelectableText) select_all() int

用途

$&SelectableText 上的操作:执行 select all 操作。

参数

s $&SelectableText
本次调用使用的 SelectableText 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

int — 该类型的值

($&SelectableText) clear_selection

XuAPI
pub fn (s $&SelectableText) clear_selection()

用途

$&SelectableText 上的操作:执行 clear selection 操作。

参数

s $&SelectableText
本次调用使用的 SelectableText 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

不返回值。

($&SelectableText) copy_selection

XuAPI
pub fn (s $&SelectableText) copy_selection() int

用途

$&SelectableText 上的操作:执行 copy selection 操作。

参数

s $&SelectableText
本次调用使用的 SelectableText 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

int — 该类型的值

(&SelectableText) cursor_at

XuAPI
pub fn (s &SelectableText) cursor_at(x f64,y f64) int

用途

&SelectableText 上的操作:执行 cursor at 操作。

参数

s &SelectableText
本次调用使用的 SelectableText 实例;以只读借用传入,调用方仍持有实例。
x f64
值(f64)
y f64
值(f64)

返回值

int — 该类型的值

(&SelectableText) measure_height

XuAPI
pub fn (s &SelectableText) measure_height(c $&Canvas,width f64) f64

用途

&SelectableText 上的操作:执行 measure height 操作。

参数

s &SelectableText
本次调用使用的 SelectableText 实例;以只读借用传入,调用方仍持有实例。
c $&Canvas
字节或字符码(独占借用,可修改原值;类型 $&Canvas)
width f64
width(f64)

返回值

f64 — 该类型的值

($&SelectableText) handle_long_press

XuAPI
pub fn (s $&SelectableText) handle_long_press(touches &Touch) bool

用途

$&SelectableText 上的操作:执行 handle long press 操作。

参数

s $&SelectableText
本次调用使用的 SelectableText 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
touches &Touch
touches(只读借用,调用方仍持有原值;类型 &Touch)

返回值

bool — 是否成立

($&SelectableText) handle_event

XuAPI
pub fn (s $&SelectableText) handle_event(event &ui.Event,touches &Touch,action int) SelectableTextResult

用途

$&SelectableText 上的操作:执行 handle event 操作。

参数

s $&SelectableText
本次调用使用的 SelectableText 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
event &ui.Event
event(只读借用,调用方仍持有原值;类型 &ui.Event)
touches &Touch
touches(只读借用,调用方仍持有原值;类型 &Touch)
action int
action(int)

返回值

SelectableTextResult — 该类型的值

($&SelectableText) set_font_stack

XuAPI
pub fn (s $&SelectableText) set_font_stack(stack font.FontStack)

用途

$&SelectableText 上的操作:设置 font stack。

参数

s $&SelectableText
本次调用使用的 SelectableText 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
stack font.FontStack
stack(font.FontStack)

返回值

不返回值。

($&SelectableText) add_ttf_bytes

XuAPI
pub fn (s $&SelectableText) add_ttf_bytes(ttf_bytes &[]u8,font_index int,face_id int) int

用途

$&SelectableText 上的操作:执行 add ttf bytes 操作。失败时抛出错误,调用方需处理或继续传播。

参数

s $&SelectableText
本次调用使用的 SelectableText 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
ttf_bytes &[]u8
ttf_bytes(只读借用,调用方仍持有原值;类型 &[]u8)
font_index int
font_index(int)
face_id int
face_id(int)

返回值

int — 该类型的值

($&SelectableText) draw

XuAPI
pub fn (s $&SelectableText) draw(c $&Canvas,t $&Touch,bounds layout.Rect,clip &layout.Rect,theme &Theme,color draw.Color) f64

用途

在 $&SelectableText 上执行 draw 操作。失败时抛出错误,调用方需处理或继续传播。

参数

s $&SelectableText
本次调用使用的 SelectableText 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
c $&Canvas
字节或字符码(独占借用,可修改原值;类型 $&Canvas)
t $&Touch
t(独占借用,可修改原值;类型 $&Touch)
bounds layout.Rect
bounds(layout.Rect)
clip &layout.Rect
clip(只读借用,调用方仍持有原值;类型 &layout.Rect)
theme &Theme
theme(只读借用,调用方仍持有原值;类型 &Theme)
color draw.Color
color(draw.Color)

返回值

f64 — 该类型的值

const FIELD_HEIGHT

XuAPI
pub const FIELD_HEIGHT = 48

用途

常量 FIELD_HEIGHT,定义了相关的协议或算法配置参数。

text_field_height

XuAPI
pub fn text_field_height() f64

用途

执行 text field height 操作。

参数

无需传入参数。

返回值

f64 — 该类型的值

struct TextField

XuAPI
pub struct TextField {
    pub id int
    pub clear_id int
    pub identity ui.CanvasEvent
    pub bounds layout.Rect
    pub focused bool
    pub enabled bool
    pub selectable bool
    pub password bool
    pub locale int
    pub error string
    pub placeholder string
    pub value string
    pub anchor int
    pub focus int
    pub revision int
    pub composing bool
    pub preedit string
    pub replacement_start int
    pub replacement_end int
    pub preedit_anchor int
    pub preedit_focus int
    pub offset_x f64
}

用途

承载 id、clear_id、identity、bounds、focused 等属性的结构体。

公开字段

id int
字段(int)
clear_id int
字段(int)
identity ui.CanvasEvent
字段(ui.CanvasEvent)
bounds layout.Rect
字段(layout.Rect)
focused bool
字段(bool)
enabled bool
字段(bool)
selectable bool
字段(bool)
password bool
字段(bool)
locale int
字段(int)
error string
字段(string)
placeholder string
字段(string)
value string
字段(string)
anchor int
字段(int)
focus int
字段(int)
revision int
字段(int)
composing bool
字段(bool)
preedit string
字段(string)
replacement_start int
字段(int)
replacement_end int
字段(int)
preedit_anchor int
字段(int)
preedit_focus int
字段(int)
offset_x f64
字段(f64)

struct TextFieldResult

XuAPI
pub struct TextFieldResult {
    pub changed bool
    pub submitted bool
    pub blurred bool
    pub cleared bool
    pub needs_paint bool
}

用途

承载 changed、submitted、blurred、cleared、needs_paint 等属性的结构体。

公开字段

changed bool
字段(bool)
submitted bool
字段(bool)
blurred bool
字段(bool)
cleared bool
字段(bool)
needs_paint bool
字段(bool)

text_field

XuAPI
pub fn text_field(context &draw.Context,identity &ui.CanvasEvent,id int,clear_id int,placeholder string) TextField

用途

执行 text field 操作。

参数

context &draw.Context
context(只读借用,调用方仍持有原值;类型 &draw.Context)
identity &ui.CanvasEvent
identity(只读借用,调用方仍持有原值;类型 &ui.CanvasEvent)
id int
id(int)
clear_id int
clear_id(int)
placeholder string
placeholder(string)

返回值

TextField — 该类型的值

($&TextField) set_font_stack

XuAPI
pub fn (f $&TextField) set_font_stack(stack font.FontStack)

用途

$&TextField 上的操作:设置 font stack。

参数

f $&TextField
本次调用使用的 TextField 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
stack font.FontStack
stack(font.FontStack)

返回值

不返回值。

($&TextField) add_ttf_bytes

XuAPI
pub fn (f $&TextField) add_ttf_bytes(ttf_bytes &[]u8,font_index int,face_id int) int

用途

$&TextField 上的操作:执行 add ttf bytes 操作。失败时抛出错误,调用方需处理或继续传播。

参数

f $&TextField
本次调用使用的 TextField 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
ttf_bytes &[]u8
ttf_bytes(只读借用,调用方仍持有原值;类型 &[]u8)
font_index int
font_index(int)
face_id int
face_id(int)

返回值

int — 该类型的值

(&TextField) is_focused

XuAPI
pub fn (f &TextField) is_focused() bool

用途

&TextField 上的操作:判断是否 focused。

参数

f &TextField
本次调用使用的 TextField 实例;以只读借用传入,调用方仍持有实例。

返回值

bool — 是否成立

(&TextField) is_selectable

XuAPI
pub fn (f &TextField) is_selectable() bool

用途

&TextField 上的操作:判断是否 selectable。

参数

f &TextField
本次调用使用的 TextField 实例;以只读借用传入,调用方仍持有实例。

返回值

bool — 是否成立

(&TextField) is_password

XuAPI
pub fn (f &TextField) is_password() bool

用途

&TextField 上的操作:判断是否 password。

参数

f &TextField
本次调用使用的 TextField 实例;以只读借用传入,调用方仍持有实例。

返回值

bool — 是否成立

(&TextField) is_copy_enabled

XuAPI
pub fn (f &TextField) is_copy_enabled() bool

用途

&TextField 上的操作:判断是否 copy enabled。

参数

f &TextField
本次调用使用的 TextField 实例;以只读借用传入,调用方仍持有实例。

返回值

bool — 是否成立

($&TextField) set_copy_enabled

XuAPI
pub fn (f $&TextField) set_copy_enabled(on bool)

用途

$&TextField 上的操作:设置 copy enabled。

参数

f $&TextField
本次调用使用的 TextField 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
on bool
on(bool)

返回值

不返回值。

($&TextField) set_locale

XuAPI
pub fn (f $&TextField) set_locale(locale int)

用途

$&TextField 上的操作:设置 locale。

参数

f $&TextField
本次调用使用的 TextField 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
locale int
locale(int)

返回值

不返回值。

($&TextField) set_selectable

XuAPI
pub fn (f $&TextField) set_selectable(selectable bool)

用途

$&TextField 上的操作:设置 selectable。

参数

f $&TextField
本次调用使用的 TextField 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
selectable bool
selectable(bool)

返回值

不返回值。

($&TextField) set_password

XuAPI
pub fn (f $&TextField) set_password(password bool)

用途

$&TextField 上的操作:设置 password。

参数

f $&TextField
本次调用使用的 TextField 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
password bool
password(bool)

返回值

不返回值。

(&TextField) display_value

XuAPI
pub fn (f &TextField) display_value() string

用途

&TextField 上的操作:执行 display value 操作。

参数

f &TextField
本次调用使用的 TextField 实例;以只读借用传入,调用方仍持有实例。

返回值

string — 结果字符串

(&TextField) display_anchor

XuAPI
pub fn (f &TextField) display_anchor() int

用途

&TextField 上的操作:执行 display anchor 操作。

参数

f &TextField
本次调用使用的 TextField 实例;以只读借用传入,调用方仍持有实例。

返回值

int — 该类型的值

(&TextField) display_focus

XuAPI
pub fn (f &TextField) display_focus() int

用途

&TextField 上的操作:执行 display focus 操作。

参数

f &TextField
本次调用使用的 TextField 实例;以只读借用传入,调用方仍持有实例。

返回值

int — 该类型的值

($&TextField) set_error

XuAPI
pub fn (f $&TextField) set_error(message string)

用途

$&TextField 上的操作:设置 error。

参数

f $&TextField
本次调用使用的 TextField 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
message string
message(string)

返回值

不返回值。

($&TextField) blur

XuAPI
pub fn (f $&TextField) blur()

用途

在 $&TextField 上执行 blur 操作。

参数

f $&TextField
本次调用使用的 TextField 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

不返回值。

($&TextField) focus_session

XuAPI
pub fn (f $&TextField) focus_session(on bool) int

用途

$&TextField 上的操作:执行 focus session 操作。失败时抛出错误,调用方需处理或继续传播。

参数

f $&TextField
本次调用使用的 TextField 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
on bool
on(bool)

返回值

int — 该类型的值

($&TextField) set_value

XuAPI
pub fn (f $&TextField) set_value(value string) int

用途

$&TextField 上的操作:设置 value。失败时抛出错误,调用方需处理或继续传播。

参数

f $&TextField
本次调用使用的 TextField 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
value string
value(string)

返回值

int — 该类型的值

($&TextField) clear

XuAPI
pub fn (f $&TextField) clear() int

用途

清空所有已缓冲或存储的数据项与内部状态。失败时抛出错误,调用方需处理或继续传播。

参数

f $&TextField
本次调用使用的 TextField 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

int — 该类型的值

($&TextField) select_all

XuAPI
pub fn (f $&TextField) select_all() int

用途

$&TextField 上的操作:执行 select all 操作。

参数

f $&TextField
本次调用使用的 TextField 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

int — 该类型的值

(&TextField) has_selection

XuAPI
pub fn (f &TextField) has_selection() bool

用途

&TextField 上的操作:判断是否具有 selection。

参数

f &TextField
本次调用使用的 TextField 实例;以只读借用传入,调用方仍持有实例。

返回值

bool — 是否成立

(&TextField) selected_text

XuAPI
pub fn (f &TextField) selected_text() string

用途

&TextField 上的操作:执行 selected text 操作。

参数

f &TextField
本次调用使用的 TextField 实例;以只读借用传入,调用方仍持有实例。

返回值

string — 结果字符串

($&TextField) copy_selection

XuAPI
pub fn (f $&TextField) copy_selection() int

用途

$&TextField 上的操作:执行 copy selection 操作。

参数

f $&TextField
本次调用使用的 TextField 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

int — 该类型的值

($&TextField) cut_selection

XuAPI
pub fn (f $&TextField) cut_selection() bool

用途

$&TextField 上的操作:执行 cut selection 操作。

参数

f $&TextField
本次调用使用的 TextField 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

bool — 是否成立

($&TextField) paste_clipboard

XuAPI
pub fn (f $&TextField) paste_clipboard() int

用途

$&TextField 上的操作:执行 paste clipboard 操作。

参数

f $&TextField
本次调用使用的 TextField 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

int — 该类型的值

(&TextField) cursor_at

XuAPI
pub fn (f &TextField) cursor_at(x f64,y f64) int

用途

&TextField 上的操作:执行 cursor at 操作。

参数

f &TextField
本次调用使用的 TextField 实例;以只读借用传入,调用方仍持有实例。
x f64
值(f64)
y f64
值(f64)

返回值

int — 该类型的值

($&TextField) handle_event

XuAPI
pub fn (f $&TextField) handle_event(event &ui.Event,touches &Touch,action int) TextFieldResult

用途

$&TextField 上的操作:执行 handle event 操作。

参数

f $&TextField
本次调用使用的 TextField 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
event &ui.Event
event(只读借用,调用方仍持有原值;类型 &ui.Event)
touches &Touch
touches(只读借用,调用方仍持有原值;类型 &Touch)
action int
action(int)

返回值

TextFieldResult — 该类型的值

($&TextField) draw

XuAPI
pub fn (f $&TextField) draw(c $&Canvas,t $&Touch,bounds layout.Rect,clip &layout.Rect,theme &Theme) int

用途

在 $&TextField 上执行 draw 操作。失败时抛出错误,调用方需处理或继续传播。

参数

f $&TextField
本次调用使用的 TextField 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
c $&Canvas
字节或字符码(独占借用,可修改原值;类型 $&Canvas)
t $&Touch
t(独占借用,可修改原值;类型 $&Touch)
bounds layout.Rect
bounds(layout.Rect)
clip &layout.Rect
clip(只读借用,调用方仍持有原值;类型 &layout.Rect)
theme &Theme
theme(只读借用,调用方仍持有原值;类型 &Theme)

返回值

int — 该类型的值

(&TextField) draw_error

XuAPI
pub fn (f &TextField) draw_error(c $&Canvas,bounds layout.Rect,theme &Theme) int

用途

&TextField 上的操作:执行 draw error 操作。

参数

f &TextField
本次调用使用的 TextField 实例;以只读借用传入,调用方仍持有实例。
c $&Canvas
字节或字符码(独占借用,可修改原值;类型 $&Canvas)
bounds layout.Rect
bounds(layout.Rect)
theme &Theme
theme(只读借用,调用方仍持有原值;类型 &Theme)

返回值

int — 该类型的值