gui_flat_button.rst

Flat Text Buttons

For an introduction the GUI system, see :ref:`gui_concepts`.

The :class:`arcade.gui.UIFlatButton` is a simple button with a text label. It doesn't have any three-dimensional look to it.

There are three ways to process button click events:

1. Create a class with a parent class of arcade.UIFlatButton and implement a method called on_click.
2. Create a button, then set the on_click attribute of that button to equal the function you want to be called.
3. Create a button. Then use a decorator to specify a method to call when an on_click event occurs for that button.

This code shows each of the three ways above. Code should pick ONE of the three ways and standardize on it though-out the program. Do NOT write code that uses all three ways.

.. literalinclude:: ../../arcade/examples/gui_flat_button.py
    :caption: gui_flat_button.py
    :linenos:

See :class:`arcade.gui.UIBoxLayout` and :class:`arcade.gui.UIAnchorLayout` for more information about positioning the buttons. For example, this change to line 31:

self.v_box = arcade.gui.widgets.layout.UIBoxLayout(space_between=20, vertical=False);

and to line 60:

ui_anchor_layout.add(child=self.v_box,
                     anchor_x="left",
                     anchor_y="bottom",
                     align_x=10,
                     align_y=10);

in the code above will align the buttons horizontally and anchor them to the bottom left of the window with 10px margins.