DynamicButton

class pygamepopup.components.DynamicButton(*args, **kwargs)

This class is representing a special button with an inner value changing after each click.

A DynamicButton has a sequence of values given at initialization, and a initial value.

The sequence will be iterated to determine the next inner value after a click.

This fluctuating value is the one that will be sent has the first argument of the method called on click, and a different label will be displayed on the button for each different value of the sequence.

Keyword Arguments:

  • callback (Callable) – the reference to the function that should be call after a click.

  • values (Sequence[any]) – the sequence of values that will be iterated to determine the next inner value.

  • current_value_index (int) – the index of the initial value of the button.

  • base_title (str) – the common prefix of all the different labels (it could be the name of the dynamic button in a way).

  • size (str) – the size of the button following the format “(width, height)”, defaults to BUTTON_SIZE.

  • position (Position) – the position of the element on the screen.

  • background_path (str) – the path to the image corresponding to the sprite of the element.

  • background_hover_path (str) – the path to the image corresponding to the sprite of the element when it has the focus.

  • no_background (bool) – specify whether a background should be present or not, defaults to False.

  • margin (Margin) – a tuple containing the margins of the box, should be in the form “(top_margin, right_margin, bottom_margin, left_margin)”, defaults to (0, 0, 0, 0).

  • disabled (bool) – a boolean indicating if it is not possible to interact with the button, defaults to False.

  • column_span (int) – the number of columns the element should span, defaults to 1.

values

the sequence of values that will be iterated to determine the next inner value.

Type:

Sequence[any]

current_value_index

the index of the current value of the button.

Type:

int

base_title

the common prefix of all the different labels (it could be the name of the dynamic button in a way).

Type:

str

action_triggered()

Method that should be called after a click.

Change the current value of the button to the next one in the sequence of values. If the end of the sequence is reach, the iteration restarts at the first value.

Returns:

a lambda containing the function that should be called with the current value of the dynamic button as an argument.

Return type:

Callable