Widget¶
Widget abstract class.
Parameters: - title (str) – Widget title
- widget_id (str) – Widget identifier
- onchange (callable, None) – Callback when updating the status of the widget, executed in
widget.change()
- onreturn (callable, None) – Callback when applying on the widget (return), executed in
widget.apply()
- args (any) – Optional arguments for callbacks
- kwargs (dict, any) – Optional keyword arguments
Adds a function to the widget to be executed each time the widget is drawn.
The function that this method receives receives two objects: the widget itself and the menu reference.
import math def draw_update_function(widget, menu): t = widget.get_attribute('t', 0) t += menu.get_clock().get_time() widget.set_padding(10*(1 + math.sin(t)))) # Oscillating padding button = menu.add_button('This button updates its padding', None) button.set_draw_callback(draw_update_function)
After creating a new callback, this functions returns the ID of the call. It can be removed anytime using
widget.remove_draw_callback(id)
.Parameters: draw_callback (callable) – Function Returns: Callback ID Return type: str
Adds a function to the widget to be executed each time the widget is updated.
The function that this method receives receives two objects: the widget itself and the menu reference. It is similar to
add_draw_callback
.After creating a new callback, this functions returns the ID of the call. It can be removed anytime using
widget.remove_update_callback(id)
.Note
Not all widgets are updated, so the provided function may never be executed.
Parameters: update_callback (callable) – Function Returns: Callback ID Return type: str
Run
on_return
callback when return event. A callback function receives the following arguments:callback_func(value, *args, *widget._args, **widget._kwargs)
- with:
value
(if something is returned byget_value()
)args
given to this methodargs
of the widgetkwargs
of the widget
Parameters: - args – Extra arguments passed to the callback
- args – any
Returns: None
Apply callbacks on widget draw.
Returns: None
Apply callbacks on widget update.
Returns: None
Run
on_change
callback after change event is triggered. A callback function receives the following arguments:callback_func(value, *args, *widget._args, **widget._kwargs)
- with:
value
(if something is returned byget_value()
)args
given to this methodargs
of the widgetkwargs
of the widget
Parameters: - args – Extra arguments passed to the callback
- args – any
Returns: None
Change widget id.
Parameters: widget_id (str) – Widget ID Returns: None
Draw the widget shape.
Parameters: surface ( pygame.Surface
) – Surface to drawReturns: None
Draw selection effect on widget.
Parameters: surface ( pygame.Surface
) – Surface to drawReturns: None
Expand background inflate to match the selection effect (the widget don’t require to be selected).
This is a permanent change; for dynamic purpuoses, depending if the widget is selected or not, setting
widget.selection_expand_background
toTrue
may help.Note
This method may have unexpected results with certain selection effects.
Returns: None
This method can flip the widget either vertically, horizontally, or both. Flipping a widget is non-destructive and does not change the dimensions.
Parameters: Returns: None
Return the widget alignment.
Returns: Widget align, see locals Return type: str
Get attribute value.
Parameters: - key (str) – Key of the attribute
- default (any) – Value if does not exists
Returns: Attribute data
Return type: any
Return a dict with the information of the widget font.
Dict values:
antialias
Font antialias (bool)background_color
Background color (tuple)color
Font color (tuple)name
Name of the font (str)selected_color
Selected color (tuple)size
Size of the font (int)
Returns: Dict Return type: dict
Return the widget height.
Warning
If the widget is not rendered, this method will return
0
.Parameters: Returns: Widget height (px)
Return type:
Return the widget ID.
Returns: Widget ID Return type: str
Return the widget margin.
Returns: Widget margin (left,bottom) Return type: tuple
Return the menu reference (if exists).
Warning
Use with caution.
Returns: Menu reference Return type: pygame_menu.Menu
, None
Return the widget padding.
Returns: Widget padding (top,right,bottom,left) Return type: tuple
Return the widget position tuple (x, y).
Returns: Widget position Return type: tuple
Return the Rect object, this forces the widget rendering.
Note
This is the only method that returns the rect with the padding applied. If widget._rect is used, the padding has not been applied.
Parameters: Returns: Widget rect
Return type:
Return time the widget has been selected in miliseconds. If the widget is not currently selected, return 0.
Returns: Time in ms Return type: float
Return the selection effect.
Warning
Use with caution.
Returns: Selection effect Return type: pygame_menu.widgets.core.Selection
Return the widget size.
Warning
If the widget is not rendered this method might return
(0,0)
.Parameters: Returns: Widget (width, height)
Return type:
Return widget surface.
Warning
Use with caution.
Returns: Widget surface Return type: pygame.Surface
Return the widget title.
Returns: Widget title Return type: str
Return the value. If exception
ValueError
is raised, no value will be passed to the callbacks.Returns: Widget data value Return type: Object
Return the widget width.
Warning
If the widget is not rendered, this method will return
0
.Parameters: Returns: Widget width (px)
Return type:
Returns true if widget has the given attribute.
Parameters: key (str) – Key of the attribute Returns: True if exists Return type: bool
Hides widget.
Returns: None
Removes the given attribute from the widget. Throws
IndexError
if given key does not exist.Parameters: key (str) – Key of the attribute Returns: None
Removes draw callback from ID.
Parameters: callback_id (str) – Callback ID Returns: None
Removes update callback from ID.
Parameters: callback_id (str) – Callback ID Returns: None
Set the widget size to another size.
Note
This method calls
widget.scale
method; thus, some widgets may not support this transformation.Parameters: Returns: None
Unfiltered counterclockwise rotation. The angle argument represents degrees and can be any floating point value. Negative angle amounts will rotate clockwise.
Note
Not all widgets accepts rotation. Also this rotation only affects the text or images, the selection or background is not rotated.
Parameters: angle (int, float) – Rotation angle (degrees 0-360) Returns: None
Scale the widget to a desired width and height factor.
Note
Not all widgets are affected by scale.
Parameters: Returns: None
Set the alignment of the widget.
Parameters: align (str) – Widget align, see locals Returns: None
Set widget attribute.
Parameters: - key (str) – Key of the attribute
- value (any) – Value of the attribute
Returns: None
Set widget background color.
Parameters: - color (tuple, list,
pygame_menu.baseimage.BaseImage
, None) – Widget background color - inflate (tuple, list, None) – Inflate background in (x,y). If None, the widget value is not updated
Returns: None
- color (tuple, list,
Enable interfaces to control the widget.
Parameters: Returns: None
Set the text font.
Parameters: - font (str) – Font name (see
pygame.font.match_font
for precise format) - font_size (int) – Size of font in pixels
- color (tuple) – Text color
- selected_color (tuple) – Text color when widget is selected
- background_color (tuple, None) – Font background color
- antialias (bool) – Determines if antialias is applied to font (uses more processing power)
Returns: None
- font (str) – Font name (see
Set Widget margin (left, bottom).
Parameters: Returns: None
Set widget max width (column support) if
force_fit_text
is enabled.Parameters: width (int, float, None) – Width in px, None if max width is disabled Returns: None
Set the menu reference.
Parameters: menu ( pygame_menu.Menu
, None) – Menu objectReturns: None
Set the Widget padding according to CSS rules.
- If an integer or float is provided: top, right, bottom and left values will be the same
- If 2-item tuple is provided: top and bottom takes the first value, left and right the second
- If 3-item tuple is provided: top will take the first value, left and right the second, and bottom the third
- If 4-item tuple is provided: padding will be (top, right, bottom, left)
Note
See CSS W3Schools for more info about padding.
Parameters: padding (int, float, tuple, list) – Can be a single number, or a tuple of 2, 3 or 4 elements following CSS style Returns: None
Set the widget position.
Parameters: Returns: None
Mark the widget as selected.
Parameters: selected (bool) – Set item as selected Returns: None
Set the selection effect handler.
Parameters: selection ( pygame_menu.widgets.core.Selection
) – Selection effect classReturns: None
Show text shadow.
Parameters: Returns: None
Set sound engine to the widget.
Parameters: sound ( pygame_menu.sound.Sound
) – Sound objectReturns: None
Update the widget title.
Parameters: title (str) – New title Returns: None
Set the widget value.
Warning
This method does not fire the callbacks as it is called programmatically. This behavior is deliberately chosen to avoid infinite loops.
Parameters: value (Object) – Value to be set on the widget Returns: None
Set widget visible.
Returns: None
Checks if the widget width/height has changed because events. If so, return true and set the status of the widget (menu widget position needs update) as false. This method is used by
Menu.update()
.Returns: True if the widget position has changed by events after the rendering. Return type: bool
Translate to (+x,+y) according to default position.
Note
To revert changes, only set to (0,0).
Parameters: Returns: None
Update internal variable according to the given events list and fire the callbacks.
Parameters: events (list[ pygame.event.Event
], tuple[pygame.event.Event
]) – List/Tuple of pygame eventsReturns: True if updated Return type: bool
Updates font. This method receives a style dict (non empty) containing the following keys:
antialias
Font antialias (bool)background_color
Background color (tuple)color
Font color (tuple)name
Name of the font (str)selected_color
Selected color (tuple)size
Size of the font (int)
Note
If a key is not defined it will be rewritten using current font style from
Widget.get_font_info()
method.Parameters: style (dict) – Font style dict Returns: None