Work on updating docs for GUI

arcade/examples/gui_elements.py

@@ -0,0 +1,92 @@
+"""
+Show GUI Elements
+
+Show how to use GUI elements.
+
+python -m arcade.examples.gui_elements_example
+"""
+import arcade
+
+import arcade.gui
+from arcade.gui import UIManager
+
+
+class MyView(arcade.View):
+    """
+    Main view. Really the only view in this example. """
+    def __init__(self):
+        super().__init__()
+
+        self.ui_manager = UIManager(window)
+
+    def on_draw(self):
+        """ Draw this view. GUI elements are automatically drawn. """
+        arcade.start_render()
+
+    def on_show(self):
+        """ Called once when view is activated. """
+        self.setup()
+        arcade.set_background_color(arcade.color.BLACK)
+
+    def setup(self):
+        """ Set up this view. """
+        self.ui_manager.purge_ui_elements()
+
+        y_slot = self.window.height // 4
+        left_column_x = self.window.width // 4
+        right_column_x = 3 * self.window.width // 4
+
+        # left side elements
+        self.ui_manager.add_ui_element(arcade.gui.UILabel(
+            'UILabel',
+            center_x=left_column_x,
+            center_y=y_slot * 3,
+        ))
+
+        ui_input_box = arcade.gui.UIInputBox(
+            center_x=left_column_x,
+            center_y=y_slot * 2,
+            width=300
+        )
+        ui_input_box.text = 'UIInputBox'
+        ui_input_box.cursor_index = len(ui_input_box.text)
+        self.ui_manager.add_ui_element(ui_input_box)
+
+        button_normal = arcade.load_texture(':resources:gui_basic_assets/red_button_normal.png')
+        hovered_texture = arcade.load_texture(':resources:gui_basic_assets/red_button_hover.png')
+        pressed_texture = arcade.load_texture(':resources:gui_basic_assets/red_button_press.png')
+        button = arcade.gui.UIImageButton(
+            center_x=left_column_x,
+            center_y=y_slot * 1,
+            normal_texture=button_normal,
+            hover_texture=hovered_texture,
+            press_texture=pressed_texture,
+            text='UIImageButton'
+        )
+        self.ui_manager.add_ui_element(button)
+
+        # right side elements
+        button = arcade.gui.UIFlatButton(
+            'FlatButton',
+            center_x=right_column_x,
+            center_y=y_slot * 1,
+            width=250,
+            # height=20
+        )
+        self.ui_manager.add_ui_element(button)
+
+        button = arcade.gui.UIGhostFlatButton(
+            'GhostFlatButton',
+            center_x=right_column_x,
+            center_y=y_slot * 2,
+            width=250,
+            # height=20
+        )
+        self.ui_manager.add_ui_element(button)
+
+
+if __name__ == '__main__':
+    window = arcade.Window(title='ARCADE_GUI')
+    view = MyView()
+    window.show_view(view)
+    arcade.run()

arcade/gui/examples/show_uiinputbox.py

@@ -32,5 +32,6 @@ def setup(self):
 
 if __name__ == '__main__':
     window = arcade.Window(title='ARCADE_GUI')
-    window.show_view(MyView(window))
+    view = MyView(window)
+    window.show_view(view)
     arcade.run()

doc/examples/gui_elements.rst

@@ -0,0 +1,19 @@
+:orphan:
+
+.. _gui_elements:
+
+GUI Elements
+============
+
+.. note::
+
+   This example requires Arcade 2.4a10 or higher.
+
+.. image:: gui_elements.png
+    :width: 600px
+    :align: center
+    :alt: GUI Elements
+
+.. literalinclude:: ../../arcade/examples/gui_elements.py
+    :caption: gui_elements.py
+    :linenos:

doc/examples/index.rst

@@ -446,25 +446,11 @@ Resizable Window and Fullscreen Games
 Buttons and Dialog Boxes
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. figure:: thumbs/gui_button.png
+.. figure:: thumbs/gui_elements.png
    :figwidth: 170px
 
-   :ref:`gui_button`
+   :ref:`gui_elements`
 
-.. figure:: thumbs/gui_dialogue_box.png
-   :figwidth: 170px
-
-   :ref:`gui_dialogue_box`
-
-.. figure:: thumbs/gui_text_box.png
-   :figwidth: 170px
-
-   :ref:`gui_text_box`
-
-.. figure:: thumbs/gui_text_button.png
-   :figwidth: 170px
-
-   :ref:`gui_text_button`
 
 Grid-Based Games
 ----------------