Add Component.description to use as label tooltip

schemas/pvi.device.schema.json

@@ -196,8 +196,22 @@
  }
  ],
  "default": null,
+ "description": "Label for component",
  "title": "Label"
  },
+ "description": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Description for label tooltip",
+ "title": "Description"
+ },
  "pv": {
  "description": "Child device PVI PV",
  "title": "Pv",
@@ -278,8 +292,22 @@
  }
  ],
  "default": null,
+ "description": "Label for component",
  "title": "Label"
  },
+ "description": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Description for label tooltip",
+ "title": "Description"
+ },
  "layout": {
  "description": "How to layout children on screen",
  "oneOf": [
@@ -467,8 +495,22 @@
  }
  ],
  "default": null,
+ "description": "Label for component",
  "title": "Label"
  },
+ "description": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Description for label tooltip",
+ "title": "Description"
+ },
  "read_pv": {
  "description": "PV to use for readback",
  "title": "Read Pv",
@@ -539,8 +581,22 @@
  }
  ],
  "default": null,
+ "description": "Label for component",
  "title": "Label"
  },
+ "description": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Description for label tooltip",
+ "title": "Description"
+ },
  "write_pv": {
  "description": "PV to use for demand",
  "title": "Write Pv",
@@ -644,8 +700,22 @@
  }
  ],
  "default": null,
+ "description": "Label for component",
  "title": "Label"
  },
+ "description": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Description for label tooltip",
+ "title": "Description"
+ },
  "type": {
  "const": "SignalRef",
  "default": "SignalRef",
@@ -682,8 +752,22 @@
  }
  ],
  "default": null,
+ "description": "Label for component",
  "title": "Label"
  },
+ "description": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Description for label tooltip",
+ "title": "Description"
+ },
  "write_pv": {
  "description": "PV to use for demand",
  "title": "Write Pv",
@@ -753,8 +837,22 @@
  }
  ],
  "default": null,
+ "description": "Label for component",
  "title": "Label"
  },
+ "description": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Description for label tooltip",
+ "title": "Description"
+ },
  "write_pv": {
  "description": "PV to use for demand",
  "title": "Write Pv",

src/pvi/_format/dls.bob

@@ -41,6 +41,7 @@
  <y>58</y>
  <width>120</width>
  <height>30</height>
+ <tooltip>$(text)</tooltip>
  </widget>
  <widget type="textentry" version="3.0.0">
  <name>TextEntry</name>

src/pvi/_format/dls.py

@@ -240,7 +240,7 @@ def format_bob(self, device: Device, path: Path):
  label_formatter_cls=LabelWidgetFormatter.from_template(
  template,
  search="Label",
- property_map={"text": "text"},
+ property_map={"text": "text", "tooltip": "description"},
  ),
  led_formatter_cls=PVWidgetFormatter.from_template(
  template,

src/pvi/_format/screen.py

@@ -475,7 +475,7 @@ def generate_component_formatters(
  self.layout.label_width, self.layout.spacing
  )
  yield self.widget_formatter_factory.label_formatter_cls(
- bounds=left, text=c.get_label()
+ bounds=left, text=c.get_label(), description=c.description or ""
  )
  else:
  # Allow full width for widget

src/pvi/_format/widget.py

@@ -141,6 +141,7 @@ def format(self: WidgetFormatter[T]) -> List[T]:
 
 class LabelWidgetFormatter(WidgetFormatter[T]):
  text: str
+ description: str = ""
 
 
 class PVWidgetFormatter(WidgetFormatter[T]):

src/pvi/device.py

@@ -291,7 +291,10 @@ class Named(TypedModel):
 class Component(Named):
  """These make up a Device"""
 
- label: Optional[str] = None
+ label: Annotated[str | None, Field(description="Label for component")] = None
+ description: Annotated[
+ str | None, Field(description="Description for label tooltip")
+ ] = None
 
  def get_label(self):
  return self.label or to_title_case(self.name)

tests/format/input/signal_default_widgets.pvi.device.yaml

@@ -5,6 +5,7 @@ children:
 
 - type: SignalR
  name: Read
+ description: A read-only signal
  read_pv: Read
 
 - type: SignalW

tests/format/output/button.bob

@@ -32,6 +32,7 @@
  <y>30</y>
  <width>120</width>
  <height>20</height>
+ <tooltip>$(text)</tooltip>
  </widget>
  <widget type="textentry" version="3.0.0">
  <name>TextEntry</name>
@@ -62,6 +63,7 @@
  <y>54</y>
  <width>120</width>
  <height>20</height>
+ <tooltip>$(text)</tooltip>
  </widget>
  <widget type="action_button" version="3.0.0">
  <name>WritePV</name>
@@ -104,6 +106,7 @@
  <y>78</y>
  <width>120</width>
  <height>20</height>
+ <tooltip>$(text)</tooltip>
  </widget>
  <widget type="action_button" version="3.0.0">
  <name>WritePV</name>

tests/format/output/combo_box.bob

@@ -32,6 +32,7 @@
  <y>30</y>
  <width>120</width>
  <height>20</height>
+ <tooltip>$(text)</tooltip>
  </widget>
  <widget type="combo" version="2.0.0">
  <name>ComboBox</name>

tests/format/output/device_ref.bob

@@ -32,6 +32,7 @@
  <y>30</y>
  <width>120</width>
  <height>20</height>
+ <tooltip>$(text)</tooltip>
  </widget>
  <widget type="action_button" version="3.0.0">
  <name>OpenDisplay</name>

tests/format/output/index.bob

@@ -32,6 +32,7 @@
  <y>30</y>
  <width>150</width>
  <height>20</height>
+ <tooltip>$(text)</tooltip>
  </widget>
  <widget type="action_button" version="3.0.0">
  <name>OpenDisplay</name>
@@ -59,6 +60,7 @@
  <y>55</y>
  <width>150</width>
  <height>20</height>
+ <tooltip>$(text)</tooltip>
  </widget>
  <widget type="action_button" version="3.0.0">
  <name>OpenDisplay</name>
@@ -86,6 +88,7 @@
  <y>80</y>
  <width>150</width>
  <height>20</height>
+ <tooltip>$(text)</tooltip>
  </widget>
  <widget type="action_button" version="3.0.0">
  <name>OpenDisplay</name>