gtk4/org.gtkkn.bindings.gtk/AlertDialog

AlertDialog

open class AlertDialog(pointer: <Error class: unknown class><<Error class: unknown class>>)

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

The message is shown with the method@Gtk.AlertDialog.choose function.

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

Skipped during bindings generation

method buttons: Property TypeInfo of getter and setter do not match

Since

4.10

Constructors

AlertDialog

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

cancelButton

open var cancelButton: Int

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

defaultButton

open var defaultButton: Int

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

detail

open var detail: String

The detail text for the alert.

gtkAlertDialogPointer

val gtkAlertDialogPointer: <Error class: unknown class><<Error class: unknown class>>

message

open var message: String

The message for the alert.

modal

open var modal: Boolean

Whether the alert is modal.

Functions

choose

open fun choose(parent: Window? = null, cancellable: <Error class: unknown class>? = null, callback: <Error class: unknown class>)

This function shows the alert to the user.

chooseFinish

open fun chooseFinish(result: <Error class: unknown class>): <Error class: unknown class><Int>

Finishes the method@Gtk.AlertDialog.choose call and returns the index of the button that was clicked.

getButtons

open fun getButtons(): List<String>?

Returns the button labels for the alert.

getCancelButton

open fun getCancelButton(): Int

Returns the index of the cancel button.

getDefaultButton

open fun getDefaultButton(): Int

Returns the index of the default button.

getDetail

open fun getDetail(): String

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

getMessage

open fun getMessage(): String

Returns the message that will be shown in the alert.

getModal

open fun getModal(): Boolean

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

setButtons

open fun setButtons(labels: List<String>)

Sets the button labels for the alert.

setCancelButton

open fun setCancelButton(button: Int)

Sets the index of the cancel button.

setDefaultButton

open fun setDefaultButton(button: Int)

Sets the index of the default button.

setDetail

open fun setDetail(detail: String)

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

setMessage

open fun setMessage(message: String)

Sets the message that will be shown in the alert.

setModal

open fun setModal(modal: Boolean)

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

show

open fun show(parent: Window? = null)

Show the alert to the user.