Struct WindowKey 

pub struct WindowKey { /* private fields */ }

Stable Dear ImGui identity for a top-level window.

A key stores a default displayed title separately from the identity used by docking and INI persistence. Use the same key in DockLayout and Ui::window so a displayed-title change cannot silently create a different native window.

let scene = WindowKey::new("scene", "Scene")?;
let layout = DockLayout::tabs([&scene]);

ui.window(scene.label("Scene (Debug)"))
    .build(|| ui.text("The stable identity is still `scene`."));

Implementations

impl WindowKey

pub fn new( stable_id: impl Into<String>, default_title: impl Into<String>, ) -> Result<Self, WindowKeyError>

Create a validated stable identity and its default displayed title.

pub fn stable_id(&self) -> &str

Return the stable identity string.

pub fn default_title(&self) -> &str

Return the default displayed title.

pub fn label<'a>(&'a self, title: impl Into<Cow<'a, str>>) -> WindowLabel<'a>

Use a different displayed title without changing the stable identity.

Trait Implementations

impl Clone for WindowKey

fn clone(&self) -> WindowKey

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WindowKey

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for WindowKey

impl<'a> From<&'a WindowKey> for WindowLabel<'a>

fn from(key: &'a WindowKey) -> Self

Converts to this type from the input type.

impl From<&WindowKey> for WindowKey

fn from(key: &WindowKey) -> Self

Converts to this type from the input type.

impl Hash for WindowKey

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for WindowKey

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.