adafruit-circuitpython-displayio-layout 2.0.1__tar.gz → 2.2.1__tar.gz

{adafruit-circuitpython-displayio-layout-2.0.1 → adafruit_circuitpython_displayio_layout-2.2.1}/.readthedocs.yaml

@@ -8,6 +8,9 @@
 # Required
 version: 2
 
+sphinx:
+  configuration: docs/conf.py
+
 build:
   os: ubuntu-20.04
   tools:

{adafruit-circuitpython-displayio-layout-2.0.1/adafruit_circuitpython_displayio_layout.egg-info → adafruit_circuitpython_displayio_layout-2.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: adafruit-circuitpython-displayio-layout
-Version: 2.0.1
+Version: 2.2.1
 Summary: CircuitPython helper library for displayio layouts and widgets.
 Author-email: Adafruit Industries <circuitpython@adafruit.com>
 License: MIT

{adafruit-circuitpython-displayio-layout-2.0.1 → adafruit_circuitpython_displayio_layout-2.2.1/adafruit_circuitpython_displayio_layout.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: adafruit-circuitpython-displayio-layout
-Version: 2.0.1
+Version: 2.2.1
 Summary: CircuitPython helper library for displayio layouts and widgets.
 Author-email: Adafruit Industries <circuitpython@adafruit.com>
 License: MIT

{adafruit-circuitpython-displayio-layout-2.0.1 → adafruit_circuitpython_displayio_layout-2.2.1}/adafruit_circuitpython_displayio_layout.egg-info/SOURCES.txt

@@ -26,6 +26,7 @@ adafruit_circuitpython_displayio_layout.egg-info/top_level.txt
 adafruit_displayio_layout/__init__.py
 adafruit_displayio_layout/layouts/__init__.py
 adafruit_displayio_layout/layouts/grid_layout.py
+adafruit_displayio_layout/layouts/linear_layout.py
 adafruit_displayio_layout/layouts/page_layout.py
 adafruit_displayio_layout/layouts/tab_layout.py
 adafruit_displayio_layout/widgets/__init__.py
@@ -64,6 +65,7 @@ examples/displayio_layout_gridlayout_dividers.py
 examples/displayio_layout_gridlayout_pygame_display_simpletest.py
 examples/displayio_layout_gridlayout_simpletest.py
 examples/displayio_layout_icon_animated_simpletest.py
+examples/displayio_layout_linearlayout_simpletest.py
 examples/displayio_layout_page_layout_advancedtest.py
 examples/displayio_layout_page_layout_simpletest.py
 examples/displayio_layout_pygame_display_switch_round.py

{adafruit-circuitpython-displayio-layout-2.0.1 → adafruit_circuitpython_displayio_layout-2.2.1}/adafruit_displayio_layout/layouts/grid_layout.py

@@ -32,7 +32,7 @@ import math
 import displayio
 from vectorio import Rectangle
 
-__version__ = "2.0.1"
+__version__ = "2.2.1"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_Layout.git"
 
 
@@ -111,8 +111,14 @@ class GridLayout(displayio.Group):
         ):
             self.cell_padding = 1
 
+    def layout_cells(self):
+        """render the grid with all cell content and dividers"""
+        self._layout_cells()
+
     def _layout_cells(self) -> None:
         # pylint: disable=too-many-locals, too-many-branches, too-many-statements
+        for line_obj in self._divider_lines:
+            self.remove(line_obj["rect"])
         for cell in self._cell_content_list:
             if cell["content"] not in self:
                 grid_size_x = self.grid_size[0]
@@ -297,9 +303,6 @@ class GridLayout(displayio.Group):
                         x=_right_line_loc_x,
                     )
 
-                    for line_obj in self._divider_lines:
-                        self.remove(line_obj["rect"])
-
                     """
                     Only use bottom divider lines on the bottom row. All
                     other rows rely on top divder lines of the row beneath them.
@@ -359,8 +362,8 @@ class GridLayout(displayio.Group):
                             }
                         )
 
-                    for line_obj in self._divider_lines:
-                        self.append(line_obj["rect"])
+        for line_obj in self._divider_lines:
+            self.append(line_obj["rect"])
 
     def add_content(
         self,
@@ -368,6 +371,7 @@ class GridLayout(displayio.Group):
         grid_position: Tuple[int, int],
         cell_size: Tuple[int, int],
         cell_anchor_point: Optional[Tuple[float, ...]] = None,
+        layout_cells=True,
     ) -> None:
         """Add a child to the grid.
 
@@ -395,7 +399,8 @@ class GridLayout(displayio.Group):
             "cell_size": cell_size,
         }
         self._cell_content_list.append(sub_view_obj)
-        self._layout_cells()
+        if layout_cells:
+            self._layout_cells()
 
     def get_cell(self, cell_coordinates: Tuple[int, int]) -> displayio.Group:
         """
@@ -406,9 +411,21 @@ class GridLayout(displayio.Group):
         :return: the displayio content object at those coordinates
         """
         for index, cell in enumerate(self._cell_content_list):
+            # exact location 1x1 cell
             if cell["grid_position"] == cell_coordinates:
                 return self._cell_content_list[index]["content"]
 
+            # multi-spanning cell, any size bigger than 1x1
+            if (
+                cell["grid_position"][0]
+                <= cell_coordinates[0]
+                < cell["grid_position"][0] + cell["cell_size"][0]
+                and cell["grid_position"][1]
+                <= cell_coordinates[1]
+                < cell["grid_position"][1] + cell["cell_size"][1]
+            ):
+                return self._cell_content_list[index]["content"]
+
         raise KeyError(
             "GridLayout does not contain cell at coordinates {}".format(
                 cell_coordinates
@@ -425,3 +442,40 @@ class GridLayout(displayio.Group):
           pixels of a 1x1 cell in the GridLayout
         """
         return (self._width // self.grid_size[0], self._height // self.grid_size[1])
+
+    @property
+    def width(self) -> int:
+        """
+        The width in pixels of the GridLayout.
+        """
+        return self._width
+
+    @property
+    def height(self) -> int:
+        """
+        The height in pixels of the GridLayout.
+        """
+        return self._height
+
+    def which_cell_contains(
+        self, pixel_location: Union[Tuple[int, int], List[int]]
+    ) -> Optional[tuple]:
+        """
+        Given a pixel x,y coordinate returns the location of the cell
+        that contains the coordinate.
+
+        :param pixel_location: x,y pixel coordinate as a tuple or list
+        :returns: cell coordinates x,y tuple or None if the pixel coordinates are
+            outside the bounds of the GridLayout
+        """
+        cell_size = self.cell_size_pixels
+        if (
+            not self.x <= pixel_location[0] < self.x + self.width
+            or not self.y <= pixel_location[1] < self.y + self.height
+        ):
+            return None
+
+        cell_x_coord = (pixel_location[0] - self.x) // cell_size[0]
+        cell_y_coord = (pixel_location[1] - self.y) // cell_size[1]
+
+        return cell_x_coord, cell_y_coord

adafruit_circuitpython_displayio_layout-2.2.1/adafruit_displayio_layout/layouts/linear_layout.py

@@ -0,0 +1,151 @@
+# SPDX-FileCopyrightText: Copyright (c) 2021 Tim Cocks
+#
+# SPDX-License-Identifier: MIT
+"""
+`linear_layout`
+================================================================================
+
+A layout that organizes cells into a vertical or horizontal line.
+
+
+* Author(s): Tim Cocks
+
+Implementation Notes
+--------------------
+
+**Hardware:**
+
+**Software and Dependencies:**
+
+* Adafruit CircuitPython firmware for the supported boards:
+  https://github.com/adafruit/circuitpython/releases
+
+"""
+
+from adafruit_displayio_layout.widgets.widget import Widget
+
+
+class LinearLayout(Widget):
+    """
+    LinearLayout holds multiple content elements and arranges
+    them in a line either horizontally or vertically.
+    """
+
+    VERTICAL_ORIENTATION = 1
+    HORIZONTAL_ORIENTATION = 2
+
+    def __init__(
+        self,
+        x,
+        y,
+        orientation=VERTICAL_ORIENTATION,
+        padding=0,
+    ):
+        """
+        :param int x: The horizontal position of the layout
+        :param int y: The vertical position of the layout
+        :param int orientation: The orientation of the layout. Must be VERTICAL_ORIENTATION
+         or HORIZONTAL_ORIENTATION
+        :param int padding: The padding between items in the layout
+        """
+
+        super().__init__(x=x, y=y, width=1, height=1)
+
+        self.x = x
+        self.y = y
+        self.padding = padding
+        if orientation not in [self.VERTICAL_ORIENTATION, self.HORIZONTAL_ORIENTATION]:
+            raise ValueError(
+                "Orientation must be either LinearLayout.VERTICAL_ORIENTATION"
+                " or LinearLayout.HORIZONTAL_ORIENTATION"
+            )
+
+        self.orientation = orientation
+        self._content_list = []
+        self._prev_content_end = 0
+
+    def add_content(self, content):
+        """Add a child to the linear layout.
+
+        :param content: the content to add to the linear layout e.g. label, button, etc...
+         Group subclasses that have width and height properties can be used.
+
+        :return: None"""
+
+        self._content_list.append(content)
+        self.append(content)
+        self._layout()
+
+    def _layout(self):
+        # pylint: disable=too-many-branches, protected-access
+        self._prev_content_end = 0
+
+        for _, content in enumerate(self._content_list):
+            if not hasattr(content, "anchor_point"):
+                if self.orientation == self.VERTICAL_ORIENTATION:
+                    content.y = self._prev_content_end
+                    try:
+                        self._prev_content_end = (
+                            self._prev_content_end + content.height + self.padding
+                        )
+                    except AttributeError as error:
+                        print(error)
+                        try:
+                            self._prev_content_end = (
+                                self._prev_content_end + content._height + self.padding
+                            )
+                        except AttributeError as inner_error:
+                            print(inner_error)
+
+                else:
+                    content.x = self._prev_content_end
+                    if not hasattr(content, "tile_width"):
+                        self._prev_content_end = (
+                            content.x + content.width + (self.padding * 2)
+                        )
+                    else:
+                        self._prev_content_end = (
+                            content.x
+                            + (content.width * content.tile_width)
+                            + (self.padding * 2)
+                        )
+            else:  # use anchor point
+                content.anchor_point = (
+                    0,
+                    content.anchor_point[1] if content.anchor_point is not None else 0,
+                )
+                if self.orientation == self.VERTICAL_ORIENTATION:
+                    content.anchored_position = (0, self._prev_content_end)
+                    # self._prev_content_end = content.y + content.height
+                    if not hasattr(content, "bounding_box"):
+                        self._prev_content_end = (
+                            self._prev_content_end + content.height + self.padding
+                        )
+                    else:
+                        self._prev_content_end = (
+                            self._prev_content_end
+                            + (content.bounding_box[3] * content.scale)
+                            + self.padding
+                        )
+
+                else:
+                    original_achored_pos_y = (
+                        content.anchored_position[1]
+                        if content.anchored_position is not None
+                        else 0
+                    )
+
+                    content.anchored_position = (
+                        self._prev_content_end,
+                        original_achored_pos_y,
+                    )
+                    if not hasattr(content, "bounding_box"):
+                        self._prev_content_end = (
+                            self._prev_content_end + content.width + self.padding
+                        )
+                    else:
+                        self._prev_content_end = (
+                            self._prev_content_end
+                            + (content.bounding_box[2] * content.scale)
+                            + self.padding
+                        )

{adafruit-circuitpython-displayio-layout-2.0.1 → adafruit_circuitpython_displayio_layout-2.2.1}/adafruit_displayio_layout/layouts/page_layout.py

@@ -32,7 +32,7 @@ except ImportError:
 
 import displayio
 
-__version__ = "2.0.1"
+__version__ = "2.2.1"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_Layout.git"
 
 

{adafruit-circuitpython-displayio-layout-2.0.1 → adafruit_circuitpython_displayio_layout-2.2.1}/adafruit_displayio_layout/layouts/tab_layout.py

@@ -37,7 +37,7 @@ from adafruit_display_text.bitmap_label import Label
 from adafruit_imageload.tilegrid_inflator import inflate_tilegrid
 from adafruit_displayio_layout.layouts.page_layout import PageLayout
 
-__version__ = "2.0.1"
+__version__ = "2.2.1"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_Layout.git"
 
 

{adafruit-circuitpython-displayio-layout-2.0.1 → adafruit_circuitpython_displayio_layout-2.2.1}/adafruit_displayio_layout/widgets/cartesian.py

@@ -41,7 +41,7 @@ except ImportError:
     pass
 
 
-__version__ = "2.0.1"
+__version__ = "2.2.1"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_Layout.git"
 
 

{adafruit-circuitpython-displayio-layout-2.0.1 → adafruit_circuitpython_displayio_layout-2.2.1}/adafruit_displayio_layout/widgets/control.py

@@ -27,7 +27,7 @@ except ImportError:
     pass
 
 
-__version__ = "2.0.1"
+__version__ = "2.2.1"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_Layout.git"
 
 # pylint: disable=unsubscriptable-object, unnecessary-pass

{adafruit-circuitpython-displayio-layout-2.0.1 → adafruit_circuitpython_displayio_layout-2.2.1}/adafruit_displayio_layout/widgets/easing.py

@@ -76,7 +76,7 @@ Implementation Notes
 import math
 
 
-__version__ = "2.0.1"
+__version__ = "2.2.1"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_Layout.git"
 
 

{adafruit-circuitpython-displayio-layout-2.0.1 → adafruit_circuitpython_displayio_layout-2.2.1}/adafruit_displayio_layout/widgets/flip_input.py

@@ -44,7 +44,7 @@ except ImportError:
     pass
 
 
-__version__ = "2.0.1"
+__version__ = "2.2.1"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_Layout.git"
 
 

{adafruit-circuitpython-displayio-layout-2.0.1 → adafruit_circuitpython_displayio_layout-2.2.1}/adafruit_displayio_layout/widgets/icon_animated.py

@@ -38,7 +38,7 @@ except ImportError:
     pass
 
 
-__version__ = "2.0.1"
+__version__ = "2.2.1"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_Layout.git"
 
 

{adafruit-circuitpython-displayio-layout-2.0.1 → adafruit_circuitpython_displayio_layout-2.2.1}/adafruit_displayio_layout/widgets/icon_widget.py

@@ -36,7 +36,7 @@ except ImportError:
     pass
 
 
-__version__ = "2.0.1"
+__version__ = "2.2.1"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_Layout.git"
 
 

{adafruit-circuitpython-displayio-layout-2.0.1 → adafruit_circuitpython_displayio_layout-2.2.1}/adafruit_displayio_layout/widgets/switch_round.py

@@ -50,7 +50,7 @@ except ImportError:
     pass
 
 
-__version__ = "2.0.1"
+__version__ = "2.2.1"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_Layout.git"
 
 

{adafruit-circuitpython-displayio-layout-2.0.1 → adafruit_circuitpython_displayio_layout-2.2.1}/adafruit_displayio_layout/widgets/widget.py

@@ -30,7 +30,7 @@ except ImportError:
     pass
 
 
-__version__ = "2.0.1"
+__version__ = "2.2.1"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_Layout.git"
 
 # pylint: disable=too-many-arguments

{adafruit-circuitpython-displayio-layout-2.0.1 → adafruit_circuitpython_displayio_layout-2.2.1}/docs/conf.py

@@ -32,6 +32,7 @@ inheritance_graph_attrs = dict(rankdir="TB")
 # autodoc module docs will fail to generate with a warning.
 autodoc_mock_imports = [
     "vectorio",
+    "terminalio",
     "bitmaptools",
 ]
 
@@ -117,7 +118,6 @@ napoleon_numpy_docstring = False
 import sphinx_rtd_theme
 
 html_theme = "sphinx_rtd_theme"
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."]
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

adafruit_circuitpython_displayio_layout-2.2.1/examples/displayio_layout_linearlayout_simpletest.py

@@ -0,0 +1,37 @@
+# SPDX-FileCopyrightText: 2024 Tim C, written for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+"""
+Illustrates usage of LinearLayout to display a text label to the right of
+an icon.
+"""
+import adafruit_imageload
+import board
+import displayio
+import terminalio
+from adafruit_display_text import label
+from adafruit_displayio_layout.layouts.linear_layout import LinearLayout
+
+# use built in display (PyPortal, PyGamer, PyBadge, CLUE, etc.)
+# see guide for setting up external displays (TFT / OLED breakouts, RGB matrices, etc.)
+# https://learn.adafruit.com/circuitpython-display-support-using-displayio/display-and-display-bus
+display = board.DISPLAY
+
+# Make the display context
+main_group = displayio.Group()
+display.root_group = main_group
+
+layout = LinearLayout(
+    x=10, y=10, padding=4, orientation=LinearLayout.HORIZONTAL_ORIENTATION
+)
+
+lbl = label.Label(terminalio.FONT, scale=4, x=0, y=0, text="Hello")
+
+icon, icon_palette = adafruit_imageload.load("icons/Play_48x48_small.bmp")
+icon_tile_grid = displayio.TileGrid(icon, pixel_shader=icon_palette)
+layout.add_content(icon_tile_grid)
+layout.add_content(lbl)
+
+main_group.append(layout)
+while True:
+    pass

{adafruit-circuitpython-displayio-layout-2.0.1 → adafruit_circuitpython_displayio_layout-2.2.1}/pyproject.toml

@@ -12,7 +12,7 @@ requires = [
 [project]
 name = "adafruit-circuitpython-displayio-layout"
 description = "CircuitPython helper library for displayio layouts and widgets."
-version = "2.0.1"
+version = "2.2.1"
 readme = "README.rst"
 authors = [
     {name = "Adafruit Industries", email = "circuitpython@adafruit.com"}