| | |
- textual.widgets._static.Static(textual.widget.Widget)
-
- ChannelEnvironmentDisplay
class ChannelEnvironmentDisplay(textual.widgets._static.Static) |
| |
ChannelEnvironmentDisplay(renderable: 'RenderableType' = '', *, expand: 'bool' = False, shrink: 'bool' = False, markup: 'bool' = True, name: 'str | None' = None, id: 'str | None' = None, classes: 'str | None' = None, disabled: 'bool' = False) -> 'None'
A channel-environment interface element.
|
| |
- Method resolution order:
- ChannelEnvironmentDisplay
- textual.widgets._static.Static
- textual.widget.Widget
- textual.dom.DOMNode
- textual.message_pump.MessagePump
- builtins.object
Methods defined here:
- add_channel(self, name: str, chan: Union[runtimepy.channel.Channel[runtimepy.primitives.int.Int8Primitive], runtimepy.channel.Channel[runtimepy.primitives.int.Int16Primitive], runtimepy.channel.Channel[runtimepy.primitives.int.Int32Primitive], runtimepy.channel.Channel[runtimepy.primitives.int.Int64Primitive], runtimepy.channel.Channel[runtimepy.primitives.int.Uint8Primitive], runtimepy.channel.Channel[runtimepy.primitives.int.Uint16Primitive], runtimepy.channel.Channel[runtimepy.primitives.int.Uint32Primitive], runtimepy.channel.Channel[runtimepy.primitives.int.Uint64Primitive], runtimepy.channel.Channel[runtimepy.primitives.float.FloatPrimitive], runtimepy.channel.Channel[runtimepy.primitives.float.DoublePrimitive], runtimepy.channel.Channel[runtimepy.primitives.bool.BooleanPrimitive]], enum: Optional[runtimepy.enum.RuntimeEnum]) -> int
- Add a channel to the table.
- add_field(self, name: str) -> None
- Add a bit-field row entry.
- compose(self) -> Iterable[textual.widget.Widget]
- Create child nodes.
- handle_cell_selected(self, event: textual.widgets._data_table.DataTable.CellSelected) -> None
- Handle input submission.
- on_mount(self) -> None
- Populate channel table.
- random_channel(self) -> None
- Switch to a random channel.
- reset_plot(self) -> None
- Reset the selected plot.
- switch_to_channel(self, row: int) -> None
- Switch the plot to a channel at the specified row.
- update_channels(self, max_plot_samples: int, update_table: bool = True, update_log: bool = True, update_plot: bool = True) -> None
- Update all channel values.
Static methods defined here:
- create(name: str, command: runtimepy.channel.environment.command.processor.ChannelCommandProcessor, source: conntextual.ui.channel.model.ChannelEnvironmentSource, logger: Union[logging.Logger, logging.LoggerAdapter[Any]], app: runtimepy.net.arbiter.info.AppInfo, channel_pattern: conntextual.ui.channel.pattern.PatternPair) -> 'ChannelEnvironmentDisplay'
- Create a channel-environment display.
Readonly properties defined here:
- label
- Obtain a label string for this instance.
Data and other attributes defined here:
- __annotations__ = {'by_index': typing.List[typing.Tuple[textual.coordinate.Coordinate, typing.Union[str, int]]], 'channel_pattern': <class 'conntextual.ui.channel.pattern.PatternPair'>, 'channels_by_row': typing.Dict[int, conntextual.ui.channel.selected.SelectedChannel], 'model': <class 'conntextual.ui.channel.model.Model'>, 'row_idx': <class 'int'>, 'selected': <class 'conntextual.ui.channel.selected.SelectedChannel'>}
- can_focus = False
- can_focus_children = True
Methods inherited from textual.widgets._static.Static:
- __init__(self, renderable: 'RenderableType' = '', *, expand: 'bool' = False, shrink: 'bool' = False, markup: 'bool' = True, name: 'str | None' = None, id: 'str | None' = None, classes: 'str | None' = None, disabled: 'bool' = False) -> 'None'
- Initialize a Widget.
Args:
*children: Child widgets.
name: The name of the widget.
id: The ID of the widget in the DOM.
classes: The CSS classes for the widget.
disabled: Whether the widget is disabled or not.
- render(self) -> 'RenderResult'
- Get a rich renderable for the widget's content.
Returns:
A rich renderable.
- update(self, renderable: 'RenderableType' = '') -> 'None'
- Update the widget's content area with new text or Rich renderable.
Args:
renderable: A new rich renderable. Defaults to empty renderable;
Data descriptors inherited from textual.widgets._static.Static:
- renderable
Data and other attributes inherited from textual.widgets._static.Static:
- DEFAULT_CSS = '\n Static {\n height: auto;\n }\n '
Methods inherited from textual.widget.Widget:
- __enter__(self) -> 'Self'
- Use as context manager when composing.
- __exit__(self, exc_type: 'type[BaseException] | None', exc_val: 'BaseException | None', exc_tb: 'TracebackType | None') -> 'None'
- Exit compose context manager.
- __repr__ = auto_repr(self: ~T) -> str
- Return repr(self)
- __rich_repr__(self) -> 'rich.repr.Result'
- action_page_down(self) -> 'None'
- action_page_up(self) -> 'None'
- action_scroll_down(self) -> 'None'
- action_scroll_end(self) -> 'None'
- action_scroll_home(self) -> 'None'
- action_scroll_left(self) -> 'None'
- action_scroll_right(self) -> 'None'
- action_scroll_up(self) -> 'None'
- allow_focus(self) -> 'bool'
- Check if the widget is permitted to focus.
The base class returns [`can_focus`][textual.widget.Widget.can_focus].
This method maybe overridden if additional logic is required.
Returns:
`True` if the widget may be focused, or `False` if it may not be focused.
- allow_focus_children(self) -> 'bool'
- Check if a widget's children may be focused.
The base class returns [`can_focus_children`][textual.widget.Widget.can_focus_children].
This method maybe overridden if additional logic is required.
Returns:
`True` if the widget's children may be focused, or `False` if the widget's children may not be focused.
- animate(self, attribute: 'str', value: 'float | Animatable', *, final_value: 'object' = Ellipsis, duration: 'float | None' = None, speed: 'float | None' = None, delay: 'float' = 0.0, easing: 'EasingFunction | str' = 'in_out_cubic', on_complete: 'CallbackType | None' = None, level: 'AnimationLevel' = 'full') -> 'None'
- Animate an attribute.
Args:
attribute: Name of the attribute to animate.
value: The value to animate to.
final_value: The final value of the animation. Defaults to `value` if not set.
duration: The duration (in seconds) of the animation.
speed: The speed of the animation.
delay: A delay (in seconds) before the animation starts.
easing: An easing method.
on_complete: A callable to invoke when the animation is finished.
level: Minimum level required for the animation to take place (inclusive).
- batch(self) -> 'AsyncGenerator[None, None]'
- Async context manager that combines widget locking and update batching.
Use this async context manager whenever you want to acquire the widget lock and
batch app updates at the same time.
Example:
```py
async with container.batch():
await container.remove_children(Button)
await container.mount(Label("All buttons are gone."))
```
- begin_capture_print(self, stdout: 'bool' = True, stderr: 'bool' = True) -> 'None'
- Capture text from print statements (or writes to stdout / stderr).
If printing is captured, the widget will be sent an [`events.Print`][textual.events.Print] message.
Call [`end_capture_print`][textual.widget.Widget.end_capture_print] to disable print capture.
Args:
stdout: Whether to capture stdout.
stderr: Whether to capture stderr.
- blur(self) -> 'Self'
- Blur (un-focus) the widget.
Focus will be moved to the next available widget in the focus chain..
Returns:
The `Widget` instance.
- async broker_event(self, event_name: 'str', event: 'events.Event') -> 'bool'
- can_view(self, widget: 'Widget') -> 'bool'
- Check if a given widget is in the current view (scrollable area).
Note: This doesn't necessarily equate to a widget being visible.
There are other reasons why a widget may not be visible.
Args:
widget: A widget that is a descendant of self.
Returns:
True if the entire widget is in view, False if it is partially visible or not in view.
- capture_mouse(self, capture: 'bool' = True) -> 'None'
- Capture (or release) the mouse.
When captured, mouse events will go to this widget even when the pointer is not directly over the widget.
Args:
capture: True to capture or False to release.
- check_message_enabled(self, message: 'Message') -> 'bool'
- Check if a given message is enabled (allowed to be sent).
Args:
message: A message object
Returns:
`True` if the message will be sent, or `False` if it is disabled.
- clear_cached_dimensions(self) -> 'None'
- Clear cached results of `get_content_width` and `get_content_height`.
Call if the widget's renderable changes size after the widget has been created.
!!! note
This is not required if you are extending [`Static`][textual.widgets.Static].
- compose_add_child(self, widget: 'Widget') -> 'None'
- Add a node to children.
This is used by the compose process when it adds children.
There is no need to use it directly, but you may want to override it in a subclass
if you want children to be attached to a different node.
Args:
widget: A Widget to add.
- end_capture_print(self) -> 'None'
- End print capture (set with [`begin_capture_print`][textual.widget.Widget.begin_capture_print]).
- focus(self, scroll_visible: 'bool' = True) -> 'Self'
- Give focus to this widget.
Args:
scroll_visible: Scroll parent to make this widget visible.
Returns:
The `Widget` instance.
- get_child_by_id(self, id: 'str', expect_type: 'type[ExpectType] | None' = None) -> 'ExpectType | Widget'
- Return the first child (immediate descendent) of this node with the given ID.
Args:
id: The ID of the child.
expect_type: Require the object be of the supplied type, or None for any type.
Returns:
The first child of this node with the ID.
Raises:
NoMatches: if no children could be found for this ID
WrongType: if the wrong type was found.
- get_child_by_type(self, expect_type: 'type[ExpectType]') -> 'ExpectType'
- Get the first immediate child of a given type.
Only returns exact matches, and so will not match subclasses of the given type.
Args:
expect_type: The type of the child to search for.
Raises:
NoMatches: If no matching child is found.
Returns:
The first immediate child widget with the expected type.
- get_component_rich_style(self, name: 'str', *, partial: 'bool' = False) -> 'Style'
- Get a *Rich* style for a component.
Args:
name: Name of component.
partial: Return a partial style (not combined with parent).
Returns:
A Rich style object.
- get_content_height(self, container: 'Size', viewport: 'Size', width: 'int') -> 'int'
- Called by Textual to get the height of the content area. May be overridden in a subclass.
Args:
container: Size of the container (immediate parent) widget.
viewport: Size of the viewport.
width: Width of renderable.
Returns:
The height of the content.
- get_content_width(self, container: 'Size', viewport: 'Size') -> 'int'
- Called by textual to get the width of the content area. May be overridden in a subclass.
Args:
container: Size of the container (immediate parent) widget.
viewport: Size of the viewport.
Returns:
The optimal width of the content.
- get_loading_widget(self) -> 'Widget'
- Get a widget to display a loading indicator.
The default implementation will defer to App.get_loading_widget.
Returns:
A widget in place of this widget to indicate a loading.
- get_pseudo_class_state(self) -> 'PseudoClasses'
- Get an object describing whether each pseudo class is present on this object or not.
Returns:
A PseudoClasses object describing the pseudo classes that are present.
- get_pseudo_classes(self) -> 'Iterable[str]'
- Pseudo classes for a widget.
Returns:
Names of the pseudo classes.
- get_style_at(self, x: 'int', y: 'int') -> 'Style'
- Get the Rich style in a widget at a given relative offset.
Args:
x: X coordinate relative to the widget.
y: Y coordinate relative to the widget.
Returns:
A rich Style object.
- get_widget_by_id(self, id: 'str', expect_type: 'type[ExpectType] | None' = None) -> 'ExpectType | Widget'
- Return the first descendant widget with the given ID.
Performs a depth-first search rooted at this widget.
Args:
id: The ID to search for in the subtree.
expect_type: Require the object be of the supplied type, or None for any type.
Returns:
The first descendant encountered with this ID.
Raises:
NoMatches: if no children could be found for this ID.
WrongType: if the wrong type was found.
- async handle_key(self, event: 'events.Key') -> 'bool'
- mount(self, *widgets: 'Widget', before: 'int | str | Widget | None' = None, after: 'int | str | Widget | None' = None) -> 'AwaitMount'
- Mount widgets below this widget (making this widget a container).
Args:
*widgets: The widget(s) to mount.
before: Optional location to mount before. An `int` is the index
of the child to mount before, a `str` is a `query_one` query to
find the widget to mount before.
after: Optional location to mount after. An `int` is the index
of the child to mount after, a `str` is a `query_one` query to
find the widget to mount after.
Returns:
An awaitable object that waits for widgets to be mounted.
Raises:
MountError: If there is a problem with the mount request.
Note:
Only one of ``before`` or ``after`` can be provided. If both are
provided a ``MountError`` will be raised.
- mount_all(self, widgets: 'Iterable[Widget]', *, before: 'int | str | Widget | None' = None, after: 'int | str | Widget | None' = None) -> 'AwaitMount'
- Mount widgets from an iterable.
Args:
widgets: An iterable of widgets.
before: Optional location to mount before. An `int` is the index
of the child to mount before, a `str` is a `query_one` query to
find the widget to mount before.
after: Optional location to mount after. An `int` is the index
of the child to mount after, a `str` is a `query_one` query to
find the widget to mount after.
Returns:
An awaitable object that waits for widgets to be mounted.
Raises:
MountError: If there is a problem with the mount request.
Note:
Only one of ``before`` or ``after`` can be provided. If both are
provided a ``MountError`` will be raised.
- async mount_composed_widgets(self, widgets: 'list[Widget]') -> 'None'
- Called by Textual to mount widgets after compose.
There is generally no need to implement this method in your application.
See [Lazy][textual.lazy.Lazy] for a class which uses this method to implement
*lazy* mounting.
Args:
widgets: A list of child widgets.
- move_child(self, child: 'int | Widget', *, before: 'int | Widget | None' = None, after: 'int | Widget | None' = None) -> 'None'
- Move a child widget within its parent's list of children.
Args:
child: The child widget to move.
before: Child widget or location index to move before.
after: Child widget or location index to move after.
Raises:
WidgetError: If there is a problem with the child or target.
Note:
Only one of `before` or `after` can be provided. If neither
or both are provided a `WidgetError` will be raised.
- notify(self, message: 'str', *, title: 'str' = '', severity: 'SeverityLevel' = 'information', timeout: 'float' = 5) -> 'None'
- Create a notification.
!!! tip
This method is thread-safe.
Args:
message: The message for the notification.
title: The title for the notification.
severity: The severity of the notification.
timeout: The timeout (in seconds) for the notification.
See [`App.notify`][textual.app.App.notify] for the full
documentation for this method.
- notify_style_update(self) -> 'None'
- Called after styles are updated.
Implement this in a subclass if you want to clear any cached data when the CSS is reloaded.
- post_message(self, message: 'Message') -> 'bool'
- Post a message to this widget.
Args:
message: Message to post.
Returns:
True if the message was posted, False if this widget was closed / closing.
- post_render(self, renderable: 'RenderableType') -> 'ConsoleRenderable'
- Applies style attributes to the default renderable.
Returns:
A new renderable.
- async recompose(self) -> 'None'
- Recompose the widget.
Recomposing will remove children and call `self.compose` again to remount.
- refresh(self, *regions: 'Region', repaint: 'bool' = True, layout: 'bool' = False, recompose: 'bool' = False) -> 'Self'
- Initiate a refresh of the widget.
This method sets an internal flag to perform a refresh, which will be done on the
next idle event. Only one refresh will be done even if this method is called multiple times.
By default this method will cause the content of the widget to refresh, but not change its size. You can also
set `layout=True` to perform a layout.
!!! warning
It is rarely necessary to call this method explicitly. Updating styles or reactive attributes will
do this automatically.
Args:
*regions: Additional screen regions to mark as dirty.
repaint: Repaint the widget (will call render() again).
layout: Also layout widgets in the view.
recompose: Re-compose the widget (will remove and re-mount children).
Returns:
The `Widget` instance.
- release_mouse(self) -> 'None'
- Release the mouse.
Mouse events will only be sent when the mouse is over the widget.
- remove(self) -> 'AwaitRemove'
- Remove the Widget from the DOM (effectively deleting it).
Returns:
An awaitable object that waits for the widget to be removed.
- remove_children(self, selector: 'str | type[QueryType]' = '*') -> 'AwaitRemove'
- Remove the immediate children of this Widget from the DOM.
Args:
selector: A CSS selector to specify which direct children to remove.
Returns:
An awaitable object that waits for the direct children to be removed.
- render_line(self, y: 'int') -> 'Strip'
- Render a line of content.
Args:
y: Y Coordinate of line.
Returns:
A rendered line.
- render_lines(self, crop: 'Region') -> 'list[Strip]'
- Render the widget in to lines.
Args:
crop: Region within visible area to render.
Returns:
A list of list of segments.
- render_str(self, text_content: 'str | Text') -> 'Text'
- Convert str in to a Text object.
If you pass in an existing Text object it will be returned unaltered.
Args:
text_content: Text or str.
Returns:
A text object.
- async run_action(self, action: 'str') -> 'None'
- Perform a given action, with this widget as the default namespace.
Args:
action: Action encoded as a string.
- scroll_down(self, *, animate: 'bool' = True, speed: 'float | None' = None, duration: 'float | None' = None, easing: 'EasingFunction | str | None' = None, force: 'bool' = False, on_complete: 'CallbackType | None' = None, level: 'AnimationLevel' = 'basic') -> 'None'
- Scroll one line down.
Args:
animate: Animate scroll.
speed: Speed of scroll if `animate` is `True`; or `None` to use `duration`.
duration: Duration of animation, if `animate` is `True` and `speed` is `None`.
easing: An easing method for the scrolling animation.
force: Force scrolling even when prohibited by overflow styling.
on_complete: A callable to invoke when the animation is finished.
level: Minimum level required for the animation to take place (inclusive).
- scroll_end(self, *, animate: 'bool' = True, speed: 'float | None' = None, duration: 'float | None' = None, easing: 'EasingFunction | str | None' = None, force: 'bool' = False, on_complete: 'CallbackType | None' = None, level: 'AnimationLevel' = 'basic') -> 'None'
- Scroll to the end of the container.
Args:
animate: Animate scroll.
speed: Speed of scroll if `animate` is `True`; or `None` to use `duration`.
duration: Duration of animation, if `animate` is `True` and `speed` is `None`.
easing: An easing method for the scrolling animation.
force: Force scrolling even when prohibited by overflow styling.
on_complete: A callable to invoke when the animation is finished.
level: Minimum level required for the animation to take place (inclusive).
- scroll_home(self, *, animate: 'bool' = True, speed: 'float | None' = None, duration: 'float | None' = None, easing: 'EasingFunction | str | None' = None, force: 'bool' = False, on_complete: 'CallbackType | None' = None, level: 'AnimationLevel' = 'basic') -> 'None'
- Scroll to home position.
Args:
animate: Animate scroll.
speed: Speed of scroll if animate is `True`; or `None` to use duration.
duration: Duration of animation, if `animate` is `True` and `speed` is `None`.
easing: An easing method for the scrolling animation.
force: Force scrolling even when prohibited by overflow styling.
on_complete: A callable to invoke when the animation is finished.
level: Minimum level required for the animation to take place (inclusive).
- scroll_left(self, *, animate: 'bool' = True, speed: 'float | None' = None, duration: 'float | None' = None, easing: 'EasingFunction | str | None' = None, force: 'bool' = False, on_complete: 'CallbackType | None' = None, level: 'AnimationLevel' = 'basic') -> 'None'
- Scroll one cell left.
Args:
animate: Animate scroll.
speed: Speed of scroll if `animate` is `True`; or `None` to use `duration`.
duration: Duration of animation, if `animate` is `True` and `speed` is `None`.
easing: An easing method for the scrolling animation.
force: Force scrolling even when prohibited by overflow styling.
on_complete: A callable to invoke when the animation is finished.
level: Minimum level required for the animation to take place (inclusive).
- scroll_page_down(self, *, animate: 'bool' = True, speed: 'float | None' = None, duration: 'float | None' = None, easing: 'EasingFunction | str | None' = None, force: 'bool' = False, on_complete: 'CallbackType | None' = None, level: 'AnimationLevel' = 'basic') -> 'None'
- Scroll one page down.
Args:
animate: Animate scroll.
speed: Speed of scroll if animate is `True`; or `None` to use `duration`.
duration: Duration of animation, if `animate` is `True` and `speed` is `None`.
easing: An easing method for the scrolling animation.
force: Force scrolling even when prohibited by overflow styling.
on_complete: A callable to invoke when the animation is finished.
level: Minimum level required for the animation to take place (inclusive).
- scroll_page_left(self, *, animate: 'bool' = True, speed: 'float | None' = None, duration: 'float | None' = None, easing: 'EasingFunction | str | None' = None, force: 'bool' = False, on_complete: 'CallbackType | None' = None, level: 'AnimationLevel' = 'basic') -> 'None'
- Scroll one page left.
Args:
animate: Animate scroll.
speed: Speed of scroll if animate is `True`; or `None` to use `duration`.
duration: Duration of animation, if `animate` is `True` and `speed` is `None`.
easing: An easing method for the scrolling animation.
force: Force scrolling even when prohibited by overflow styling.
on_complete: A callable to invoke when the animation is finished.
level: Minimum level required for the animation to take place (inclusive).
- scroll_page_right(self, *, animate: 'bool' = True, speed: 'float | None' = None, duration: 'float | None' = None, easing: 'EasingFunction | str | None' = None, force: 'bool' = False, on_complete: 'CallbackType | None' = None, level: 'AnimationLevel' = 'basic') -> 'None'
- Scroll one page right.
Args:
animate: Animate scroll.
speed: Speed of scroll if animate is `True`; or `None` to use `duration`.
duration: Duration of animation, if `animate` is `True` and `speed` is `None`.
easing: An easing method for the scrolling animation.
force: Force scrolling even when prohibited by overflow styling.
on_complete: A callable to invoke when the animation is finished.
level: Minimum level required for the animation to take place (inclusive).
- scroll_page_up(self, *, animate: 'bool' = True, speed: 'float | None' = None, duration: 'float | None' = None, easing: 'EasingFunction | str | None' = None, force: 'bool' = False, on_complete: 'CallbackType | None' = None, level: 'AnimationLevel' = 'basic') -> 'None'
- Scroll one page up.
Args:
animate: Animate scroll.
speed: Speed of scroll if animate is `True`; or `None` to use `duration`.
duration: Duration of animation, if `animate` is `True` and `speed` is `None`.
easing: An easing method for the scrolling animation.
force: Force scrolling even when prohibited by overflow styling.
on_complete: A callable to invoke when the animation is finished.
level: Minimum level required for the animation to take place (inclusive).
- scroll_relative(self, x: 'float | None' = None, y: 'float | None' = None, *, animate: 'bool' = True, speed: 'float | None' = None, duration: 'float | None' = None, easing: 'EasingFunction | str | None' = None, force: 'bool' = False, on_complete: 'CallbackType | None' = None, level: 'AnimationLevel' = 'basic') -> 'None'
- Scroll relative to current position.
Args:
x: X distance (columns) to scroll, or ``None`` for no change.
y: Y distance (rows) to scroll, or ``None`` for no change.
animate: Animate to new scroll position.
speed: Speed of scroll if `animate` is `True`. Or `None` to use `duration`.
duration: Duration of animation, if animate is `True` and speed is `None`.
easing: An easing method for the scrolling animation.
force: Force scrolling even when prohibited by overflow styling.
on_complete: A callable to invoke when the animation is finished.
level: Minimum level required for the animation to take place (inclusive).
- scroll_right(self, *, animate: 'bool' = True, speed: 'float | None' = None, duration: 'float | None' = None, easing: 'EasingFunction | str | None' = None, force: 'bool' = False, on_complete: 'CallbackType | None' = None, level: 'AnimationLevel' = 'basic') -> 'None'
- Scroll one cell right.
Args:
animate: Animate scroll.
speed: Speed of scroll if animate is `True`; or `None` to use `duration`.
duration: Duration of animation, if `animate` is `True` and `speed` is `None`.
easing: An easing method for the scrolling animation.
force: Force scrolling even when prohibited by overflow styling.
on_complete: A callable to invoke when the animation is finished.
level: Minimum level required for the animation to take place (inclusive).
- scroll_to(self, x: 'float | None' = None, y: 'float | None' = None, *, animate: 'bool' = True, speed: 'float | None' = None, duration: 'float | None' = None, easing: 'EasingFunction | str | None' = None, force: 'bool' = False, on_complete: 'CallbackType | None' = None, level: 'AnimationLevel' = 'basic') -> 'None'
- Scroll to a given (absolute) coordinate, optionally animating.
Args:
x: X coordinate (column) to scroll to, or `None` for no change.
y: Y coordinate (row) to scroll to, or `None` for no change.
animate: Animate to new scroll position.
speed: Speed of scroll if `animate` is `True`; or `None` to use `duration`.
duration: Duration of animation, if `animate` is `True` and `speed` is `None`.
easing: An easing method for the scrolling animation.
force: Force scrolling even when prohibited by overflow styling.
on_complete: A callable to invoke when the animation is finished.
level: Minimum level required for the animation to take place (inclusive).
Note:
The call to scroll is made after the next refresh.
- scroll_to_center(self, widget: 'Widget', animate: 'bool' = True, *, speed: 'float | None' = None, duration: 'float | None' = None, easing: 'EasingFunction | str | None' = None, force: 'bool' = False, origin_visible: 'bool' = True, on_complete: 'CallbackType | None' = None, level: 'AnimationLevel' = 'basic') -> 'None'
- Scroll this widget to the center of self.
The center of the widget will be scrolled to the center of the container.
Args:
widget: The widget to scroll to the center of self.
animate: Whether to animate the scroll.
speed: Speed of scroll if animate is `True`; or `None` to use `duration`.
duration: Duration of animation, if `animate` is `True` and `speed` is `None`.
easing: An easing method for the scrolling animation.
force: Force scrolling even when prohibited by overflow styling.
origin_visible: Ensure that the top left corner of the widget remains visible after the scroll.
on_complete: A callable to invoke when the animation is finished.
level: Minimum level required for the animation to take place (inclusive).
- scroll_to_region(self, region: 'Region', *, spacing: 'Spacing | None' = None, animate: 'bool' = True, speed: 'float | None' = None, duration: 'float | None' = None, easing: 'EasingFunction | str | None' = None, center: 'bool' = False, top: 'bool' = False, origin_visible: 'bool' = True, force: 'bool' = False, on_complete: 'CallbackType | None' = None, level: 'AnimationLevel' = 'basic') -> 'Offset'
- Scrolls a given region in to view, if required.
This method will scroll the least distance required to move `region` fully within
the scrollable area.
Args:
region: A region that should be visible.
spacing: Optional spacing around the region.
animate: `True` to animate, or `False` to jump.
speed: Speed of scroll if `animate` is `True`; or `None` to use `duration`.
duration: Duration of animation, if `animate` is `True` and `speed` is `None`.
easing: An easing method for the scrolling animation.
top: Scroll `region` to top of container.
origin_visible: Ensure that the top left of the widget is within the window.
force: Force scrolling even when prohibited by overflow styling.
on_complete: A callable to invoke when the animation is finished.
level: Minimum level required for the animation to take place (inclusive).
Returns:
The distance that was scrolled.
- scroll_to_widget(self, widget: 'Widget', *, animate: 'bool' = True, speed: 'float | None' = None, duration: 'float | None' = None, easing: 'EasingFunction | str | None' = None, center: 'bool' = False, top: 'bool' = False, origin_visible: 'bool' = True, force: 'bool' = False, on_complete: 'CallbackType | None' = None, level: 'AnimationLevel' = 'basic') -> 'bool'
- Scroll scrolling to bring a widget in to view.
Args:
widget: A descendant widget.
animate: `True` to animate, or `False` to jump.
speed: Speed of scroll if `animate` is `True`; or `None` to use `duration`.
duration: Duration of animation, if `animate` is `True` and `speed` is `None`.
easing: An easing method for the scrolling animation.
top: Scroll widget to top of container.
origin_visible: Ensure that the top left of the widget is within the window.
force: Force scrolling even when prohibited by overflow styling.
on_complete: A callable to invoke when the animation is finished.
level: Minimum level required for the animation to take place (inclusive).
Returns:
`True` if any scrolling has occurred in any descendant, otherwise `False`.
- scroll_up(self, *, animate: 'bool' = True, speed: 'float | None' = None, duration: 'float | None' = None, easing: 'EasingFunction | str | None' = None, force: 'bool' = False, on_complete: 'CallbackType | None' = None, level: 'AnimationLevel' = 'basic') -> 'None'
- Scroll one line up.
Args:
animate: Animate scroll.
speed: Speed of scroll if `animate` is `True`; or `None` to use `duration`.
duration: Duration of animation, if `animate` is `True` and speed is `None`.
easing: An easing method for the scrolling animation.
force: Force scrolling even when prohibited by overflow styling.
on_complete: A callable to invoke when the animation is finished.
level: Minimum level required for the animation to take place (inclusive).
- scroll_visible(self, animate: 'bool' = True, *, speed: 'float | None' = None, duration: 'float | None' = None, top: 'bool' = False, easing: 'EasingFunction | str | None' = None, force: 'bool' = False, on_complete: 'CallbackType | None' = None, level: 'AnimationLevel' = 'basic') -> 'None'
- Scroll the container to make this widget visible.
Args:
animate: Animate scroll.
speed: Speed of scroll if animate is `True`; or `None` to use `duration`.
duration: Duration of animation, if `animate` is `True` and `speed` is `None`.
top: Scroll to top of container.
easing: An easing method for the scrolling animation.
force: Force scrolling even when prohibited by overflow styling.
on_complete: A callable to invoke when the animation is finished.
level: Minimum level required for the animation to take place (inclusive).
- set_loading(self, loading: 'bool') -> 'Awaitable'
- Set or reset the loading state of this widget.
A widget in a loading state will display a LoadingIndicator that obscures the widget.
Args:
loading: `True` to put the widget into a loading state, or `False` to reset the loading state.
Returns:
An optional awaitable.
- async stop_animation(self, attribute: 'str', complete: 'bool' = True) -> 'None'
- Stop an animation on an attribute.
Args:
attribute: Name of the attribute whose animation should be stopped.
complete: Should the animation be set to its final value?
Note:
If there is no animation scheduled or running, this is a no-op.
- validate_scroll_target_x(self, value: 'float') -> 'float'
- validate_scroll_target_y(self, value: 'float') -> 'float'
- validate_scroll_x(self, value: 'float') -> 'float'
- validate_scroll_y(self, value: 'float') -> 'float'
- watch_disabled(self) -> 'None'
- Update the styles of the widget and its children when disabled is toggled.
- watch_has_focus(self, value: 'bool') -> 'None'
- Update from CSS if has focus state changes.
- watch_hover_style(self, previous_hover_style: 'Style', hover_style: 'Style') -> 'None'
- watch_mouse_over(self, value: 'bool') -> 'None'
- Update from CSS if mouse over state changes.
- watch_scroll_x(self, old_value: 'float', new_value: 'float') -> 'None'
- watch_scroll_y(self, old_value: 'float', new_value: 'float') -> 'None'
Class methods inherited from textual.widget.Widget:
- __init_subclass__(can_focus: 'bool | None' = None, can_focus_children: 'bool | None' = None, inherit_css: 'bool' = True, inherit_bindings: 'bool' = True) -> 'None' from textual.message_pump._MessagePumpMeta
- This method is called when a class is subclassed.
The default implementation does nothing. It may be
overridden to extend subclasses.
Readonly properties inherited from textual.widget.Widget:
- allow_horizontal_scroll
- Check if horizontal scroll is permitted.
May be overridden if you want different logic regarding allowing scrolling.
- allow_vertical_scroll
- Check if vertical scroll is permitted.
May be overridden if you want different logic regarding allowing scrolling.
- container_size
- The size of the container (parent widget).
Returns:
Container size.
- container_viewport
- The viewport region (parent window).
Returns:
The region that contains this widget.
- content_offset
- An offset from the Widget origin where the content begins.
Returns:
Offset from widget's origin.
- content_region
- Gets an absolute region containing the content (minus padding and border).
Returns:
Screen region that contains a widget's content.
- content_size
- The size of the content area.
Returns:
Content area size.
- dock_gutter
- Space allocated to docks in the parent.
Returns:
Space to be subtracted from scrollable area.
- focusable
- Can this widget currently be focused?
- gutter
- Spacing for padding / border / scrollbars.
Returns:
Additional spacing around content area.
- horizontal_scrollbar
- The horizontal scrollbar.
Note:
This will *create* a scrollbar if one doesn't exist.
Returns:
ScrollBar Widget.
- is_container
- Is this widget a container (contains other widgets)?
- is_horizontal_scroll_end
- Is the horizontal scroll position at the maximum?
- is_horizontal_scrollbar_grabbed
- Is the user dragging the vertical scrollbar?
- is_mounted
- Check if this widget is mounted.
- is_scrollable
- Can this widget be scrolled?
- is_vertical_scroll_end
- Is the vertical scroll position at the maximum?
- is_vertical_scrollbar_grabbed
- Is the user dragging the vertical scrollbar?
- layer
- Get the name of this widgets layer.
Returns:
Name of layer.
- layers
- Layers of from parent.
Returns:
Tuple of layer names.
- link_style
- Style of links.
Returns:
Rich style.
- link_style_hover
- Style of links underneath the mouse cursor.
Returns:
Rich Style.
- max_scroll_x
- The maximum value of `scroll_x`.
- max_scroll_y
- The maximum value of `scroll_y`.
- opacity
- Total opacity of widget.
- outer_size
- The size of the widget (including padding and border).
Returns:
Outer size.
- region
- The region occupied by this widget, relative to the Screen.
Raises:
NoScreen: If there is no screen.
errors.NoWidget: If the widget is not on the screen.
Returns:
Region within screen occupied by widget.
- scroll_offset
- Get the current scroll offset.
Returns:
Offset a container has been scrolled by.
- scrollable_content_region
- Gets an absolute region containing the scrollable content (minus padding, border, and scrollbars).
Returns:
Screen region that contains a widget's content.
- scrollbar_corner
- The scrollbar corner.
Note:
This will *create* a scrollbar corner if one doesn't exist.
Returns:
ScrollBarCorner Widget.
- scrollbar_gutter
- Spacing required to fit scrollbar(s).
Returns:
Scrollbar gutter spacing.
- scrollbar_size_horizontal
- Get the height used by the *horizontal* scrollbar.
Returns:
Number of rows in the horizontal scrollbar.
- scrollbar_size_vertical
- Get the width used by the *vertical* scrollbar.
Returns:
Number of columns in the vertical scrollbar.
- scrollbars_enabled
- A tuple of booleans that indicate if scrollbars are enabled.
Returns:
A tuple of (<vertical scrollbar enabled>, <horizontal scrollbar enabled>)
- scrollbars_space
- The number of cells occupied by scrollbars for width and height
- siblings
- Get the widget's siblings (self is removed from the return list).
Returns:
A list of siblings.
- size
- The size of the content area.
Returns:
Content area size.
- vertical_scrollbar
- The vertical scrollbar (create if necessary).
Note:
This will *create* a scrollbar if one doesn't exist.
Returns:
ScrollBar Widget.
- virtual_region
- The widget region relative to it's container (which may not be visible,
depending on scroll offset).
Returns:
The virtual region.
- virtual_region_with_margin
- The widget region relative to its container (*including margin*), which may not be visible,
depending on the scroll offset.
Returns:
The virtual region of the Widget, inclusive of its margin.
- visible_siblings
- A list of siblings which will be shown.
Returns:
List of siblings.
- window_region
- The region within the scrollable area that is currently visible.
Returns:
New region.
Data descriptors inherited from textual.widget.Widget:
- auto_links
- border_subtitle
- border_title
- disabled
- expand
- has_focus
- highlight_link_id
- hover_style
- loading
- mouse_over
- offset
- Widget offset from origin.
Returns:
Relative offset.
- scroll_target_x
- scroll_target_y
- scroll_x
- scroll_y
- show_horizontal_scrollbar
- show_vertical_scrollbar
- shrink
- tooltip
- Tooltip for the widget, or `None` for no tooltip.
- virtual_size
Data and other attributes inherited from textual.widget.Widget:
- BORDER_SUBTITLE = ''
- BORDER_TITLE = ''
- COMPONENT_CLASSES = set()
- ExpectType = ~ExpectType
Methods inherited from textual.dom.DOMNode:
- async action_toggle(self, attribute_name: 'str') -> 'None'
- Toggle an attribute on the node.
Assumes the attribute is a bool.
Args:
attribute_name: Name of the attribute.
- add_class(self, *class_names: 'str', update: 'bool' = True) -> 'Self'
- Add class names to this Node.
Args:
*class_names: CSS class names to add.
update: Also update styles.
Returns:
Self.
- data_bind(self, *reactives: 'Reactive[Any]', **bind_vars: 'Reactive[Any] | object') -> 'Self'
- Bind reactive data so that changes to a reactive automatically change the reactive on another widget.
Reactives may be given as positional arguments or keyword arguments.
See the [guide on data binding](/guide/reactivity#data-binding).
Example:
```python
def compose(self) -> ComposeResult:
yield WorldClock("Europe/London").data_bind(WorldClockApp.time)
yield WorldClock("Europe/Paris").data_bind(WorldClockApp.time)
yield WorldClock("Asia/Tokyo").data_bind(WorldClockApp.time)
```
Raises:
ReactiveError: If the data wasn't bound.
Returns:
Self.
- get_component_styles(self, name: 'str') -> 'RenderStyles'
- Get a "component" styles object (must be defined in COMPONENT_CLASSES classvar).
Args:
name: Name of the component.
Raises:
KeyError: If the component class doesn't exist.
Returns:
A Styles object.
- has_class(self, *class_names: 'str') -> 'bool'
- Check if the Node has all the given class names.
Args:
*class_names: CSS class names to check.
Returns:
``True`` if the node has all the given class names, otherwise ``False``.
- has_pseudo_class(self, class_name: 'str') -> 'bool'
- Check the node has the given pseudo class.
Args:
class_name: The pseudo class to check for.
Returns:
`True` if the DOM node has the pseudo class, `False` if not.
- has_pseudo_classes(self, class_names: 'set[str]') -> 'bool'
- Check the node has all the given pseudo classes.
Args:
class_names: Set of class names to check for.
Returns:
`True` if all pseudo class names are present.
- query(self, selector: 'str | type[QueryType] | None' = None) -> 'DOMQuery[Widget] | DOMQuery[QueryType]'
- Query the DOM for children that match a selector or widget type.
Args:
selector: A CSS selector, widget type, or `None` for all nodes.
Returns:
A query object.
- query_one(self, selector: 'str | type[QueryType]', expect_type: 'type[QueryType] | None' = None) -> 'QueryType | Widget'
- Get a widget from this widget's children that matches a selector or widget type.
Args:
selector: A selector or widget type.
expect_type: Require the object be of the supplied type, or None for any type.
Raises:
WrongType: If the wrong type was found.
NoMatches: If no node matches the query.
TooManyMatches: If there is more than one matching node in the query.
Returns:
A widget matching the selector.
- remove_class(self, *class_names: 'str', update: 'bool' = True) -> 'Self'
- Remove class names from this Node.
Args:
*class_names: CSS class names to remove.
update: Also update styles.
Returns:
Self.
- reset_styles(self) -> 'None'
- Reset styles back to their initial state.
- run_worker(self, work: 'WorkType[ResultType]', name: 'str | None' = '', group: 'str' = 'default', description: 'str' = '', exit_on_error: 'bool' = True, start: 'bool' = True, exclusive: 'bool' = False, thread: 'bool' = False) -> 'Worker[ResultType]'
- Run work in a worker.
A worker runs a function, coroutine, or awaitable, in the *background* as an async task or as a thread.
Args:
work: A function, async function, or an awaitable object to run in a worker.
name: A short string to identify the worker (in logs and debugging).
group: A short string to identify a group of workers.
description: A longer string to store longer information on the worker.
exit_on_error: Exit the app if the worker raises an error. Set to `False` to suppress exceptions.
start: Start the worker immediately.
exclusive: Cancel all workers in the same group.
thread: Mark the worker as a thread worker.
Returns:
New Worker instance.
- set_class(self, add: 'bool', *class_names: 'str', update: 'bool' = True) -> 'Self'
- Add or remove class(es) based on a condition.
Args:
add: Add the classes if True, otherwise remove them.
update: Also update styles.
Returns:
Self.
- set_classes(self, classes: 'str | Iterable[str]') -> 'Self'
- Replace all classes.
Args:
classes: A string containing space separated classes, or an
iterable of class names.
Returns:
Self.
- set_reactive(self, reactive: 'Reactive[ReactiveType]', value: 'ReactiveType') -> 'None'
- Sets a reactive value *without* invoking validators or watchers.
Example:
```python
self.set_reactive(App.dark_mode, True)
```
Args:
name: Name of reactive attribute.
value: New value of reactive.
Raises:
AttributeError: If the first argument is not a reactive.
- set_styles(self, css: 'str | None' = None, **update_styles: 'Any') -> 'Self'
- Set custom styles on this object.
Args:
css: Styles in CSS format.
update_styles: Keyword arguments map style names onto style values.
Returns:
Self.
- sort_children(self, *, key: 'Callable[[Widget], SupportsRichComparison] | None' = None, reverse: 'bool' = False) -> 'None'
- Sort child widgets with an optional key function.
If `key` is not provided then widgets will be sorted in the order they are constructed.
Example:
```python
# Sort widgets by name
screen.sort_children(key=lambda widget: widget.name or "")
```
Args:
key: A callable which accepts a widget and returns something that can be sorted,
or `None` to sort without a key function.
reverse: Sort in descending order.
- toggle_class(self, *class_names: 'str') -> 'Self'
- Toggle class names on this Node.
Args:
*class_names: CSS class names to toggle.
Returns:
Self.
- walk_children(self, filter_type: 'type[WalkType] | None' = None, *, with_self: 'bool' = False, method: 'WalkMethod' = 'depth', reverse: 'bool' = False) -> 'list[DOMNode] | list[WalkType]'
- Walk the subtree rooted at this node, and return every descendant encountered in a list.
Args:
filter_type: Filter only this type, or None for no filter.
with_self: Also yield self in addition to descendants.
method: One of "depth" or "breadth".
reverse: Reverse the order (bottom up).
Returns:
A list of nodes.
- watch(self, obj: 'DOMNode', attribute_name: 'str', callback: 'WatchCallbackType', init: 'bool' = True) -> 'None'
- Watches for modifications to reactive attributes on another object.
Example:
Here's how you could detect when the app changes from dark to light mode (and vice versa).
```python
def on_dark_change(old_value:bool, new_value:bool):
# Called when app.dark changes.
print("App.dark when from {old_value} to {new_value}")
self.watch(self.app, "dark", self.on_dark_change, init=False)
```
Args:
obj: Object containing attribute to watch.
attribute_name: Attribute to watch.
callback: A callback to run when attribute changes.
init: Check watchers on first call.
Readonly properties inherited from textual.dom.DOMNode:
- ancestors
- A list of ancestor nodes found by tracing a path all the way back to App.
Returns:
A list of nodes.
- ancestors_with_self
- A list of ancestor nodes found by tracing a path all the way back to App.
Note:
This is inclusive of ``self``.
Returns:
A list of nodes.
- background_colors
- The background color and the color of the parent's background.
Returns:
`(<background color>, <color>)`
- children
- A view on to the children.
Returns:
The node's children.
- colors
- The widget's background and foreground colors, and the parent's background and foreground colors.
Returns:
`(<parent background>, <parent color>, <background>, <color>)`
- css_identifier
- A CSS selector that identifies this DOM node.
- css_identifier_styled
- A syntax highlighted CSS identifier.
Returns:
A Rich Text object.
- css_path_nodes
- A list of nodes from the App to this node, forming a "path".
Returns:
A list of nodes, where the first item is the App, and the last is this node.
- css_tree
- A Rich tree to display the DOM, annotated with the node's CSS.
Log this to visualize your app in the textual console.
Example:
```python
self.log(self.css_tree)
```
Returns:
A Tree renderable.
- displayed_children
- The child nodes which will be displayed.
Returns:
A list of nodes.
- is_modal
- Is the node a modal?
- name
- The name of the node.
- parent
- The parent node.
All nodes have parent once added to the DOM, with the exception of the App which is the *root* node.
- pseudo_classes
- A (frozen) set of all pseudo classes.
- rich_style
- Get a Rich Style object for this DOMNode.
Returns:
A Rich style.
- screen
- The screen containing this node.
Returns:
A screen object.
Raises:
NoScreen: If this node isn't mounted (and has no screen).
- text_style
- Get the text style object.
A widget's style is influenced by its parent. for instance if a parent is bold, then
the child will also be bold.
Returns:
A Rich Style.
- tree
- A Rich tree to display the DOM.
Log this to visualize your app in the textual console.
Example:
```python
self.log(self.tree)
```
Returns:
A Tree renderable.
- workers
- The app's worker manager. Shortcut for `self.app.workers`.
Data descriptors inherited from textual.dom.DOMNode:
- auto_refresh
- Number of seconds between automatic refresh, or `None` for no automatic refresh.
- classes
- display
- Should the DOM node be displayed?
May be set to a boolean to show or hide the node, or to any valid value for the `display` rule.
Example:
```python
my_widget.display = False # Hide my_widget
```
- id
- The ID of this node, or None if the node has no ID.
- visible
- Is this widget visible in the DOM?
If a widget hasn't had its visibility set explicitly, then it inherits it from its
DOM ancestors.
This may be set explicitly to override inherited values.
The valid values include the valid values for the `visibility` rule and the booleans
`True` or `False`, to set the widget to be visible or invisible, respectively.
When a node is invisible, Textual will reserve space for it, but won't display anything.
Data and other attributes inherited from textual.dom.DOMNode:
- BINDINGS = []
- DEFAULT_CLASSES = ''
- SCOPED_CSS = True
- WalkType = ~WalkType
Methods inherited from textual.message_pump.MessagePump:
- call_after_refresh(self, callback: 'Callback', *args: 'Any', **kwargs: 'Any') -> 'bool'
- Schedule a callback to run after all messages are processed and the screen
has been refreshed. Positional and keyword arguments are passed to the callable.
Args:
callback: A callable.
Returns:
`True` if the callback was scheduled, or `False` if the callback could not be
scheduled (may occur if the message pump was closed or closing).
- call_later(self, callback: 'Callback', *args: 'Any', **kwargs: 'Any') -> 'bool'
- Schedule a callback to run after all messages are processed in this object.
Positional and keywords arguments are passed to the callable.
Args:
callback: Callable to call next.
*args: Positional arguments to pass to the callable.
**kwargs: Keyword arguments to pass to the callable.
Returns:
`True` if the callback was scheduled, or `False` if the callback could not be
scheduled (may occur if the message pump was closed or closing).
- call_next(self, callback: 'Callback', *args: 'Any', **kwargs: 'Any') -> 'None'
- Schedule a callback to run immediately after processing the current message.
Args:
callback: Callable to run after current event.
*args: Positional arguments to pass to the callable.
**kwargs: Keyword arguments to pass to the callable.
- check_idle(self) -> 'None'
- Prompt the message pump to call idle if the queue is empty.
- disable_messages(self, *messages: 'type[Message]') -> 'None'
- Disable message types from being processed.
- async dispatch_key(self, event: 'events.Key') -> 'bool'
- Dispatch a key event to method.
This method will call the method named 'key_<event.key>' if it exists.
Some keys have aliases. The first alias found will be invoked if it exists.
If multiple handlers exist that match the key, an exception is raised.
Args:
event: A key event.
Returns:
True if key was handled, otherwise False.
Raises:
DuplicateKeyHandlers: When there's more than 1 handler that could handle this key.
- enable_messages(self, *messages: 'type[Message]') -> 'None'
- Enable processing of messages types.
- async on_callback(self, event: 'events.Callback') -> 'None'
- async on_event(self, event: 'events.Event') -> 'None'
- Called to process an event.
Args:
event: An Event object.
- async on_timer(self, event: 'events.Timer') -> 'None'
- prevent(self, *message_types: 'type[Message]') -> 'Generator[None, None, None]'
- A context manager to *temporarily* prevent the given message types from being posted.
Example:
```python
input = self.query_one(Input)
with self.prevent(Input.Changed):
input.value = "foo"
```
- set_interval(self, interval: 'float', callback: 'TimerCallback | None' = None, *, name: 'str | None' = None, repeat: 'int' = 0, pause: 'bool' = False) -> 'Timer'
- Call a function at periodic intervals.
Args:
interval: Time (in seconds) between calls.
callback: Function to call.
name: Name of the timer object.
repeat: Number of times to repeat the call or 0 for continuous.
pause: Start the timer paused.
Returns:
A timer object.
- set_timer(self, delay: 'float', callback: 'TimerCallback | None' = None, *, name: 'str | None' = None, pause: 'bool' = False) -> 'Timer'
- Make a function call after a delay.
Args:
delay: Time (in seconds) to wait before invoking callback.
callback: Callback to call after time has expired.
name: Name of the timer (for debug).
pause: Start timer paused.
Returns:
A timer object.
Readonly properties inherited from textual.message_pump.MessagePump:
- app
- Get the current app.
Returns:
The current app.
Raises:
NoActiveAppError: if no active app could be found for the current asyncio context
- has_parent
- Does this object have a parent?
- is_attached
- Is the node attached to the app via the DOM?
- is_parent_active
- Is the parent active?
- is_running
- Is the message pump running (potentially processing messages)?
- log
- Get a logger for this object.
Returns:
A logger.
- message_queue_size
- The current size of the message queue.
- task
Data descriptors inherited from textual.message_pump.MessagePump:
- __dict__
- dictionary for instance variables
- __weakref__
- list of weak references to the object
| |