Struct imgui::ChildWindow[][src]

pub struct ChildWindow<'a> { /* fields omitted */ }
Expand description

Builder for a child window

Implementations

Creates a new child window builder with the given ID

Replace current window flags with the given value

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)

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.

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

Sets the background color alpha value.

See also draw_background

Enables/disables the child window border.

Disabled by default.

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

Enabled by default.

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

Enabled by default.

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.

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

Disabled by default.

Enables/disables drawing of background color and outside border.

Enabled by default.

Enables/disables catching mouse input.

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

Enables/disables the menu bar.

Disabled by default.

Enables/disables the horizontal scrollbar.

Disabled by default.

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

Enabled by default.

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

Enabled by default.

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

Disabled by default.

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

Disabled by default.

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

Disabled by default.

Enables/disables gamepad/keyboard navigation within the window.

Enabled by default.

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

Enabled by default.

Disable gamepad/keyboard navigation and focusing.

Shorthand for

.nav_inputs(false)
.nav_focus(false)

Don’t handle input.

Shorthand for

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

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.

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

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Performs the conversion.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.