Skip to main content

Dialog

Struct Dialog 

Source
pub struct Dialog { /* private fields */ }

Implementations§

Source§

impl Dialog

Source

pub fn new<W>(title: impl Into<String>, body: W) -> Self
where W: Widget + 'static,

Source

pub fn show_inline(self) -> Self

Lays the dialog surface out in flow at its content size, without a scrim, entrance animation, or dismissal, instead of centering it in the window overlay stack. Widget galleries and documentation use this to show a dialog beside other content.

Source

pub fn theme(self, theme: DefaultTheme) -> Self

Source

pub fn theme_when<F>(self, theme: F) -> Self
where F: Fn() -> DefaultTheme + 'static,

Resolve the theme on every layout and paint, including for the dialog’s built-in action buttons.

Source

pub fn description(self, description: impl Into<String>) -> Self

Source

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

Whether the dialog is open; it is open from the start. A dialog never closes itself: when the user asks to close it, it calls Self::on_dismiss, and the app closes it.

Source

pub fn open_when<F>(self, open: F) -> Self
where F: Fn() -> bool + 'static,

Self::open, read each time the dialog lays out.

Source

pub fn open_from<O>(self, open: O) -> Self
where O: Observable<bool> + 'static,

Self::open, following an observable and laying out again when it changes.

Source

pub fn is_open(&self) -> bool

Source

pub fn set_open(&mut self, open: bool) -> bool

Open or close a built dialog, returning whether that changed it.

Source

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

Source

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

Source

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

The widest the dialog grows; never narrower than the theme’s dialog_min_width.

Source

pub fn on_dismiss<F>(self, on_dismiss: F) -> Self
where F: FnMut() + 'static,

Source

pub fn on_dismiss_with_ctx<F>(self, on_dismiss: F) -> Self
where F: FnMut(&mut EventCtx) + 'static,

Self::on_dismiss, with the event context first.

Source

pub fn header_action<W: Widget + 'static>(self, action: W) -> Self

Place a compact control beside the title, such as a close button.

Source

pub fn action<W: Widget + 'static>(self, action: W) -> Self

Add a footer control or a composed action row outside the scrolling body.

Source

pub fn primary_action<F>(self, label: impl Into<String>, on_press: F) -> Self
where F: FnMut() + 'static,

Source

pub fn secondary_action<F>(self, label: impl Into<String>, on_press: F) -> Self
where F: FnMut() + 'static,

Trait Implementations§

Source§

impl Widget for Dialog

Source§

fn command(&mut self, ctx: &mut EventCtx, command: &Command<'_>)

Receive a typed command addressed directly to this widget. Commands are target-only and do not capture or bubble through the widget tree.
Source§

fn event(&mut self, ctx: &mut EventCtx, event: &Event)

Source§

fn measure(&mut self, ctx: &mut MeasureCtx, constraints: Constraints) -> Size

Source§

fn arrange(&mut self, ctx: &mut ArrangeCtx, bounds: Rect)

Source§

fn paint(&self, ctx: &mut PaintCtx)

Source§

fn layer_options(&self) -> LayerOptions

Source§

fn layer_properties_at(&self, frame_time: f64) -> LayerProperties

Layer properties for the frame shown at frame_time. Override this instead of Widget::layer_properties when they come from Motion values; the runtime refreshes them without repainting when the motion invalidates Transform or Effect.
Source§

fn stack_surface_options(&self) -> Option<StackSurfaceOptions>

Source§

fn overlay_options(&self) -> Option<OverlayOptions>

Describe this widget as the logical owner of a presented overlay. Read more
Source§

fn semantics(&self, ctx: &mut SemanticsCtx)

Source§

fn accepts_focus(&self) -> bool

Source§

fn focus_changed(&mut self, ctx: &mut EventCtx, focused: bool)

Source§

fn visit_children(&self, visitor: &mut dyn WidgetPodVisitor)

Visit this widget’s logical children. Read more
Source§

fn visit_children_mut(&mut self, visitor: &mut dyn WidgetPodMutVisitor)

Mutably visit this widget’s logical children. Read more
Source§

fn debug_name(&self) -> &'static str

Source§

fn diagnostics(&self, _ctx: &mut WidgetDiagnosticsCtx)

Publish widget-specific state for an inspector snapshot. Read more
Source§

fn measure_size( &mut self, ctx: &mut MeasureCtx, constraints: Constraints, ) -> Size

Compute a provisional size. Containers can override this to query child sizes without committing their final layouts. The default preserves existing custom widgets by delegating to measure; it may mutate state. Child measure calls still commit state. Use child size probes explicitly when only their scalar results are needed. Results must match measure for the same content and constraints. A final measure is still required before arrangement after a probe miss.
Source§

fn measure_axis( &mut self, ctx: &mut MeasureCtx, constraints: Constraints, axis: Axis, ) -> f32

Query one component of measure_size under exactly the same constraints. Overrides may avoid computing the other component, but must return the same extent. Like size probes, this does not replace final measurement.
Source§

fn intrinsic_size( &mut self, ctx: &mut MeasureCtx, axis: Axis, available_cross: f32, ) -> IntrinsicSize

Report the smallest and preferred extent along one axis. Read more
Source§

fn supports_output_reuse(&self) -> bool

Opt into retaining paint and semantics between targeted invalidations. Output must depend only on widget state, context, and observed sources; changes must invalidate the widget. Untracked readers and callbacks with side effects should keep the default. An opaque descendant also prevents caching its ancestors. Explicit subtree/window requests always rerun them. A source observed only in paint or semantics invalidates that callback, not its descendants. Mutating child state requires a child/subtree request.
Source§

fn layer_properties(&self) -> LayerProperties

Source§

fn stack_host_options(&self) -> Option<StackHostOptions>

Source§

fn hit_test_self(&self) -> bool

Whether points inside this widget that none of its children take hit the widget itself. Containers laid over other content, like a layer of floating views, return false so those points reach what is behind them.

Auto Trait Implementations§

§

impl !Freeze for Dialog

§

impl !RefUnwindSafe for Dialog

§

impl !Send for Dialog

§

impl !Sync for Dialog

§

impl !UnwindSafe for Dialog

§

impl Forget for Dialog

§

impl Move for Dialog

§

impl Unpin for Dialog

§

impl UnsafeUnpin for Dialog

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.