spacr.qt.widgets.info_link

Compact teal documentation dot used for spaCR API links.

Classes

InfoLink

A small teal dot that opens an API-reference URL when pressed.

Module Contents

class spacr.qt.widgets.info_link.InfoLink(url: str, *, tooltip: str = 'Open API reference', parent=None)

Bases: spacr.qt.widgets.dot_link.DotLink

A small teal dot that opens an API-reference URL when pressed.

Parameters:

• url – the page to open in the browser.

• tooltip – hover text, also the accessible name.

• parent – parent widget.

The colours and the accessible description are fixed here rather than passed: every one of these dots means the same thing, and a caller choosing its own would make them stop reading as one control.

Build the teal dot that opens a documentation page.

Parameters:

• url – the page to open.

• tooltip – hover text.

• parent – parent widget, or None.

open_documentation() → None

Open the configured documentation page in the system browser.

set_url(url: str) → None

Change the destination without rebuilding the compact link.

Parameters:

url – the address opened in the desktop browser on click; converted with str.

url() → str

Return the documentation URL opened by this button.