Struct WindowClass 

pub struct WindowClass { /* private fields */ }

Window class for docking configuration.

Native pointer fields are intentionally private so safe code cannot bypass their lifetime contracts.

let mut class = WindowClass::default();
class.platform_icon_data = None;

Implementations

impl WindowClass

pub fn new(class_id: Id) -> Self

Creates a new window class with the specified class ID

pub fn class_id(&self) -> Option<Id>

Returns the user class ID, or None for the default unclassed class.

pub fn parent_viewport_policy(&self) -> WindowClassParentViewport

Returns the platform parent viewport policy.

pub fn focus_route_parent_window_id_raw(&self) -> Option<Id>

Returns the raw focus-route parent window ID, when configured.

pub fn viewport_flags_to_set(&self) -> WindowClassViewportFlags

Returns the viewport flags this class sets.

pub fn viewport_flags_to_clear(&self) -> WindowClassViewportFlags

Returns the viewport flags this class clears.

pub fn tab_item_options(&self) -> TabItemOptions

Returns the tab item options this class applies.

pub fn dock_node_flags_to_set(&self) -> WindowClassDockNodeFlags

Returns the dock node flags this class applies.

pub fn always_tab_bar(&self) -> bool

Returns whether single floating windows always receive a tab bar.

pub fn allows_unclassed(&self) -> bool

Returns whether this class may dock with unclassed windows.

pub unsafe fn parent_viewport(self, parent: WindowClassParentViewport) -> Self

Sets the raw parent viewport policy.

Safety

For WindowClassParentViewport::Parent, the target viewport must be live when the window begins, belong to the same Context, and the resulting parent graph must contain no self-edge or cycle. Dear ImGui stores a raw parent pointer and traverses it without cycle detection. The Default and NoParent policies satisfy these requirements inherently.

pub fn no_parent_viewport(self) -> Self

Requests the platform backend to avoid parenting this class’s platform windows.

pub unsafe fn parent_viewport_id(self, id: Id) -> Self

Requests a specific raw parent viewport ID.

Safety

The target viewport must be live when the window begins, belong to the same Context, and the resulting parent graph must contain no self-edge or cycle.

let class = WindowClass::default().parent_viewport_id(Id::from(1u32));

pub unsafe fn focus_route_parent_window_id(self, id: Id) -> Self

Sets the raw focus-route parent window ID.

Safety

A window with id must already exist when a window using this class begins. The resulting focus route must not contain a cycle and the class must not be applied to the parent window itself. Dear ImGui assumes these conditions and may dereference the resolved parent without checking it in non-assert builds.

let class = WindowClass::default().focus_route_parent_window_id(Id::from(1u32));

pub fn viewport_flags_override_set( self, flags: WindowClassViewportFlags, ) -> Self

Sets viewport flags when a window of this class owns a viewport.

pub fn viewport_flags_override_clear( self, flags: WindowClassViewportFlags, ) -> Self

Clears viewport flags when a window of this class owns a viewport.

pub fn viewport_flags_overrides( self, set: WindowClassViewportFlags, clear: WindowClassViewportFlags, ) -> Self

Sets and clears viewport flags when a window of this class owns a viewport.

pub fn tab_item_flags_override_set( self, options: impl Into<TabItemOptions>, ) -> Self

Sets tab item flags when a window of this class is submitted into a dock node tab bar.

pub fn dock_node_flags_override_set( self, flags: WindowClassDockNodeFlags, ) -> Self

Sets dock node flags when a window of this class is hosted by a dock node.

pub fn docking_always_tab_bar(self, enabled: bool) -> Self

Enables always showing tab bar for single floating windows

pub fn docking_allow_unclassed(self, enabled: bool) -> Self

Allows docking with unclassed windows

pub unsafe fn platform_icon_data_raw(self, data: *mut c_void) -> Self

Sets opaque icon data consumed by the platform backend.

Safety

data must remain valid for as long as the platform backend may read it, and it must point to the representation expected by that backend.

pub fn validate(&self) -> Result<(), WindowClassError>

Validate every typed override without touching Dear ImGui state.

Trait Implementations

impl Clone for WindowClass

fn clone(&self) -> WindowClass

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WindowClass

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

Formats the value using the given formatter.

impl Default for WindowClass

fn default() -> Self

Returns the “default value” for a type.