ScrollBar
Bases:
Widget
A scroll bar include 3 separate controls: a slider, scroll arrows, and a page control:
The slider provides a way to quickly go to any part of the document.
The scroll arrows are push buttons which can be used to accurately navigate to a particular place in a document.
The page control is the area over which the slider is dragged (the scroll bar’s background). Clicking here moves the scroll bar towards the click by one page.
Note
ScrollBar only accepts translation transformation.
- Parameters
values_range (
Union
[Tuple
[int
,...
],List
[int
]]) – Min and max valuesscrollbar_id (
str
) – Bar identifierorientation (
str
) – Bar orientation (horizontal or vertical). Seepygame_menu.locals
slider_pad (
Union
[int
,float
]) – Space between slider and page control (px)slider_color (
Union
[Tuple
[int
,int
,int
],Tuple
[int
,int
,int
,int
],str
,int
,Color
]) – Color of the sliderpage_ctrl_thick (
int
) – Page control thicknesspage_ctrl_color (
Union
[Tuple
[int
,int
,int
],Tuple
[int
,int
,int
,int
],str
,int
,Color
]) – Page control coloronchange (
Optional
[Callable
]) – Callback when pressing and moving the scroll
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.
Run
onchange
callback after change event is triggered. The callback function receives the following arguments:onchange(value, *args, *widget._args, **widget._kwargs)
- Where
value
if something is returned bypygame_menu.widgets.core.widget.Widget.get_value()
args
given to this methodargs
of the widgetkwargs
of the widget
Note
Not all widgets have an
onchange
method.- Parameters
args – Extra arguments passed to the callback
- Return type
- Returns
Callback return value
Disables visibility force. That is, .show() and .hide() will change the visibility status without the need for ´´force´´ param.
- Return type
- Returns
Self
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
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 aclled 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
- Returns
Focus rect
Return a dict with the information of the Widget font.
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 greatest acceptable value.
- Return type
- Returns
Greatest acceptable value
Return the Menu reference,
None
if it has not been set.
Return the smallest acceptable value.
- Return type
- Returns
Smallest acceptable value
Return the scrollbar orientation (pygame-menu locals).
- Return type
- Returns
Scrollbar orientation
Return the Widget padding.
Return amount that the value changes by when the user click on the page control surface.
- Return type
- Returns
Page step
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). 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
- Returns
Widget rect object
Return the scrollarea object.
- Return type
- Returns
ScrollArea object
Return the Widget size.
Warning
If the widget is not rendered this method might return
(0, 0)
.
Get slider rect.
- Return type
- Returns
Slider rect
Return the Widget sound engine.
- Return type
- Returns
Sound API
Return the Widget surface.
Warning
Use with caution.
- Return type
- Returns
Widget surface object
Return the thickness of the bar.
- Return type
- Returns
Thickness in px
Return the Widget title.
Note
Not all widgets implements this method, for example, images don’t accept a title, and such widget would return an empty string if this method is called.
- Return type
- Returns
Widget title
Get Widget translation on x-axis and y-axis (x, y) in px.
Return the value according to the slider position.
- Return type
- Returns
Position in px
Return the value but in percentage between
0
(minimum value) and1
(maximum value).- Return type
- Returns
Value as percentage
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.
Hide the scrollbars. If
force
param is provided the scrollbars will be hidden if them were shown with ´´force´´ method.
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.
Reset the Widget value to the default one.
- Return type
- Returns
Self reference
The container ScrollArea scrolls to the Widget.
- Parameters
margin – Extra margin around the rect in px on x-axis and y-axis
scroll_parent – If
True
parent scroll also scrolls to widget
- Return type
- Returns
Self reference
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
Enable interfaces to control the Widget.
Set the Widget cursor if user places the mouse over the Widget.
Set the Widget value, and then make it as default.
Note
This method is intended to be used along
pygame_menu.widgets.core.widget.Widget.reset_value()
method that sets the Widget value back to the default set with this method.Note
Not all widgets accepts a value, for example the image 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 the length of the page control area.
Set the Widget margin (left, bottom).
Set the greatest acceptable value.
Set the Widget menu reference.
Set the smallest acceptable value.
Set
onchange
callback. This method is executed inpygame_menu.widgets.core.widget.Widget.change()
method. The callback function receives the following arguments:onchange(value, *args, *widget._args, **widget._kwargs)
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 the scroll bar orientation to vertical or horizontal.
Note
See
pygame_menu.locals
for validorientation
values.
Set the amount that the value changes by when the user click on the page control surface.
Note
The length of the slider is related to this value, and typically represents the proportion of the document area shown in a scrolling view.
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 scrollbars shadow.
Note
See
pygame_menu.locals
for validposition
values.
Set sound engine to the Widget.
Set widget tab size.
Set the position of the scrollbar.
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
Show the scrollbars. If
force
param is provided the scrollbars will be shown if them were hidden with ´´force´´ method.
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
.
Return
True
if the Widget’s value changed from the default value.- Return type
- Returns
True
if changed