Skip to main content

Alert

Struct Alert 

Source
pub struct Alert { /* private fields */ }
Expand description

An inline banner: Info, Success, Warning or Error, with a message.

Not interactive, not focusable, not a tab stop. It sits in the layout, in the place the thing it is about would be.

Alert::new(Role::Success, "Lagret").with_icon('✓');
Alert::new(Role::Error, "Kunne ikke lagre: disken er full");

§This is a banner, not a dialog

Worth being explicit, because the word covers both. A dialog — something that takes over, dims what is behind it and demands an answer — is Ui::push_scene, which already exists and already dims and captures input. This is the strip of colour that reports something happened.

Neither one opens a window. Denise is a single Surface: on denise-drm there is no window system to open one in, and denise-win32, denise-macos and denise-activex are embedded — the host owns the window and Denise owns one rectangle inside it, so a control that spawned a top-level window would escape its host’s modality and outlive the dialog that owns it.

An application that wants a native message box on a desktop build should call the platform for one. It knows which build it is; the toolkit would have to guess. That is the same conclusion the backend choice reached.

§Sizing

preferred_height reports what the message needs once wrapped to a width — the query convention every sizable widget here uses, called by the application and never by the tree.

Implementations§

Source§

impl Alert

Source

pub fn new(role: Role, text: impl Into<String>) -> Self

A banner in role carrying text.

text may contain \n, and is wrapped to the width it is given.

Source

pub fn with_icon(self, icon: char) -> Self

Puts a character in front of the message.

A char, not an icon set. There is no icon story in this toolkit and inventing one inside a banner would be the wrong place to start; whether or actually draws depends on the font in use, and the built-in bitmap font has Latin and æøå and nothing else. ! and i always work.

Source

pub fn with_style(self, style: TextStyle) -> Self

Sets the message’s font and size.

Source

pub fn text(&self) -> &str

The current message.

Source

pub fn set_text(&mut self, text: impl Into<String>)

Replaces the message.

Source

pub fn update(&mut self, text: &str) -> bool

Replaces the message, reporting whether it actually changed.

Source

pub fn set_role(&mut self, role: Role)

Replaces the role.

Source

pub const fn role(&self) -> Role

The current role.

Source

pub fn set_icon(&mut self, icon: Option<char>)

Replaces the leading character, or removes it.

Source

pub fn preferred_height(&self, engine: &mut TextEngine, width: i32) -> i32

Height this banner needs for its message wrapped to width.

Trait Implementations§

Source§

impl Clone for Alert

Source§

fn clone(&self) -> Alert

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Alert

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Describe for Alert

Source§

const KIND: &'static str = "alert"

The name a form file uses for this widget. Kebab-case.
Source§

const DOC: &'static str = "A coloured banner saying something happened, in the place it happened."

One line saying what this widget is, for somebody choosing one. Read more
Source§

const GROUP: Group = Group::Display

Which shelf of the catalogue this belongs on.
Source§

const ICON: &'static Icon

The widget’s glyph: a small portrait of the thing, for a palette to draw beside — or instead of — its name. Read more
Source§

const PROPERTIES: &'static [Property]

Every property, in the order an inspector should show them.
Source§

fn get(&self, name: &str) -> Option<Value>

The current value. Read more
Source§

fn apply(&mut self, name: &str, value: Value) -> Result<(), Mismatch>

Applies a value, reporting only what went wrong. Read more
Source§

fn set(&mut self, name: &str, value: Value) -> Result<(), PropertyError>

Applies a value, reporting what went wrong and where.
Source§

impl<M: 'static> Widget<M> for Alert

Source§

fn describe(&self) -> Option<&dyn DynDescribe>

This widget’s property description, if it has one. Read more
Source§

fn describe_mut(&mut self) -> Option<&mut dyn DynDescribe>

The mutable half of describe.
Source§

fn measure(&self, ctx: &mut MeasureCtx<'_>, offered: Offer) -> Measured

How big this widget would like to be, given what the caller can promise. Read more
Source§

fn paint(&self, ctx: &mut PaintCtx<'_>, canvas: &mut Pen<'_>)

Draws into canvas, which is already clipped to this widget’s bounds intersected with the damage region being repainted. Read more
Source§

fn on_event(&mut self, event: &Event<'_>, ctx: &mut EventCtx<'_, M>) -> Handled

Reacts to an event routed to this widget.
Source§

fn accepts_pointer(&self) -> bool

Returns true if the pointer can hit this widget. Read more
Source§

fn focusable(&self) -> bool

Returns true if this widget can take keyboard focus.
Source§

fn preserves_focus(&self) -> bool

Returns true if a press on this widget should leave focus exactly where it is. Read more
Source§

fn animate(&mut self, now_ms: u64) -> Animation

Advances time-based state. Called only while this widget has asked to animate — see EventCtx::request_animation — and stops being called the moment it answers Wake::Never. Read more
Source§

fn snap(&mut self, now_ms: u64) -> Animation

Lands whatever is in flight at its end state, without animating it. Read more

Auto Trait Implementations§

§

impl Freeze for Alert

§

impl RefUnwindSafe for Alert

§

impl Send for Alert

§

impl Sync for Alert

§

impl Unpin for Alert

§

impl UnsafeUnpin for Alert

§

impl UnwindSafe for Alert

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> AsAny for T
where T: Any,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Borrows as dyn Any.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Mutably borrows as dyn Any.
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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynDescribe for T
where T: Describe,

Source§

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

Source§

fn properties(&self) -> &'static [Property]

Source§

fn get_property(&self, name: &str) -> Option<Value>

Source§

fn set_property( &mut self, name: &str, value: Value, ) -> Result<(), PropertyError>

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.