Method get_hover_widgets_at

src/textual/screen.py:648–673

Get the widget, and its region directly under the mouse, and the first widget, region pair with a hover style. Args: x: X Coordinate. y: Y Coordinate. Returns: A pair of (WIDGET, REGION) tuples for the top most and first hover style respe

(self, x: int, y: int)

        return self._compositor.get_widget_at(x, y)

    def get_hover_widgets_at(self, x: int, y: int) -> HoverWidgets:
        """Get the widget, and its region directly under the mouse, and the first
        widget, region pair with a hover style.

        Args:
            x: X Coordinate.
            y: Y Coordinate.

        Returns:
            A pair of (WIDGET, REGION) tuples for the top most and first hover style respectively.

        Raises:
            NoWidget: If there is no widget under the screen coordinate.

        """
        widgets_under_coordinate = iter(self._compositor.get_widgets_at(x, y))
        try:
            top_widget, top_region = next(widgets_under_coordinate)
        except StopIteration:
            raise errors.NoWidget(f"No hover widget under screen coordinate ({x}, {y})")
        if not top_widget._has_hover_style:
            for widget, region in widgets_under_coordinate:
                if widget._has_hover_style:
                    return HoverWidgets((top_widget, top_region), (widget, region))
            return HoverWidgets((top_widget, top_region), None)
        return HoverWidgets((top_widget, top_region), (top_widget, top_region))

    def get_widgets_at(self, x: int, y: int) -> Iterable[tuple[Widget, Region]]:
        """Get all widgets under a given coordinate.