UI / WIDGETS / 文本与标记
StyledLabel
带排版与主题样式的文本标签
在演练场运行 Xu 示例 ↗示例由浏览器中的 Xu/WASM 运行器执行。
体验什么
修改示例代码中的标题和字号,重新运行比较排版。
使用要点
标签用于显示内容,不代替输入框。文字或字号改变后重新测量,避免裁剪与错误换行。
通过 Screen 创建
下面的 Screen 构造方法返回节点 ID。将 ID 交给 Screen 的布局、状态与事件接口;它不是下方独立控件类型的实例。
原生 Xu 创建片段:在已有 Screen 的初始化阶段调用 configure;窗口创建、事件循环与资源释放参见完整原生示例。
#ui/widgets
fn configure(screen $&widgets.Screen) int {
id := screen.label("Make room for ideas.",20.0,false) or >>
screen.place(id,24.0,24.0,320.0,80.0) or >>
<< id
}
($&Screen) label
pub fn (s $&Screen) label(text string,size f64,muted bool) int
用途
在 Screen 中创建 StyledLabel,返回组件节点 ID;创建失败时抛出错误。
参数
s $&Screen- 本次调用使用的
Screen 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
text string- 文本(string)
size f64- size(f64)
muted bool- muted(bool)
返回值
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 方法。
($&StyledLabel) paint_ellipsized_styled
pub fn (label $&StyledLabel) paint_ellipsized_styled(frame $&draw.Frame,bounds &layout.Rect,styles &Styles,fallback &ControlStyle,state int) int
用途
$&StyledLabel 上的操作:执行 paint ellipsized styled 操作。失败时抛出错误,调用方需处理或继续传播。
参数
label $&StyledLabel- 本次调用使用的
StyledLabel 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
frame $&draw.Frame- frame(独占借用,可修改原值;类型 $&draw.Frame)
bounds &layout.Rect- bounds(只读借用,调用方仍持有原值;类型 &layout.Rect)
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
fallback &ControlStyle- fallback(只读借用,调用方仍持有原值;类型 &ControlStyle)
state int- state(int)
返回值
int — 该类型的值
struct StyledLabel
pub struct StyledLabel {
}
用途
拥有文字与原生排版缓存的标签;改色复用排版,字体变化重新排版,用完 dispose。
公开字段
此类型没有公开字段。
查看用法示例
($&StyledLabel) set_font_stack
pub fn (label $&StyledLabel) set_font_stack(stack font.FontStack)
用途
$&StyledLabel 上的操作:设置 font stack。
参数
label $&StyledLabel- 本次调用使用的
StyledLabel 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
stack font.FontStack- stack(font.FontStack)
返回值
不返回值。
($&StyledLabel) add_ttf_bytes
pub fn (label $&StyledLabel) add_ttf_bytes(ttf_bytes &[]u8,font_index int,face_id int) int
用途
$&StyledLabel 上的操作:执行 add ttf bytes 操作。失败时抛出错误,调用方需处理或继续传播。
参数
label $&StyledLabel- 本次调用使用的
StyledLabel 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
ttf_bytes &[]u8- ttf_bytes(只读借用,调用方仍持有原值;类型 &[]u8)
font_index int- font_index(int)
face_id int- face_id(int)
返回值
int — 该类型的值
(&StyledLabel) paint_layout_at
pub fn (label &StyledLabel) paint_layout_at(frame $&draw.Frame,shaped &draw.TextLayout,x f64,y f64,color draw.Color) int
用途
&StyledLabel 上的操作:执行 paint layout at 操作。失败时抛出错误,调用方需处理或继续传播。
参数
label &StyledLabel- 本次调用使用的
StyledLabel 实例;以只读借用传入,调用方仍持有实例。
frame $&draw.Frame- frame(独占借用,可修改原值;类型 $&draw.Frame)
shaped &draw.TextLayout- shaped(只读借用,调用方仍持有原值;类型 &draw.TextLayout)
x f64- 值(f64)
y f64- 值(f64)
color draw.Color- color(draw.Color)
返回值
int — 该类型的值
(&StyledLabel) text
pub fn (label &StyledLabel) text() string
用途
&StyledLabel 上的操作:返回当前文本。
参数
label &StyledLabel- 本次调用使用的
StyledLabel 实例;以只读借用传入,调用方仍持有实例。
返回值
string — 结果字符串
(&StyledLabel) has_style
pub fn (label &StyledLabel) has_style() bool
用途
&StyledLabel 上的操作:判断是否具有 style。
参数
label &StyledLabel- 本次调用使用的
StyledLabel 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&StyledLabel) style_or
pub fn (label &StyledLabel) style_or(fallback &ControlStyle) ControlStyle
用途
&StyledLabel 上的操作:执行 style or 操作。
参数
label &StyledLabel- 本次调用使用的
StyledLabel 实例;以只读借用传入,调用方仍持有实例。
fallback &ControlStyle- fallback(只读借用,调用方仍持有原值;类型 &ControlStyle)
返回值
ControlStyle — 该类型的值
($&StyledLabel) set_style
pub fn (label $&StyledLabel) set_style(style &ControlStyle) int
用途
$&StyledLabel 上的操作:设置 style。失败时抛出错误,调用方需处理或继续传播。
参数
label $&StyledLabel- 本次调用使用的
StyledLabel 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
style &ControlStyle- style(只读借用,调用方仍持有原值;类型 &ControlStyle)
返回值
int — 该类型的值
($&StyledLabel) clear_style
pub fn (label $&StyledLabel) clear_style()
用途
$&StyledLabel 上的操作:执行 clear style 操作。
参数
label $&StyledLabel- 本次调用使用的
StyledLabel 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
返回值
不返回值。
($&StyledLabel) set_text
pub fn (label $&StyledLabel) set_text(value &string)
用途
替换拥有的文字;接入 View 时还需 mark_measure。
参数
label $&StyledLabel- 本次调用使用的
StyledLabel 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
value &string- value(只读借用,调用方仍持有原值;类型 &string)
返回值
不返回值。
($&StyledLabel) measure_styled
pub fn (label $&StyledLabel) measure_styled(styles &Styles,control &ControlStyle) layout.Size
用途
按有效字体、密度、内容和最小尺寸测量StyledLabel。
参数
label $&StyledLabel- 本次调用使用的
StyledLabel 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
control &ControlStyle- control(只读借用,调用方仍持有原值;类型 &ControlStyle)
返回值
固有逻辑尺寸;原生排版失败时抛出错误
($&StyledLabel) measure_wrapped
pub fn (label $&StyledLabel) measure_wrapped(styles &Styles,control &ControlStyle,width f64) layout.Size
用途
$&StyledLabel 上的操作:执行 measure wrapped 操作。失败时抛出错误,调用方需处理或继续传播。
参数
label $&StyledLabel- 本次调用使用的
StyledLabel 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
control &ControlStyle- control(只读借用,调用方仍持有原值;类型 &ControlStyle)
width f64- width(f64)
返回值
layout.Size — 该类型的值
($&StyledLabel) measure_box_styled
pub fn (label $&StyledLabel) measure_box_styled(styles &Styles,fallback &ControlStyle) layout.Size
用途
$&StyledLabel 上的操作:执行 measure box styled 操作。失败时抛出错误,调用方需处理或继续传播。
参数
label $&StyledLabel- 本次调用使用的
StyledLabel 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
fallback &ControlStyle- fallback(只读借用,调用方仍持有原值;类型 &ControlStyle)
返回值
layout.Size — 该类型的值
($&StyledLabel) paint_text_styled
pub fn (label $&StyledLabel) paint_text_styled(frame $&draw.Frame,bounds &layout.Rect,styles &Styles,fallback &ControlStyle,state int) int
用途
$&StyledLabel 上的操作:执行 paint text styled 操作。失败时抛出错误,调用方需处理或继续传播。
参数
label $&StyledLabel- 本次调用使用的
StyledLabel 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
frame $&draw.Frame- frame(独占借用,可修改原值;类型 $&draw.Frame)
bounds &layout.Rect- bounds(只读借用,调用方仍持有原值;类型 &layout.Rect)
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
fallback &ControlStyle- fallback(只读借用,调用方仍持有原值;类型 &ControlStyle)
state int- state(int)
返回值
int — 该类型的值
($&StyledLabel) paint_styled
pub fn (label $&StyledLabel) paint_styled(frame $&draw.Frame,bounds &layout.Rect,styles &Styles,fallback &ControlStyle,state int) int
用途
$&StyledLabel 上的操作:执行 paint styled 操作。失败时抛出错误,调用方需处理或继续传播。
参数
label $&StyledLabel- 本次调用使用的
StyledLabel 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
frame $&draw.Frame- frame(独占借用,可修改原值;类型 $&draw.Frame)
bounds &layout.Rect- bounds(只读借用,调用方仍持有原值;类型 &layout.Rect)
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
fallback &ControlStyle- fallback(只读借用,调用方仍持有原值;类型 &ControlStyle)
state int- state(int)
返回值
int — 该类型的值
($&StyledLabel) dispose
pub fn (label $&StyledLabel) dispose()
用途
释放标签的原生排版缓存。
参数
label $&StyledLabel- 本次调用使用的
StyledLabel 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
返回值
不返回值。
完整原生示例
Component Workshop · 返回 Widgets 目录