batgrl.gadgets.split_layout#

Draggable horizontal and vertical split layouts.

Classes

`HSplitLayout`(*[, split_row, split_anchor, ...])	A horizontal split layout.
`VSplitLayout`([split_col, split_anchor, ...])	A vertical split layout.
`_HSplitHandle`(size_hint)
`_Handle`(size_hint)
`_VSplitHandle`(size_hint)

class batgrl.gadgets.split_layout.HSplitLayout(*, split_row: int = 1, split_anchor: Literal['top', 'bottom'] = 'top', split_resizable: bool = True, top_min_height: int = 1, bottom_min_height: int = 1, size: Size = (10, 10), pos: Point = (0, 0), size_hint: SizeHint | None = None, pos_hint: PosHint | None = None, is_transparent: bool = False, is_visible: bool = True, is_enabled: bool = True)#

Bases: Gadget

A horizontal split layout.

Add gadgets to the :attr:top_pane or :attr:bottom_pane, e.g., my_hsplit.top_pane.add_gadget(my_gadget).

If :attr:top_min_height and :attr:bottom_min_height can’t both be satisfied, :attr:split_anchor will determine which pane’s height requirement is preferred.

Parameters:

split_rowint, default: 1: Height of top pane. Height of bottom pane is self.width - split_row.
split_anchorLiteral[“top”, “bottom”], default: “top: If gadget is resized, split_anchor determines which pane’s height isn’t changed.
split_resizablebool, default: True: Whether split is resizable with a grabbable handle.
top_min_heightint, default: 1: Minimum height of top pane.
bottom_min_heightint, default: 1: Minimum height of bottom pane.
sizeSize, default: Size(10, 10): Size of gadget.
posPoint, default: Point(0, 0): Position of upper-left corner in parent.
size_hintSizeHint | None, default: None: Size as a proportion of parent’s height and width.
pos_hintPosHint | None, default: None: Position as a proportion of parent’s height and width.
is_transparentbool, default: False: Whether gadget is transparent.
is_visiblebool, default: True: Whether gadget is visible. Gadget will still receive input events if not visible.
is_enabledbool, default: True: Whether gadget is enabled. A disabled gadget is not painted and doesn’t receive input events.

Attributes:

top_paneGadget: Container gadget for top side of split layout.
bottom_paneGadget: Container gadget for bottom side of split layout.
split_rowint: Height of top pane.
split_anchorLiteral[“top”, “bottom”]: If gadget is resized, split_anchor determines which pane’s height isn’t changed.
split_resizablebool: Whether split is resizable with a grabbable handle.
top_min_heightint: Minimum height of top pane.
bottom_min_heightint: Minimum height of bottom pane.
sizeSize: Size of gadget.
heightint: Height of gadget.
rowsint: Height of gadget.
widthint: Width of gadget.
columnsint: Width of gadget.
posPoint: Position relative to parent.
topint: y-coordinate of top of gadget.
yint: y-coordinate of top of gadget.
leftint: x-coordinate of left side of gadget.
xint: x-coordinate of left side of gadget.
bottomint: y-coordinate of bottom of gadget.
rightint: x-coordinate of right side of gadget.
centerPoint: Position of center of gadget.
absolute_posPoint: Absolute position on screen.
size_hintSizeHint: Gadget’s size as a proportion of its parent’s size.
pos_hintPosHint: Gadget’s position as a proportion of its parent’s size.
parent: Gadget | None: Parent gadget.
childrenlist[Gadget]: Children gadgets.
is_transparentbool: Whether gadget is transparent.
is_visiblebool: Whether gadget is visible.
is_enabledbool: Whether gadget is enabled.
rootGadget | None: Return the root gadget if connected to gadget tree.
appApp: The running app.

Methods

apply_hints()	Apply size and pos hints.
to_local(point)	Convert point in absolute coordinates to local coordinates.
collides_point(point)	Return true if point collides with visible portion of gadget.
collides_gadget(other)	Return true if other is within gadget’s bounding box.
pull_to_front()	Move to end of gadget stack so gadget is drawn last.
walk()	Yield all descendents of this gadget (preorder traversal).
walk_reverse()	Yield all descendents of this gadget (reverse postorder traversal).
ancestors()	Yield all ancestors of this gadget.
add_gadget(gadget)	Add a child gadget.
*add_gadgets(gadgets)**	Add multiple child gadgets.
remove_gadget(gadget)	Remove a child gadget.
prolicide()	Recursively remove all children.
destroy()	Remove this gadget and recursively remove all its children.
bind(prop, callback)	Bind callback to a gadget property.
unbind(uid)	Unbind a callback from a gadget property.
tween(…)	Sequentially update gadget properties over time.
on_size()	Update gadget after a resize.
on_transparency()	Update gadget after transparency is enabled/disabled.
on_add()	Update gadget after being added to the gadget tree.
on_remove()	Update gadget after being removed from the gadget tree.
on_key(key_event)	Handle a key press event.
on_mouse(mouse_event)	Handle a mouse event.
on_paste(paste_event)	Handle a paste event.
on_terminal_focus(focus_event)	Handle a focus event.

property absolute_pos: Point | None#: Absolute position on screen.

add_gadget(gadget: Self) → None#

Add a child gadget.

Parameters:

gadgetGadget: A gadget to add as a child.

add_gadgets(*gadgets: Self) → None#

Add multiple child gadgets.

Parameters:

*gadgetsGadget: Gadgets to add as children. Can also accept a single iterable of gadgets.

ancestors() → Iterator[Self]#

Yield all ancestors of this gadget.

Yields:

Gadget: An ancestor of this gadget.

property app#: The running app.

apply_hints() → None#

Apply size and pos hints.

This is called automatically when the gadget is added to the gadget tree and when the gadget’s parent’s size changes.

bind(prop: str, callback: Callable[[], None]) → int#

Bind callback to a gadget property. When the property is updated, callback is called with no arguments.

Parameters:

propstr: The name of the gadget property.
callbackCallable[[], None]: Callback to bind to property.

Returns:

int: A unique id used to unbind the callback.

property bottom: int#: y-coordinate of bottom of gadget.

property bottom_min_height: int#: Minimum height of bottom pane.

bottom_pane#: Container gadget for bottom side of split layout.

property center: Point#: Position of center of gadget.

children: _GadgetList#: The gadget’s children.

collides_gadget(other: Self) → bool#

Return true if other is within gadget’s bounding box.

Parameters:

otherGadget: Another gadget.

Returns:

bool: Whether other collides with gadget.

collides_point(point: Point) → bool#

Return true if point collides with visible portion of gadget.

Parameters:

pointPoint: A point.

Returns:

bool: Whether point collides with gadget.

property columns: int#: Width of gadget.

destroy() → None#: Remove this gadget and recursively remove all its children.

dispatch_key(key_event: KeyEvent) → bool | None#

Dispatch a key press event until handled.

A key press event is handled if a handler returns True.

Parameters:

key_eventKeyEvent: The key event to dispatch.

Returns:

bool | None: Whether the dispatch was handled.

dispatch_mouse(mouse_event: MouseEvent) → bool | None#

Dispatch a mouse event until handled.

A mouse event is handled if a handler returns True.

Parameters:

mouse_eventMouseEvent: The mouse event to dispatch.

Returns:

bool | None: Whether the dispatch was handled.

dispatch_paste(paste_event: PasteEvent) → bool | None#

Dispatch a paste event until handled.

A paste event is handled if a handler returns True.

Parameters:

paste_eventPasteEvent: The paste event to dispatch.

Returns:

bool | None: Whether the dispatch was handled.

dispatch_terminal_focus(focus_event: FocusEvent) → bool | None#

Dispatch a focus event until handled.

A focus event is handled if a handler returns True.

Parameters:

focus_eventFocusEvent: The focus event to dispatch.

Returns:

bool | None: Whether the dispatch was handled.

handle#: Grabbable handle gadget used to resize split layout.

property height: int#: Height of gadget.

property is_enabled: bool#: Whether gadget is enabled. A disabled gadget is not painted and doesn’t receive input events.

property is_transparent: bool#: Whether gadget is transparent.

property is_visible: bool#: Whether gadget is visible. Gadget will still receive input events if not visible.

property left: int#: x-coordinate of left side of gadget.

on_add() → None#: Update gadget after being added to the gadget tree.

on_key(key_event: KeyEvent) → bool | None#

Handle a key press event.

Handled key presses should return True.

Parameters:

key_eventKeyEvent: The key event to handle.

Returns:

bool | None: Whether the key event was handled.

on_mouse(mouse_event: MouseEvent) → bool | None#

Handle a mouse event.

Handled mouse events should return True.

Parameters:

mouse_eventMouseEvent: The mouse event to handle.

Returns:

bool | None: Whether the mouse event was handled.

on_paste(paste_event: PasteEvent) → bool | None#

Handle a paste event.

Handled paste events should return True.

Parameters:

paste_eventPasteEvent: The paste event to handle.

Returns:

bool | None: Whether the paste event was handled.

on_remove() → None#: Update gadget after being removed from the gadget tree.

on_size()#: Resize panes on resize.

on_terminal_focus(focus_event: FocusEvent) → bool | None#

Handle a focus event.

Handled focus events should return True.

Parameters:

focus_eventFocusEvent: The focus event to handle.

Returns:

bool | None: Whether the focus event was handled.

on_transparency() → None#: Update gadget after transparency is enabled/disabled.

parent: Gadget | None#: The gadget’s parent.

property pos: Point#: Position relative to parent.

property pos_hint: PosHint#: Gadget’s position as a proportion of its parent’s size.

prolicide() → None#: Recursively remove all children.

pull_to_front() → None#: Move gadget to end of gadget stack so that it is drawn last.

remove_gadget(gadget: Self) → None#

Remove a child gadget.

Parameters:

gadgetGadget: The gadget to remove from children.

property right: int#: x-coordinate of right side of gadget.

property root: Self | None#: Return the root gadget if connected to gadget tree.

property rows: int#: Height of gadget.

property size: Size#: Size of gadget.

property size_hint: SizeHint#: Gadget’s size as a proportion of its parent’s size.

split_anchor#: If gadget is resized, split_anchor determines which pane’s height isn’t changed.

property split_resizable: bool#: Whether split is resizable with a grabbable handle.

property split_row: int#: Height of top pane.

to_local(point: Point) → Point#

Convert point in absolute coordinates to local coordinates.

Parameters:

pointPoint: Point in absolute (screen) coordinates.

Returns:

Point: The point in local coordinates.

property top: int#: y-coordinate of top of gadget.

property top_min_height: int#: Minimum height of top pane.

top_pane#: Container gadget for top side of split layout.

async tween(*, duration: float = 1.0, easing: Literal['linear', 'in_quad', 'out_quad', 'in_out_quad', 'in_cubic', 'out_cubic', 'in_out_cubic', 'in_quart', 'out_quart', 'in_out_quart', 'in_quint', 'out_quint', 'in_out_quint', 'in_sine', 'out_sine', 'in_out_sine', 'in_exp', 'out_exp', 'in_out_exp', 'in_circ', 'out_circ', 'in_out_circ', 'in_elastic', 'out_elastic', 'in_out_elastic', 'in_back', 'out_back', 'in_out_back', 'in_bounce', 'out_bounce', 'in_out_bounce'] = 'linear', on_start: Callable[[], None] | None = None, on_progress: Callable[[float], None] | None = None, on_complete: Callable[[], None] | None = None, **properties: Real | ndarray[Any, dtype[number]] | Sequence[Real] | PosHint | SizeHint) → None#

Coroutine that sequentially updates gadget properties over a duration (in seconds).

Parameters:

durationfloat, default: 1.0: The duration of the tween in seconds.
easingEasing, default: “linear”: The easing used for tweening.
on_startCallable[[], None] | None, default: None: Called when tween starts.
on_progressCallable[[float], None] | None, default: None: Called as tween updates with current progress.
on_completeCallable[[], None] | None, default: None: Called when tween completes.
**propertiesReal | NDArray[np.number] | Sequence[Real] | PosHint | SizeHint: Gadget properties’ target values. E.g., to smoothly tween a gadget’s position to (5, 10) over 2.5 seconds, specify the pos property as a keyword-argument: await gadget.tween(pos=(5, 10), duration=2.5, easing="out_bounce")

Warning

Running several tweens on the same properties concurrently will probably result in unexpected behavior.

Notes

Tweened values will be coerced to match the type of the initial value of their corresponding property.

Non-numeric values will be set immediately.

unbind(uid: int) → None#

Unbind a callback from a gadget property.

Parameters:

uidint: Unique id returned by the bind() method.

walk() → Iterator[Self]#

Yield all descendents of this gadget (preorder traversal).

Yields:

Gadget: A descendent of this gadget.

walk_reverse() → Iterator[Self]#

Yield all descendents of this gadget (reverse postorder traversal).

Yields:

Gadget: A descendent of this gadget.

property width: int#: Width of gadget.

property x: int#: x-coordinate of left side of gadget.

property y: int#: y-coordinate of top of gadget.

class batgrl.gadgets.split_layout.VSplitLayout(split_col: int = 1, split_anchor: Literal['left', 'right'] = 'left', split_resizable: bool = True, left_min_width: int = 1, right_min_width: int = 1, size: Size = (10, 10), pos: Point = (0, 0), size_hint: SizeHint | None = None, pos_hint: PosHint | None = None, is_transparent: bool = False, is_visible: bool = True, is_enabled: bool = True)#

Bases: Gadget

A vertical split layout.

Add gadgets to the :attr:left_pane or :attr:right_pane, e.g., my_vsplit.left_pane.add_gadget(my_gadget).

If :attr:left_min_width and :attr:right_min_width can’t both be satisfied, :attr:split_anchor will determine which pane’s width requirement is preferred.

Parameters:

split_colint, default: 1: Width of left pane. Height of right pane is self.width - split_col.
split_anchorLiteral[“left”, “right”], default: “left”: If gadget is resized, split_anchor determines which pane’s width isn’t changed.
split_resizablebool, default: True: Whether split is resizable with a grabbable handle.
left_min_widthint, default: 1: Minimum width of left pane.
right_min_widthint, default: 1: Minimum width of right pane.
sizeSize, default: Size(10, 10): Size of gadget.
posPoint, default: Point(0, 0): Position of upper-left corner in parent.
size_hintSizeHint | None, default: None: Size as a proportion of parent’s height and width.
pos_hintPosHint | None, default: None: Position as a proportion of parent’s height and width.
is_transparentbool, default: False: Whether gadget is transparent.
is_visiblebool, default: True: Whether gadget is visible. Gadget will still receive input events if not visible.
is_enabledbool, default: True: Whether gadget is enabled. A disabled gadget is not painted and doesn’t receive input events.

Attributes:

left_paneGadget: Container gadget for left side of split layout.
right_paneGadget: Container gadget for right side of split layout.
split_colint: Width of left pane.
split_anchorLiteral[“left”, “right”]: If gadget is resized, split_anchor determines which pane’s width isn’t changed.
split_resizablebool: Whether split is resizable with a grabbable handle.
left_min_widthint: Minimum width of left pane.
right_min_widthint: Minimum width of right pane.
sizeSize: Size of gadget.
heightint: Height of gadget.
rowsint: Height of gadget.
widthint: Width of gadget.
columnsint: Width of gadget.
posPoint: Position relative to parent.
topint: y-coordinate of top of gadget.
yint: y-coordinate of top of gadget.
leftint: x-coordinate of left side of gadget.
xint: x-coordinate of left side of gadget.
bottomint: y-coordinate of bottom of gadget.
rightint: x-coordinate of right side of gadget.
centerPoint: Position of center of gadget.
absolute_posPoint: Absolute position on screen.
size_hintSizeHint: Gadget’s size as a proportion of its parent’s size.
pos_hintPosHint: Gadget’s position as a proportion of its parent’s size.
parent: Gadget | None: Parent gadget.
childrenlist[Gadget]: Children gadgets.
is_transparentbool: Whether gadget is transparent.
is_visiblebool: Whether gadget is visible.
is_enabledbool: Whether gadget is enabled.
rootGadget | None: Return the root gadget if connected to gadget tree.
appApp: The running app.

Methods

apply_hints()	Apply size and pos hints.
to_local(point)	Convert point in absolute coordinates to local coordinates.
collides_point(point)	Return true if point collides with visible portion of gadget.
collides_gadget(other)	Return true if other is within gadget’s bounding box.
pull_to_front()	Move to end of gadget stack so gadget is drawn last.
walk()	Yield all descendents of this gadget (preorder traversal).
walk_reverse()	Yield all descendents of this gadget (reverse postorder traversal).
ancestors()	Yield all ancestors of this gadget.
add_gadget(gadget)	Add a child gadget.
*add_gadgets(gadgets)**	Add multiple child gadgets.
remove_gadget(gadget)	Remove a child gadget.
prolicide()	Recursively remove all children.
destroy()	Remove this gadget and recursively remove all its children.
bind(prop, callback)	Bind callback to a gadget property.
unbind(uid)	Unbind a callback from a gadget property.
tween(…)	Sequentially update gadget properties over time.
on_size()	Update gadget after a resize.
on_transparency()	Update gadget after transparency is enabled/disabled.
on_add()	Update gadget after being added to the gadget tree.
on_remove()	Update gadget after being removed from the gadget tree.
on_key(key_event)	Handle a key press event.
on_mouse(mouse_event)	Handle a mouse event.
on_paste(paste_event)	Handle a paste event.
on_terminal_focus(focus_event)	Handle a focus event.

property absolute_pos: Point | None#: Absolute position on screen.

add_gadget(gadget: Self) → None#

Add a child gadget.

Parameters:

gadgetGadget: A gadget to add as a child.

add_gadgets(*gadgets: Self) → None#

Add multiple child gadgets.

Parameters:

*gadgetsGadget: Gadgets to add as children. Can also accept a single iterable of gadgets.

ancestors() → Iterator[Self]#

Yield all ancestors of this gadget.

Yields:

Gadget: An ancestor of this gadget.

property app#: The running app.

apply_hints() → None#

Apply size and pos hints.

This is called automatically when the gadget is added to the gadget tree and when the gadget’s parent’s size changes.

bind(prop: str, callback: Callable[[], None]) → int#

Bind callback to a gadget property. When the property is updated, callback is called with no arguments.

Parameters:

propstr: The name of the gadget property.
callbackCallable[[], None]: Callback to bind to property.

Returns:

int: A unique id used to unbind the callback.

property bottom: int#: y-coordinate of bottom of gadget.

property center: Point#: Position of center of gadget.

children: _GadgetList#: The gadget’s children.

collides_gadget(other: Self) → bool#

Return true if other is within gadget’s bounding box.

Parameters:

otherGadget: Another gadget.

Returns:

bool: Whether other collides with gadget.

collides_point(point: Point) → bool#

Return true if point collides with visible portion of gadget.

Parameters:

pointPoint: A point.

Returns:

bool: Whether point collides with gadget.

property columns: int#: Width of gadget.

destroy() → None#: Remove this gadget and recursively remove all its children.

dispatch_key(key_event: KeyEvent) → bool | None#

Dispatch a key press event until handled.

A key press event is handled if a handler returns True.

Parameters:

key_eventKeyEvent: The key event to dispatch.

Returns:

bool | None: Whether the dispatch was handled.

dispatch_mouse(mouse_event: MouseEvent) → bool | None#

Dispatch a mouse event until handled.

A mouse event is handled if a handler returns True.

Parameters:

mouse_eventMouseEvent: The mouse event to dispatch.

Returns:

bool | None: Whether the dispatch was handled.

dispatch_paste(paste_event: PasteEvent) → bool | None#

Dispatch a paste event until handled.

A paste event is handled if a handler returns True.

Parameters:

paste_eventPasteEvent: The paste event to dispatch.

Returns:

bool | None: Whether the dispatch was handled.

dispatch_terminal_focus(focus_event: FocusEvent) → bool | None#

Dispatch a focus event until handled.

A focus event is handled if a handler returns True.

Parameters:

focus_eventFocusEvent: The focus event to dispatch.

Returns:

bool | None: Whether the dispatch was handled.

handle#: Grabbable handle gadget used to resize split layout.

property height: int#: Height of gadget.

property is_enabled: bool#: Whether gadget is enabled. A disabled gadget is not painted and doesn’t receive input events.

property is_transparent: bool#: Whether gadget is transparent.

property is_visible: bool#: Whether gadget is visible. Gadget will still receive input events if not visible.

property left: int#: x-coordinate of left side of gadget.

property left_min_width: int#: Minimum width of left pane.

left_pane#: Container gadget for left side of split layout.

on_add() → None#: Update gadget after being added to the gadget tree.

on_key(key_event: KeyEvent) → bool | None#

Handle a key press event.

Handled key presses should return True.

Parameters:

key_eventKeyEvent: The key event to handle.

Returns:

bool | None: Whether the key event was handled.

on_mouse(mouse_event: MouseEvent) → bool | None#

Handle a mouse event.

Handled mouse events should return True.

Parameters:

mouse_eventMouseEvent: The mouse event to handle.

Returns:

bool | None: Whether the mouse event was handled.

on_paste(paste_event: PasteEvent) → bool | None#

Handle a paste event.

Handled paste events should return True.

Parameters:

paste_eventPasteEvent: The paste event to handle.

Returns:

bool | None: Whether the paste event was handled.

on_remove() → None#: Update gadget after being removed from the gadget tree.

on_size()#: Resize panes on resize.

on_terminal_focus(focus_event: FocusEvent) → bool | None#

Handle a focus event.

Handled focus events should return True.

Parameters:

focus_eventFocusEvent: The focus event to handle.

Returns:

bool | None: Whether the focus event was handled.

on_transparency() → None#: Update gadget after transparency is enabled/disabled.

parent: Gadget | None#: The gadget’s parent.

property pos: Point#: Position relative to parent.

property pos_hint: PosHint#: Gadget’s position as a proportion of its parent’s size.

prolicide() → None#: Recursively remove all children.

pull_to_front() → None#: Move gadget to end of gadget stack so that it is drawn last.

remove_gadget(gadget: Self) → None#

Remove a child gadget.

Parameters:

gadgetGadget: The gadget to remove from children.

property right: int#: x-coordinate of right side of gadget.

property right_min_width: int#: Minimum width of right pane.

right_pane#: Container gadget for right side of split layout.

property root: Self | None#: Return the root gadget if connected to gadget tree.

property rows: int#: Height of gadget.

property size: Size#: Size of gadget.

property size_hint: SizeHint#: Gadget’s size as a proportion of its parent’s size.

split_anchor#: If gadget is resized, split_anchor determines which pane’s width isn’t changed.

property split_col: int#: Width of left pane.

property split_resizable: bool#: Whether split is resizable with a grabbable handle.

to_local(point: Point) → Point#

Convert point in absolute coordinates to local coordinates.

Parameters:

pointPoint: Point in absolute (screen) coordinates.

Returns:

Point: The point in local coordinates.

property top: int#: y-coordinate of top of gadget.

Coroutine that sequentially updates gadget properties over a duration (in seconds).

Parameters:

durationfloat, default: 1.0: The duration of the tween in seconds.
easingEasing, default: “linear”: The easing used for tweening.
on_startCallable[[], None] | None, default: None: Called when tween starts.
on_progressCallable[[float], None] | None, default: None: Called as tween updates with current progress.
on_completeCallable[[], None] | None, default: None: Called when tween completes.
**propertiesReal | NDArray[np.number] | Sequence[Real] | PosHint | SizeHint: Gadget properties’ target values. E.g., to smoothly tween a gadget’s position to (5, 10) over 2.5 seconds, specify the pos property as a keyword-argument: await gadget.tween(pos=(5, 10), duration=2.5, easing="out_bounce")

Warning

Running several tweens on the same properties concurrently will probably result in unexpected behavior.

Notes

Tweened values will be coerced to match the type of the initial value of their corresponding property.

Non-numeric values will be set immediately.

unbind(uid: int) → None#

Unbind a callback from a gadget property.

Parameters:

uidint: Unique id returned by the bind() method.

walk() → Iterator[Self]#

Yield all descendents of this gadget (preorder traversal).

Yields:

Gadget: A descendent of this gadget.

walk_reverse() → Iterator[Self]#

Yield all descendents of this gadget (reverse postorder traversal).

Yields:

Gadget: A descendent of this gadget.

property width: int#: Width of gadget.

property x: int#: x-coordinate of left side of gadget.

property y: int#: y-coordinate of top of gadget.