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

Constructors

NativeDialog (ManagedPtr NativeDialog)

Instances

GObject NativeDialog

Methods

gobjectType :: NativeDialog -> IO GType

IsObject NativeDialog

IsNativeDialog NativeDialog

((~) * info (ResolveNativeDialogMethod t NativeDialog), MethodInfo * info NativeDialog p) => IsLabel t (NativeDialog -> p)

Methods

fromLabel :: Proxy# Symbol t -> NativeDialog -> p

((~) * info (ResolveNativeDialogMethod t NativeDialog), MethodInfo * info NativeDialog p) => IsLabelProxy t (NativeDialog -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> NativeDialog -> p

HasAttributeList * NativeDialog

type AttributeList NativeDialog

type AttributeList NativeDialog

type SignalList NativeDialog

type SignalList NativeDialog

class GObject o => IsNativeDialog o

Instances

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

IsNativeDialog NativeDialog

IsNativeDialog FileChooserNative

toNativeDialog :: IsNativeDialog o => o -> IO NativeDialog

noNativeDialog :: Maybe NativeDialog

Methods

destroy

data NativeDialogDestroyMethodInfo

Instances

((~) * signature (m ()), MonadIO m, IsNativeDialog a) => MethodInfo * NativeDialogDestroyMethodInfo a signature

Methods

overloadedMethod :: MethodProxy NativeDialogDestroyMethodInfo a -> signature -> s

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

data NativeDialogGetModalMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsNativeDialog a) => MethodInfo * NativeDialogGetModalMethodInfo a signature

Methods

overloadedMethod :: MethodProxy NativeDialogGetModalMethodInfo a -> signature -> s

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

data NativeDialogGetTitleMethodInfo

Instances

((~) * signature (m (Maybe Text)), MonadIO m, IsNativeDialog a) => MethodInfo * NativeDialogGetTitleMethodInfo a signature

Methods

overloadedMethod :: MethodProxy NativeDialogGetTitleMethodInfo a -> signature -> s

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

data NativeDialogGetTransientForMethodInfo

Instances

((~) * signature (m (Maybe Window)), MonadIO m, IsNativeDialog a) => MethodInfo * NativeDialogGetTransientForMethodInfo a signature

Methods

overloadedMethod :: MethodProxy NativeDialogGetTransientForMethodInfo a -> signature -> s

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

data NativeDialogGetVisibleMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsNativeDialog a) => MethodInfo * NativeDialogGetVisibleMethodInfo a signature

Methods

overloadedMethod :: MethodProxy NativeDialogGetVisibleMethodInfo a -> signature -> s

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

data NativeDialogHideMethodInfo

Instances

((~) * signature (m ()), MonadIO m, IsNativeDialog a) => MethodInfo * NativeDialogHideMethodInfo a signature

Methods

overloadedMethod :: MethodProxy NativeDialogHideMethodInfo a -> signature -> s

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

data NativeDialogRunMethodInfo

Instances

((~) * signature (m Int32), MonadIO m, IsNativeDialog a) => MethodInfo * NativeDialogRunMethodInfo a signature

Methods

overloadedMethod :: MethodProxy NativeDialogRunMethodInfo a -> signature -> s

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

data NativeDialogSetModalMethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsNativeDialog a) => MethodInfo * NativeDialogSetModalMethodInfo a signature

Methods

overloadedMethod :: MethodProxy NativeDialogSetModalMethodInfo a -> signature -> s

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

data NativeDialogSetTitleMethodInfo

Instances

((~) * signature (Text -> m ()), MonadIO m, IsNativeDialog a) => MethodInfo * NativeDialogSetTitleMethodInfo a signature

Methods

overloadedMethod :: MethodProxy NativeDialogSetTitleMethodInfo a -> signature -> s

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

data NativeDialogSetTransientForMethodInfo

Instances

((~) * signature (Maybe b -> m ()), MonadIO m, IsNativeDialog a, IsWindow b) => MethodInfo * NativeDialogSetTransientForMethodInfo a signature

Methods

overloadedMethod :: MethodProxy NativeDialogSetTransientForMethodInfo a -> signature -> s

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

data NativeDialogShowMethodInfo

Instances

((~) * signature (m ()), MonadIO m, IsNativeDialog a) => MethodInfo * NativeDialogShowMethodInfo a signature

Methods

overloadedMethod :: MethodProxy NativeDialogShowMethodInfo a -> signature -> s

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

data NativeDialogModalPropertyInfo

Instances

AttrInfo NativeDialogModalPropertyInfo

Associated Types

type AttrAllowedOps NativeDialogModalPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint NativeDialogModalPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint NativeDialogModalPropertyInfo :: * -> Constraint

type AttrGetType NativeDialogModalPropertyInfo :: *

type AttrLabel NativeDialogModalPropertyInfo :: Symbol

type AttrOrigin NativeDialogModalPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint NativeDialogModalPropertyInfo o => Proxy * NativeDialogModalPropertyInfo -> o -> IO (AttrGetType NativeDialogModalPropertyInfo)

attrSet :: (AttrBaseTypeConstraint NativeDialogModalPropertyInfo o, AttrSetTypeConstraint NativeDialogModalPropertyInfo b) => Proxy * NativeDialogModalPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint NativeDialogModalPropertyInfo o => Proxy * NativeDialogModalPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint NativeDialogModalPropertyInfo o, AttrSetTypeConstraint NativeDialogModalPropertyInfo b) => Proxy * NativeDialogModalPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin NativeDialogModalPropertyInfo

type AttrOrigin NativeDialogModalPropertyInfo = NativeDialog

type AttrLabel NativeDialogModalPropertyInfo

type AttrLabel NativeDialogModalPropertyInfo = "modal"

type AttrGetType NativeDialogModalPropertyInfo

type AttrGetType NativeDialogModalPropertyInfo = Bool

type AttrBaseTypeConstraint NativeDialogModalPropertyInfo

type AttrBaseTypeConstraint NativeDialogModalPropertyInfo = IsNativeDialog

type AttrSetTypeConstraint NativeDialogModalPropertyInfo

type AttrSetTypeConstraint NativeDialogModalPropertyInfo = * ~ Bool

type AttrAllowedOps NativeDialogModalPropertyInfo

type AttrAllowedOps NativeDialogModalPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

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

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

nativeDialogModal :: AttrLabelProxy "modal"

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

title

data NativeDialogTitlePropertyInfo

Instances

AttrInfo NativeDialogTitlePropertyInfo

Associated Types

type AttrAllowedOps NativeDialogTitlePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint NativeDialogTitlePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint NativeDialogTitlePropertyInfo :: * -> Constraint

type AttrGetType NativeDialogTitlePropertyInfo :: *

type AttrLabel NativeDialogTitlePropertyInfo :: Symbol

type AttrOrigin NativeDialogTitlePropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint NativeDialogTitlePropertyInfo o => Proxy * NativeDialogTitlePropertyInfo -> o -> IO (AttrGetType NativeDialogTitlePropertyInfo)

attrSet :: (AttrBaseTypeConstraint NativeDialogTitlePropertyInfo o, AttrSetTypeConstraint NativeDialogTitlePropertyInfo b) => Proxy * NativeDialogTitlePropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint NativeDialogTitlePropertyInfo o => Proxy * NativeDialogTitlePropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint NativeDialogTitlePropertyInfo o, AttrSetTypeConstraint NativeDialogTitlePropertyInfo b) => Proxy * NativeDialogTitlePropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin NativeDialogTitlePropertyInfo

type AttrOrigin NativeDialogTitlePropertyInfo = NativeDialog

type AttrLabel NativeDialogTitlePropertyInfo

type AttrLabel NativeDialogTitlePropertyInfo = "title"

type AttrGetType NativeDialogTitlePropertyInfo

type AttrGetType NativeDialogTitlePropertyInfo = Maybe Text

type AttrBaseTypeConstraint NativeDialogTitlePropertyInfo

type AttrBaseTypeConstraint NativeDialogTitlePropertyInfo = IsNativeDialog

type AttrSetTypeConstraint NativeDialogTitlePropertyInfo

type AttrSetTypeConstraint NativeDialogTitlePropertyInfo = * ~ Text

type AttrAllowedOps NativeDialogTitlePropertyInfo

type AttrAllowedOps NativeDialogTitlePropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

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

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

nativeDialogTitle :: AttrLabelProxy "title"

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

transientFor

data NativeDialogTransientForPropertyInfo

Instances

AttrInfo NativeDialogTransientForPropertyInfo

Associated Types

type AttrAllowedOps NativeDialogTransientForPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint NativeDialogTransientForPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint NativeDialogTransientForPropertyInfo :: * -> Constraint

type AttrGetType NativeDialogTransientForPropertyInfo :: *

type AttrLabel NativeDialogTransientForPropertyInfo :: Symbol

type AttrOrigin NativeDialogTransientForPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint NativeDialogTransientForPropertyInfo o => Proxy * NativeDialogTransientForPropertyInfo -> o -> IO (AttrGetType NativeDialogTransientForPropertyInfo)

attrSet :: (AttrBaseTypeConstraint NativeDialogTransientForPropertyInfo o, AttrSetTypeConstraint NativeDialogTransientForPropertyInfo b) => Proxy * NativeDialogTransientForPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint NativeDialogTransientForPropertyInfo o => Proxy * NativeDialogTransientForPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint NativeDialogTransientForPropertyInfo o, AttrSetTypeConstraint NativeDialogTransientForPropertyInfo b) => Proxy * NativeDialogTransientForPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin NativeDialogTransientForPropertyInfo

type AttrOrigin NativeDialogTransientForPropertyInfo = NativeDialog

type AttrLabel NativeDialogTransientForPropertyInfo

type AttrLabel NativeDialogTransientForPropertyInfo = "transient-for"

type AttrGetType NativeDialogTransientForPropertyInfo

type AttrGetType NativeDialogTransientForPropertyInfo = Maybe Window

type AttrBaseTypeConstraint NativeDialogTransientForPropertyInfo

type AttrBaseTypeConstraint NativeDialogTransientForPropertyInfo = IsNativeDialog

type AttrSetTypeConstraint NativeDialogTransientForPropertyInfo

type AttrSetTypeConstraint NativeDialogTransientForPropertyInfo = IsWindow

type AttrAllowedOps NativeDialogTransientForPropertyInfo

type AttrAllowedOps NativeDialogTransientForPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag))))

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

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

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

nativeDialogTransientFor :: AttrLabelProxy "transientFor"

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

visible

data NativeDialogVisiblePropertyInfo

Instances

AttrInfo NativeDialogVisiblePropertyInfo

Associated Types

type AttrAllowedOps NativeDialogVisiblePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint NativeDialogVisiblePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint NativeDialogVisiblePropertyInfo :: * -> Constraint

type AttrGetType NativeDialogVisiblePropertyInfo :: *

type AttrLabel NativeDialogVisiblePropertyInfo :: Symbol

type AttrOrigin NativeDialogVisiblePropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint NativeDialogVisiblePropertyInfo o => Proxy * NativeDialogVisiblePropertyInfo -> o -> IO (AttrGetType NativeDialogVisiblePropertyInfo)

attrSet :: (AttrBaseTypeConstraint NativeDialogVisiblePropertyInfo o, AttrSetTypeConstraint NativeDialogVisiblePropertyInfo b) => Proxy * NativeDialogVisiblePropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint NativeDialogVisiblePropertyInfo o => Proxy * NativeDialogVisiblePropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint NativeDialogVisiblePropertyInfo o, AttrSetTypeConstraint NativeDialogVisiblePropertyInfo b) => Proxy * NativeDialogVisiblePropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin NativeDialogVisiblePropertyInfo

type AttrOrigin NativeDialogVisiblePropertyInfo = NativeDialog

type AttrLabel NativeDialogVisiblePropertyInfo

type AttrLabel NativeDialogVisiblePropertyInfo = "visible"

type AttrGetType NativeDialogVisiblePropertyInfo

type AttrGetType NativeDialogVisiblePropertyInfo = Bool

type AttrBaseTypeConstraint NativeDialogVisiblePropertyInfo

type AttrBaseTypeConstraint NativeDialogVisiblePropertyInfo = IsNativeDialog

type AttrSetTypeConstraint NativeDialogVisiblePropertyInfo

type AttrSetTypeConstraint NativeDialogVisiblePropertyInfo = * ~ Bool

type AttrAllowedOps NativeDialogVisiblePropertyInfo

type AttrAllowedOps NativeDialogVisiblePropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

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

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

nativeDialogVisible :: AttrLabelProxy "visible"

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

Signals

response

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

type NativeDialogResponseCallback = Int32 -> IO ()

data NativeDialogResponseSignalInfo

Instances

SignalInfo NativeDialogResponseSignalInfo

Associated Types

type HaskellCallbackType NativeDialogResponseSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o NativeDialogResponseSignalInfo -> o -> HaskellCallbackType NativeDialogResponseSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType NativeDialogResponseSignalInfo

type HaskellCallbackType NativeDialogResponseSignalInfo = NativeDialogResponseCallback

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

genClosure_NativeDialogResponse :: NativeDialogResponseCallback -> IO Closure

mk_NativeDialogResponseCallback :: C_NativeDialogResponseCallback -> IO (FunPtr C_NativeDialogResponseCallback)

noNativeDialogResponseCallback :: Maybe NativeDialogResponseCallback

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

wrap_NativeDialogResponseCallback :: NativeDialogResponseCallback -> Ptr () -> Int32 -> Ptr () -> IO ()