SurfaceWidget
Bases:
Widget
Surface widget. Implements a widget from an external surface.
Note
SurfaceWidget only accepts translation transformation.
- Parameters:
Adds a function to the Widget to be executed each time the widget is drawn.
The function that this method 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
pygame_menu.widgets.core.widget.Widget.remove_draw_callback()
.Note
If Menu surface cache is enabled this method may run only once. To force running the added method each time call
widget.force_menu_surface_update()
to force Menu update the cache status if the drawing callback does not make the Widget to render. Remember that rendering the Widget forces the Menu to update its surface, thus updating the cache too.
Adds the Widget object to kwargs, it helps to get the Widget reference for callbacks. It raises
KeyError
if key is duplicated.
Adds a function to the Widget to be executed each time the Widget is updated.
The function that this method receives three objects: the events list, the Widget itself and the Menu reference. It is similar to
pygame_menu.widgets.core.widget.Widget.add_draw_callback()
.After creating a new callback, this functions returns the ID of the call. It can be removed anytime using
pygame_menu.widgets.core.widget.Widget.remove_update_callback()
.Note
Not all widgets are updated, so the provided function may never be executed in some widgets (for example, label or images).
Apply callbacks on Widget draw.
- Return type:
- Returns:
Self reference
Apply callbacks on Widget update.
Note
Readonly widgets or hidden widgets do not apply update callbacks.
Expand the Widget background inflate to match the selection effect (the Widget don’t require to be selected).
This is a permanent change; for dynamic purposes, depending on 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.
- Return type:
- Returns:
Self reference
Draw the Widget on a given surface.
Note
Widget drawing order:
Background color
prev
decoratorWidget selection effect (if prev)
Widget surface
Widget selection effect (if post)
Widget border
post
decorator
- Parameters:
surface (
Surface
) – Surface to draw- Return type:
- Returns:
Self reference
Forces menu surface cache to update after next drawing call. This also updates widget decoration.
Note
This method only updates the surface cache, without forcing re-rendering of all Menu widgets as
pygame_menu.widgets.core.widget.Widget.force_menu_surface_update()
does.- Return type:
- Returns:
Self reference
Forces menu surface update after next rendering call. This method automatically updates widget decoration cache as Menu render forces it to re-render.
This method also should be called by each widget after render.
Note
This method is expensive, as menu surface update forces re-rendering of all widgets (because them can change in size, position, etc…).
- Return type:
- Returns:
Self reference
Return the Widget alignment.
- Return type:
- Returns:
Widget align
Get an attribute value.
Return the widget border properties.
Return the Class+ID as a string.
- Return type:
- Returns:
Class+ID format
Get the Widget column/row position.
Return the widget controller. Each widget has their own controller object.
- Return type:
- Returns:
Controller object
Get counter attribute.
Return the Widget decorator API.
- Return type:
- Returns:
Decorator API
Return rect to be used in Widget focus.
- Return type:
Rect
- Returns:
Focus rect
Get container frame of Widget. If Widget is not within a Frame, the method returns
None
.- Returns:
Frame object
- Return type:
Get frame depth (If frame is packed within another frame).
- Return type:
- Returns:
Frame depth
Return the Widget height.
Warning
If the widget is not rendered, this method will return
0
.
Return the object ID.
- Return type:
- Returns:
Object ID
Return the Menu reference,
None
if it has not been set.
Return the Widget padding.
Return the widget position tuple on x-axis and y-axis (x, y) in px.
- Parameters:
apply_padding (
bool
) – Apply widget padding to positionuse_transformed_padding (
bool
) – Use scaled padding if the widget is scaledto_real_position (
bool
) – Get the real position within window (not the surface container)to_absolute_position (
bool
) – Get the absolute position within surface container, considering also the parent scrollarea positioningreal_position_visible (
bool
) – Return only the visible width/height ifto_real_position=True
- Return type:
- Returns:
Widget position
Return the
pygame.Rect
object of the Widget. This method forces rendering.- Parameters:
inflate (
Optional
[Tuple
[int
,int
]]) – Inflate rect on x-axis and y-axis (x, y) in pxapply_padding (
bool
) – Apply widget paddinguse_transformed_padding (
bool
) – Use scaled padding if the widget is scaledto_real_position (
bool
) – Transform the widget rect to real coordinates (if the Widget change the position if scrollbars move offsets) within the window. Used by eventsto_absolute_position (
bool
) – Transform the widget rect to absolute coordinates (if the Widget does not change the position if scrollbars move offsets). Used by eventsrender (
bool
) – Force widget renderingreal_position_visible (
bool
) – Return only the visible width/height ifto_real_position=True
- Return type:
Rect
- Returns:
Widget rect object
Return the scrollarea object.
- Return type:
- Returns:
ScrollArea object
Return time the Widget has been selected in milliseconds. If the Widget is not currently selected, return
0
.
Return the selection effect.
Note
If no selection has been provided,
_WidgetNullSelection
class will be returned.Note
For drawing, use
pygame_menu.widgets.core.widget.Widget.draw_selection_effect()
.Warning
Use with caution.
- Return type:
- Returns:
Selection effect
Return the Widget size.
Warning
If the widget is not rendered this method might return
(0, 0)
.
Return the Widget surface.
Warning
Use with caution.
- Return type:
Surface
- Returns:
Widget surface object
Get Widget translation on x-axis and y-axis (x, y) in px.
Return the Widget width.
Warning
If the Widget is not rendered, this method will return
0
.
Return
True
if the object has the given attribute.
Hides the Widget.
- Return type:
- Returns:
Self reference
Return
True
if the Widget is floating.- Return type:
- Returns:
Float status
Return
True
if the Widget is selected.- Return type:
- Returns:
Selected status
Return
True
if the Widget is visible.
Run the
onmouseleave
callback if the mouse is placed outside the Widget. The callback receive the Widget object reference and the mouse event:onmouseleave(widget, event) <or> onmouseleave()
Warning
This method does not evaluate if the mouse is placed over the Widget. Only executes the callback and updates the cursor if enabled.
Run the
onmouseover
if the mouse is placed over the Widget. The callback receive the Widget object reference and the mouse event:onmouseover(widget, event) <or> onmouseover()
Warning
This method does not evaluate if the mouse is placed over the Widget. Only executes the callback and updates the cursor if enabled.
Function executed if the Widget is removed from the Menu.
- Return type:
- Returns:
Self reference
Removes the given attribute from the object. Throws
IndexError
if the given key does not exist.- Parameters:
key (
str
) – Key of the attribute- Return type:
Base
- Returns:
Self reference
Removes draw callback from ID.
Removes update callback from ID.
Public rendering method.
Note
Unlike private
_render
method, public method forces widget rendering (callingpygame_menu.widgets.core.widget.Widget._force_render()
). Use this method only if the widget has changed the state. Running this function many times may affect the performance.Note
Before rendering, check out if the widget font/title/values are set. If not, it is probable that a zero-size surface is set.
The container ScrollArea scrolls to the Widget.
Mark the Widget as selected and execute the
onselect
callback function as follows:onselect(selected, widget, menu) <or> onselect()
If Widget
is_selectable
isFalse
this function is not executed.Note
Use
pygame_menu.widgets.core.widget.Widget.render()
method to force Widget rendering after calling this method.Warning
This method should only be used by the menu.
Set the alignment of the Widget.
Note
Alignment is only applied when updating the widget position, done by Menu when rendering the surface. Thus, the alignment change is not immediate.
Note
Use
pygame_menu.widgets.core.widget.Widget.render()
method to force widget rendering after calling this method.Note
See
pygame_menu.locals
for validalign
values.
Set an attribute.
Set the Widget background color.
- Parameters:
- Return type:
- Returns:
Self reference
Set the Widget border.
Note
Inflate is added to the background inflate in drawing time.
- Parameters:
width (
int
) – Border width in pxcolor (
Union
[Tuple
[int
,int
,int
],Tuple
[int
,int
,int
,int
],str
,int
,Color
,None
]) – Border colorinflate (
Tuple
[int
,int
]) – Inflate on x-axis and y-axis (x, y) in pxposition (
Union
[str
,List
[str
],Tuple
[str
,...
]]) – Border position. Valid only: north, south, east, and west. Seepygame_menu.locals
- Return type:
- Returns:
Self reference
Set the (column, row, index) position. If the column or row is
-1
then the widget is not assigned to a certain column/row (for example, if it’s hidden).
Set a new controller object.
- Parameters:
controller (
Controller
) – Controller- Return type:
- Returns:
Self reference
Set the Widget cursor if user places the mouse over the Widget.
Set the floating status. If
True
the Widget don’t contribute its width/height to the Menu widget positioning computation (for example, the surface area or the column/row layout), and don’t add one unit to the rows (use the same vertical place as the previous widget).For example, before floating:
---------------------------- | wid1 | wid3 | | wid2 | wid4 | ----------------------------
After
wid3.set_float(True)
:---------------------------- | wid1 | wid4 | | wid2,wid3 | | ----------------------------
If the Widget is within a Frame, it does not contribute to the width/height of the layout. Also, it is being set to the (0, 0) position, thus, the only way to move the Widget to a desired position is by translating it.
- Parameters:
- Return type:
Set Widget frame.
Set the Widget margin (left, bottom).
Set the Widget menu reference.
Set
onmouseleave
callback. This method is executed inpygame_menu.widgets.core.widget.Widget.mouseleave()
method. The callback function receives the following arguments:onmouseleave(widget, event) <or> onmouseleave()
Set
onmouseover
callback. This method is executed inpygame_menu.widgets.core.widget.Widget.mouseover()
method. The callback function receives the following arguments:onmouseover(widget, event) <or> onmouseover()
Set
onselect
callback. This method is executed inpygame_menu.widgets.core.widget.Widget.select()
method. The callback function receives the following arguments:onselect(selected, widget, menu) <or> onselect()
Set the Widget position relative to the Menu/Frame.
This method is executed by the Menu when updating the widget positioning. For moving the widget use
translate
method instead, as this position will be rewritten on next menu rendering phase.Note
Use
pygame_menu.widgets.core.widget.Widget.render()
method to force Widget rendering after calling this method.
Set scrollarea reference. Mostly used for events.
- Parameters:
scrollarea (
Optional
[ScrollArea
]) – Scrollarea object- Return type:
Set the selection effect handler.
Note
If
selection=None
the selection effect will be established to_WidgetNullSelection
class.
Update the widget surface.
- Parameters:
surface (
Surface
) – New surface- Return type:
- Returns:
Self reference
Configure the widget shadow.
- Parameters:
shadow_type (
str
) – Shadow type, it can be rectangular or ellipseshadow_width (
int
) – Shadow width in px. If0
the shadow is disabledcorner_radius (
int
) – Shadow corner radius if rectangular in pxcolor (
Union
[Tuple
[int
,int
,int
],Tuple
[int
,int
,int
,int
],str
,int
,Color
]) – Shadow coloraa_amount (
int
) – Antialiasing amout
- Return type:
- Returns:
Self reference
Set the Widget visible.
- Return type:
- Returns:
Self reference
Transformation: Translate to (+x, +y) according to the default position.
Note
Translate is only applied when updating the widget position (calling
pygame_menu.widgets.core.widget.Widget.set_position()
). This is done by Menu when rendering the surface. Thus, the position change is not immediate. To force translation update you may call Menu render method.Note
To revert changes, only set to
(0, 0)
.Note
Use
pygame_menu.widgets.core.widget.Widget.render()
method to force widget rendering after calling this method.
Update according to the given events list and fire the callbacks. This method must return
True
if it updated (the internal variables changed during user input).Note
Update is not performed if the Widget is in
readonly
state, or it’s hidden. However,apply_update_callbacks
method is called in most widgets, exceptpygame_menu.widgets.NoneWidget
.