Text

GuiText

GuiText(
    content: str | None = None,
    *,
    color: str | tuple[int, int, int] | None = None,
    toggle_state: bool = True,
    title: str | None = None
)

Bases: GuiWidget

Text widget. Goes grey on toggle off.

Tip

Use GuiText('⬤', color='green') for a toggleable "LED indicator".

Parameters:

content (str | None, default: None ) –

Widget's text
color (str | tuple[int, int, int] | None, default: None ) –

Text color as color name or RGB tuple
toggle_state (bool, default: True ) –

False to "grey out" text
title (str | None, default: None ) –

Title for dock widget and position saving, set by content or type if None

content

content: Any | tuple[Any, ...]

Widget's text or text for its items

color

color: str | tuple[int, int, int] | None

Color as color name or RGB tuple

toggle_state

toggle_state: bool | None

Toggle state

is_visible

is_visible: bool

Widget is currently visible

qt_widget

qt_widget: QWidget | WrappedQWidgetMixin

Wrapped PySide6 QWidget that can be altered for extra customization

subscribe

subscribe(
    type: None | Container[GuiEvent] | GuiEvent = None,
    data: None | Container | str | int | bool | Sequence = None,
) -> Callable

Decorator to subscribe a callable to the input's messages.

Decorator without arguments subscribes a callable to all the input's messages.

Decorator with arguments subscribes a callable to the input's messages that match conditions set by arguments. It works the same way as message's matches method:

If condition is None or omitted it matches anything.
If condition equals the message's attribute value it matches the attribute.
If condition is a container (list, tuple) and contains the message's attribute value, it matches the attribute.

Examples

Calls function for all MIDI port's messages:

@midi_input_instance.subscribe
def function(msg: MidiMsg) -> None:
    pass

Calls function for OSC messages from specific address:

@osc_input_instance.subscribe(address='/live/song/get/track_data')
def function(msg: OscMsg) -> None:
    pass

Call object instance method for MIDI port's "note on" and "note off" messages:

midi_input_instance.subscribe((MidiType.NOTE_ON, MidiType.NOTE_OFF))(object.method)

Returns:

Callable –

Subscribed callable.

GuiEditableText

GuiEditableText(
    content: str | None = None,
    *,
    color: str | tuple[int, int, int] | None = None,
    toggle_state: bool = True,
    title: str | None = None
)