Button Documentation

Button class

class pygameyagui.Button(toolbox, label)

This class creates a Button widget.

Parameters:
  • toolbox (pygameyagui.Toolbox) – The toolbox that will host the widget.

  • label (str) – The text to be shown in the Button widget.

Inheritance

Button class inherits from Widget class.

Button methods

Nothing to see here

Button class has no methods.

Button properties

property Button.clicked

Get or set the the state of a Button (bool).

Default value is False and it is toggled to True if there is a pygame.MOUSEBUTTONUP event during the button being clicked.

Note: This property is always set back to False every iteration of the event loop.

Button constants

constants.BUTTON_MIN_SIZE_FACTOR = 1
constants.BUTTON_MAX_SIZE_FACTOR = 1
constants.BUTTON_DEFAULT_SIZE_FACTOR = 1