set_dimensions now support dynamic sizes

[LondonClass]

Fixes #498

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.62%. Comparing base (38291c9) to head (02c20ca).
Report is 14 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #514      +/-   ##
==========================================
- Coverage   95.71%   95.62%   -0.10%     
==========================================
  Files          84       84              
  Lines       11676    11788     +112     
==========================================
+ Hits        11176    11272      +96     
- Misses        500      516      +16     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[MyreMylar]

I have tested this with a small program and using button.set_dimensions(-1,-1) does not change the button permanently into a dynamically sized button, it just adjusts the button size dynamically once. I would expect calling the function like this to make it behave like creating a button with dynamic dimensions.

Test program to compare:

import pygame

from pygame import Rect
from pygame_gui import UIManager
from pygame_gui.elements import UIButton


pygame.init()

pygame.display.set_caption('Quick Start')
window_surface = pygame.display.set_mode((800, 600))
manager = UIManager((800, 600))

background = pygame.Surface((800, 600))
background.fill((50, 50, 50))


hello_button = UIButton(Rect(350, 280, 100, 30), 'Hello')  # button starts with static dimensions
hello_button_2 = UIButton(Rect(350, 180, -1, -1), 'Hello')  # button that starts with dynamic dimensions
clock = pygame.time.Clock()
is_running = True

while is_running:
    time_delta = clock.tick(60)/1000.0
    for event in pygame.event.get():
        if event.type == pygame.QUIT:
            is_running = False

        if event.type == pygame.KEYDOWN and event.key == pygame.K_d:
            hello_button.set_dimensions((-1, -1))  # press 'd' to convert to dynamic dimensions
        if event.type == pygame.KEYDOWN and event.key == pygame.K_s:
            hello_button.set_text("Long string of text")  # press 's' and 'a' to toggle text in the buttons
            hello_button_2.set_text("Long string of text")
        if event.type == pygame.KEYDOWN and event.key == pygame.K_a:
            hello_button.set_text("Hello")
            hello_button_2.set_text("Hello")

        manager.process_events(event)

    manager.update(time_delta)

    window_surface.blit(background, (0, 0))
    manager.draw_ui(window_surface)

    pygame.display.update()

[LondonClass]

@MyreMylar This may disrupt the previous code, causing the element to become dynamic unexpectedly. (For example, when an error occurs and a negative value is passed in)

[MyreMylar]

@MyreMylar This may disrupt the previous code, causing the element to become dynamic unexpectedly. (For example, when an error occurs and a negative value is passed in)

I think that is a risk that we have to take given the API of passing in -1 to indicate a dynamic dimension.

The alternative would be adding some keyword only parameters that override whatever is specified in the dimensions e.g:

element.set_dimensions((0,0), dynamic_width=True. dynamic_height=True)

[MyreMylar]

OK, LGTM 👍

Works how I would expect now.