class Gtk::AlertDialog

Overview

Collects the arguments that are needed to present a message to the user.

The message is shown with the Gtk::AlertDialog#choose function.

If you don't need to wait for a button to be clicked, you can use Gtk::AlertDialog#show.

Defined in:

lib/gi-crystal/src/auto/gtk-4.0/alert_dialog.cr

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from class GObject::Object

==(other : self) ==, bind_property(source_property : String, target : GObject::Object, target_property : String, flags : GObject::BindingFlags) : GObject::Binding bind_property, bind_property_full(source_property : String, target : GObject::Object, target_property : String, flags : GObject::BindingFlags, transform_to : GObject::Closure, transform_from : GObject::Closure) : GObject::Binding bind_property_full, data(key : String) : Pointer(Void) | Nil data, finalize finalize, freeze_notify : Nil freeze_notify, getv(names : Enumerable(String), values : Enumerable(_)) : Nil getv, hash(hasher) hash, notify(property_name : String) : Nil notify, notify_by_pspec(pspec : GObject::ParamSpec) : Nil notify_by_pspec, notify_signal notify_signal, property(property_name : String, value : _) : Nil property, qdata(quark : UInt32) : Pointer(Void) | Nil qdata, ref_count : UInt32 ref_count, run_dispose : Nil run_dispose, set_data(key : String, data : Pointer(Void) | Nil) : Nil set_data, set_property(property_name : String, value : _) : Nil set_property, steal_data(key : String) : Pointer(Void) | Nil steal_data, steal_qdata(quark : UInt32) : Pointer(Void) | Nil steal_qdata, thaw_notify : Nil thaw_notify, to_unsafe : Pointer(Void) to_unsafe, watch_closure(closure : GObject::Closure) : Nil watch_closure

Constructor methods inherited from class GObject::Object

cast(obj : GObject::Object) : self cast, new(pointer : Pointer(Void), transfer : GICrystal::Transfer)
new new, newv(object_type : UInt64, parameters : Enumerable(GObject::Parameter)) : self newv

Class methods inherited from class GObject::Object

cast?(obj : GObject::Object) : self | Nil cast?, compat_control(what : UInt64, data : Pointer(Void) | Nil) : UInt64 compat_control, g_type : UInt64 g_type, interface_find_property(g_iface : GObject::TypeInterface, property_name : String) : GObject::ParamSpec interface_find_property, interface_list_properties(g_iface : GObject::TypeInterface) : Enumerable(GObject::ParamSpec) interface_list_properties

Macros inherited from class GObject::Object

previous_vfunc(*args) previous_vfunc, previous_vfunc!(*args) previous_vfunc!, signal(signature) signal

Constructor Detail

def self.new #

Initialize a new AlertDialog.


def self.new(*, buttons : Enumerable(String) | Nil = nil, cancel_button : Int32 | Nil = nil, default_button : Int32 | Nil = nil, detail : String | Nil = nil, message : String | Nil = nil, modal : Bool | Nil = nil) #

Class Method Detail

def self.g_type : UInt64 #

Returns the type id (GType) registered in GLib type system.


Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def buttons : Enumerable(String) | Nil #

Returns the button labels for the alert.


def buttons=(labels : Enumerable(String)) : Nil #

Sets the button labels for the alert.


def cancel_button : Int32 #

Returns the index of the cancel button.


def cancel_button=(button : Int32) : Nil #

Sets the index of the cancel button.

See [property@Gtk.AlertDialog:cancel-button] for details of how this value is used.


def choose(parent : Gtk::Window | Nil, cancellable : Gio::Cancellable | Nil, &callback : Gio::AsyncReadyCallback) : Nil #

Shows the alert to the user.

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 Gtk::AlertDialog#show.


def choose_finish(result : Gio::AsyncResult) : Int32 #

Finishes the Gtk::AlertDialog#choose call.


def default_button : Int32 #

Returns the index of the default button.


def default_button=(button : Int32) : Nil #

Sets the index of the default button.

See [property@Gtk.AlertDialog:default-button] for details of how this value is used.


def detail : String #

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


def detail=(detail : String) : Nil #

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


def detail=(value : Nil) : Nil #

Set #detail property to nil.


def detail? : String | Nil #

Same as #detail, but can return nil.


def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def message : String #

Returns the message that will be shown in the alert.


def message=(message : String) : Nil #

Sets the message that will be shown in the alert.


def message=(value : Nil) : Nil #

Set #message property to nil.


def message? : String | Nil #

Same as #message, but can return nil.


def modal : Bool #

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


def modal=(modal : Bool) : Nil #

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


def modal? : Bool #

def show(parent : Gtk::Window | Nil) : Nil #

Shows the alert to the user.

This function is a simpler version of Gtk::AlertDialog#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 Gio::Cancellable and callback respectively.