Update transparency description in all gadget doc strings.

batgrl/gadgets/animation.py

@@ -81,8 +81,8 @@ class Animation(Gadget):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: True
-        If true, gadget is rendered with alpha compositing; otherwise, alpha values are
-        ignored.
+        A transparent gadget allows regions beneath it to be painted. Additionally,
+        non-transparent graphic gadgets are not alpha composited.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.

batgrl/gadgets/bar_chart.py

@@ -80,7 +80,7 @@ class BarChart(Gadget):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: False
-        Whether :attr:`background_char` and :attr:`background_color_pair` are painted.
+        A transparent gadget allows regions beneath it to be painted.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.

batgrl/gadgets/box_image.py

@@ -52,7 +52,7 @@ class BoxImage(Text):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: False
-        Whether :attr:`background_char` and :attr:`background_color_pair` are painted.
+        A transparent gadget allows regions beneath it to be painted.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.

batgrl/gadgets/braille_image.py

@@ -52,7 +52,7 @@ class BrailleImage(Text):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: False
-        Whether :attr:`background_char` and :attr:`background_color_pair` are painted.
+        A transparent gadget allows regions beneath it to be painted.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.

batgrl/gadgets/braille_video_player.py

@@ -69,7 +69,7 @@ class BrailleVideoPlayer(Text):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: False
-        Whether :attr:`background_char` and :attr:`background_color_pair` are painted.
+        A transparent gadget allows regions beneath it to be painted.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.

batgrl/gadgets/button.py

@@ -44,7 +44,7 @@ class Button(Themable, ButtonBehavior, Gadget):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: False
-        Whether :attr:`background_char` and :attr:`background_color_pair` are painted.
+        A transparent gadget allows regions beneath it to be painted.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.

batgrl/gadgets/color_picker.py

@@ -164,7 +164,7 @@ class ColorPicker(Themable, Gadget):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: False
-        Whether :attr:`background_char` and :attr:`background_color_pair` are painted.
+        A transparent gadget allows regions beneath it to be painted.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.

batgrl/gadgets/console.py

@@ -243,7 +243,7 @@ class Console(Themable, Focusable, Gadget):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: False
-        Whether :attr:`background_char` and :attr:`background_color_pair` are painted.
+        A transparent gadget allows regions beneath it to be painted.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.

batgrl/gadgets/data_table.py

@@ -372,7 +372,7 @@ class DataTable(Themable, ScrollView):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: False
-        Whether :attr:`background_char` and :attr:`background_color_pair` are painted.
+        A transparent gadget allows regions beneath it to be painted.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.

batgrl/gadgets/digital_display.py

@@ -165,7 +165,7 @@ class DigitalDisplay(Gadget):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: False
-        Whether :attr:`background_char` and :attr:`background_color_pair` are painted.
+        A transparent gadget allows regions beneath it to be painted.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.

batgrl/gadgets/file_chooser.py

@@ -241,7 +241,7 @@ class FileChooser(Themable, ScrollView):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: False
-        Whether :attr:`background_char` and :attr:`background_color_pair` are painted.
+        A transparent gadget allows regions beneath it to be painted.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.

batgrl/gadgets/flat_toggle.py

@@ -133,7 +133,7 @@ class FlatToggle(Gadget):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: False
-        Whether :attr:`background_char` and :attr:`background_color_pair` are painted.
+        A transparent gadget allows regions beneath it to be painted.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.

batgrl/gadgets/gadget.py

@@ -484,7 +484,7 @@ class Gadget:
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: False
-        Whether :attr:`background_char` and :attr:`background_color_pair` are painted.
+        A transparent gadget allows regions beneath it to be painted.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.

batgrl/gadgets/graphic_field.py

@@ -61,8 +61,8 @@ class GraphicParticleField(Gadget):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: True
-        If true, gadget is rendered with alpha compositing; otherwise, alpha values are
-        ignored.
+        A transparent gadget allows regions beneath it to be painted. Additionally,
+        non-transparent graphic gadgets are not alpha composited.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.

batgrl/gadgets/graphics.py

@@ -75,8 +75,8 @@ class Graphics(Gadget):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: True
-        If true, gadget is rendered with alpha compositing; otherwise, alpha values are
-        ignored.
+        A transparent gadget allows regions beneath it to be painted. Additionally,
+        non-transparent graphic gadgets are not alpha composited.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.

batgrl/gadgets/grid_layout.py

@@ -94,7 +94,7 @@ class GridLayout(Gadget):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: False
-        Whether :attr:`background_char` and :attr:`background_color_pair` are painted.
+        A transparent gadget allows regions beneath it to be painted.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.

batgrl/gadgets/image.py

@@ -56,8 +56,8 @@ class Image(Graphics):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: True
-        If true, gadget is rendered with alpha compositing; otherwise, alpha values are
-        ignored.
+        A transparent gadget allows regions beneath it to be painted. Additionally,
+        non-transparent graphic gadgets are not alpha composited.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.

batgrl/gadgets/line_plot.py

@@ -128,7 +128,7 @@ class LinePlot(Gadget):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: False
-        Whether :attr:`background_char` and :attr:`background_color_pair` are painted.
+        A transparent gadget allows regions beneath it to be painted.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.

batgrl/gadgets/menu.py

@@ -84,7 +84,7 @@ class MenuItem(Themable, ToggleButtonBehavior, Gadget):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: False
-        Whether :attr:`background_char` and :attr:`background_color_pair` are painted.
+        A transparent gadget allows regions beneath it to be painted.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.
@@ -423,7 +423,7 @@ class Menu(GridLayout):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: False
-        Whether :attr:`background_char` and :attr:`background_color_pair` are painted.
+        A transparent gadget allows regions beneath it to be painted.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.
@@ -927,7 +927,7 @@ class MenuBar(GridLayout):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: False
-        Whether :attr:`background_char` and :attr:`background_color_pair` are painted.
+        A transparent gadget allows regions beneath it to be painted.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.

batgrl/gadgets/parallax.py

@@ -78,8 +78,8 @@ class Parallax(Gadget):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: True
-        If true, gadget is rendered with alpha compositing; otherwise, alpha values are
-        ignored.
+        A transparent gadget allows regions beneath it to be painted. Additionally,
+        non-transparent graphic gadgets are not alpha composited.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.

batgrl/gadgets/progress_bar.py

@@ -57,7 +57,7 @@ class ProgressBar(Themable, Text):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: False
-        Whether :attr:`background_char` and :attr:`background_color_pair` are painted.
+        A transparent gadget allows regions beneath it to be painted.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.

batgrl/gadgets/raycaster.py

@@ -170,8 +170,8 @@ class Raycaster(Graphics):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: True
-        If true, gadget is rendered with alpha compositing; otherwise, alpha values are
-        ignored.
+        A transparent gadget allows regions beneath it to be painted. Additionally,
+        non-transparent graphic gadgets are not alpha composited.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.

batgrl/gadgets/scroll_view.py

@@ -252,7 +252,7 @@ class ScrollView(Grabbable, Gadget):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: False
-        Whether :attr:`background_char` and :attr:`background_color_pair` are painted.
+        A transparent gadget allows regions beneath it to be painted.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.

batgrl/gadgets/shadow_caster.py

@@ -209,8 +209,8 @@ class ShadowCaster(Graphics):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: True
-        If true, gadget is rendered with alpha compositing; otherwise, alpha values are
-        ignored.
+        A transparent gadget allows regions beneath it to be painted. Additionally,
+        non-transparent graphic gadgets are not alpha composited.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.

batgrl/gadgets/slider.py

@@ -79,7 +79,7 @@ class Slider(Grabbable, Text):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: False
-        Whether :attr:`background_char` and :attr:`background_color_pair` are painted.
+        A transparent gadget allows regions beneath it to be painted.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.

batgrl/gadgets/sparkline.py

@@ -80,7 +80,7 @@ class Sparkline(Text):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: False
-        Whether :attr:`background_char` and :attr:`background_color_pair` are painted.
+        A transparent gadget allows regions beneath it to be painted.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.

batgrl/gadgets/split_layout.py

@@ -95,7 +95,7 @@ class HSplitLayout(Gadget):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: False
-        Whether :attr:`background_char` and :attr:`background_color_pair` are painted.
+        A transparent gadget allows regions beneath it to be painted.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.
@@ -357,7 +357,7 @@ class VSplitLayout(Gadget):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: False
-        Whether :attr:`background_char` and :attr:`background_color_pair` are painted.
+        A transparent gadget allows regions beneath it to be painted.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.

batgrl/gadgets/tabs.py

@@ -97,7 +97,7 @@ class Tabs(Themable, Gadget):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: False
-        Whether :attr:`background_char` and :attr:`background_color_pair` are painted.
+        A transparent gadget allows regions beneath it to be painted.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.

batgrl/gadgets/text.py

@@ -86,7 +86,7 @@ class Text(Gadget):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: False
-        Whether :attr:`background_char` and :attr:`background_color_pair` are painted.
+        A transparent gadget allows regions beneath it to be painted.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.

batgrl/gadgets/text_animation.py

@@ -58,7 +58,7 @@ class TextAnimation(Gadget):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: False
-        Whether :attr:`background_char` and :attr:`background_color_pair` are painted.
+        A transparent gadget allows regions beneath it to be painted.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.

batgrl/gadgets/text_field.py

@@ -62,7 +62,7 @@ class TextParticleField(Gadget):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: False
-        Whether :attr:`background_char` and :attr:`background_color_pair` are painted.
+        A transparent gadget allows regions beneath it to be painted.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.

batgrl/gadgets/text_pad.py

@@ -82,7 +82,7 @@ class TextPad(Themable, Focusable, ScrollView):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: False
-        Whether :attr:`background_char` and :attr:`background_color_pair` are painted.
+        A transparent gadget allows regions beneath it to be painted.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.

batgrl/gadgets/textbox.py

@@ -72,7 +72,7 @@ class Textbox(Themable, Focusable, Grabbable, Gadget):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: False
-        Whether :attr:`background_char` and :attr:`background_color_pair` are painted.
+        A transparent gadget allows regions beneath it to be painted.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.

batgrl/gadgets/tiled_image.py

@@ -53,8 +53,8 @@ class TiledImage(Graphics):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: True
-        If true, gadget is rendered with alpha compositing; otherwise, alpha values are
-        ignored.
+        A transparent gadget allows regions beneath it to be painted. Additionally,
+        non-transparent graphic gadgets are not alpha composited.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.

batgrl/gadgets/toggle_button.py

@@ -65,7 +65,7 @@ class ToggleButton(Themable, ToggleButtonBehavior, Gadget):
     pos_hint : PosHint | PosHintDict | None , default: None
         Position as a proportion of parent's height and width.
     is_transparent : bool, default: False
-        Whether :attr:`background_char` and :attr:`background_color_pair` are painted.
+        A transparent gadget allows regions beneath it to be painted.
     is_visible : bool, default: True
         Whether gadget is visible. Gadget will still receive input events if not
         visible.