模块 lib.ui

UI组件模块。

用于分页、标签页、列表、拨盘、滑块等的组件。 norns脚本参考 包含此模块的示例。

信息:

  • 版本: v1.0.2
  • 作者: Mark Eats

Pages

UI.Pages.new (index, num_pages) 创建一个新的Pages对象。
UI.Pages:set_index (index) 设置选中的页面。
UI.Pages:set_index_delta (delta, wrap) 使用增量设置选中的页面。
UI.Pages:redraw () 重绘Pages。

Tabs

UI.Tabs.new (index, titles) 创建一个新的Tabs对象。
UI.Tabs:set_index (index) 设置选中的标签页。
UI.Tabs:set_index_delta (delta, wrap) 使用增量设置选中的标签页。
UI.Tabs:redraw () 重绘Tabs。

List

UI.List.new (x, y, index, entries) 创建一个新的List对象。
UI.List:set_index (index) 设置选中的条目。
UI.List:set_index_delta (delta, wrap) 使用增量设置选中的列表。
UI.List:set_active (state) 设置选中列表的活动状态。
UI.List:redraw () 重绘List。

ScrollingList

UI.ScrollingList.new (x, y, index, entries) 创建一个新的ScrollingList对象。
UI.ScrollingList:set_index (index) 设置选中的条目。
UI.ScrollingList:set_index_delta (delta, wrap) 使用增量设置选中的滚动列表。
UI.ScrollingList:set_active (state) 设置选中滚动列表的活动状态。
UI.ScrollingList:redraw () 重绘ScrollingList。

Message

UI.Message.new (text_array) 创建一个新的Message对象。
UI.Message:set_active (state) 设置消息的活动状态。
UI.Message:redraw () 重绘Message。

Slider

UI.Slider.new (x, y, width, height, value, min_value, max_value, markers, direction) 创建一个新的Slider对象。
UI.Slider:set_value (number) 设置值。
UI.Slider:set_value_delta (delta) 使用增量设置值。
UI.Slider:set_marker_position (id, position) 设置标记位置。
UI.Slider:set_active (state) 设置滑块的活动状态。
UI.Slider:redraw () 重绘Slider。

Dial

UI.Dial.new (x, y, size, value, min_value, max_value, rounding, 开始_value, markers, units, title) 创建一个新的Dial对象。
UI.Dial:set_value (number) 设置值。
UI.Dial:set_value_delta (delta) 使用增量设置值。
UI.Dial:set_marker_position (id, position) 设置标记位置。
UI.Dial:set_active (state) 设置拨盘的活动状态。
UI.Dial:redraw () 重绘Dial。

PlaybackIcon

UI.PlaybackIcon.new (x, y, size, status) 创建一个新的PlaybackIcon对象。
UI.PlaybackIcon:set_status (status) 设置PlaybackIcon的状态。
UI.PlaybackIcon:set_active (state) 设置PlaybackIcon的活动状态。
UI.PlaybackIcon:redraw () 重绘PlaybackIcon。


Pages

UI.Pages.new (index, num_pages)
创建一个新的Pages对象。

参数:

  • index number 选中的页面，默认为1。
  • num_pages number 总页数，默认为3。

返回:

    Pages Pages的实例。
UI.Pages:set_index (index)
设置选中的页面。

参数:

  • index number 页码。
UI.Pages:set_index_delta (delta, wrap)
使用增量设置选中的页面。

参数:

  • delta number 从选中页面移动的数量。
  • wrap boolean 布尔值，true表示循环页面。
UI.Pages:redraw ()
重绘Pages。 在更改时调用。

Tabs

UI.Tabs.new (index, titles)
创建一个新的Tabs对象。

参数:

  • index number 选中的标签页，默认为1。
  • titles {string,...} 标签页标题的字符串表。

返回:

    Tabs Tabs的实例。
UI.Tabs:set_index (index)
设置选中的标签页。

参数:

  • index number 标签页编号。
UI.Tabs:set_index_delta (delta, wrap)
使用增量设置选中的标签页。

参数:

  • delta number 从选中的标签页移动的数量。
  • wrap boolean 布尔值，true表示循环标签页。
UI.Tabs:redraw ()
重绘Tabs。 在更改时调用。

List

UI.List.new (x, y, index, entries)
创建一个新的List对象。

参数:

  • x number X位置，默认为0。
  • y number Y位置，默认为0。
  • index number 选中的条目，默认为1。
  • entries {string,...} 列表条目的字符串表。

返回:

    List List的实例。
UI.List:set_index (index)
设置选中的条目。

参数:

  • index number 条目编号。
UI.List:set_index_delta (delta, wrap)
使用增量设置选中的列表。

参数:

  • delta number 从选中的条目移动的数量。
  • wrap boolean 布尔值，true表示循环列表。
UI.List:set_active (state)
设置选中列表的活动状态。

参数:

  • state boolean 布尔值，true表示活动。
UI.List:redraw ()
重绘List。 在更改时调用。

ScrollingList

UI.ScrollingList.new (x, y, index, entries)
创建一个新的ScrollingList对象。

参数:

  • x number X位置，默认为0。
  • y number Y位置，默认为0。
  • index number 选中的条目，默认为1。
  • entries {string,...} 列表条目的字符串表。

返回:

    ScrollingList ScrollingList的实例。
UI.ScrollingList:set_index (index)
设置选中的条目。

参数:

  • index number 条目编号。
UI.ScrollingList:set_index_delta (delta, wrap)
使用增量设置选中的滚动列表。

参数:

  • delta number 从选中的条目移动的数量。
  • wrap boolean 布尔值，true表示循环列表。
UI.ScrollingList:set_active (state)
设置选中滚动列表的活动状态。

参数:

  • state boolean 布尔值，true表示活动。
UI.ScrollingList:redraw ()
重绘ScrollingList。 在更改时调用。

Message

UI.Message.new (text_array)
创建一个新的Message对象。

参数:

返回:

    Message Message的实例。
UI.Message:set_active (state)
设置消息的活动状态。

参数:

  • state boolean 布尔值，true表示活动。
UI.Message:redraw ()
重绘Message。 在更改时调用。

Slider

UI.Slider.new (x, y, width, height, value, min_value, max_value, markers, direction)
创建一个新的Slider对象。

参数:

  • x number X位置，默认为0。
  • y number Y位置，默认为0。
  • width number Slider的宽度，默认为3。
  • height number Slider的高度，默认为36。
  • value number 当前值，默认为0。
  • min_value number 最小值，默认为0。
  • max_value number 最大值，默认为1。
  • markers table 标记位置的数组。
  • direction string 滑块的方向，"up"（默认），down, left, right

返回:

    Slider Slider的实例。
UI.Slider:set_value (number)
设置值。

参数:

  • number number 值编号。
UI.Slider:set_value_delta (delta)
使用增量设置值。

参数:

  • delta number 数字。
UI.Slider:set_marker_position (id, position)
设置标记位置。

参数:

  • id number 标记编号。
  • position number 标记位置编号。
UI.Slider:set_active (state)
设置滑块的活动状态。

参数:

  • state boolean 布尔值，true表示活动。
UI.Slider:redraw ()
重绘Slider。 在更改时调用。

Dial

UI.Dial.new (x, y, size, value, min_value, max_value, rounding, 开始_value, markers, units, title)
创建一个新的Dial对象。

参数:

  • x number X位置，默认为0。
  • y number Y位置，默认为0。
  • size number Dial的直径，默认为22。
  • value number 当前值，默认为0。
  • min_value number 最小值，默认为0。
  • max_value number 最大值，默认为1。
  • rounding number 设置值的精度，默认为0.01。
  • 开始_value number 设置填充线从哪里开始，默认为0。
  • markers table 标记位置的数组。
  • units string 显示在值文本后的字符串。
  • title string 显示在值文本后的字符串。

返回:

    Dial Dial的实例。
UI.Dial:set_value (number)
设置值。

参数:

  • number number 值编号。
UI.Dial:set_value_delta (delta)
使用增量设置值。

参数:

  • delta number 数字。
UI.Dial:set_marker_position (id, position)
设置标记位置。

参数:

  • id number 标记编号。
  • position number 标记位置编号。
UI.Dial:set_active (state)
设置Dial的活动状态。

参数:

  • state boolean 布尔值，true表示活动。
UI.Dial:redraw ()
重绘Dial。 在更改时调用。

PlaybackIcon

UI.PlaybackIcon.new (x, y, size, status)
创建一个新的PlaybackIcon对象。

参数:

  • x number X位置，默认为0。
  • y number Y位置，默认为0。
  • size number 图标大小，默认为6。
  • status number 状态编号。1 = 播放，2 = 反向播放，3 = 暂停，4 = 停止。默认为1。

返回:

    PlaybackIcon PlaybackIcon的实例。
UI.PlaybackIcon:set_status (status)
设置PlaybackIcon的状态。

参数:

  • status number 状态编号。1 = 播放，2 = 反向播放，3 = 暂停，4 = 停止。
UI.PlaybackIcon:set_active (state)
设置PlaybackIcon的活动状态。

参数:

  • state boolean 布尔值，true表示激活。
UI.PlaybackIcon:redraw ()
重绘PlaybackIcon。 在更改时调用。
由 LDoc 1.5.0 生成 最后更新于 2025-04-06 15:35:25