Struct SystemWindowTabController 

pub struct SystemWindowTabController { /* private fields */ }

A global that tracks which windows are grouped into native window tabs.

Stored as a Global. Call SystemWindowTabController::init once at startup. The methods that take cx read and update this global.

Implementations

impl SystemWindowTabController

pub fn new() -> Self

Creates an empty controller with no tab groups and tabs hidden.

pub fn init(cx: &mut App)

Sets the global SystemWindowTabController to a new, empty controller.

pub fn tab_groups(&self) -> &FxHashMap<usize, Vec<SystemWindowTab>>

Returns every tab group, keyed by group ID.

pub fn get_next_tab_group_window( cx: &mut App, id: WindowId, ) -> Option<&AnyWindowHandle>

Returns the handle of the window in the tab group that follows the group containing id in the iteration order of tab_groups. That order is arbitrary.

The window chosen is the most recently active tab in that group. Returns None if id is not in a group.

pub fn get_prev_tab_group_window( cx: &mut App, id: WindowId, ) -> Option<&AnyWindowHandle>

Returns the handle of the window in the tab group that precedes the group containing id in the iteration order of tab_groups. That order is arbitrary.

The window chosen is the most recently active tab in that group. Returns None if id is not in a group.

pub fn tabs(&self, id: WindowId) -> Option<&Vec<SystemWindowTab>>

Returns the tabs in the group that contains the window id, or None if it has none.

pub fn init_visible(cx: &mut App, visible: bool)

Sets tab visibility to visible, but only if it has not been set yet.

pub fn is_visible(&self) -> bool

Returns whether window tabs are shown. Defaults to false until set.

pub fn set_visible(cx: &mut App, visible: bool)

Shows or hides window tabs.

pub fn update_last_active(cx: &mut App, id: WindowId)

Records that the window id is now the active tab, for ordering tab groups.

pub fn update_tab_position(cx: &mut App, id: WindowId, ix: usize)

Moves the tab for window id to index ix within its group.

Does nothing if ix is out of range or the tab is already there.

pub fn update_tab_title(cx: &mut App, id: WindowId, title: SharedString)

Sets the title of the tab for window id. Does nothing if the title is unchanged.

pub fn add_tab(cx: &mut App, id: WindowId, tabs: Vec<SystemWindowTab>)

Adds the window id to the group that holds the other tabs in tabs.

If no existing group holds exactly the other tabs, tabs becomes a new group. Does nothing if tabs does not contain id.

pub fn remove_tab(cx: &mut App, id: WindowId) -> Option<SystemWindowTab>

Removes the tab for window id from its group and returns it.

A group that becomes empty is removed. Returns None if id is in no group.

pub fn move_tab_to_new_window(cx: &mut App, id: WindowId)

Moves the tab for window id out of its group into a new group of its own.

pub fn merge_all_windows(cx: &mut App, id: WindowId)

Merges every tab group into one group, starting with the group that holds id.

pub fn select_next_tab(cx: &mut App, id: WindowId)

Activates the tab after window id’s tab in its group, wrapping around at the end.

pub fn select_previous_tab(cx: &mut App, id: WindowId)

Activates the tab before window id’s tab in its group, wrapping around at the start.

Trait Implementations

impl Default for SystemWindowTabController

fn default() -> Self

Returns the “default value” for a type.

impl Global for SystemWindowTabController