batgrl.gadgets.toggle_button#

A toggle button gadget.

Classes

ToggleButton(*[, label, callback, alpha, ...])

A toggle button gadget.

class batgrl.gadgets.toggle_button.ToggleButton(*, label: str = '', callback: Callable[[Literal['on', 'off']], None] | None = None, alpha: float = 1.0, group: None | Hashable = None, allow_no_selection: bool = False, always_release: bool = False, 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: Themable, ToggleButtonBehavior, Gadget

A toggle button gadget.

Without a group, a toggle button acts like a checkbox. With a group, it behaves like a radio button (only a single button in a group is allowed to be in the “on” state).

Parameters:

labelstr, default: “”: Toggle button label.
callbackCallable[[ToggleState], None] | None, default: None: Called when toggle state changes. The new state is provided as first argument.
alphafloat, default: 1.0: Transparency of gadget.
groupHashable | None, default: None: If a group is provided, only one button in a group can be in the on state.
allow_no_selectionbool, default: False: If a group is provided, setting this to true allows no selection, i.e., every button can be in the off state.
always_releasebool, default: False: Whether a mouse up event outside the button will trigger it.
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:

labelstr: Toggle button label.
callbackCallable[[ToggleState], None] | None: Called when toggle state changes.
alphafloat: Transparency of gadget.
groupHashable | None: If a group is provided, only one button in a group can be in the on state.
allow_no_selectionbool: If true and button is in a group, every button can be in the off state.
toggle_stateToggleState: Toggle state of button.
always_releasebool: Whether a mouse up event outside the button will trigger it.
button_stateButtonState: Current button state.
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

update_theme()	Paint the gadget with current theme.
on_toggle()	Triggled on toggle state change.
update_off()	Paint the off state.
update_on()	Paint the on state.
on_release()	Triggered when a button is released.
update_normal()	Paint the normal state.
update_hover()	Paint the hover state.
update_down()	Paint the down state.
update_disallowed()	Paint the disallowed state.
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.

property alpha: float#: Transparency of gadget.

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 button_state: Literal['normal', 'hover', 'down', 'disallowed']#: Current button state.

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.

color_theme: _ColorTheme#

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.

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 label: str#: Toggle button label.

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

on_add()#: Update theme.

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) → bool | None#: Determine button state from mouse event.

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_release()#: Triggered when button is released.

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

on_size() → None#: Update gadget after a 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_toggle()#: Call callback on toggle state change.

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.

classmethod set_theme(color_theme: ColorTheme)#: Set color theme.

property size: Size#: Size of gadget.

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

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 toggle_state: Literal['on', 'off']#: Toggle state of button.

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

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.

update_disallowed()#: Paint the disallowed state.

update_down()#: Paint the down state.

update_hover()#: Paint the hover state.

update_normal()#: Paint the normal state.

update_off()#: Paint the off state.

update_on()#: Paint the on state.

update_theme()#: Paint the gadget with current theme.

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.