XU XUv0.13.1
EN

UI / WIDGETS / 数据展示

ListBox

在可滚动列表中选择条目

在演练场运行 Xu 示例

示例由浏览器中的 Xu/WASM 运行器执行。

体验什么

点击条目或聚焦后使用方向键,观察选择变化。

使用要点

列表选择与滚动是独立状态。让当前选中项可辨认,并在内容变化时校验选择下标。

通过 Screen 创建

下面的 Screen 构造方法返回节点 ID。将 ID 交给 Screen 的布局、状态与事件接口;它不是下方独立控件类型的实例。

原生 Xu 创建片段:在已有 Screen 的初始化阶段调用 configure;窗口创建、事件循环与资源释放参见完整原生示例。

#ui/widgets

fn configure(screen $&widgets.Screen) int {
    options := ["Design","Develop","Review"]
    id := screen.list_box(&options,0) or >>
    screen.place(id,24.0,24.0,320.0,80.0) or >>
    << id
}

($&Screen) list_box

XuAPI
pub fn (s $&Screen) list_box(options &[]string,selected int) int

用途

在 Screen 中创建 ListBox,返回组件节点 ID;创建失败时抛出错误。

参数

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

返回值

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 方法。

(&ListBox) clone

XuAPI
pub fn (value &ListBox) clone() ListBox

用途

复制控件或样式快照,返回独立的 ListBox 值。

参数

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

返回值

ListBox — 该类型的值

struct ListBox

XuAPI
pub struct ListBox {

}

用途

ListBox 上下文或状态结构体。

公开字段

此类型没有公开字段。

查看用法示例

(&ListBox) id

XuAPI
pub fn (lb &ListBox) id() int

用途

返回当前控件、元素或节点的唯一标识 ID。

参数

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

返回值

int — 该类型的值

(&ListBox) bounds

XuAPI
pub fn (lb &ListBox) bounds() layout.Rect

用途

返回当前控件或几何对象的有效外接矩形边界(Rectangle)。

参数

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

返回值

layout.Rect — 该类型的值

(&ListBox) count

XuAPI
pub fn (lb &ListBox) count() int

用途

返回该控件当前包含的项目数量。

参数

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

返回值

int — 该类型的值

(&ListBox) selected

XuAPI
pub fn (lb &ListBox) selected() int

用途

获取或判断当前选中的项索引、节点或文本状态。

参数

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

返回值

int — 该类型的值

(&ListBox) hovered_item

XuAPI
pub fn (lb &ListBox) hovered_item() int

用途

&ListBox 上的操作:执行 hovered item 操作。

参数

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

返回值

int — 该类型的值

(&ListBox) scroll_offset

XuAPI
pub fn (lb &ListBox) scroll_offset() f64

用途

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

参数

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

返回值

f64 — 该类型的值

(&ListBox) is_selectable

XuAPI
pub fn (lb &ListBox) is_selectable() bool

用途

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

参数

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

返回值

bool — 是否成立

($&ListBox) set_selectable

XuAPI
pub fn (lb $&ListBox) set_selectable(selectable bool)

用途

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

参数

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

返回值

不返回值。

(&ListBox) has_popup_open

XuAPI
pub fn (lb &ListBox) has_popup_open() bool

用途

&ListBox 上的操作:判断是否具有 popup open。

参数

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

返回值

bool — 是否成立

(&ListBox) popup_bounds

XuAPI
pub fn (lb &ListBox) popup_bounds() layout.Rect

用途

&ListBox 上的操作:执行 popup bounds 操作。

参数

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

返回值

layout.Rect — 该类型的值

(&ListBox) cursor

XuAPI
pub fn (lb &ListBox) cursor() int

用途

&ListBox 上的操作:游标。

参数

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

返回值

int — 该类型的值

($&ListBox) set_locale

XuAPI
pub fn (lb $&ListBox) set_locale(locale &Locale) int

用途

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

参数

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

返回值

int — 该类型的值

($&ListBox) set_viewport

XuAPI
pub fn (lb $&ListBox) set_viewport(viewport &layout.Rect,context &draw.Context)

用途

$&ListBox 上的操作:设置 viewport。

参数

lb $&ListBox
本次调用使用的 ListBox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
viewport &layout.Rect
viewport(只读借用,调用方仍持有原值;类型 &layout.Rect)
context &draw.Context
context(只读借用,调用方仍持有原值;类型 &draw.Context)

返回值

不返回值。

($&ListBox) paint_popup_styled

XuAPI
pub fn (lb $&ListBox) paint_popup_styled(frame $&draw.Frame,styles &Styles) int

用途

$&ListBox 上的操作:执行 paint popup styled 操作。

参数

lb $&ListBox
本次调用使用的 ListBox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
frame $&draw.Frame
frame(独占借用,可修改原值;类型 $&draw.Frame)
styles &Styles
styles(只读借用,调用方仍持有原值;类型 &Styles)

返回值

int — 该类型的值

($&ListBox) dispose_aux

XuAPI
pub fn (lb $&ListBox) dispose_aux()

用途

$&ListBox 上的操作:执行 dispose aux 操作。

参数

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

返回值

不返回值。

($&ListBox) set_styles_cache

XuAPI
pub fn (lb $&ListBox) set_styles_cache(styles &Styles)

用途

$&ListBox 上的操作:设置 styles cache。

参数

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

返回值

不返回值。

(&ListBox) style_snapshot

XuAPI
pub fn (lb &ListBox) style_snapshot() Styles

用途

&ListBox 上的操作:执行 style snapshot 操作。

参数

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

返回值

Styles — 该类型的值

(&ListBox) has_selection_for_row

XuAPI
pub fn (lb &ListBox) has_selection_for_row(row int) bool

用途

&ListBox 上的操作:判断是否具有 selection for row。

参数

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

返回值

bool — 是否成立

(&ListBox) row_sel_anchor

XuAPI
pub fn (lb &ListBox) row_sel_anchor() int

用途

&ListBox 上的操作:执行 row sel anchor 操作。

参数

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

返回值

int — 该类型的值

(&ListBox) row_sel_focus

XuAPI
pub fn (lb &ListBox) row_sel_focus() int

用途

&ListBox 上的操作:执行 row sel focus 操作。

参数

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

返回值

int — 该类型的值

(&ListBox) selected_text

XuAPI
pub fn (lb &ListBox) selected_text() string

用途

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

参数

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

返回值

string — 结果字符串

($&ListBox) route_popup

XuAPI
pub fn (lb $&ListBox) route_popup(event &ui.InputEvent) Action

用途

$&ListBox 上的操作:执行 route popup 操作。

参数

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

返回值

Action — 输入处理结果,包含 kind、id、重绘与焦点请求。

($&ListBox) handle_text_key

XuAPI
pub fn (lb $&ListBox) handle_text_key(event &ui.InputEvent) Action

用途

$&ListBox 上的操作:执行 handle text key 操作。

参数

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

返回值

Action — 输入处理结果,包含 kind、id、重绘与焦点请求。

($&ListBox) ensure_row_text

XuAPI
pub fn (lb $&ListBox) ensure_row_text(row int,col int,text &string,row_text &string)

用途

$&ListBox 上的操作:执行 ensure row text 操作。

参数

lb $&ListBox
本次调用使用的 ListBox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
row int
row(int)
col int
col(int)
text &string
文本(只读借用,调用方仍持有原值;类型 &string)
row_text &string
row_text(只读借用,调用方仍持有原值;类型 &string)

返回值

不返回值。

($&ListBox) open_row_menu

XuAPI
pub fn (lb $&ListBox) open_row_menu(context &draw.Context,x f64,y f64,text &string,row_text &string,row int,col int,show_row bool) bool

用途

$&ListBox 上的操作:执行 open row menu 操作。

参数

lb $&ListBox
本次调用使用的 ListBox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
context &draw.Context
context(只读借用,调用方仍持有原值;类型 &draw.Context)
x f64
值(f64)
y f64
值(f64)
text &string
文本(只读借用,调用方仍持有原值;类型 &string)
row_text &string
row_text(只读借用,调用方仍持有原值;类型 &string)
row int
row(int)
col int
col(int)
show_row bool
show_row(bool)

返回值

bool — 是否成立

($&ListBox) begin_row_pointer

XuAPI
pub fn (lb $&ListBox) begin_row_pointer(text &string,row_text &string,idx int,row int,col int,event &ui.InputEvent) bool

用途

$&ListBox 上的操作:执行 begin row pointer 操作。

参数

lb $&ListBox
本次调用使用的 ListBox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
text &string
文本(只读借用,调用方仍持有原值;类型 &string)
row_text &string
row_text(只读借用,调用方仍持有原值;类型 &string)
idx int
idx(int)
row int
row(int)
col int
col(int)
event &ui.InputEvent
event(只读借用,调用方仍持有原值;类型 &ui.InputEvent)

返回值

bool — 是否成立

($&ListBox) should_begin_row_drag

XuAPI
pub fn (lb $&ListBox) should_begin_row_drag(x f64,y f64,density f64) bool

用途

$&ListBox 上的操作:执行 should begin row drag 操作。

参数

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

返回值

bool — 是否成立

($&ListBox) drag_row_pointer

XuAPI
pub fn (lb $&ListBox) drag_row_pointer(idx int) bool

用途

$&ListBox 上的操作:执行 drag row pointer 操作。

参数

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

返回值

bool — 是否成立

($&ListBox) end_row_pointer

XuAPI
pub fn (lb $&ListBox) end_row_pointer()

用途

$&ListBox 上的操作:执行 end row pointer 操作。

参数

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

返回值

不返回值。

($&ListBox) clear_text_selection

XuAPI
pub fn (lb $&ListBox) clear_text_selection()

用途

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

参数

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

返回值

不返回值。

(&ListBox) needs_paint

XuAPI
pub fn (lb &ListBox) needs_paint() bool

用途

返回控件是否需要重新绘制;绘制完成后调用 painted 清除标记。

参数

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

返回值

bool — 是否成立

($&ListBox) painted

XuAPI
pub fn (lb $&ListBox) painted()

用途

确认当前帧已绘制,清除重绘标记;不是状态查询。

参数

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

返回值

不返回值。

($&ListBox) invalidate

XuAPI
pub fn (lb $&ListBox) invalidate()

用途

标记控件区域为脏,请求系统在下一帧重新绘制。

参数

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

返回值

不返回值。

($&ListBox) cancel

XuAPI
pub fn (lb $&ListBox) cancel()

用途

$&ListBox 上的操作:取消。

参数

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

返回值

不返回值。

(&ListBox) is_enabled

XuAPI
pub fn (lb &ListBox) is_enabled() bool

用途

返回控件当前是否可用。

参数

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

返回值

bool — 是否成立

($&ListBox) set_enabled

XuAPI
pub fn (lb $&ListBox) set_enabled(enabled bool)

用途

$&ListBox 上的操作:设置 enabled。

参数

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

返回值

不返回值。

(&ListBox) is_focused

XuAPI
pub fn (lb &ListBox) is_focused() bool

用途

返回控件当前是否拥有输入焦点。

参数

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

返回值

bool — 是否成立

($&ListBox) set_focus

XuAPI
pub fn (lb $&ListBox) set_focus(focused bool)

用途

$&ListBox 上的操作:设置 focus。

参数

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

返回值

不返回值。

(&ListBox) is_hovered

XuAPI
pub fn (lb &ListBox) is_hovered() bool

用途

&ListBox 上的操作:判断是否 hovered。

参数

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

返回值

bool — 是否成立

(&ListBox) is_invalid

XuAPI
pub fn (lb &ListBox) is_invalid() bool

用途

&ListBox 上的操作:判断是否 invalid。

参数

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

返回值

bool — 是否成立

($&ListBox) set_invalid

XuAPI
pub fn (lb $&ListBox) set_invalid(invalid bool)

用途

$&ListBox 上的操作:设置 invalid。

参数

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

返回值

不返回值。

(&ListBox) is_read_only

XuAPI
pub fn (lb &ListBox) is_read_only() bool

用途

&ListBox 上的操作:判断是否 read only。

参数

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

返回值

bool — 是否成立

($&ListBox) set_read_only

XuAPI
pub fn (lb $&ListBox) set_read_only(read_only bool)

用途

$&ListBox 上的操作:设置 read only。

参数

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

返回值

不返回值。

($&ListBox) set_scroll_offset

XuAPI
pub fn (lb $&ListBox) set_scroll_offset(offset f64) int

用途

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

参数

lb $&ListBox
本次调用使用的 ListBox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
offset f64
偏移(f64)

返回值

int — 该类型的值

($&ListBox) ensure_visible

XuAPI
pub fn (lb $&ListBox) ensure_visible(index int)

用途

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

参数

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

返回值

不返回值。

($&ListBox) set_count

XuAPI
pub fn (lb $&ListBox) set_count(count int) int

用途

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

参数

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

返回值

int — 该类型的值

($&ListBox) set_selected

XuAPI
pub fn (lb $&ListBox) set_selected(index int) int

用途

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

参数

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

返回值

int — 该类型的值

($&ListBox) set_bounds

XuAPI
pub fn (lb $&ListBox) set_bounds(bounds &layout.Rect) int

用途

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

参数

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

返回值

int — 该类型的值

(&ListBox) visual_state

XuAPI
pub fn (lb &ListBox) visual_state() int

用途

&ListBox 上的操作:执行 visual state 操作。

参数

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

返回值

int — 该类型的值

(&ListBox) item_visual_state

XuAPI
pub fn (lb &ListBox) item_visual_state(index int) int

用途

&ListBox 上的操作:执行 item visual state 操作。

参数

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

返回值

int — 该类型的值

(&ListBox) has_style

XuAPI
pub fn (lb &ListBox) has_style() bool

用途

&ListBox 上的操作:判断是否具有 style。

参数

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

返回值

bool — 是否成立

(&ListBox) style_or

XuAPI
pub fn (lb &ListBox) style_or(styles &Styles) ControlStyle

用途

&ListBox 上的操作:执行 style or 操作。

参数

lb &ListBox
本次调用使用的 ListBox 实例;以只读借用传入,调用方仍持有实例。
styles &Styles
styles(只读借用,调用方仍持有原值;类型 &Styles)

返回值

ControlStyle — 该类型的值

($&ListBox) set_style

XuAPI
pub fn (lb $&ListBox) set_style(style &ControlStyle) int

用途

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

参数

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

返回值

int — 该类型的值

($&ListBox) clear_style

XuAPI
pub fn (lb $&ListBox) clear_style()

用途

$&ListBox 上的操作:执行 clear style 操作。

参数

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

返回值

不返回值。

($&ListBox) apply_styles

XuAPI
pub fn (lb $&ListBox) apply_styles(styles &Styles) int

用途

根据当前主题样式表解析并应用几何与视觉度量。失败时抛出错误,调用方需处理或继续传播。

参数

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

返回值

int — 该类型的值

(&ListBox) hit_row

XuAPI
pub fn (lb &ListBox) hit_row(x f64,y f64) int

用途

&ListBox 上的操作:执行 hit row 操作。

参数

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

返回值

int — 该类型的值

($&ListBox) input

XuAPI
pub fn (lb $&ListBox) input(input &ui.InputEvent) Action

用途

接收并处理分发的鼠标、键盘或触摸交互输入事件。失败时抛出错误,调用方需处理或继续传播。

参数

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

返回值

Action — 输入处理结果,包含 kind、id、重绘与焦点请求。

($&ListBox) event

XuAPI
pub fn (lb $&ListBox) event(event &ui.Event) Action

用途

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

参数

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

返回值

Action — 输入处理结果,包含 kind、id、重绘与焦点请求。

(&ListBox) paint

XuAPI
pub fn (lb &ListBox) paint(frame $&draw.Frame,labels &[]draw.TextLayout,theme &Theme) int

用途

在目标画布或渲染目标上执行控件的视觉绘制。失败时抛出错误,调用方需处理或继续传播。

参数

lb &ListBox
本次调用使用的 ListBox 实例;以只读借用传入,调用方仍持有实例。
frame $&draw.Frame
frame(独占借用,可修改原值;类型 $&draw.Frame)
labels &[]draw.TextLayout
labels(只读借用,调用方仍持有原值;类型 &[]draw.TextLayout)
theme &Theme
theme(只读借用,调用方仍持有原值;类型 &Theme)

返回值

int — 该类型的值

(&ListBox) measure_styled

XuAPI
pub fn (lb &ListBox) measure_styled(label $&StyledLabel,styles &Styles) layout.Size

用途

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

参数

lb &ListBox
本次调用使用的 ListBox 实例;以只读借用传入,调用方仍持有实例。
label $&StyledLabel
label(独占借用,可修改原值;类型 $&StyledLabel)
styles &Styles
styles(只读借用,调用方仍持有原值;类型 &Styles)

返回值

layout.Size — 该类型的值

(&ListBox) paint_box_styled

XuAPI
pub fn (lb &ListBox) paint_box_styled(frame $&draw.Frame,styles &Styles) int

用途

&ListBox 上的操作:执行 paint box styled 操作。失败时抛出错误,调用方需处理或继续传播。

参数

lb &ListBox
本次调用使用的 ListBox 实例;以只读借用传入,调用方仍持有实例。
frame $&draw.Frame
frame(独占借用,可修改原值;类型 $&draw.Frame)
styles &Styles
styles(只读借用,调用方仍持有原值;类型 &Styles)

返回值

int — 该类型的值

(&ListBox) paint_item_styled

XuAPI
pub fn (lb &ListBox) paint_item_styled(frame $&draw.Frame,index int,label $&StyledLabel,styles &Styles) int

用途

&ListBox 上的操作:执行 paint item styled 操作。失败时抛出错误,调用方需处理或继续传播。

参数

lb &ListBox
本次调用使用的 ListBox 实例;以只读借用传入,调用方仍持有实例。
frame $&draw.Frame
frame(独占借用,可修改原值;类型 $&draw.Frame)
index int
index(int)
label $&StyledLabel
label(独占借用,可修改原值;类型 $&StyledLabel)
styles &Styles
styles(只读借用,调用方仍持有原值;类型 &Styles)

返回值

int — 该类型的值

(&ListBox) paint_styled

XuAPI
pub fn (lb &ListBox) paint_styled(frame $&draw.Frame,label $&StyledLabel,styles &Styles) int

用途

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

参数

lb &ListBox
本次调用使用的 ListBox 实例;以只读借用传入,调用方仍持有实例。
frame $&draw.Frame
frame(独占借用,可修改原值;类型 $&draw.Frame)
label $&StyledLabel
label(独占借用,可修改原值;类型 $&StyledLabel)
styles &Styles
styles(只读借用,调用方仍持有原值;类型 &Styles)

返回值

int — 该类型的值

($&ListBox) set_appearance

XuAPI
pub fn (lb $&ListBox) set_appearance(appearance &ListAppearance) int

用途

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

参数

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

返回值

int — 该类型的值

(&ListBox) item_bounds

XuAPI
pub fn (lb &ListBox) item_bounds(index int,styles &Styles) layout.Rect

用途

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

参数

lb &ListBox
本次调用使用的 ListBox 实例;以只读借用传入,调用方仍持有实例。
index int
index(int)
styles &Styles
styles(只读借用,调用方仍持有原值;类型 &Styles)

返回值

layout.Rect — 该类型的值

(&ListBox) hit_item_byte

XuAPI
pub fn (lb &ListBox) hit_item_byte(index int,title $&StyledLabel,styles &Styles,has_row_layout bool,has_description bool,has_detail bool,icon int,x_pos f64,y_pos f64) int

用途

&ListBox 上的操作:执行 hit item byte 操作。

参数

lb &ListBox
本次调用使用的 ListBox 实例;以只读借用传入,调用方仍持有实例。
index int
index(int)
title $&StyledLabel
title(独占借用,可修改原值;类型 $&StyledLabel)
styles &Styles
styles(只读借用,调用方仍持有原值;类型 &Styles)
has_row_layout bool
has_row_layout(bool)
has_description bool
has_description(bool)
has_detail bool
has_detail(bool)
icon int
icon(int)
x_pos f64
x_pos(f64)
y_pos f64
y_pos(f64)

返回值

int — 该类型的值

(&ListBox) paint_row_styled

XuAPI
pub fn (lb &ListBox) paint_row_styled(frame $&draw.Frame,index int,title $&StyledLabel,description $&StyledLabel,detail $&StyledLabel,icon int,styles &Styles) int

用途

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

参数

lb &ListBox
本次调用使用的 ListBox 实例;以只读借用传入,调用方仍持有实例。
frame $&draw.Frame
frame(独占借用,可修改原值;类型 $&draw.Frame)
index int
index(int)
title $&StyledLabel
title(独占借用,可修改原值;类型 $&StyledLabel)
description $&StyledLabel
description(独占借用,可修改原值;类型 $&StyledLabel)
detail $&StyledLabel
detail(独占借用,可修改原值;类型 $&StyledLabel)
icon int
icon(int)
styles &Styles
styles(只读借用,调用方仍持有原值;类型 &Styles)

返回值

int — 该类型的值

($&ListBox) route

XuAPI
pub fn (lb $&ListBox) route(kind int,input &ui.InputEvent) Action

用途

路由并分发交互事件至命中的子节点或处理器。失败时抛出错误,调用方需处理或继续传播。

参数

lb $&ListBox
本次调用使用的 ListBox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
kind int
类型标签(int)
input &ui.InputEvent
input(只读借用,调用方仍持有原值;类型 &ui.InputEvent)

返回值

Action — 输入处理结果,包含 kind、id、重绘与焦点请求。

完整原生示例

Component Workshop · 返回 Widgets 目录