euporie.core.layout.mouse

Defines a container which displays all children at full height vertially stacked.

Functions

get_app()	Get the current active (running) Application.
lru_cache([maxsize, typed])	Least-recently-used cache decorator.
to_container(container)	Monkey-patch to_container to collect container status functions.

Classes

Condition(func)	Turn any callable into a Filter.
Container()	Base class for user interface layout.
DisableMouseOnScroll(content)	A container which disables mouse support on unhandled scroll up events.
MouseEventType(value[, names, module, ...])

class euporie.core.layout.mouse.DisableMouseOnScroll(content: AnyContainer)

Bases: Container

A container which disables mouse support on unhandled scroll up events.

This enables the terminal scroll-back buffer to be scrolled if there is nothing in the application which is scrollable.

get_children() → list[prompt_toolkit.layout.containers.Container]

Return a list of all child containers.

get_key_bindings() → prompt_toolkit.key_binding.key_bindings.KeyBindingsBase | None

Returns a KeyBindings object. These bindings become active when any user control in this container has the focus, except if any containers between this container and the focused user control is modal.

is_modal() → bool

When this container is modal, key bindings from parent containers are not taken into account if a user control in this container is focused.

preferred_height(width: int, max_available_height: int) → Dimension

Return the desired height for this container.

preferred_width(max_available_width: int) → Dimension

Return the desired width for this container.

reset() → None

Reset the state of this container.

write_to_screen(screen: Screen, mouse_handlers: MouseHandlers, write_position: WritePosition, parent_style: str, erase_bg: bool, z_index: int | None) → None

Render the container to a Screen instance.

Wrap mouse handelrs, hooking unhandled scroll up events so the terminal can be scrolled if the scroll event is not handled.

Parameters:

• screen – The Screen class to which the output has to be written.

• mouse_handlers – prompt_toolkit.layout.mouse_handlers.MouseHandlers.

• write_position – A prompt_toolkit.layout.screen.WritePosition object defining where this container should be drawn.

• erase_bg – If true, the background will be erased prior to drawing.

• parent_style – Style string to pass to the Window object. This will be applied to all content of the windows. VSplit and prompt_toolkit.layout.containers.HSplit can use it to pass their style down to the windows that they contain.

• z_index – Used for propagating z_index from parent to child.