GI.Gtk.Objects.NativeDialog

Native dialogs are platform dialogs that don't use Dialog or Window. They are used in order to integrate better with a platform, by looking the same as other native applications and supporting platform specific features.

The Dialog functions cannot be used on such objects, but we need a similar API in order to drive them. The NativeDialog object is an API that allows you to do this. It allows you to set various common properties on the dialog, as well as show and hide it and get a NativeDialog::response signal when the user finished with the dialog.

There is also a nativeDialogRun helper that makes it easy to run any native dialog in a modal way with a recursive mainloop, similar to dialogRun.

Exported types

newtype NativeDialog

Memory-managed wrapper type.

Constructors

NativeDialog (ManagedPtr NativeDialog)

Instances

GObject NativeDialog

Defined in GI.Gtk.Objects.NativeDialog

Methods

gobjectType :: NativeDialog -> IO GType

IsObject NativeDialog

Defined in GI.Gtk.Objects.NativeDialog

IsNativeDialog NativeDialog

Defined in GI.Gtk.Objects.NativeDialog

class GObject o => IsNativeDialog o

Type class for types which can be safely cast to NativeDialog, for instance with toNativeDialog.

Instances

(GObject a, (UnknownAncestorError NativeDialog a :: Constraint)) => IsNativeDialog a

Defined in GI.Gtk.Objects.NativeDialog

IsNativeDialog NativeDialog

Defined in GI.Gtk.Objects.NativeDialog

IsNativeDialog FileChooserNative

Defined in GI.Gtk.Objects.FileChooserNative

toNativeDialog :: (MonadIO m, IsNativeDialog o) => o -> m NativeDialog

Cast to NativeDialog, for types for which this is known to be safe. For general casts, use castTo.

noNativeDialog :: Maybe NativeDialog

A convenience alias for Nothing :: Maybe NativeDialog.

Methods

destroy

nativeDialogDestroy

Arguments

:: (HasCallStack, MonadIO m, IsNativeDialog a)

=> a

self: a NativeDialog

-> m ()

Destroys a dialog.

When a dialog is destroyed, it will break any references it holds to other objects. If it is visible it will be hidden and any underlying window system resources will be destroyed.

Note that this does not release any reference to the object (as opposed to destroying a GtkWindow) because there is no reference from the windowing system to the NativeDialog.

Since: 3.20

getModal

nativeDialogGetModal

Arguments

:: (HasCallStack, MonadIO m, IsNativeDialog a)

=> a

self: a NativeDialog

-> m Bool

Returns: True if the dialog is set to be modal

Returns whether the dialog is modal. See nativeDialogSetModal.

Since: 3.20

getTitle

nativeDialogGetTitle

Arguments

:: (HasCallStack, MonadIO m, IsNativeDialog a)

=> a

self: a NativeDialog

-> m (Maybe Text)

Returns: the title of the dialog, or Nothing if none has been set explicitly. The returned string is owned by the widget and must not be modified or freed.

Gets the title of the NativeDialog.

Since: 3.20

getTransientFor

nativeDialogGetTransientFor

Arguments

:: (HasCallStack, MonadIO m, IsNativeDialog a)

=> a

self: a NativeDialog

-> m (Maybe Window)

Returns: the transient parent for this window, or Nothing if no transient parent has been set.

Fetches the transient parent for this window. See nativeDialogSetTransientFor.

Since: 3.20

getVisible

nativeDialogGetVisible

Arguments

:: (HasCallStack, MonadIO m, IsNativeDialog a)

=> a

self: a NativeDialog

-> m Bool

Returns: True if the dialog is visible

Determines whether the dialog is visible.

Since: 3.20

hide

nativeDialogHide

Arguments

:: (HasCallStack, MonadIO m, IsNativeDialog a)

=> a

self: a NativeDialog

-> m ()

Hides the dialog if it is visilbe, aborting any interaction. Once this is called the NativeDialog::response signal will not be emitted until after the next call to nativeDialogShow.

If the dialog is not visible this does nothing.

Since: 3.20

run

nativeDialogRun

Arguments

:: (HasCallStack, MonadIO m, IsNativeDialog a)

=> a

self: a NativeDialog

-> m Int32

Returns: response ID

Blocks in a recursive main loop until self emits the NativeDialog::response signal. It then returns the response ID from the ::response signal emission.

Before entering the recursive main loop, nativeDialogRun calls nativeDialogShow on the dialog for you.

After nativeDialogRun returns, then dialog will be hidden.

Typical usage of this function might be:

C code

 gint result = gtk_native_dialog_run (GTK_NATIVE_DIALOG (dialog));
 switch (result)
   {
     case GTK_RESPONSE_ACCEPT:
        do_application_specific_something ();
        break;
     default:
        do_nothing_since_dialog_was_cancelled ();
        break;
   }
 g_object_unref (dialog);

Note that even though the recursive main loop gives the effect of a modal dialog (it prevents the user from interacting with other windows in the same window group while the dialog is run), callbacks such as timeouts, IO channel watches, DND drops, etc, will be triggered during a gtk_nautilus_dialog_run() call.

Since: 3.20

setModal

nativeDialogSetModal

Arguments

:: (HasCallStack, MonadIO m, IsNativeDialog a)

=> a

self: a NativeDialog

-> Bool

modal: whether the window is modal

-> m ()

Sets a dialog modal or non-modal. Modal dialogs prevent interaction with other windows in the same application. To keep modal dialogs on top of main application windows, use nativeDialogSetTransientFor to make the dialog transient for the parent; most [window managers][gtk-X11-arch] will then disallow lowering the dialog below the parent.

Since: 3.20

setTitle

nativeDialogSetTitle

Arguments

:: (HasCallStack, MonadIO m, IsNativeDialog a)

=> a

self: a NativeDialog

-> Text

title: title of the dialog

-> m ()

Sets the title of the NativeDialog.

Since: 3.20

setTransientFor

nativeDialogSetTransientFor

Arguments

:: (HasCallStack, MonadIO m, IsNativeDialog a, IsWindow b)

=> a

self: a NativeDialog

-> Maybe b

parent: parent window, or Nothing

-> m ()

Dialog windows should be set transient for the main application window they were spawned from. This allows [window managers][gtk-X11-arch] to e.g. keep the dialog on top of the main window, or center the dialog over the main window.

Passing Nothing for parent unsets the current transient window.

Since: 3.20

show

nativeDialogShow

Arguments

:: (HasCallStack, MonadIO m, IsNativeDialog a)

=> a

self: a NativeDialog

-> m ()

Shows the dialog on the display, allowing the user to interact with it. When the user accepts the state of the dialog the dialog will be automatically hidden and the NativeDialog::response signal will be emitted.

Multiple calls while the dialog is visible will be ignored.

Since: 3.20

Properties

modal

Whether the window should be modal with respect to its transient parent.

Since: 3.20

constructNativeDialogModal :: IsNativeDialog o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “modal” property. This is rarely needed directly, but it is used by new.

getNativeDialogModal :: (MonadIO m, IsNativeDialog o) => o -> m Bool

Get the value of the “modal” property. When overloading is enabled, this is equivalent to

get nativeDialog #modal

setNativeDialogModal :: (MonadIO m, IsNativeDialog o) => o -> Bool -> m ()

Set the value of the “modal” property. When overloading is enabled, this is equivalent to

set nativeDialog [ #modal := value ]

title

The title of the dialog window

Since: 3.20

constructNativeDialogTitle :: IsNativeDialog o => Text -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “title” property. This is rarely needed directly, but it is used by new.

getNativeDialogTitle :: (MonadIO m, IsNativeDialog o) => o -> m (Maybe Text)

Get the value of the “title” property. When overloading is enabled, this is equivalent to

get nativeDialog #title

setNativeDialogTitle :: (MonadIO m, IsNativeDialog o) => o -> Text -> m ()

Set the value of the “title” property. When overloading is enabled, this is equivalent to

set nativeDialog [ #title := value ]

transientFor

The transient parent of the dialog, or Nothing for none.

Since: 3.20

clearNativeDialogTransientFor :: (MonadIO m, IsNativeDialog o) => o -> m ()

Set the value of the “transient-for” property to Nothing. When overloading is enabled, this is equivalent to

clear #transientFor

constructNativeDialogTransientFor :: (IsNativeDialog o, IsWindow a) => a -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “transient-for” property. This is rarely needed directly, but it is used by new.

getNativeDialogTransientFor :: (MonadIO m, IsNativeDialog o) => o -> m (Maybe Window)

Get the value of the “transient-for” property. When overloading is enabled, this is equivalent to

get nativeDialog #transientFor

setNativeDialogTransientFor :: (MonadIO m, IsNativeDialog o, IsWindow a) => o -> a -> m ()

Set the value of the “transient-for” property. When overloading is enabled, this is equivalent to

set nativeDialog [ #transientFor := value ]

visible

Whether the window is currenlty visible.

Since: 3.20

constructNativeDialogVisible :: IsNativeDialog o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “visible” property. This is rarely needed directly, but it is used by new.

getNativeDialogVisible :: (MonadIO m, IsNativeDialog o) => o -> m Bool

Get the value of the “visible” property. When overloading is enabled, this is equivalent to

get nativeDialog #visible

setNativeDialogVisible :: (MonadIO m, IsNativeDialog o) => o -> Bool -> m ()

Set the value of the “visible” property. When overloading is enabled, this is equivalent to

set nativeDialog [ #visible := value ]

Signals

response

type C_NativeDialogResponseCallback = Ptr () -> Int32 -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type NativeDialogResponseCallback

Arguments

 = Int32

responseId: the response ID

-> IO ()

Emitted when the user responds to the dialog.

When this is called the dialog has been hidden.

If you call nativeDialogHide before the user responds to the dialog this signal will not be emitted.

Since: 3.20

afterNativeDialogResponse :: (IsNativeDialog a, MonadIO m) => a -> NativeDialogResponseCallback -> m SignalHandlerId

Connect a signal handler for the “response” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after nativeDialog #response callback

genClosure_NativeDialogResponse :: NativeDialogResponseCallback -> IO Closure

Wrap the callback into a Closure.

mk_NativeDialogResponseCallback :: C_NativeDialogResponseCallback -> IO (FunPtr C_NativeDialogResponseCallback)

Generate a function pointer callable from C code, from a C_NativeDialogResponseCallback.

noNativeDialogResponseCallback :: Maybe NativeDialogResponseCallback

A convenience synonym for Nothing :: Maybe NativeDialogResponseCallback.

onNativeDialogResponse :: (IsNativeDialog a, MonadIO m) => a -> NativeDialogResponseCallback -> m SignalHandlerId

Connect a signal handler for the “response” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on nativeDialog #response callback

wrap_NativeDialogResponseCallback :: NativeDialogResponseCallback -> C_NativeDialogResponseCallback

Wrap a NativeDialogResponseCallback into a C_NativeDialogResponseCallback.