Struct gtk4::AlertDialog

#[repr(transparent)]
pub struct AlertDialog { /* private fields */ }

Available on crate feature v4_10 only.

A AlertDialog object collects the arguments that are needed to present a message to the user.

The message is shown with the choose() function. This API follows the GIO async pattern, and the result can be obtained by calling Gtk::AlertDialog::choose_finish().

If you don’t need to wait for a button to be clicked, you can use show().

Properties

buttons

Labels for buttons to show in the alert.

The labels should be translated and may contain a _ to indicate the mnemonic character.

If this property is not set, then a ‘Close’ button is automatically created.

Readable | Writeable

cancel-button

This property determines what happens when the Escape key is pressed while the alert is shown.

If this property holds the index of a button in buttons, then pressing Escape is treated as if that button was pressed. If it is -1 or not a valid index for the buttons array, then an error is returned.

If buttons is NULL, then the automatically created ‘Close’ button is treated as both cancel and default button, so 0 is returned.

Readable | Writeable

default-button

This property determines what happens when the Return key is pressed while the alert is shown.

If this property holds the index of a button in buttons, then pressing Return is treated as if that button was pressed. If it is -1 or not a valid index for the buttons array, then nothing happens.

If buttons is NULL, then the automatically created ‘Close’ button is treated as both cancel and default button, so 0 is returned.

Readable | Writeable

detail

The detail text for the alert.

Readable | Writeable

message

The message for the alert.

Readable | Writeable

modal

Whether the alert is modal.

Readable | Writeable

Implements

glib::ObjectExt

Implementations

impl AlertDialog

pub fn builder() -> AlertDialogBuilder

Creates a new builder-pattern struct instance to construct AlertDialog objects.

This method returns an instance of AlertDialogBuilder which can be used to create AlertDialog objects.

pub fn choose<P: FnOnce(Result<i32, Error>) + 'static>( &self, parent: Option<&impl IsA<Window>>, cancellable: Option<&impl IsA<Cancellable>>, callback: P )

This function shows the alert to the user.

The @callback will be called when the alert is dismissed. It should call Gtk::AlertDialog::choose_finish() to obtain the result.

It is ok to pass NULL for the callback if the alert does not have more than one button. A simpler API for this case is show().

parent

the parent Window

cancellable

a GCancellable to cancel the operation

callback

a callback to call when the operation is complete

pub fn choose_future( &self, parent: Option<&(impl IsA<Window> + Clone + 'static)> ) -> Pin<Box_<dyn Future<Output = Result<i32, Error>> + 'static>>

pub fn buttons(&self) -> Vec<GString>

Returns the button labels for the alert.

Returns

the button labels

pub fn cancel_button(&self) -> i32

Returns the index of the cancel button.

Returns

the index of the cancel button, or -1

pub fn default_button(&self) -> i32

Returns the index of the default button.

Returns

the index of the default button, or -1

pub fn detail(&self) -> GString

Returns the detail text that will be shown in the alert.

Returns

the detail text

pub fn message(&self) -> GString

Returns the message that will be shown in the alert.

Returns

the message

pub fn is_modal(&self) -> bool

Returns whether the alert blocks interaction with the parent window while it is presented.

Returns

TRUE if the alert is modal

pub fn set_buttons(&self, labels: &[&str])

Sets the button labels for the alert.

labels

the new button labels

pub fn set_cancel_button(&self, button: i32)

Sets the index of the cancel button.

See cancel-button for details of how this value is used.

button

the new cancel button

pub fn set_default_button(&self, button: i32)

Sets the index of the default button.

See default-button for details of how this value is used.

button

the new default button

pub fn set_detail(&self, detail: &str)

Sets the detail text that will be shown in the alert.

detail

the new detail text

pub fn set_message(&self, message: &str)

Sets the message that will be shown in the alert.

message

the new message

pub fn set_modal(&self, modal: bool)

Sets whether the alert blocks interaction with the parent window while it is presented.

modal

the new value

pub fn show(&self, parent: Option<&impl IsA<Window>>)

Show the alert to the user.

This function is a simple version of choose() intended for dialogs with a single button. If you want to cancel the dialog or if the alert has more than one button, you should use that function instead and provide it with a #GCancellable or callback respectively.

parent

the parent Window

pub fn connect_buttons_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_cancel_button_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_default_button_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_detail_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_message_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_modal_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Trait Implementations

impl Clone for AlertDialog

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AlertDialog

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

Formats the value using the given formatter.

impl Default for AlertDialog

fn default() -> Self

Returns the “default value” for a type.

impl Display for AlertDialog

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

Formats the value using the given formatter.

impl HasParamSpec for AlertDialog

type ParamSpec = ParamSpecObject

type SetValue = AlertDialog

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, AlertDialog>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for AlertDialog

fn hash<H>(&self, state: &mut H)where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for AlertDialog

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for AlertDialog

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for AlertDialog

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for AlertDialog

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for AlertDialog

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for AlertDialog