docs: explain host widget interaction and visual states

src/shell/system_ui/widgets.rs

@@ -14,13 +14,16 @@ use std::hash::Hash;
 
 /// 一次按钮绘制的借用描述，包括显示、角色和启用/选中状态。
 pub struct Button<'a> {
+    // 只在本次构建借用按钮文本，最终显示列表命令拥有自己的字符串，不依赖这个描述存活。
     pub label: &'a str,
     pub selected: bool,
     pub enabled: bool,
+    // 默认 Button，可显式切 Toggle/Tab；角色影响焦点/光标和 Tab 底线，不替代 Action 身份。
     pub role: Role,
 }
 impl<'a> Button<'a> {
     /// 创建默认启用、未选中的普通按钮描述，借用 label 而不分配文本。
+    // 侧栏与 Painter 用 builder 描述按钮，每帧重新构造，不在 Button 内保存 hover 或按下状态。
     pub fn new(label: &'a str) -> Self {
         Self {
             label,
@@ -48,7 +51,9 @@ impl<'a> Button<'a> {
 
 /// 本帧宿主控件绘制上下文，共同拥有显示列表与交互目标登记入口。
 pub struct Ui<A> {
+    // 本帧逻辑空间命令，scene 或 developer_tools 外层统一按设备比例缩放。
     pub list: DisplayList,
+    // 按追加顺序保存交互目标，Interaction::hit 逆序查找，追加时序也是覆盖命中优先级。
     pub targets: Vec<Target<A>>,
     pub theme: Theme,
     // 绘制使用跨帧交互状态的本轮副本，只查询 visual/captured；事件处理器在外部更新权威状态。
@@ -56,6 +61,7 @@ pub struct Ui<A> {
 }
 impl<A: Hash> Ui<A> {
     /// 建立空显示列表和目标集合，保存本轮主题与交互状态快照。
+    // sidebar::draw 与 developer_tools::build 创建本帧 Ui，传入上次事件更新后的 Interaction 克隆。
     pub fn new(theme: Theme, interaction: Interaction) -> Self {
         Self {
             list: DisplayList::default(),
@@ -65,6 +71,7 @@ impl<A: Hash> Ui<A> {
         }
     }
     /// 追加无圆角填充矩形命令；不注册交互目标。
+    // 背景、选中高亮、分隔线和手柄的通用原语，不改变任何跨帧状态。
     pub fn fill(&mut self, r: Rect, color: Color) {
         self.list.push(DrawCommand::FillRoundedRect {
             rect: r,
@@ -73,9 +80,10 @@ impl<A: Hash> Ui<A> {
         });
     }
     /// 追加向内收缩的圆角描边，使传入矩形作为控件外边界。
+    // surface、text_field 和 swatch 绘制焦点/边框时调用，下面对底层描边矩形留出内缩空间。
     fn outline(&mut self, r: Rect, color: Color, width: f32) {
         self.list.push(DrawCommand::StrokeRoundedRect {
-            // 描边以路径中心为基准，向内缩半个线宽，使描边整体尽量位于传入矩形内；尺寸钳非负。
+            // 传给底层的描边矩形四边各缩半线宽，额外保留内侧空间；小矩形宽高钳到非负。
             rect: Rect::new(
                 r.x + width / 2.0,
                 r.y + width / 2.0,
@@ -88,6 +96,7 @@ impl<A: Hash> Ui<A> {
         });
     }
     /// 追加等宽或界面字体文字命令；调用方负责裁剪与可用宽度。
+    // Painter 与侧栏调用，界面标签固定 12/18 逻辑字号/行高，code 则使用统一等宽样式。
     pub fn label(&mut self, x: f32, y: f32, value: &str, color: Color, code: bool) {
         self.list.push(DrawCommand::Text {
             origin: Point::new(x, y),
@@ -105,6 +114,7 @@ impl<A: Hash> Ui<A> {
         });
     }
     /// 把控件身份、几何、角色、启用状态和 action 一起加入本帧交互目标。
+    // 所有可交互控件共用登记入口；同一 id 的视觉响应与新矩形一起产生，但此处不执行命中测试或激活动作。
     fn register(
         &mut self,
         id: WidgetId,
@@ -126,6 +136,7 @@ impl<A: Hash> Ui<A> {
         response
     }
     /// 按视觉状态绘制控件背景和焦点轮廓；本方法不注册目标。
+    // 按钮、文本框与行共用状态背景，base=None 时未交互/未选中可以完全不画底色。
     fn surface(&mut self, rect: Rect, s: VisualState, base: Option<Color>) {
         // 背景优先级为禁用、按下、悬停、选中、默认；焦点轮廓单独绘制，可与选中同时存在。
         let color = if !s.enabled {
@@ -139,17 +150,21 @@ impl<A: Hash> Ui<A> {
         } else {
             base
         };
+        // 仅有实际状态色或调用方 base 才追加填充，不凭空覆盖底层背景。
         if let Some(color) = color {
             self.fill(rect, color);
         }
+        // 焦点圈独立叠在背景之上，键盘聚焦的已选按钮可同时有选中底色和强调轮廓。
         if s.focused {
             self.outline(rect, self.theme.accent, 1.5);
         }
     }
     /// 登记按钮目标，绘制状态背景、裁剪后的标签及可选 Tab 底线，返回组合视觉状态。
+    // 侧栏与 Painter 的按钮/切换入口，返回 VisualState 可供调用方进一步画图标或其他状态装饰。
     pub fn button(&mut self, rect: Rect, action: A, button: Button<'_>) -> VisualState {
         // 默认以 action 哈希为稳定身份；同一帧多个独立控件若 action 完全相同会共享身份，调用方需合理区分。
         let id = WidgetId::new(&action);
+        // Action 在此移入目标集合，视觉状态先取回本地用于生成背景、文字颜色及可选底线。
         let s = self.register(
             id,
             rect,
@@ -188,10 +203,12 @@ impl<A: Hash> Ui<A> {
                 self.theme.accent,
             );
         }
+        // 标签和 Tab 底线绘制结束后恢复外层裁剪，返回的状态仅为本轮快照。
         self.list.push(DrawCommand::PopClip);
         s
     }
     /// 登记文本输入角色并绘制背景和焦点/悬停描边，不负责实际文本与光标。
+    // Network Filter 和 Settings 自定义颜色框使用，仅负责框的目标/外观，实际文字与编辑缓冲由工具状态维护。
     pub fn text_field(&mut self, rect: Rect, action: A, focused: bool) {
         let s = self.register(
             WidgetId::new(&action),
@@ -218,6 +235,7 @@ impl<A: Hash> Ui<A> {
     /// A terminal prompt shares its surface with output; its caret is the focus cue.
     /// 只登记无边框终端输入的交互区域，外观由调用方绘制。
     // 终端输入与输出共享背景，只注册文本输入命中区，不绘制框线或文字，光标由 Console 负责。
+    // Console 使用无框输入命中区域，焦点由按下的 Focus 动作建立，光标与内容由 console::build 自行绘制。
     pub fn inline_input(&mut self, rect: Rect, action: A) {
         self.register(
             WidgetId::new(&action),
@@ -230,6 +248,7 @@ impl<A: Hash> Ui<A> {
     }
     /// 分别接受行背景区域和可见命中区域，登记行选择并绘制其状态背景。
     // 行背景可绘制完整行，但 hit 可裁到可见部分；不要把裁剪区外的行注册成可点击区域。
+    // Painter 为请求、AST 等有动作的显示行调用，paint 可是完整行，hit 只允许可见片段。
     pub fn row(&mut self, paint: Rect, hit: Rect, action: A, selected: bool) {
         let s = self.register(
             WidgetId::new(&action),
@@ -242,6 +261,7 @@ impl<A: Hash> Ui<A> {
         self.surface(paint, s, None);
     }
     /// 登记色块目标，绘制按压变暗、外圈及选中勾号。
+    // Settings 调色板调用，颜色来自候选色，selected 来自当前强调色比较；点击只登记主题 Action。
     pub fn swatch(&mut self, rect: Rect, action: A, color: Color, selected: bool) {
         let s = self.register(
             WidgetId::new(&action),
@@ -251,7 +271,7 @@ impl<A: Hash> Ui<A> {
             selected,
             true,
         );
-        // 滚动条手柄捕获时保持强调色，悬停使用混色，其余用中性底色；实际偏移换算由调用方处理。
+        // 色块保留传入颜色，按下时向正文深色混合 20% 变暗；外圈和选中勾号在下方单独叠加。
         self.fill(
             rect,
             if s.pressed {
@@ -282,6 +302,7 @@ impl<A: Hash> Ui<A> {
         }
     }
     /// 登记扩大的拖动命中区，绘制捕获/悬停强调线。
+    // DeveloperTools 父入口最后统一调用，显式 id 来自分隔类别，axis 表示拖动方向而非线条延伸方向。
     pub fn splitter(&mut self, rect: Rect, id: WidgetId, axis: Axis) {
         // 分隔线命中区四边扩展 3，提高细线可拖动性；真实绘制线宽与命中区域独立。
         let hit = Rect::new(
@@ -290,6 +311,7 @@ impl<A: Hash> Ui<A> {
             rect.width + 6.0,
             rect.height + 6.0,
         );
+        // 无点击 action 但保留拖动角色与命中，外层 press 再用布局记录决定调整哪块区域。
         let mut s = self.register(id, hit, Role::Splitter(axis), None, false, true);
         // 分隔条捕获后即使拖出命中区仍显示按压态，不采用普通按钮“拖出取消外观”的规则。
         s.pressed |= self.interaction.captured(id);
@@ -298,6 +320,7 @@ impl<A: Hash> Ui<A> {
         } else {
             theme::BORDER
         };
+        // 悬停/捕获时沿操作轴加粗到 3 单位：Horizontal 画竖线，Vertical 画横线。
         let line = if s.hovered || s.pressed {
             match axis {
                 Axis::Horizontal => Rect::new(rect.x - 1.0, rect.y, 3.0, rect.height),
@@ -309,8 +332,10 @@ impl<A: Hash> Ui<A> {
         self.fill(line, color);
     }
     /// 登记滚动手柄目标并绘制其状态颜色，偏移和拖动倍率由外部维护。
+    // Painter 在内容裁剪弹出后调用，只有手柄几何和轴进入 Ui，内容偏移及倍率仍由外层状态管理。
     pub fn scrollbar(&mut self, rect: Rect, id: WidgetId, axis: Axis) {
         let mut s = self.register(id, rect, Role::Scrollbar(axis), None, false, true);
+        // 拖动捕获时即使指针移到手柄外仍保持强调色，不能套用普通按钮拖出后取消按下外观的规则。
         s.pressed |= self.interaction.captured(id);
         self.fill(
             rect,