organoid_tracker.text_popup.text_popup module

class organoid_tracker.text_popup.text_popup.RichTextPopup

Bases: ABC

Represents a “rich text popup” (a collection of HTML pages), shown using dialog.popup_rich_text(). The help files are one example of a RichTextPopup. If you need to build a quick GUI with text, this class could help you.

INDEX = 'index'

get_root_folder() → str

Paths for things like images will be relative to this path.

get_title() → str

Returns the title for the whole website.

navigate(url: str) → Optional[str]

Returns the Markdown for the given URL. The website can also perform some other action, like zooming in on a position or starting a program. If this method returns None, then the navigation is cancelled.