Source code for pygame_menu.widgets.widget.menubar
# coding=utf-8
"""
pygame-menu
https://github.com/ppizarror/pygame-menu
MENUBAR
MenuBar class to display menu title.
License:
-------------------------------------------------------------------------------
The MIT License (MIT)
Copyright 2017-2021 Pablo Pizarro R. @ppizarror
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the Software
is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-------------------------------------------------------------------------------
"""
# File constants no. 1000
import pygame
import pygame.gfxdraw as gfxdraw
import pygame_menu.controls as _controls
from pygame_menu.widgets.core import Widget
from pygame_menu.utils import assert_color, to_string
MENUBAR_STYLE_ADAPTIVE = 1000
MENUBAR_STYLE_SIMPLE = 1001
MENUBAR_STYLE_TITLE_ONLY = 1002
MENUBAR_STYLE_TITLE_ONLY_DIAGONAL = 1003
MENUBAR_STYLE_NONE = 1004
MENUBAR_STYLE_UNDERLINE = 1005
MENUBAR_STYLE_UNDERLINE_TITLE = 1006
_MODE_CLOSE = 1020
_MODE_BACK = 1021
[docs]class MenuBar(Widget):
"""
MenuBar widget.
.. note:: This widget does not accept scale/resize transformation.
:param title: Title of the menubar
:type title: str
:param width: Width of the widget, generally width of the Menu
:type width: int, float
:param background_color: Background color
:type background_color: tuple, list
:param back_box: Draw a back-box button on header
:type back_box: bool
:param mode: Mode of drawing the bar
:type mode: int
:param offsetx: Offset x-position of title (px)
:type offsetx: int, float
:param offsety: Offset y-position of title (px)
:type offsety: int, float
:param onreturn: Callback when pressing the back-box button
:type onreturn: callable, None
:param args: Optional arguments for callbacks
:type args: any
:param kwargs: Optional keyword arguments for callbacks
:type kwargs: dict
"""
def __init__(self,
title,
width,
background_color,
back_box=False,
mode=MENUBAR_STYLE_ADAPTIVE,
offsetx=0.0,
offsety=0.0,
onreturn=None,
*args,
**kwargs
):
assert isinstance(width, (int, float))
assert isinstance(back_box, bool)
assert_color(background_color)
# MenuBar has no ID
super(MenuBar, self).__init__(
title=title,
onreturn=onreturn,
args=args,
kwargs=kwargs
)
self._backbox = back_box
self._backbox_border_width = 1 # px
self._backbox_pos = None # type: (tuple,None)
self._backbox_rect = None # type: (pygame.rect.Rect,None)
self._background_color = background_color
self._box_mode = 0
self._offsetx = 0.0
self._offsety = 0.0
self._polygon_pos = None # type: (tuple,None)
self._style = mode
self._title = ''
self._width = width
self.set_title(title, offsetx, offsety)
def _apply_font(self):
pass
[docs] def set_backbox_border_width(self, width):
"""
Set backbox border width in px.
:param width: Width in px
:type width: int
:return: None
"""
assert isinstance(width, int)
assert width > 0
self._backbox_border_width = width
# noinspection PyMissingOrEmptyDocstring
[docs] def draw(self, surface):
self._render()
if len(self._polygon_pos) > 2:
gfxdraw.filled_polygon(surface, self._polygon_pos, self._background_color)
# Draw backbox if enabled
if self.mouse_enabled and self._backbox:
# The following check belongs to the case if the menu displays a "x" button to close
# the menu, but onclose Menu method is None (Nothing is executed), then the button will
# not be displayed
# noinspection PyProtectedMember
if self._box_mode == _MODE_CLOSE and self.get_menu()._onclose is None:
pass
else:
# noinspection PyArgumentList
pygame.draw.rect(surface, self._font_selected_color, self._backbox_rect, self._backbox_border_width)
pygame.draw.polygon(surface, self._font_selected_color, self._backbox_pos)
surface.blit(self._surface,
(self._rect.topleft[0] + self._offsetx,
self._rect.topleft[1] + self._offsety))
def _render(self):
# noinspection PyProtectedMember
menu_prev_condition = not self._menu or not self._menu._top or not self._menu._top._prev
if not self._render_hash_changed(self._menu.get_id(), self._rect.x, self._rect.y, self._title,
self._font_selected_color, menu_prev_condition, self.visible):
return True
# Update box mode
if menu_prev_condition:
self._box_mode = _MODE_CLOSE
else:
self._box_mode = _MODE_BACK
self._surface = self._render_string(self._title, self._font_selected_color)
self._rect.width, self._rect.height = self._surface.get_size()
self._apply_surface_transforms() # Rotation does not affect rect size
if self._style == MENUBAR_STYLE_ADAPTIVE:
"""
A-------------------B D-E: 25 dx
|**** x | *0,6 height
| D------------C
F----E/
"""
a = self._rect.x, self._rect.y
b = self._rect.x + self._width - 1, self._rect.y
c = self._rect.x + self._width - 1, self._rect.y + self._rect.height * 0.6
d = self._rect.x + self._rect.width + 25 + self._offsetx, self._rect.y + self._rect.height * 0.6
e = self._rect.x + self._rect.width + 5 + self._offsetx, \
self._rect.y + self._rect.height
f = self._rect.x, self._rect.y + self._rect.height
self._polygon_pos = a, b, c, d, e, f
cross_size = self._rect.height * 0.6
elif self._style == MENUBAR_STYLE_SIMPLE:
"""
A-------------------B
|**** x | *1,0 height
D-------------------C
"""
a = self._rect.x, self._rect.y
b = self._rect.x + self._width - 1, self._rect.y
c = self._rect.x + self._width - 1, self._rect.y + self._rect.height
d = self._rect.x, self._rect.y + self._rect.height
self._polygon_pos = a, b, c, d
cross_size = self._rect.height
elif self._style == MENUBAR_STYLE_TITLE_ONLY:
"""
A-----B
| *** | x *0,6 height
D-----C
"""
a = self._rect.x, self._rect.y
b = self._rect.x + self._rect.width + 5 + self._offsetx, self._rect.y
c = self._rect.x + self._rect.width + 5 + self._offsetx, \
self._rect.y + self._rect.height
d = self._rect.x, self._rect.y + self._rect.height
self._polygon_pos = a, b, c, d
cross_size = self._rect.height * 0.6
elif self._style == MENUBAR_STYLE_TITLE_ONLY_DIAGONAL:
"""
A--------B
| **** / x *0,6 height
D-----C
"""
a = self._rect.x, self._rect.y
b = self._rect.x + self._rect.width + 25 + self._offsetx, self._rect.y
c = self._rect.x + self._rect.width + 5 + self._offsetx, \
self._rect.y + self._rect.height
d = self._rect.x, self._rect.y + self._rect.height
self._polygon_pos = a, b, c, d
cross_size = self._rect.height * 0.6
elif self._style == MENUBAR_STYLE_NONE:
"""
A------------------B
**** x *0,6 height
"""
a = self._rect.x, self._rect.y
b = self._rect.x + self._width - 1, self._rect.y
self._polygon_pos = a, b
cross_size = self._rect.height * 0.6
elif self._style == MENUBAR_STYLE_UNDERLINE:
"""
**** x
A-------------------B *0,20 height
D-------------------C
"""
dy = 3
a = self._rect.x, self._rect.y + 0.9 * self._rect.height + dy
b = self._rect.x + self._width - 1, self._rect.y + 0.9 * self._rect.height + dy
c = self._rect.x + self._width - 1, self._rect.y + self._rect.height + dy
d = self._rect.x, self._rect.y + self._rect.height + dy
self._polygon_pos = a, b, c, d
cross_size = 0.6 * self._rect.height
elif self._style == MENUBAR_STYLE_UNDERLINE_TITLE:
"""
**** x
A----B *0,20 height
D----C
"""
dy = 3
a = self._rect.x, self._rect.y + 0.9 * self._rect.height + dy
b = self._rect.x + self._rect.width + 5 + self._offsetx, self._rect.y + 0.9 * self._rect.height + dy
c = self._rect.x + self._rect.width + 5 + self._offsetx, self._rect.y + self._rect.height + dy
d = self._rect.x, self._rect.y + self._rect.height + dy
self._polygon_pos = a, b, c, d
cross_size = 0.6 * self._rect.height
else:
raise ValueError('invalid menubar mode {0}'.format(self._style))
# Create the back box
if self._backbox:
backbox_margin = 4
self._backbox_rect = pygame.Rect(
int(self._rect.x + self._width - cross_size + backbox_margin),
int(self._rect.y + backbox_margin),
int(cross_size - 2 * backbox_margin),
int(cross_size - 2 * backbox_margin)
)
if self._box_mode == _MODE_CLOSE:
# Make a cross for top menu
self._backbox_pos = (
(self._backbox_rect.left + 4, self._backbox_rect.top + 4),
(self._backbox_rect.centerx, self._backbox_rect.centery),
(self._backbox_rect.right - 4, self._backbox_rect.top + 4),
(self._backbox_rect.centerx, self._backbox_rect.centery),
(self._backbox_rect.right - 4, self._backbox_rect.bottom - 4),
(self._backbox_rect.centerx, self._backbox_rect.centery),
(self._backbox_rect.left + 4, self._backbox_rect.bottom - 4),
(self._backbox_rect.centerx, self._backbox_rect.centery),
(self._backbox_rect.left + 4, self._backbox_rect.top + 4),
)
elif self._box_mode == _MODE_BACK:
# Make a back arrow for sub-menus
self._backbox_pos = (
(self._backbox_rect.left + 5, self._backbox_rect.centery),
(self._backbox_rect.centerx, self._backbox_rect.top + 5),
(self._backbox_rect.centerx, self._backbox_rect.centery - 2),
(self._backbox_rect.right - 5, self._backbox_rect.centery - 2),
(self._backbox_rect.right - 5, self._backbox_rect.centery + 2),
(self._backbox_rect.centerx, self._backbox_rect.centery + 2),
(self._backbox_rect.centerx, self._backbox_rect.bottom - 5),
(self._backbox_rect.left + 5, self._backbox_rect.centery)
)
[docs] def set_title(self, title, offsetx=0, offsety=0):
"""
Set the Menu title.
:param title: Menu title
:type title: str
:param offsetx: Offset x-position of title (px)
:type offsetx: int, float
:param offsety: Offset y-position of title (px)
:type offsety: int, float
:return: None
"""
assert isinstance(offsetx, (int, float))
assert isinstance(offsety, (int, float))
self._title = to_string(title)
self._offsety = offsety
self._offsetx = offsetx
# noinspection PyMissingOrEmptyDocstring
[docs] def update(self, events):
updated = False
for event in events: # type: pygame.event.Event
if self.mouse_enabled and event.type == pygame.MOUSEBUTTONUP:
if self._backbox_rect and self._backbox_rect.collidepoint(*event.pos):
self.sound.play_click_mouse()
self.apply()
updated = True
elif self.joystick_enabled and event.type == pygame.JOYBUTTONDOWN:
if event.button == _controls.JOY_BUTTON_BACK:
self.sound.play_key_del()
self.apply()
updated = True
elif self.touchscreen_enabled and event.type == pygame.FINGERUP:
window_size = self.get_menu().get_window_size()
finger_pos = (event.x * window_size[0], event.y * window_size[1])
if self._backbox_rect and self._backbox_rect.collidepoint(finger_pos):
self.sound.play_click_mouse()
self.apply()
updated = True
if updated:
self.apply_update_callbacks()
return updated