Show Simple Content
The Mycroft GUI Framework has a number of common methods for displaying standard simple content types.
Display simple strings of text.
self.gui.show_text(self, text, title=None, override_idle=None, override_animations=False)
Arguments:
- text (str): Main text content. It will auto-paginate
- title (str): A title to display above the text content.
- override_idle (boolean, int):
- True: Takes over the resting page indefinitely
- (int): Delays resting page for the specified number of seconds.
- override_animations (boolean):
- True: Disables showing all platform skill animations.
- False: 'Default' always show animations.
Display a static image such as a jpeg or png.
self.gui.show_image(self, url, caption=None, title=None, fill=None, override_idle=None, override_animations=False)
Arguments:
- url (str): Pointer to the image
- caption (str): A caption to show under the image
- title (str): A title to display above the image content
- fill (str): Fill type - supports:
- 'PreserveAspectFit',
- 'PreserveAspectCrop',
- 'Stretch'
- override_idle (boolean, int):
- True: Takes over the resting page indefinitely
- (int): Delays resting page for the specified number of seconds.
- override_animations (boolean):
- True: Disables showing all platform skill animations.
- False: 'Default' always show animations.
Display an animated image such as a gif.
self.gui.show_animated_image(self, url, caption=None, title=None, fill=None, override_idle=None, override_animations=False)
Arguments:
- url (str): Pointer to the .gif image
- caption (str): A caption to show under the image
- title (str): A title to display above the image content
- fill (str): Fill type - supports:
- 'PreserveAspectFit',
- 'PreserveAspectCrop',
- 'Stretch'
- override_idle (boolean, int):
- True: Takes over the resting page indefinitely
- (int): Delays resting page for the specified number of seconds.
- override_animations (boolean):
- True: Disables showing all platform skill animations.
- False: 'Default' always show animations.
Display a local HTML page.
self.gui.show_html(self, html, resource_url=None, override_idle=None, override_animations=False)
Arguments:
- html (str): HTML text to display
- resource_url (str): Pointer to HTML resources
- override_idle (boolean, int):
- True: Takes over the resting page indefinitely
- (int): Delays resting page for the specified number of seconds.
- override_animations (boolean):
- True: Disables showing all platform skill animations.
- False: 'Default' always show animations.
Display a webpage.
self.gui.show_url(self, url, override_idle=None, override_animations=False)
Arguments:
- url (str): URL to render
- override_idle (boolean, int):
- True: Takes over the resting page indefinitely
- (int): Delays resting page for the specified number of seconds.
- override_animations (boolean):
- True: Disables showing all platform skill animations.
- False: 'Default' always show animations.
Last modified 2yr ago