Added some documentation for menudisplay
This commit is contained in:
parent
ca86572677
commit
d987e60006
|
@ -6,6 +6,9 @@ from ..resources import ResourceManager
|
||||||
|
|
||||||
|
|
||||||
class MenuDisplay(Display):
|
class MenuDisplay(Display):
|
||||||
|
"""
|
||||||
|
A class to display the menu objects
|
||||||
|
"""
|
||||||
position: int
|
position: int
|
||||||
|
|
||||||
def __init__(self, *args):
|
def __init__(self, *args):
|
||||||
|
@ -62,6 +65,9 @@ class MenuDisplay(Display):
|
||||||
|
|
||||||
|
|
||||||
class SettingsMenuDisplay(MenuDisplay):
|
class SettingsMenuDisplay(MenuDisplay):
|
||||||
|
"""
|
||||||
|
A class to display specifically a settingsmenu object
|
||||||
|
"""
|
||||||
@property
|
@property
|
||||||
def values(self) -> List[str]:
|
def values(self) -> List[str]:
|
||||||
return [a[1][1] + (" : "
|
return [a[1][1] + (" : "
|
||||||
|
@ -71,6 +77,9 @@ class SettingsMenuDisplay(MenuDisplay):
|
||||||
|
|
||||||
|
|
||||||
class MainMenuDisplay(Display):
|
class MainMenuDisplay(Display):
|
||||||
|
"""
|
||||||
|
A class to display specifically a mainmenu object
|
||||||
|
"""
|
||||||
def __init__(self, menu: MainMenu, *args):
|
def __init__(self, menu: MainMenu, *args):
|
||||||
super().__init__(*args)
|
super().__init__(*args)
|
||||||
self.menu = menu
|
self.menu = menu
|
||||||
|
@ -96,6 +105,9 @@ class MainMenuDisplay(Display):
|
||||||
self.height - menuy), menuwidth)
|
self.height - menuy), menuwidth)
|
||||||
|
|
||||||
class VariableMenuDisplay(MenuDisplay):
|
class VariableMenuDisplay(MenuDisplay):
|
||||||
|
"""
|
||||||
|
A class to display a menu in which each value is associated to a parameter
|
||||||
|
"""
|
||||||
@property
|
@property
|
||||||
def values(self) -> List[str]:
|
def values(self) -> List[str]:
|
||||||
return [a[1][1] + (" : "
|
return [a[1][1] + (" : "
|
||||||
|
|
Loading…
Reference in New Issue