Skip to main content

CollapsingSection

Struct CollapsingSection 

Source
pub struct CollapsingSection<'a> { /* private fields */ }
Expand description

A collapsible content section.

CollapsingSection::new("advanced", "Show advanced options").show(ui, |ui| {
    ui.label("…hidden until expanded…");
});

Implementations§

Source§

impl<'a> CollapsingSection<'a>

Source

pub fn new(id_salt: impl Hash, label: impl Into<WidgetText>) -> Self

Create a collapsing section keyed by id_salt with the given header label. The section is closed by default.

Source

pub fn open(self, open: &'a mut bool) -> Self

Bind the open state to a &mut bool the caller owns. If omitted, the section remembers its state in egui’s temp storage.

Source

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

Starting state when no prior state exists. Default: closed.

Source

pub fn show<R>( self, ui: &mut Ui, add_body: impl FnOnce(&mut Ui) -> R, ) -> InnerResponse<Option<R>>

Render the trigger row, and the body when open. Returns an InnerResponse whose response is the trigger row (useful for checking clicked(), hovered(), etc.) and whose inner is the body closure’s return value, or None if the section is closed.

Trait Implementations§

Source§

impl<'a> Debug for CollapsingSection<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for CollapsingSection<'a>

§

impl<'a> RefUnwindSafe for CollapsingSection<'a>

§

impl<'a> Send for CollapsingSection<'a>

§

impl<'a> Sync for CollapsingSection<'a>

§

impl<'a> Unpin for CollapsingSection<'a>

§

impl<'a> UnsafeUnpin for CollapsingSection<'a>

§

impl<'a> !UnwindSafe for CollapsingSection<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(value: T, _simd: S) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.