Struct imgui::CollapsingHeader

pub struct CollapsingHeader<T> { /* fields omitted */ }

Builder for a collapsing header widget

Implementations

impl<T: AsRef<str>> CollapsingHeader<T>

pub fn new(label: T) -> CollapsingHeader<T>

Constructs a new collapsing header builder

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

Replaces all current settings with the given flags.

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

Enables/disables allowing the collapsing header to overlap subsequent widgets.

Disabled by default.

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

Sets the default open state for the collapsing header.

Collapsing headers are closed by default.

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

Only open when the collapsing header is double-clicked.

Disabled by default.

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

Only open when clicking the arrow part of the collapsing header.

Disabled by default.

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

Enable/disables leaf mode (no collapsing, no arrow).

Disabled by default.

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

Display a bullet instead of arrow.

Disabled by default.

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

Use frame_padding to vertically align text baseline to regular widget height.

Disabled by default.

pub fn begin(self, ui: &Ui<'_>) -> bool

Begins the collapsing header.

Returns true if the collapsing header is open and content should be rendered.

This is the same as build but is provided for consistent naming.

pub fn begin_with_close_button(self, ui: &Ui<'_>, opened: &mut bool) -> bool

Begins the collapsing header.

Returns true if the collapsing header is open and content should be rendered.

This is the same as build_with_close_button but is provided for consistent naming.

pub fn build(self, ui: &Ui<'_>) -> bool

Builds the collapsing header.

Returns true if the collapsing header is open and content should be rendered.

pub fn build_with_close_button(self, ui: &Ui<'_>, opened: &mut bool) -> bool

Builds the collapsing header, and adds an additional close button that changes the value of the given mutable reference when clicked.

Returns true if the collapsing header is open and content should be rendered.

Trait Implementations

impl<T: Clone> Clone for CollapsingHeader<T>

fn clone(&self) -> CollapsingHeader<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for CollapsingHeader<T>

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

Formats the value using the given formatter.

impl<T: Copy> Copy for CollapsingHeader<T>