XU XUv0.13.1
EN

UI / WIDGETS / 选择与调节

ColorPicker

选择并查看颜色值

在演练场运行 Xu 示例

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

体验什么

更换颜色并查看色值。

使用要点

同时提供色块与可读的颜色值。应用应检查输入格式与透明度含义,不能只通过颜色表达状态。

通过 Screen 创建

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

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

#ui/widgets
#ui/draw

fn configure(screen $&widgets.Screen) int {
    id := screen.color_picker(draw.rgb(180,69,50)) or >>
    screen.place(id,24.0,24.0,320.0,80.0) or >>
    << id
}

($&Screen) color_picker

XuAPI
pub fn (s $&Screen) color_picker(value draw.Color) int

用途

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

参数

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

返回值

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

struct ColorPicker

XuAPI
pub struct ColorPicker {

}

用途

RGBA 颜色选择调色板控件,支持通道调节与实时预览。

公开字段

此类型没有公开字段。

(&ColorPicker) id

XuAPI
pub fn (picker &ColorPicker) id() int

用途

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

参数

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

返回值

int — 该类型的值

(&ColorPicker) bounds

XuAPI
pub fn (picker &ColorPicker) bounds() layout.Rect

用途

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

参数

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

返回值

layout.Rect — 该类型的值

(&ColorPicker) is_enabled

XuAPI
pub fn (picker &ColorPicker) is_enabled() bool

用途

返回控件当前是否可用。

参数

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

返回值

bool — 是否成立

(&ColorPicker) is_selectable

XuAPI
pub fn (picker &ColorPicker) is_selectable() bool

用途

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

参数

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

返回值

bool — 是否成立

($&ColorPicker) set_selectable

XuAPI
pub fn (picker $&ColorPicker) set_selectable(selectable bool)

用途

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

参数

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

返回值

不返回值。

(&ColorPicker) is_focused

XuAPI
pub fn (picker &ColorPicker) is_focused() bool

用途

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

参数

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

返回值

bool — 是否成立

(&ColorPicker) active_channel

XuAPI
pub fn (picker &ColorPicker) active_channel() int

用途

&ColorPicker 上的操作:执行 active channel 操作。

参数

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

返回值

int — 该类型的值

(&ColorPicker) needs_paint

XuAPI
pub fn (picker &ColorPicker) needs_paint() bool

用途

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

参数

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

返回值

bool — 是否成立

(&ColorPicker) channel

XuAPI
pub fn (picker &ColorPicker) channel(index int) int

用途

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

参数

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

返回值

int — 该类型的值

(&ColorPicker) value

XuAPI
pub fn (picker &ColorPicker) value() draw.Color

用途

读取当前四个通道组成的颜色,供绘制或保存。

参数

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

返回值

包含红、绿、蓝和透明度的 draw.Color。

($&ColorPicker) set_channel

XuAPI
pub fn (picker $&ColorPicker) set_channel(index int,value int) int

用途

更新一个 RGBA 通道,适合从数值输入框单独调整颜色分量。

参数

picker $&ColorPicker
本次调用使用的 ColorPicker 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
index int
通道编号:0 红、1 绿、2 蓝、3 透明度。
value int
通道强度 0..255;透明度 0 全透明、255 不透明。

返回值

成功返回 0;失败时抛错,不以非零返回码表示失败。

错误处理

  • 控件已释放、通道编号或数值越界时抛错;这里不会静默截断到有效范围。

($&ColorPicker) set_value

XuAPI
pub fn (picker $&ColorPicker) set_value(value draw.Color) int

用途

一次设置 RGBA 颜色,并同步四个通道滑块。

参数

picker $&ColorPicker
本次调用使用的 ColorPicker 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
value draw.Color
完整的 draw.Color,包含透明度。

返回值

成功返回 0;失败时抛错,不以非零返回码表示失败。

错误处理

  • 任一通道更新失败时继续抛错。

(&ColorPicker) style_or

XuAPI
pub fn (picker &ColorPicker) style_or(styles &Styles) ControlStyle

用途

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

参数

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

返回值

ControlStyle — 该类型的值

($&ColorPicker) set_style

XuAPI
pub fn (picker $&ColorPicker) set_style(style &ControlStyle) int

用途

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

参数

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

返回值

int — 该类型的值

($&ColorPicker) set_enabled

XuAPI
pub fn (picker $&ColorPicker) set_enabled(enabled bool)

用途

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

参数

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

返回值

不返回值。

($&ColorPicker) set_read_only

XuAPI
pub fn (picker $&ColorPicker) set_read_only(read_only bool) int

用途

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

参数

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

返回值

int — 该类型的值

($&ColorPicker) set_invalid

XuAPI
pub fn (picker $&ColorPicker) set_invalid(invalid bool)

用途

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

参数

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

返回值

不返回值。

($&ColorPicker) set_focus

XuAPI
pub fn (picker $&ColorPicker) set_focus(focused bool)

用途

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

参数

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

返回值

不返回值。

(&ColorPicker) preview_bounds

XuAPI
pub fn (picker &ColorPicker) preview_bounds() layout.Rect

用途

&ColorPicker 上的操作:执行 preview bounds 操作。

参数

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

返回值

layout.Rect — 该类型的值

(&ColorPicker) channel_bounds

XuAPI
pub fn (picker &ColorPicker) channel_bounds(index int) layout.Rect

用途

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

参数

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

返回值

layout.Rect — 该类型的值

($&ColorPicker) set_bounds

XuAPI
pub fn (picker $&ColorPicker) set_bounds(bounds &layout.Rect) int

用途

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

参数

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

返回值

int — 该类型的值

($&ColorPicker) apply_styles

XuAPI
pub fn (picker $&ColorPicker) apply_styles(styles &Styles) int

用途

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

参数

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

返回值

int — 该类型的值

($&ColorPicker) input

XuAPI
pub fn (picker $&ColorPicker) input(event &ui.InputEvent) Action

用途

把输入交给当前 RGBA 通道,更新颜色并返回颜色变化或提交动作。

参数

picker $&ColorPicker
本次调用使用的 ColorPicker 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
event &ui.InputEvent
同一窗口、画布和代次的输入事件;坐标按控件所在的画布空间传入。

返回值

Action 描述本次交互:kind 是动作类型,consumed 表示事件是否已处理,request_focus 请求焦点,needs_paint 表示需要重绘。

使用时注意

  • 聚焦时用上/下方向键切换通道;Action.value 是打包颜色的数值,读取 value() 可得到 draw.Color。

($&ColorPicker) route

XuAPI
pub fn (picker $&ColorPicker) route(kind int,event &ui.InputEvent) Action

用途

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

参数

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

返回值

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

($&ColorPicker) event

XuAPI
pub fn (picker $&ColorPicker) event(event &ui.Event) Action

用途

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

参数

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

返回值

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

($&ColorPicker) measure_styled

XuAPI
pub fn (picker $&ColorPicker) measure_styled(styles &Styles) layout.Size

用途

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

参数

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

返回值

layout.Size — 该类型的值

($&ColorPicker) paint_styled

XuAPI
pub fn (picker $&ColorPicker) paint_styled(frame $&draw.Frame,styles &Styles) int

用途

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

参数

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

返回值

int — 该类型的值

($&ColorPicker) dispose

XuAPI
pub fn (picker $&ColorPicker) dispose()

用途

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

参数

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

返回值

不返回值。

(&ColorPicker) hex

XuAPI
pub fn (picker &ColorPicker) hex() string

用途

&ColorPicker 上的操作:十六进制。

参数

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

返回值

string — 结果字符串

($&ColorPicker) set_hex

XuAPI
pub fn (picker $&ColorPicker) set_hex(text &string) int

用途

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

参数

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

返回值

int — 该类型的值

($&ColorPicker) set_swatches

XuAPI
pub fn (picker $&ColorPicker) set_swatches(colors &[]draw.Color) int

用途

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

参数

picker $&ColorPicker
本次调用使用的 ColorPicker 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
colors &[]draw.Color
colors(只读借用,调用方仍持有原值;类型 &[]draw.Color)

返回值

int — 该类型的值

($&ColorPicker) remember

XuAPI
pub fn (picker $&ColorPicker) remember()

用途

在 $&ColorPicker 上执行 remember 操作。

参数

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

返回值

不返回值。

(&ColorPicker) recent_colors

XuAPI
pub fn (picker &ColorPicker) recent_colors() []draw.Color

用途

&ColorPicker 上的操作:执行 recent colors 操作。

参数

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

返回值

[]draw.Color — 切片结果

(&ColorPicker) swatch_bounds

XuAPI
pub fn (picker &ColorPicker) swatch_bounds(index int) layout.Rect

用途

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

参数

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

返回值

layout.Rect — 该类型的值

($&ColorPicker) set_show_swatches

XuAPI
pub fn (picker $&ColorPicker) set_show_swatches(visible bool)

用途

$&ColorPicker 上的操作:设置 show swatches。

参数

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

返回值

不返回值。

($&ColorPicker) set_locale

XuAPI
pub fn (picker $&ColorPicker) set_locale(locale &Locale) int

用途

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

参数

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

返回值

int — 该类型的值

完整原生示例

Component Workshop · 返回 Widgets 目录