TermUI.Focus.Tracker (TermUI v0.2.0)

Focus state tracker with action registration.

Maintains focus state and executes registered actions when focus changes. Supports optimization hooks for reducing work when the application is backgrounded.

Usage

{:ok, tracker} = Focus.Tracker.start_link()

# Register focus actions
Focus.Tracker.on_focus_lost(tracker, fn ->
  save_state()
end)

Focus.Tracker.on_focus_gained(tracker, fn ->
  refresh_content()
end)

# Update focus state
Focus.Tracker.set_focus(tracker, true)

# Query focus state
Focus.Tracker.has_focus?(tracker)

Summary

Types

t()

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

clear_actions(tracker)

Clears all registered actions.

enable_auto_pause(tracker)

Enables automatic pause when focus is lost.

enable_auto_reduce_framerate(tracker)

Enables automatic framerate reduction when focus is lost.

has_focus?(tracker)

Returns true if the application has focus.

on_focus_gained(tracker, action)

Registers an action to execute when focus is gained.

on_focus_lost(tracker, action)

Registers an action to execute when focus is lost.

paused?(tracker)

Returns true if animations should be paused.

reduced_framerate?(tracker)

Returns true if framerate should be reduced.

set_focus(tracker, focused)

Sets the focus state.

set_paused(tracker, paused)

Sets the paused state manually.

set_reduced_framerate(tracker, reduced)

Sets the reduced framerate state manually.

start_link(opts \\ [])

Starts the focus tracker.

Types

t()

@type t() :: %TermUI.Focus.Tracker{
  auto_pause: boolean(),
  auto_reduce_framerate: boolean(),
  has_focus: boolean(),
  on_gained: [(-> any())],
  on_lost: [(-> any())],
  paused: boolean(),
  reduced_framerate: boolean()
}

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

clear_actions(tracker)

@spec clear_actions(GenServer.server()) :: :ok

Clears all registered actions.

enable_auto_pause(tracker)

@spec enable_auto_pause(GenServer.server()) :: :ok

Enables automatic pause when focus is lost.

enable_auto_reduce_framerate(tracker)

@spec enable_auto_reduce_framerate(GenServer.server()) :: :ok

Enables automatic framerate reduction when focus is lost.

has_focus?(tracker)

@spec has_focus?(GenServer.server()) :: boolean()

Returns true if the application has focus.

on_focus_gained(tracker, action)

@spec on_focus_gained(GenServer.server(), (-> any())) :: :ok

Registers an action to execute when focus is gained.

on_focus_lost(tracker, action)

@spec on_focus_lost(GenServer.server(), (-> any())) :: :ok

Registers an action to execute when focus is lost.

paused?(tracker)

@spec paused?(GenServer.server()) :: boolean()

Returns true if animations should be paused.

This is set when focus is lost and auto_pause is enabled.

reduced_framerate?(tracker)

@spec reduced_framerate?(GenServer.server()) :: boolean()

Returns true if framerate should be reduced.

This is set when focus is lost and auto_reduce_framerate is enabled.

set_focus(tracker, focused)

@spec set_focus(GenServer.server(), boolean()) :: :ok

Sets the focus state.

set_paused(tracker, paused)

@spec set_paused(GenServer.server(), boolean()) :: :ok

Sets the paused state manually.

set_reduced_framerate(tracker, reduced)

@spec set_reduced_framerate(GenServer.server(), boolean()) :: :ok

Sets the reduced framerate state manually.

start_link(opts \\ [])

@spec start_link(keyword()) :: GenServer.on_start()

Starts the focus tracker.