Pokemon-Terminal/pokemonterminal/terminal/adapters/__init__.py
2018-01-06 19:51:42 -05:00

27 lines
865 B
Python

class TerminalProvider:
"""
Interface representing all the different terminal emulators supported
by pokemon-terminal if you want to implement a TE, create a module in this
folder that implements this interface, reflection will do the rest.
"""
def change_terminal(path: str):
"""
This sets the wallpaper of the corresponding TE of this adapter.
:param path The full path of the required pokemon image
"""
raise NotImplementedError()
def is_compatible() -> bool:
"""
checks for compatibility
:return a boolean saying whether or not the current adaptor is
compatible with the running TE
"""
raise NotImplementedError()
def clear(self):
"""
Clear the terminal's background image.
"""
raise NotImplementedError()