GUI: 3.0 cleanup (#2371)

* Remove unlisted old examples * Fix scroll example * Inform about UIView in gui.concepts
pythonarcade · Sep 22, 2024 · c650082 · c650082
1 parent 0ed4661
commit c650082
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 208 deletions.
diff --git a/arcade/examples/gui/dropdown.py b/arcade/examples/gui/dropdown.py
diff --git a/arcade/examples/gui/exp_scroll_area.py b/arcade/examples/gui/exp_scroll_area.py
@@ -58,11 +58,11 @@ def __init__(self):
         h_scroll_area = UIBoxLayout(vertical=True, size_hint=(0.8, 0.8))
         content_right.add(h_scroll_area, anchor_x="center", anchor_y="center")
 
-        scroll_layout = h_scroll_area.add(UIScrollArea(size_hint=(1, 1)))
-        scroll_layout.with_border(color=arcade.uicolor.WHITE_CLOUDS)
-        scroll_layout.add(horizontal_list)
+        h_scroll_layout = h_scroll_area.add(UIScrollArea(size_hint=(1, 1)))
+        h_scroll_layout.with_border(color=arcade.uicolor.WHITE_CLOUDS)
+        h_scroll_layout.add(horizontal_list)
 
-        h_scroll_area.add(UIScrollBar(scroll_layout, vertical=False))
+        h_scroll_area.add(UIScrollBar(h_scroll_layout, vertical=False))
 
     def on_key_press(self, symbol: int, modifiers: int) -> bool | None:
         if symbol == arcade.key.ESCAPE:

diff --git a/arcade/examples/gui/grid_layout.py b/arcade/examples/gui/grid_layout.py
diff --git a/arcade/examples/gui/side_bars_with_box_layout.py b/arcade/examples/gui/side_bars_with_box_layout.py
diff --git a/arcade/gui/experimental/scroll_area.py b/arcade/gui/experimental/scroll_area.py
@@ -196,10 +196,13 @@ def do_layout(self):
             if new_rect != child.rect:
                 child.rect = new_rect
 
+        total_min_x = round(total_min_x)
+        total_min_y = round(total_min_y)
+
         # resize surface to fit all children
         if self.surface.size != (total_min_x, total_min_y):
             self.surface.resize(
-                size=(round(total_min_x), round(total_min_y)), pixel_ratio=self.surface.pixel_ratio
+                size=(total_min_x, total_min_y), pixel_ratio=self.surface.pixel_ratio
             )
             self.scroll_x = 0
             self.scroll_y = 0

diff --git a/doc/programming_guide/gui/concepts.rst b/doc/programming_guide/gui/concepts.rst
@@ -35,6 +35,12 @@ And disable it with :py:meth:`~arcade.gui.UIManager.disable()` within :py:meth:`
 
 To draw the GUI, call :py:meth:`~arcade.gui.UIManager.draw` within the :py:meth:`~arcade.View.on_draw` method.
 
+The :py:class`~arcade.gui.UIView` class is a subclass of :py:class:`~arcade.View` and provides
+a convenient way to use the GUI. It instanciates a :py:class:`~arcade.gui.UIManager` which can be accessed
+via the :py:attr:`~arcade.gui.UIView.ui` attribute.
+It automatically enables and disables the
+:py:class:`~arcade.gui.UIManager` when the view is shown or hidden.
+
 
 UIWidget
 ````````