Source code for pygame_menu.themes

# coding=utf-8
"""
pygame-menu
https://github.com/ppizarror/pygame-menu

THEMES
Theme class and predefined themes.

License:
-------------------------------------------------------------------------------
The MIT License (MIT)
Copyright 2017-2020 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.
-------------------------------------------------------------------------------
"""

import pygame_menu.font
import pygame_menu.utils as _utils
import pygame_menu.widgets as _widgets
from pygame_menu.baseimage import BaseImage

import copy
import pygame


[docs]class Theme(object): """ Class defining the visual rendering of menus and widgets. .. note:: All colors must be defined with a tuple of 3 or 4 numbers in the formats: - (R,G,B) - (R,G,B,A) Red (R), Green (G) and Blue (B) must be numbers between 0 and 255. A means the alpha channel (opacity), if 0 the color is transparent, 100 means opaque. :param background_color: Menu background color :type background_color: tuple, list, :py:class:`pygame_menu.baseimage.BaseImage` :param cursor_color: Color of cursor :type cursor_color: tuple, list :param cursor_selection_color: Selection box color :type cursor_selection_color: tuple, list :param focus_background_color: Color of the widget focus, this must be a tuple of 4 elements. And must be transparent :type focus_background_color: tuple, list :param scrollbar_color: Scrollbars color :type scrollbar_color: tuple, list :param scrollbar_shadow: Indicate if a shadow is drawn on each scrollbar :type scrollbar_shadow: bool :param scrollbar_shadow_color: Color of the shadow :type scrollbar_shadow_color: tuple, list :param scrollbar_shadow_offset: Offset of shadow :type scrollbar_shadow_offset: int, float :param scrollbar_shadow_position: Position of shadow :type scrollbar_shadow_position: str :param scrollbar_slider_color: Color of the sliders :type scrollbar_slider_color: tuple, list :param scrollbar_slider_pad: Space between slider and scrollbars borders :type scrollbar_slider_pad: int, float :param scrollbar_thick: Scrollbars thickness :type scrollbar_thick: int, float :param selection_color: Color of the selector widget :type selection_color: tuple, list :param surface_clear_color: Surface clear color before applying background function :type surface_clear_color: tuple, list :param title_background_color: Title background color :type title_background_color: tuple, list :param title_bar_style: Style of the title, use menubar widget styles :type title_bar_style: int :param title_font: Optional title font, if None use the Menu default font :type title_font: str, None :param title_font_antialias: Title font renders with antialiasing :type title_font_antialias: bool :param title_font_color: Title font color, if None use the widget font color :type title_font_color: tuple, list, None :param title_font_size: Font size of the title :type title_font_size: int :param title_offset: Offset (x-position,y-position) of title (px). Default (0,0) :type title_offset: tuple, list :param title_shadow: Enable shadow on title :type title_shadow: bool :param title_shadow_color: Title shadow color :type title_shadow_color: tuple, list :param title_shadow_offset: Offset of shadow on title :type title_shadow_offset: int, float :param title_shadow_position: Position of the shadow on title :type title_shadow_position: str :param widget_alignment: Widget default alignment :type widget_alignment: str :param widget_background_color: Background color of a widget :type widget_background_color: tuple, list, :py:class:`pygame_menu.baseimage.BaseImage`, None :param widget_font: Widget font path or name :type widget_font: str :param widget_font_antialias: Widget font renders with antialiasing :type widget_font_antialias: bool :param widget_font_background_color_from_menu: Use menu background color as font background color, True by default in pygame v2 :type widget_font_background_color_from_menu: bool :param widget_font_color: Color of the font :type widget_font_color: tuple, list :param widget_font_size: Font size :type widget_font_size: int :param widget_margin: Horizontal and vertical margin of each element in Menu (px). Default (0, 10) :type widget_margin: tuple, list :param widget_offset: X,Y axis offset of widgets inside Menu (px). If value less than 1 use percentage of width/height. Default *(0, 0)* :type widget_offset: tuple, list :param widget_selection_effect: Widget selection effect object :type widget_selection_effect: :py:class:`pygame_menu.widgets.core.Selection` :param widget_shadow: Indicate if a shadow is drawn on each widget :type widget_shadow: bool :param widget_shadow_color: Color of the shadow :type widget_shadow_color: tuple, list :param widget_shadow_offset: Offset of shadow :type widget_shadow_offset: int, float :param widget_shadow_position: Position of shadow :type widget_shadow_position: str """ def __init__(self, **kwargs): self.background_color = self._get(kwargs, 'background_color', 'color_image', (220, 220, 220)) # type: tuple self.cursor_color = self._get(kwargs, 'cursor_color', 'color', (0, 0, 0)) # type: tuple self.cursor_selection_color = self._get(kwargs, 'cursor_selection_color', 'color', (30, 30, 30, 120)) # type: tuple self.focus_background_color = self._get(kwargs, 'focus_background_color', 'color', (0, 0, 0, 180)) # type: tuple self.scrollbar_color = self._get(kwargs, 'scrollbar_color', 'color', (220, 220, 220)) # type: tuple self.scrollbar_shadow = self._get(kwargs, 'scrollbar_shadow', bool, False) # type: bool self.scrollbar_shadow_color = self._get(kwargs, 'scrollbar_shadow_color', 'color', (0, 0, 0)) # type: bool self.scrollbar_shadow_offset = self._get(kwargs, 'scrollbar_shadow_offset', (int, float), 2) # type: (int, float) self.scrollbar_shadow_position = self._get(kwargs, 'scrollbar_shadow_position', 'position', pygame_menu.locals.POSITION_NORTHWEST) # type: str self.scrollbar_slider_color = self._get(kwargs, 'scrollbar_slider_color', 'color', (200, 200, 200)) # type: tuple self.scrollbar_slider_pad = self._get(kwargs, 'scrollbar_slider_pad', (int, float), 0) # type: (int,float) self.scrollbar_thick = self._get(kwargs, 'scrollbar_thick', (int, float), 20) # type: (int,float) self.selection_color = self._get(kwargs, 'selection_color', 'color', (255, 255, 255)) # type: tuple self.surface_clear_color = self._get(kwargs, 'surface_clear_color', 'color', (0, 0, 0)) # type: tuple self.title_background_color = self._get(kwargs, 'title_background_color', 'color', (70, 70, 70)) # type: tuple self.title_bar_style = self._get(kwargs, 'title_bar_style', int, _widgets.MENUBAR_STYLE_ADAPTIVE) # type: int self.title_font = self._get(kwargs, 'title_font', str, pygame_menu.font.FONT_OPEN_SANS) # type: str self.title_font_antialias = self._get(kwargs, 'title_font_antialias', bool, True) # type: bool self.title_font_color = self._get(kwargs, 'title_font_color', 'color', (220, 220, 220)) # type: tuple self.title_font_size = self._get(kwargs, 'title_font_size', int, 40) # type: int self.title_offset = self._get(kwargs, 'title_offset', 'tuple2', (5, 0)) # type: tuple self.title_shadow = self._get(kwargs, 'title_shadow', bool, False) # type: bool self.title_shadow_color = self._get(kwargs, 'title_shadow_color', 'color', (0, 0, 0)) # type: tuple self.title_shadow_offset = self._get(kwargs, 'title_shadow_offset', (int, float), 2) # type: (int,float) self.title_shadow_position = self._get(kwargs, 'title_shadow_position', 'position', pygame_menu.locals.POSITION_NORTHWEST) # type: str self.widget_font = self._get(kwargs, 'widget_font', str, pygame_menu.font.FONT_OPEN_SANS) # type: str self.widget_alignment = self._get(kwargs, 'widget_alignment', 'alignment', pygame_menu.locals.ALIGN_CENTER) # type: str self.widget_background_color = self._get(kwargs, 'widget_background_color', 'color_image_none') # type: (tuple, type(None)) self.widget_background_inflate = self._get(kwargs, 'background_inflate', 'tuple2', (16, 8)) # type: tuple self.widget_font_antialias = self._get(kwargs, 'widget_font_antialias', bool, True) # type: bool self.widget_font_background_color_from_menu = self._get(kwargs, 'widget_font_background_color_from_menu', bool, pygame.vernum.major == 2) # type: bool self.widget_font_color = self._get(kwargs, 'widget_font_color', 'color', (70, 70, 70)) # type: tuple self.widget_font_size = self._get(kwargs, 'widget_font_size', int, 30) # type: int self.widget_margin = self._get(kwargs, 'widget_margin', 'tuple2', (0, 10)) # type: tuple self.widget_offset = self._get(kwargs, 'widget_offset', 'tuple2', (0, 0)) # type: tuple self.widget_selection_effect = self._get(kwargs, 'widget_selection_effect', _widgets.core.Selection, _widgets.HighlightSelection()) # type: _widgets.core.Selection self.widget_shadow = self._get(kwargs, 'widget_shadow', bool, False) # type: bool self.widget_shadow_color = self._get(kwargs, 'widget_shadow_color', 'color', (0, 0, 0)) # type: tuple self.widget_shadow_offset = self._get(kwargs, 'widget_shadow_offset', (int, float), 2) # type: (int,float) self.widget_shadow_position = self._get(kwargs, 'widget_shadow_position', 'position', pygame_menu.locals.POSITION_NORTHWEST) # type: str # Upon this, no more kwargs should exist, raise exception if there's more for invalid_keyword in kwargs.keys(): raise ValueError('parameter Theme.{} does not exist'.format(invalid_keyword))
[docs] def validate(self): """ Validate the values of the theme. If there's a invalid parameter throws an AssertionError. This function also converts all lists to tuples. This is done because lists are mutable. :return: None """ # Size asserts assert self.scrollbar_thick > 0, 'scrollbar thickness must be greater than zero' assert self.scrollbar_shadow_offset > 0, 'scrollbar shadow offset must be greater than zero' assert self.title_font_size > 0, 'title font size must be greater than zero' assert self.widget_font_size > 0, 'widget font size must be greater than zero' assert self.widget_shadow_offset > 0, 'widget shadow offset must be greater than zero' assert self.widget_offset[0] >= 0 and self.widget_offset[1] >= 0, \ 'widget offset must be greater or equal than zero' # Format colors, this converts all color lists to tuples automatically self.background_color = self._format_opacity(self.background_color) self.cursor_color = self._format_opacity(self.cursor_color) self.cursor_selection_color = self._format_opacity(self.cursor_selection_color) self.focus_background_color = self._format_opacity(self.focus_background_color) self.scrollbar_color = self._format_opacity(self.scrollbar_color) self.scrollbar_shadow_color = self._format_opacity(self.scrollbar_shadow_color) self.scrollbar_slider_color = self._format_opacity(self.scrollbar_slider_color) self.selection_color = self._format_opacity(self.selection_color) self.surface_clear_color = self._format_opacity(self.surface_clear_color) self.title_background_color = self._format_opacity(self.title_background_color) self.title_font_color = self._format_opacity(self.title_font_color) self.title_shadow_color = self._format_opacity(self.title_shadow_color) self.widget_background_color = self._format_opacity(self.widget_background_color) self.widget_font_color = self._format_opacity(self.widget_font_color) # List to tuple self.title_offset = self._vec_2tuple(self.title_offset) self.widget_background_inflate = self._vec_2tuple(self.widget_background_inflate) self.widget_margin = self._vec_2tuple(self.widget_margin) self.widget_offset = self._vec_2tuple(self.widget_offset) # Configs self.widget_selection_effect.set_color(self.selection_color) # Color asserts assert self.focus_background_color[3] != 0, \ 'focus background color cannot be fully transparent, suggested opacity between 1 and 255'
@staticmethod def _vec_2tuple(obj): """ Return a tuple from a list or tuple object. :param obj: Object :type obj: list, tuple :return: Tuple :rtype: tuple """ if isinstance(obj, tuple): return obj elif isinstance(obj, list): return obj[0], obj[1] else: raise ValueError('object is not a 2 vector')
[docs] def copy(self): """ Creates a deep copy of the object. :return: Copied theme :rtype: Theme """ return copy.deepcopy(self)
@staticmethod def _format_opacity(color): """ Adds opacity to a 3 channel color. (R,G,B) -> (R,G,B,A) if the color has not an alpha channel. Also updates the opacity to a number between 0 and 255. Color may be an Image, so if this is the case return the same object. If the color is a list, return a tuple. :param color: Color tuple :type color: tuple, list :return: Color in the same format :rtype: tuple, None """ if isinstance(color, BaseImage): return color if color is None: return color if isinstance(color, (tuple, list)): _utils.assert_color(color) if len(color) == 4: if isinstance(color, tuple): return color else: return color[0], color[1], color[2], color[3] elif len(color) == 3: color = color[0], color[1], color[2], 255 else: raise ValueError('invalid color type {0}, only tuple or list are valid'.format(color)) return color @staticmethod def _get(params, key, allowed_types=None, default=None): """ Return a value from a dictionary. :param params: parameters dictionary :type params: dict :param key: key to look for :type key: str :param allowed_types: list of allowed types :type allowed_types: any :param default: default value to return :type default: any :return: The value associated to the key :rtype: any """ if key not in params: return default value = params.pop(key) if allowed_types: if not isinstance(allowed_types, (tuple, list)): allowed_types = (allowed_types,) for valtype in allowed_types: if valtype == 'color': _utils.assert_color(value) elif valtype == 'color_none': if value is None: return value _utils.assert_color(value) elif valtype == 'color_image': if isinstance(value, BaseImage): return value _utils.assert_color(value) elif valtype == 'color_image_none': if value is None: return value elif isinstance(value, BaseImage): return value _utils.assert_color(value) elif valtype == 'position': _utils.assert_position(value) elif valtype == 'alignment': _utils.assert_alignment(value) elif valtype == 'tuple2': _utils.assert_vector2(value) all_types = ('color', 'color_none', 'color_image', 'color_image_none', 'position', 'alignment', 'tuple2') others = tuple(t for t in allowed_types if t not in all_types) if others: msg = 'Theme.{} type shall be in {} types (got {})'.format(key, others, type(value)) assert isinstance(value, others), msg return value
THEME_DEFAULT = Theme() THEME_DARK = Theme( background_color=(40, 41, 35), cursor_color=(255, 255, 255), cursor_selection_color=(80, 80, 80, 120), scrollbar_color=(39, 41, 42), scrollbar_slider_color=(65, 66, 67), selection_color=(255, 255, 255), title_background_color=(47, 48, 51), title_font_color=(215, 215, 215), widget_font_color=(200, 200, 200), ) THEME_BLUE = Theme( background_color=(228, 230, 246), scrollbar_shadow=True, scrollbar_slider_color=(150, 200, 230), scrollbar_slider_pad=2, scrollbar_thick=14, selection_color=(100, 62, 132), title_background_color=(62, 149, 195), title_font_color=(228, 230, 246), title_shadow=True, widget_font_color=(61, 170, 220), ) THEME_GREEN = Theme( background_color=(186, 214, 177), scrollbar_slider_color=(125, 121, 114), scrollbar_slider_pad=2, selection_color=(125, 121, 114), title_background_color=(125, 121, 114), title_font_color=(228, 230, 246), widget_font_color=(255, 255, 255), ) THEME_ORANGE = Theme( background_color=(228, 100, 36), selection_color=(255, 255, 255), title_background_color=(170, 65, 50), widget_font_color=(0, 0, 0), widget_font_size=30, ) THEME_SOLARIZED = Theme( background_color=(239, 231, 211), cursor_color=(0, 0, 0), cursor_selection_color=(146, 160, 160, 120), selection_color=(207, 62, 132), title_background_color=(4, 47, 58), title_font_color=(38, 158, 151), widget_font_color=(102, 122, 130), )