Alto
latest

alto.ui.circle_colours

The pages of the circle of fifths settings that choose its colours: a grid of schemes to pick from, and an editor to make one.

Examples

>>> from alto.circle_schemes import preset
>>> SchemeThumb(preset("midnight")).scheme.name
'Midnight'

blank

def blank(key: str) -> CustomRecord

Make the scheme a new one starts as: colours by key signature, from cyan through blue to indigo, on dark wedges.

Parameters

  • key (str): The key the new scheme gets.

Returns

  • CustomRecord: The scheme.

Examples

>>> blank("custom-3")["id"], blank("custom-3")["mode"]
('custom-3', 'signature')

SchemeThumb

SchemeThumb(
    scheme: Scheme,
    *,
    size: int = THUMB,
    parent: QWidget | None = None,
)

Bases: QPushButton

A small picture of the circle in a colour scheme, to click to choose the scheme.

Attributes

  • scheme (Scheme): The scheme it shows and chooses.

Examples

>>> from alto.circle_schemes import preset
>>> thumb = SchemeThumb(preset("paper"))
>>> thumb.isCheckable(), thumb.toolTip()
(True, 'Pastel wedges of every hue with dark names, which deepen when lit.')

Constructor

Build the picture.

Parameters

  • scheme (Scheme): The colour scheme to draw.
  • size (int, default 112): Its width and height in pixels. Keyword-only.
  • parent (QWidget or None, default None): The widget that owns it. Keyword-only.

Constructor examples

>>> from alto.circle_schemes import preset
>>> SchemeThumb(preset("paper"), size=80).width()
80

SchemeThumb.sizeHint

def sizeHint() -> QSize

Return the size it asks for.

Returns

  • QSize: The size it was built with.

Examples

>>> from alto.circle_schemes import preset
>>> SchemeThumb(preset("paper"), size=90).sizeHint().width()
90

SchemeThumb.paintEvent

def paintEvent(_: QPaintEvent) -> None

Draw the circle, with one cell asked and its relative lit, and a ring round it when it is the chosen scheme.

Parameters

  • _ (QPaintEvent): The paint request.

Examples

>>> from alto.circle_schemes import preset
>>> SchemeThumb(preset("midnight")).grab().isNull()
False

SchemePage

SchemePage(parent: QWidget | None = None)

Bases: QWidget

The page that lists the colour schemes: the presets, the user’s own, and a button to make another.

Attributes

  • chosen (Signal): Emitted with the key of the scheme that was clicked.
  • new (Signal): Emitted when “Create your own” is clicked.
  • edit_asked (Signal): Emitted with the key of one of the user’s schemes when its Edit button is clicked.
  • thumbs (dict of str to SchemeThumb): The picture of each scheme, by its key.

Examples

>>> page = SchemePage()
>>> page.load(current="midnight", customs=[])
>>> page.thumbs["midnight"].isChecked(), len(page.thumbs)
(True, 14)

Constructor

Build the page, empty until load is called.

Parameters

  • parent (QWidget or None, default None): The widget that owns it.

Constructor examples

>>> SchemePage().thumbs
{}

SchemePage.load

def load(
    *,
    current: str,
    customs: list[CustomRecord],
) -> None

Fill the page: a picture and a name for each scheme, with the current one marked.

Parameters

  • current (str): The key of the chosen scheme. Keyword-only.
  • customs (list of CustomRecord): The user’s own schemes. Keyword-only.

Examples

>>> page = SchemePage()
>>> from alto.circle_schemes import record_of
>>> mine = record_of("custom-1", name="Mine", mode="single", colours=["#2f6bd0"])
>>> page.load(current="custom-1", customs=[mine])
>>> page.thumbs["custom-1"].isChecked(), page.thumbs["midnight"].isChecked()
(True, False)

SchemeEditor

SchemeEditor(parent: QWidget | None = None)

Bases: QWidget

The editor for a colour scheme of the user’s own: a name, how its colours are made, and the colours.

The colours are what a cell looks like when lit; the quiet cells are made from them. A picture shows the result as it is edited.

Attributes

  • saved (Signal): Emitted with the record when Save is clicked.
  • deleted (Signal): Emitted with the scheme’s key when Delete is clicked (only an existing scheme can be deleted).
  • cancelled (Signal): Emitted when Cancel is clicked.
  • name (QLineEdit): The name.
  • mode (QComboBox): How the colours are made: a key of MODES is each item’s data.
  • wedges (QComboBox): Whether the wedges are dark, with light names, or light, with dark names.
  • swatches (list of QPushButton): One button for each colour the mode takes; the others are hidden.
  • preview (SchemeThumb): The picture of the scheme as it is.

Examples

>>> editor = SchemeEditor()
>>> editor.load(None, taken=[])
>>> editor.record()["mode"], editor.record()["id"]
('signature', 'custom-1')

Constructor

Build the editor.

Parameters

  • parent (QWidget or None, default None): The widget that owns it.

Constructor examples

>>> len(SchemeEditor().swatches)
3

SchemeEditor.load

def load(
    record: CustomRecord | None,
    *,
    taken: list[CustomRecord],
) -> None

Start editing a scheme, or a new one.

Parameters

  • record (CustomRecord or None): The scheme to edit, or None to start a new one.
  • taken (list of CustomRecord): The user’s schemes, so that a new one gets a key none of them has. Keyword-only.

Examples

>>> editor = SchemeEditor()
>>> editor.load(None, taken=[])
>>> editor.name.text(), editor.delete_button.isHidden()
('My colours', True)

SchemeEditor.record

def record() -> CustomRecord

Return the scheme as it is being edited.

Returns

  • CustomRecord: Its key, name, mode, colours and whether its wedges are light.

Examples

>>> editor = SchemeEditor()
>>> editor.load(None, taken=[])
>>> editor.record()["colours"]
['#1fa7c9', '#2f6bd0', '#6a4fe0']

SchemeEditor.set_colour

def set_colour(
    index: int,
    *,
    colour: str,
) -> None

Set one of the colours.

Parameters

  • index (int): Which colour of the mode: 0, 1 or 2.
  • colour (str): The colour, “#rrggbb”. Keyword-only.

Examples

>>> editor = SchemeEditor()
>>> editor.load(None, taken=[])
>>> editor.set_colour(0, colour="#ff0000")
>>> editor.record()["colours"][0]
'#ff0000'