Struct imgui::ChildWindow

pub struct ChildWindow<'ui> { /* private fields */ }

Builder for a child window

Implementations

impl<'ui> ChildWindow<'ui>

pub fn new(ui: &'ui Ui, name: impl AsRef<str>) -> Self

👎Deprecated since 0.9.0: use ui.child_window(…) instead

Creates a new child window builder with the str.

pub fn new_id(ui: &'ui Ui, id: Id) -> Self

Creates a new child window builder with the given imgui id.

pub fn flags(self, flags: WindowFlags) -> Self

Replace current window flags with the given value

pub fn size(self, size: impl Into<Vector2<f32>>) -> Self

Sets the child window size.

For each independent axis of size:

• > 0.0: fixed size
• = 0.0: use remaining host window size
• < 0.0: use remaining host window size minus abs(size)

pub fn content_size(self, size: impl Into<Vector2<f32>>) -> Self

Sets the window content size, which can be used to enforce scrollbars.

Does not include window decorations (title bar, menu bar, etc.). Set one of the values to 0.0 to leave the size automatic.

pub fn focused(self, focused: bool) -> Self

Sets the window focused state, which can be used to bring the window to front

pub fn bg_alpha(self, bg_alpha: f32) -> Self

Sets the background color alpha value.

See also draw_background

pub fn border(self, border: bool) -> Self

Enables/disables the child window border.

Disabled by default.

pub fn movable(self, value: bool) -> Self

Enables/disables moving the window when child window is dragged.

Enabled by default.

pub fn scroll_bar(self, value: bool) -> Self

Enables/disables scrollbars (scrolling is still possible with the mouse or programmatically).

Enabled by default.

pub fn scrollable(self, value: bool) -> Self

Enables/disables vertical scrolling with the mouse wheel.

Enabled by default. When enabled, child windows forward the mouse wheel to the parent unless NO_SCROLLBAR is also set.

pub fn always_auto_resize(self, value: bool) -> Self

Enables/disables resizing the window to its content on every frame.

Disabled by default.

pub fn draw_background(self, value: bool) -> Self

Enables/disables drawing of background color and outside border.

Enabled by default.

pub fn mouse_inputs(self, value: bool) -> Self

Enables/disables catching mouse input.

Enabled by default. Note: Hovering test will pass through when disabled

pub fn menu_bar(self, value: bool) -> Self

Enables/disables the menu bar.

Disabled by default.

pub fn horizontal_scrollbar(self, value: bool) -> Self

Enables/disables the horizontal scrollbar.

Disabled by default.

pub fn focus_on_appearing(self, value: bool) -> Self

Enables/disables taking focus when transitioning from hidden to visible state.

Enabled by default.

pub fn bring_to_front_on_focus(self, value: bool) -> Self

Enables/disables bringing the window to front when taking focus (e.g. clicking it or programmatically giving it focus).

Enabled by default.

pub fn always_vertical_scrollbar(self, value: bool) -> Self

When enabled, forces the vertical scrollbar to render regardless of the content size.

Disabled by default.

pub fn always_horizontal_scrollbar(self, value: bool) -> Self

When enabled, forces the horizontal scrollbar to render regardless of the content size.

Disabled by default.

pub fn always_use_window_padding(self, value: bool) -> Self

When enabled, ensures child windows without border use style.window_padding.

Disabled by default.

pub fn nav_inputs(self, value: bool) -> Self

Enables/disables gamepad/keyboard navigation within the window.

Enabled by default.

pub fn nav_focus(self, value: bool) -> Self

Enables/disables focusing toward this window with gamepad/keyboard navigation (e.g. CTRL+TAB).

Enabled by default.

pub fn no_nav(self) -> Self

Disable gamepad/keyboard navigation and focusing.

Shorthand for

.nav_inputs(false)
.nav_focus(false)

pub fn no_inputs(self) -> Self

Don’t handle input.

Shorthand for

.mouse_inputs(false)
.nav_inputs(false)
.nav_focus(false)

pub fn begin(self) -> Option<ChildWindowToken<'ui>>

Creates a child window and starts append to it.

Returns Some(ChildWindowToken) if the window is visible. After content has been rendered, the token must be ended by calling .end().

Returns None if the window is not visible and no content should be rendered.

pub fn build<T, F: FnOnce() -> T>(self, f: F) -> Option<T>

Creates a child window and runs a closure to construct the contents. Returns the result of the closure, if it is called.

Note: the closure is not called if no window content is visible (e.g. window is collapsed or fully clipped).

Trait Implementations

impl<'ui> Clone for ChildWindow<'ui>

fn clone(&self) -> ChildWindow<'ui>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'ui> Debug for ChildWindow<'ui>

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

Formats the value using the given formatter.

impl<'ui> Copy for ChildWindow<'ui>