Add possibility for element to span accross multiple columns

Author: Grimmys

src/pygamepopup/components/box_element.py

@@ -20,16 +20,18 @@ class BoxElement:
     In fact, it adds a margin to any border of an element to have a cleaner interface.
 
     Keyword arguments:
-        position (Position): the position of the box on the screen
-        content (Optional[pygame.Surface]): a surface that will be wrapped by the box
+        position (Position): the position of the box on the screen.
+        content (Optional[pygame.Surface]): a surface that will be wrapped by the box.
         margin (Margin): a tuple containing the margins of the box, should be in the form
-            "(top_margin, right_margin, bottom_margin, left_margin), defaults to (0, 0, 0, 0)"
+            "(top_margin, right_margin, bottom_margin, left_margin), defaults to (0, 0, 0, 0)".
+        column_span (int): the number of columns the element should span, defaults to 1.
 
     Attributes:
-        position (Position): the position of the box on the screen
-        content (Optional[pygame.Surface]): the element wrapped in the box
+        position (Position): the position of the box on the screen.
+        content (Optional[pygame.Surface]): the element wrapped in the box.
         size (tuple[int, int]): the size of the content following the format "(width, height)"
-        margin (dict[str, int]): a dict containing all the values for margins TOP, BOTTOM, LEFT and RIGHT
+        margin (dict[str, int]): a dict containing all the values for margins TOP, BOTTOM, LEFT and RIGHT.
+        column_span (int): the number of columns the element should span.
     """
 
     def __new__(cls, *args, **kwargs):
@@ -45,6 +47,7 @@ def __init__(
         position: Position,
         content: Optional[pygame.Surface],
         margin: Margin = (0, 0, 0, 0),
+        column_span: int = 1,
     ) -> None:
         self.position: Position = position
         self.content: pygame.Surface = content
@@ -57,6 +60,7 @@ def __init__(
             "LEFT": margin[3],
             "RIGHT": margin[1],
         }
+        self.column_span = column_span
 
     def get_width(self) -> int:
         """

src/pygamepopup/components/info_box.py

@@ -27,9 +27,12 @@
 
 class _Row:
     def __init__(self, elements: list[BoxElement], height: int = 0):
-        self.elements = elements
+        self.elements: list[BoxElement] = elements
         self.height = height
 
+    def compute_number_columns(self):
+        return sum(element.column_span for element in self.elements)
+
 
 class InfoBox:
     """
@@ -286,18 +289,18 @@ def determine_elements_position(self) -> None:
         mouse_pos = pygame.mouse.get_pos()
         # A row begins by a value identifying its height, followed by its elements
         for row in self.__elements:
-            nb_elements = len(row.elements)
-            i = 1
+            number_columns = row.compute_number_columns()
+            column = 1
             for element in row.elements:
-                base_x = self.position.x + (self.__size[0] // (2 * nb_elements)) * i
+                base_x = self.position.x + (self.__size[0] // (2 * number_columns)) * (column + element.column_span - 1)
                 x_coordinate = base_x - element.get_width() // 2
                 element.position = pygame.Vector2(
                     x_coordinate,
                     y_coordinate + element.get_margin_top(),
                 )
                 if isinstance(element, Button):
                     element.set_hover(element.get_rect().collidepoint(mouse_pos))
-                i += 2
+                column += 2 * element.column_span
             y_coordinate += row.height
 
     def display(self, screen: pygame.Surface) -> None:

src/pygamepopup/components/text_element.py

@@ -26,6 +26,7 @@ class TextElement(BoxElement):
         margin (Margin): a tuple containing the margins of the box,
             should be in the form "(top_margin, right_margin, bottom_margin, left_margin)", defaults to (0, 0, 0, 0).
         text_color (pygame.Color): the color of the rendered text, defaults to WHITE.
+        column_span (int): the number of columns the element should span, defaults to 1.
     """
 
     def __init__(
@@ -35,14 +36,15 @@ def __init__(
         font: pygame.font.Font = None,
         margin: Margin = (0, 0, 0, 0),
         text_color: pygame.Color = WHITE,
+        column_span: int = 1,
     ) -> None:
         if not font:
             font = _default_fonts["text_element_content"]
         self._font = font
         self._text = text
         self._text_color = text_color
         rendered_text: pygame.Surface = font.render(text, True, text_color)
-        super().__init__(position, rendered_text, margin)
+        super().__init__(position, rendered_text, margin, column_span)
 
     def _verify_rendered_text_size(
         self, rendered_text: pygame.Surface, text: str, container_width: int