Module textual.messages

Classes

class InvokeLater (sender: MessagePump, callback: CallbackType)

Base class for a message.

Args

sender : MessageTarget

The sender of the message / event.

Expand source code

class InvokeLater(Message, verbose=True, bubble=False):
    def __init__(self, sender: MessagePump, callback: CallbackType) -> None:
        self.callback = callback
        super().__init__(sender)

    def __rich_repr__(self) -> rich.repr.Result:
        yield "callback", self.callback

Ancestors

• Message

Class variables

var bubble : ClassVar[bool]

var namespace : ClassVar[str]

var no_dispatch : ClassVar[bool]

var verbose : ClassVar[bool]

Inherited members

• Message:
  • can_replace
  • handler_name
  • name
  • prevent_default
  • sender
  • stop
  • time

class Layout (sender: MessageTarget)

Base class for a message.

Args

sender : MessageTarget

The sender of the message / event.

Expand source code

class Layout(Message, verbose=True):
    def can_replace(self, message: Message) -> bool:
        return isinstance(message, Layout)

Ancestors

• Message

Class variables

var bubble : ClassVar[bool]

var namespace : ClassVar[str]

var no_dispatch : ClassVar[bool]

var verbose : ClassVar[bool]

Inherited members

• Message:
  • can_replace
  • handler_name
  • name
  • prevent_default
  • sender
  • stop
  • time

class Prompt (sender: MessageTarget)

Used to 'wake up' an event loop.

Expand source code

class Prompt(Message, no_dispatch=True):
    """Used to 'wake up' an event loop."""

    def can_replace(self, message: Message) -> bool:
        return isinstance(message, Prompt)

Ancestors

• Message

Class variables

var bubble : ClassVar[bool]

var namespace : ClassVar[str]

var no_dispatch : ClassVar[bool]

var verbose : ClassVar[bool]

Inherited members

• Message:
  • can_replace
  • handler_name
  • name
  • prevent_default
  • sender
  • stop
  • time

class ScrollToRegion (sender: MessagePump, region: Region)

Ask the parent to scroll a given region in to view.

Expand source code

class ScrollToRegion(Message, bubble=False):
    """Ask the parent to scroll a given region in to view."""

    def __init__(self, sender: MessagePump, region: Region) -> None:
        self.region = region
        super().__init__(sender)

Ancestors

• Message

Class variables

var bubble : ClassVar[bool]

var namespace : ClassVar[str]

var no_dispatch : ClassVar[bool]

var verbose : ClassVar[bool]

Inherited members

• Message:
  • can_replace
  • handler_name
  • name
  • prevent_default
  • sender
  • stop
  • time

class StylesUpdated (sender: MessagePump)

Base class for a message.

Args

sender : MessageTarget

The sender of the message / event.

Expand source code

class StylesUpdated(Message, verbose=True):
    def __init__(self, sender: MessagePump) -> None:
        super().__init__(sender)

    def can_replace(self, message: Message) -> bool:
        return isinstance(message, StylesUpdated)

Ancestors

• Message

Class variables

var bubble : ClassVar[bool]

var namespace : ClassVar[str]

var no_dispatch : ClassVar[bool]

var verbose : ClassVar[bool]

Inherited members

• Message:
  • can_replace
  • handler_name
  • name
  • prevent_default
  • sender
  • stop
  • time

class TerminalSupportsSynchronizedOutput (sender: MessageTarget)

Used to make the App aware that the terminal emulator supports synchronised output. @link https://gist.github.com/christianparpart/d8a62cc1ab659194337d73e399004036

Expand source code

class TerminalSupportsSynchronizedOutput(Message):
    """
    Used to make the App aware that the terminal emulator supports synchronised output.
    @link https://gist.github.com/christianparpart/d8a62cc1ab659194337d73e399004036
    """

Ancestors

• Message

Class variables

var bubble : ClassVar[bool]

var namespace : ClassVar[str]

var no_dispatch : ClassVar[bool]

var verbose : ClassVar[bool]

Inherited members

• Message:
  • can_replace
  • handler_name
  • name
  • prevent_default
  • sender
  • stop
  • time

class Update (sender: MessagePump, widget: Widget)

Base class for a message.

Args

sender : MessageTarget

The sender of the message / event.

Expand source code

class Update(Message, verbose=True):
    def __init__(self, sender: MessagePump, widget: Widget):
        super().__init__(sender)
        self.widget = widget

    def __rich_repr__(self) -> rich.repr.Result:
        yield self.sender
        yield self.widget

    def __eq__(self, other: object) -> bool:
        if isinstance(other, Update):
            return self.widget == other.widget
        return NotImplemented

    def can_replace(self, message: Message) -> bool:
        # Update messages can replace update for the same widget
        return isinstance(message, Update) and self.widget == message.widget

Ancestors

• Message

Class variables

var bubble : ClassVar[bool]

var namespace : ClassVar[str]

var no_dispatch : ClassVar[bool]

var verbose : ClassVar[bool]

Inherited members

• Message:
  • can_replace
  • handler_name
  • name
  • prevent_default
  • sender
  • stop
  • time