UI / WIDGETS / 文本输入
FieldArea
为多行文本提供标签与校验
在演练场运行 Xu 示例 ↗示例由浏览器中的 Xu/WASM 运行器执行。
体验什么
填写说明并观察字数。
使用要点
通过 text_field_area 创建带装饰的多行字段。设置合理行数与字数提示,错误信息需指出如何修正。
通过 Screen 创建
下面的 Screen 构造方法返回节点 ID。将 ID 交给 Screen 的布局、状态与事件接口;它不是下方独立控件类型的实例。
原生 Xu 创建片段:在已有 Screen 的初始化阶段调用 configure;窗口创建、事件循环与资源释放参见完整原生示例。
#ui/widgets
fn configure(screen $&widgets.Screen) int {
decoration := widgets.field_decoration(&"Project name")
id := screen.text_field_area("",&decoration) or >>
screen.place(id,24.0,24.0,320.0,80.0) or >>
<< id
}
($&Screen) text_field_area
pub fn (s $&Screen) text_field_area(value string,decoration &FieldDecoration) int
用途
在 Screen 中创建 FieldArea,返回组件节点 ID;创建失败时抛出错误。
参数
s $&Screen- 本次调用使用的
Screen 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
value string- value(string)
decoration &FieldDecoration- decoration(只读借用,调用方仍持有原值;类型 &FieldDecoration)
返回值
int — 组件节点 ID,供 place 和其他 Screen 方法使用。
放置、状态与事件
组件由应用拥有。Screen.place 放置节点,Screen.set_enabled 和 Screen.set_visible 管理可用性与显示。状态变化后重新呈现;创建和修改时处理 or 错误,不在绘制回调中修改拓扑。ToastHost 使用自己的队列接口。
Action · Styles · 界面生命周期与样式指南
Screen.place · Screen.set_enabled · Screen.set_visible
独立控件对象 API
以下类型与方法用于自行管理控件、输入和绘制的进阶用法。接收者是控件对象,不是 Screen 返回的节点 ID;普通 Screen 用法请使用上面的创建接口及 Widgets 模块中的 Screen 方法。
($&Field) set_locale
pub fn (field $&Field) set_locale(locale &Locale) int
用途
$&Field 上的操作:设置 locale。失败时抛出错误,调用方需处理或继续传播。
参数
field $&Field- 本次调用使用的
Field 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
locale &Locale- locale(只读借用,调用方仍持有原值;类型 &Locale)
返回值
int — 该类型的值
struct Field
用途
Field 上下文或状态结构体。
公开字段
此类型没有公开字段。
(&Field) id
pub fn (f &Field) id() int
用途
返回当前控件、元素或节点的唯一标识 ID。
参数
f &Field- 本次调用使用的
Field 实例;以只读借用传入,调用方仍持有实例。
返回值
int — 该类型的值
(&Field) bounds
pub fn (f &Field) bounds() layout.Rect
用途
返回当前控件或几何对象的有效外接矩形边界(Rectangle)。
参数
f &Field- 本次调用使用的
Field 实例;以只读借用传入,调用方仍持有实例。
返回值
layout.Rect — 该类型的值
(&Field) value
pub fn (f &Field) value() string
用途
&Field 上的操作:值。
参数
f &Field- 本次调用使用的
Field 实例;以只读借用传入,调用方仍持有实例。
返回值
string — 结果字符串
(&Field) has_selection
pub fn (f &Field) has_selection() bool
用途
&Field 上的操作:判断是否具有 selection。
参数
f &Field- 本次调用使用的
Field 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&Field) is_copy_enabled
pub fn (f &Field) is_copy_enabled() bool
用途
&Field 上的操作:判断是否 copy enabled。
参数
f &Field- 本次调用使用的
Field 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&Field) selected_text
pub fn (f &Field) selected_text() string
用途
&Field 上的操作:执行 selected text 操作。
参数
f &Field- 本次调用使用的
Field 实例;以只读借用传入,调用方仍持有实例。
返回值
string — 结果字符串
(&Field) is_enabled
pub fn (f &Field) is_enabled() bool
用途
返回控件当前是否可用。
参数
f &Field- 本次调用使用的
Field 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&Field) is_focused
pub fn (f &Field) is_focused() bool
用途
返回控件当前是否拥有输入焦点。
参数
f &Field- 本次调用使用的
Field 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&Field) is_read_only
pub fn (f &Field) is_read_only() bool
用途
&Field 上的操作:判断是否 read only。
参数
f &Field- 本次调用使用的
Field 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&Field) is_invalid
pub fn (f &Field) is_invalid() bool
用途
&Field 上的操作:判断是否 invalid。
参数
f &Field- 本次调用使用的
Field 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&Field) is_selectable
pub fn (f &Field) is_selectable() bool
用途
&Field 上的操作:判断是否 selectable。
参数
f &Field- 本次调用使用的
Field 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&Field) cursor
pub fn (f &Field) cursor() int
用途
&Field 上的操作:游标。
参数
f &Field- 本次调用使用的
Field 实例;以只读借用传入,调用方仍持有实例。
返回值
int — 该类型的值
(&Field) needs_paint
pub fn (f &Field) needs_paint() bool
用途
返回控件是否需要重新绘制;绘制完成后调用 painted 清除标记。
参数
f &Field- 本次调用使用的
Field 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
($&Field) painted
pub fn (f $&Field) painted()
用途
确认当前帧已绘制,清除重绘标记;不是状态查询。
参数
f $&Field- 本次调用使用的
Field 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
返回值
不返回值。
(&Field) style_or
pub fn (f &Field) style_or(styles &Styles) ControlStyle
用途
&Field 上的操作:执行 style or 操作。
参数
f &Field- 本次调用使用的
Field 实例;以只读借用传入,调用方仍持有实例。
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
返回值
ControlStyle — 该类型的值
($&Field) set_style
pub fn (f $&Field) set_style(style &ControlStyle) int
用途
$&Field 上的操作:设置 style。失败时抛出错误,调用方需处理或继续传播。
参数
f $&Field- 本次调用使用的
Field 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
style &ControlStyle- style(只读借用,调用方仍持有原值;类型 &ControlStyle)
返回值
int — 该类型的值
($&Field) set_decoration
pub fn (f $&Field) set_decoration(decoration &FieldDecoration) int
用途
$&Field 上的操作:设置 decoration。失败时抛出错误,调用方需处理或继续传播。
参数
f $&Field- 本次调用使用的
Field 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
decoration &FieldDecoration- decoration(只读借用,调用方仍持有原值;类型 &FieldDecoration)
返回值
int — 该类型的值
($&Field) set_motion
pub fn (f $&Field) set_motion(spec &MotionSpec) int
用途
$&Field 上的操作:设置 motion。失败时抛出错误,调用方需处理或继续传播。
参数
f $&Field- 本次调用使用的
Field 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
spec &MotionSpec- spec(只读借用,调用方仍持有原值;类型 &MotionSpec)
返回值
int — 该类型的值
($&Field) set_invalid
pub fn (f $&Field) set_invalid(invalid bool)
用途
$&Field 上的操作:设置 invalid。
参数
f $&Field- 本次调用使用的
Field 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
invalid bool- invalid(bool)
返回值
不返回值。
($&Field) set_value
pub fn (f $&Field) set_value(value &string) int
用途
$&Field 上的操作:设置 value。失败时抛出错误,调用方需处理或继续传播。
参数
f $&Field- 本次调用使用的
Field 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
value &string- value(只读借用,调用方仍持有原值;类型 &string)
返回值
int — 该类型的值
($&Field) set_read_only
pub fn (f $&Field) set_read_only(read_only bool) int
用途
$&Field 上的操作:设置 read only。失败时抛出错误,调用方需处理或继续传播。
参数
f $&Field- 本次调用使用的
Field 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
read_only bool- read_only(bool)
返回值
int — 该类型的值
($&Field) set_selectable
pub fn (f $&Field) set_selectable(selectable bool) int
用途
$&Field 上的操作:设置 selectable。失败时抛出错误,调用方需处理或继续传播。
参数
f $&Field- 本次调用使用的
Field 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
selectable bool- selectable(bool)
返回值
int — 该类型的值
($&Field) set_copy_enabled
pub fn (f $&Field) set_copy_enabled(on bool)
用途
$&Field 上的操作:设置 copy enabled。
参数
f $&Field- 本次调用使用的
Field 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
on bool- on(bool)
返回值
不返回值。
($&Field) set_viewport
pub fn (f $&Field) set_viewport(viewport &layout.Rect)
用途
$&Field 上的操作:设置 viewport。
参数
f $&Field- 本次调用使用的
Field 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
viewport &layout.Rect- viewport(只读借用,调用方仍持有原值;类型 &layout.Rect)
返回值
不返回值。
($&Field) focus_session
pub fn (f $&Field) focus_session(focused bool) int
用途
$&Field 上的操作:执行 focus session 操作。失败时抛出错误,调用方需处理或继续传播。
参数
f $&Field- 本次调用使用的
Field 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
focused bool- focused(bool)
返回值
int — 该类型的值
($&Field) enable
pub fn (f $&Field) enable(enabled bool) int
用途
在 $&Field 上执行 enable 操作。失败时抛出错误,调用方需处理或继续传播。
参数
f $&Field- 本次调用使用的
Field 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
enabled bool- enabled(bool)
返回值
int — 该类型的值
($&Field) place
pub fn (f $&Field) place(bounds &layout.Rect) int
用途
在画布中计算并设置控件的局部几何布局坐标与尺寸。失败时抛出错误,调用方需处理或继续传播。
参数
f $&Field- 本次调用使用的
Field 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
bounds &layout.Rect- bounds(只读借用,调用方仍持有原值;类型 &layout.Rect)
返回值
int — 该类型的值
($&Field) apply_styles
pub fn (f $&Field) apply_styles(styles &Styles) int
用途
根据当前主题样式表解析并应用几何与视觉度量。失败时抛出错误,调用方需处理或继续传播。
参数
f $&Field- 本次调用使用的
Field 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
返回值
int — 该类型的值
($&Field) input
pub fn (f $&Field) input(input &ui.InputEvent) Action
用途
接收并处理分发的鼠标、键盘或触摸交互输入事件。失败时抛出错误,调用方需处理或继续传播。
参数
f $&Field- 本次调用使用的
Field 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
input &ui.InputEvent- input(只读借用,调用方仍持有原值;类型 &ui.InputEvent)
返回值
Action — 输入处理结果,包含 kind、id、重绘与焦点请求。
($&Field) route
pub fn (f $&Field) route(kind int,event &ui.InputEvent) Action
用途
路由并分发交互事件至命中的子节点或处理器。失败时抛出错误,调用方需处理或继续传播。
参数
f $&Field- 本次调用使用的
Field 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
kind int- 类型标签(int)
event &ui.InputEvent- event(只读借用,调用方仍持有原值;类型 &ui.InputEvent)
返回值
Action — 输入处理结果,包含 kind、id、重绘与焦点请求。
($&Field) event
pub fn (f $&Field) event(event &ui.Event) Action
用途
处理并响应窗口与系统的交互及生命周期事件。失败时抛出错误,调用方需处理或继续传播。
参数
f $&Field- 本次调用使用的
Field 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
event &ui.Event- event(只读借用,调用方仍持有原值;类型 &ui.Event)
返回值
Action — 输入处理结果,包含 kind、id、重绘与焦点请求。
($&Field) tick
pub fn (f $&Field) tick(now time.Instant,reduced bool) bool
用途
推进动画时间戳与状态过渡动画步进。失败时抛出错误,调用方需处理或继续传播。
参数
f $&Field- 本次调用使用的
Field 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
now time.Instant- now(time.Instant)
reduced bool- reduced(bool)
返回值
bool — 是否成立
(&Field) next_caret_tick
pub fn (f &Field) next_caret_tick(now time.Instant,reduced bool) time.Instant
用途
&Field 上的操作:执行 next caret tick 操作。失败时抛出错误,调用方需处理或继续传播。
参数
f &Field- 本次调用使用的
Field 实例;以只读借用传入,调用方仍持有实例。
now time.Instant- now(time.Instant)
reduced bool- reduced(bool)
返回值
time.Instant — 该类型的值
($&Field) measure_styled
pub fn (f $&Field) measure_styled(styles &Styles) layout.Size
用途
$&Field 上的操作:执行 measure styled 操作。失败时抛出错误,调用方需处理或继续传播。
参数
f $&Field- 本次调用使用的
Field 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
返回值
layout.Size — 该类型的值
($&Field) dispose
pub fn (f $&Field) dispose()
用途
释放并清理对象所持有的系统原生资源与底层句柄。
参数
f $&Field- 本次调用使用的
Field 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
返回值
不返回值。
($&Field) paint_styled
pub fn (f $&Field) paint_styled(frame $&draw.Frame,styles &Styles) int
用途
$&Field 上的操作:执行 paint styled 操作。失败时抛出错误,调用方需处理或继续传播。
参数
f $&Field- 本次调用使用的
Field 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
frame $&draw.Frame- frame(独占借用,可修改原值;类型 $&draw.Frame)
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
返回值
int — 该类型的值
($&Field) set_text_options
pub fn (f $&Field) set_text_options(options &FieldTextOptions) int
用途
$&Field 上的操作:设置 text options。失败时抛出错误,调用方需处理或继续传播。
参数
f $&Field- 本次调用使用的
Field 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
options &FieldTextOptions- options(只读借用,调用方仍持有原值;类型 &FieldTextOptions)
返回值
int — 该类型的值
(&Field) text_options
pub fn (f &Field) text_options() FieldTextOptions
用途
&Field 上的操作:执行 text options 操作。
参数
f &Field- 本次调用使用的
Field 实例;以只读借用传入,调用方仍持有实例。
返回值
FieldTextOptions — 该类型的值
(&Field) character_count
pub fn (f &Field) character_count() int
用途
&Field 上的操作:执行 character count 操作。
参数
f &Field- 本次调用使用的
Field 实例;以只读借用传入,调用方仍持有实例。
返回值
int — 该类型的值
(&Field) is_over_limit
pub fn (f &Field) is_over_limit() bool
用途
&Field 上的操作:判断是否 over limit。
参数
f &Field- 本次调用使用的
Field 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&Field) preferred_rows
pub fn (f &Field) preferred_rows() int
用途
&Field 上的操作:执行 preferred rows 操作。
参数
f &Field- 本次调用使用的
Field 实例;以只读借用传入,调用方仍持有实例。
返回值
int — 该类型的值
完整原生示例
Component Workshop · 返回 Widgets 目录