fix vertical alignment of outlined accents. backwards compat classes. manual display.refresh() for scrolling.

Author: FoamyGuy

adafruit_display_text/bitmap_label.py

@@ -587,13 +587,28 @@ def _place_text(
                                 # only one accent range can effect a given character
                                 break
 
+                    if (
+                        not accented
+                        and self._has_outline_accent()
+                        or accented
+                        and accent_type == "foreground_background"
+                    ):
+                        y_blit_target += self._outline_size
+
                     if accented:
-                        bitmaptools.blit(
-                            bitmap,
-                            self._tmp_glyph_bitmap,
-                            max(xposition + my_glyph.dx, 0),
-                            y_blit_target,
-                        )
+                        try:
+                            bitmaptools.blit(
+                                bitmap,
+                                self._tmp_glyph_bitmap,
+                                max(xposition + my_glyph.dx, 0),
+                                y_blit_target,
+                            )
+                        except ValueError:
+                            # It's possible to overshoot the width of the bitmap if max_characters
+                            # is enabled and outline is used on at least some of the text.
+                            # In this case just skip any characters that fall outside the
+                            # max_characters box size without accounting for outline size.
+                            pass
                     else:
                         try:
                             self._blit(
@@ -651,6 +666,12 @@ def _add_outline(self, bitmap):
                                 "Try using either larger padding sizes, or smaller outline_size."
                             ) from value_error
 
+    def _has_outline_accent(self):
+        for accent in self._accent_ranges:
+            if accent[ACCENT_TYPE] == "outline":
+                return True
+        return False
+
     def _blit(
         self,
         bitmap: displayio.Bitmap,  # target bitmap
@@ -777,14 +798,14 @@ def bitmap(self) -> displayio.Bitmap:
         """
         return self._bitmap
 
-    def update(self, force: bool = False) -> None:
+    def update(self, force: bool = False) -> bool:
         """Attempt to update the display. If ``animate_time`` has elapsed since
         previews animation frame then move the characters over by 1 index.
         Must be called in the main loop of user code.
 
         :param bool force: whether to ignore ``animation_time`` and force the update.
          Default is False.
-        :return: None
+        :return: bool updated: whether anything changed and the display needs to be refreshed.
         """
         _now = adafruit_ticks.ticks_ms()
         if force or adafruit_ticks.ticks_less(
@@ -815,10 +836,13 @@ def update(self, force: bool = False) -> None:
 
                 _showing_string = f"{_showing_string_start}{_showing_string_end}"
             self._set_text(_showing_string, self.scale)
-            self.current_index += 1
+            if not force:
+                self.current_index += 1
             self._last_animate_time = _now
 
-            return
+            return True
+
+        return False
 
     @property
     def current_index(self) -> int:

adafruit_display_text/outlined_label.py

@@ -0,0 +1,12 @@
+# SPDX-FileCopyrightText: 2025 Tim C for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+import warnings
+
+from .bitmap_label import Label as BitmapLabel
+
+warnings.warn(
+    "outlined_label.OutlinedLabel is deprecated, adafruit_display_text.bitmap_label.Label"
+    " now supports outline functionality with the same API, it should be used instead."
+)
+OutlineLabel = BitmapLabel

adafruit_display_text/scrolling_label.py

@@ -0,0 +1,12 @@
+# SPDX-FileCopyrightText: 2025 Tim C for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+import warnings
+
+from .bitmap_label import Label as BitmapLabel
+
+warnings.warn(
+    "scrolling_label.ScrollingLabel is deprecated, adafruit_display_text.bitmap_label.Label"
+    " now supports scrolling functionality with the same API, it should be used instead."
+)
+ScrollingLabel = BitmapLabel

examples/display_text_accent_scrolling_example.py

@@ -33,5 +33,8 @@
 scrolling_label.add_accent_to_substring("CircuitPython", 5, 6)
 scrolling_label.add_accent_to_substring("awesome!", 3, 4, "outline")
 
+display.auto_refresh = False
+display.refresh()
 while True:
-    scrolling_label.update()
+    if scrolling_label.update():
+        display.refresh()

examples/display_text_scrolling_label.py

@@ -12,5 +12,8 @@
 scrolling_label.x = 10
 scrolling_label.y = 10
 display.root_group = scrolling_label
+display.auto_refresh = False
+display.refresh()
 while True:
-    scrolling_label.update()
+    if scrolling_label.update():
+        display.refresh()