Raxol.Terminal.Emulator.Window (Raxol v0.4.0)
View SourceHandles window management for the terminal emulator. Provides functions for window state, manipulation, and properties.
Summary
Functions
Deiconifies the window. Returns {:ok, updated_emulator}.
Gets the current window state. Returns the window state.
Iconifies the window. Returns {:ok, updated_emulator}.
Maximizes the window. Returns {:ok, updated_emulator}.
Restores the window from maximized state. Returns {:ok, updated_emulator}.
Sets the window icon name. Returns {:ok, updated_emulator}.
Sets the window position. Returns {:ok, updated_emulator}.
Sets the window size. Returns {:ok, updated_emulator}.
Sets the window stacking order. Returns {:ok, updated_emulator}.
Sets the window title. Returns {:ok, updated_emulator}.
Functions
@spec deiconify(Raxol.Terminal.Emulator.t()) :: {:ok, Raxol.Terminal.Emulator.t()}
Deiconifies the window. Returns {:ok, updated_emulator}.
@spec get_state(Raxol.Terminal.Emulator.t()) :: map()
Gets the current window state. Returns the window state.
@spec iconify(Raxol.Terminal.Emulator.t()) :: {:ok, Raxol.Terminal.Emulator.t()}
Iconifies the window. Returns {:ok, updated_emulator}.
@spec maximize(Raxol.Terminal.Emulator.t()) :: {:ok, Raxol.Terminal.Emulator.t()}
Maximizes the window. Returns {:ok, updated_emulator}.
@spec restore(Raxol.Terminal.Emulator.t()) :: {:ok, Raxol.Terminal.Emulator.t()}
Restores the window from maximized state. Returns {:ok, updated_emulator}.
@spec set_icon_name(Raxol.Terminal.Emulator.t(), String.t()) :: {:ok, Raxol.Terminal.Emulator.t()}
Sets the window icon name. Returns {:ok, updated_emulator}.
@spec set_position(Raxol.Terminal.Emulator.t(), non_neg_integer(), non_neg_integer()) :: {:ok, Raxol.Terminal.Emulator.t()}
Sets the window position. Returns {:ok, updated_emulator}.
@spec set_size(Raxol.Terminal.Emulator.t(), non_neg_integer(), non_neg_integer()) :: {:ok, Raxol.Terminal.Emulator.t()}
Sets the window size. Returns {:ok, updated_emulator}.
@spec set_stacking_order( Raxol.Terminal.Emulator.t(), :normal | :maximized | :iconified ) :: {:ok, Raxol.Terminal.Emulator.t()}
Sets the window stacking order. Returns {:ok, updated_emulator}.
@spec set_title(Raxol.Terminal.Emulator.t(), String.t()) :: {:ok, Raxol.Terminal.Emulator.t()}
Sets the window title. Returns {:ok, updated_emulator}.