Skip to content

Pre 3.0 GUI changes #1945

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 10, 2024
Merged

Pre 3.0 GUI changes #1945

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 4 additions & 8 deletions arcade/gui/widgets/layout.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,8 @@ class UIBoxLayout(UILayout):
Or use :py:meth:`arcade.gui.UIBoxLayout.fit_content` to resize the layout. The
bottom-left corner is used as the default anchor point.

Supports the options: ``size_hint``, ``size_hint_min``, ``size_hint_max``.
Supports the options: ``size_hint``, ``size_hint_min``, ``size_hint_max``. ``size_hint_min`` is automatically
updated based on the minimal required space by children.

If a child widget provides a ``size_hint`` for a dimension, the child will
be resized within the given range of ``size_hint_min`` and
Expand All @@ -208,7 +209,6 @@ class UIBoxLayout(UILayout):
:param size_hint: Size hint for the :py:class:`~arcade.gui.UILayout` if
the widget would like to grow. Defaults to ``0, 0`` ->
minimal size to contain children.
:param size_hint_min: Minimum width and height in pixels.
:param size_hint_max: Maximum width and height in pixels.
:param space_between: Space in pixels between the children.
"""
Expand All @@ -223,7 +223,6 @@ def __init__(
align="center",
children: Iterable[UIWidget] = tuple(),
size_hint=(0, 0),
size_hint_min=None,
size_hint_max=None,
space_between=0,
style=None,
Expand All @@ -236,7 +235,6 @@ def __init__(
height=height,
children=children,
size_hint=size_hint,
size_hint_min=size_hint_min,
size_hint_max=size_hint_max,
style=style,
**kwargs
Expand Down Expand Up @@ -472,7 +470,8 @@ class UIGridLayout(UILayout):
``size_hint_max``.

Children are resized based on ``size_hint``. Maximum and minimum
``size_hint``s only take effect if a ``size_hint`` is given.
``size_hint``s only take effect if a ``size_hint`` is given. ``size_hint_min`` is automatically
updated based on the minimal required space by children.

:param x: ``x`` coordinate of bottom left corner.
:param y: ``y`` coordinate of bottom left corner.
Expand All @@ -485,7 +484,6 @@ class UIGridLayout(UILayout):
added later.
:param size_hint: A size hint for :py:class:`~arcade.gui.UILayout`, if the
:py:class:`~arcade.gui.UIWidget` would like to grow.
:param size_hint_min: Minimum width and height in pixels.
:param size_hint_max: Maximum width and height in pixels.
:param horizontal_spacing: Space between columns.
:param vertical_spacing: Space between rows.
Expand All @@ -503,7 +501,6 @@ def __init__(
align_vertical="center",
children: Iterable[UIWidget] = tuple(),
size_hint=(0, 0),
size_hint_min=None,
size_hint_max=None,
horizontal_spacing: int = 0,
vertical_spacing: int = 0,
Expand All @@ -520,7 +517,6 @@ def __init__(
height=0,
children=children,
size_hint=size_hint,
size_hint_min=size_hint_min,
size_hint_max=size_hint_max,
style=style,
**kwargs
Expand Down
8 changes: 8 additions & 0 deletions doc/programming_guide/release_notes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,14 @@ API in a way that is not compatible with how it was used in 2.6.
* The GUI package has been changed significantly.
* Buffered shapes (shape list items) have been moved to their own sub-module.
* `use_spatial_hash` parameter for `SpriteList` and `TileMap` is now a `bool` instead of `Optional[bool]`
* GUI

* Removed :py:class:`~arcade.gui.widgets.UIWrapper` this is now general available in :py:class:`~arcade.gui.widgets.UILayout`
* Removed :py:class:`~arcade.gui.widgets.UIBorder` this is now general available in :py:class:`~arcade.gui.widgets.UIWidget`
* Removed :py:class:`~arcade.gui.widgets.UIPadding` this is now general available in :py:class:`~arcade.gui.widgets.UIWidget`
* Removed :py:class:`~arcade.gui.widgets.UITexturePane` this is now general available in :py:class:`~arcade.gui.widgets.UIWidget`
* Removed :py:class:`~arcade.gui.widgets.UIAnchorWidget` replaced by :py:class:`~arcade.gui.widgets.UIAnchorLayout`


Featured Updates
~~~~~~~~~~~~~~~~
Expand Down