Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	Safe-Inferred
Language	Haskell2010

GI.Gtk.Objects.NativeDialog

Contents

Exported types
Methods
Properties
Signals
- response

Description

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 response signal when the user finished with the dialog.

Note that unlike Dialog, NativeDialog objects are not toplevel widgets, and GTK does not keep them alive. It is your responsibility to keep a reference until you are done with the object.

Synopsis

newtype NativeDialog = NativeDialog (ManagedPtr NativeDialog)
class (GObject o, IsDescendantOf NativeDialog o) => IsNativeDialog o
toNativeDialog :: (MonadIO m, IsNativeDialog o) => o -> m NativeDialog
nativeDialogDestroy :: (HasCallStack, MonadIO m, IsNativeDialog a) => a -> m ()
nativeDialogGetModal :: (HasCallStack, MonadIO m, IsNativeDialog a) => a -> m Bool
nativeDialogGetTitle :: (HasCallStack, MonadIO m, IsNativeDialog a) => a -> m (Maybe Text)
nativeDialogGetTransientFor :: (HasCallStack, MonadIO m, IsNativeDialog a) => a -> m (Maybe Window)
nativeDialogGetVisible :: (HasCallStack, MonadIO m, IsNativeDialog a) => a -> m Bool
nativeDialogHide :: (HasCallStack, MonadIO m, IsNativeDialog a) => a -> m ()
nativeDialogSetModal :: (HasCallStack, MonadIO m, IsNativeDialog a) => a -> Bool -> m ()
nativeDialogSetTitle :: (HasCallStack, MonadIO m, IsNativeDialog a) => a -> Text -> m ()
nativeDialogSetTransientFor :: (HasCallStack, MonadIO m, IsNativeDialog a, IsWindow b) => a -> Maybe b -> m ()
nativeDialogShow :: (HasCallStack, MonadIO m, IsNativeDialog a) => a -> m ()
constructNativeDialogModal :: (IsNativeDialog o, MonadIO m) => Bool -> m (GValueConstruct o)
getNativeDialogModal :: (MonadIO m, IsNativeDialog o) => o -> m Bool
setNativeDialogModal :: (MonadIO m, IsNativeDialog o) => o -> Bool -> m ()
constructNativeDialogTitle :: (IsNativeDialog o, MonadIO m) => Text -> m (GValueConstruct o)
getNativeDialogTitle :: (MonadIO m, IsNativeDialog o) => o -> m (Maybe Text)
setNativeDialogTitle :: (MonadIO m, IsNativeDialog o) => o -> Text -> m ()
clearNativeDialogTransientFor :: (MonadIO m, IsNativeDialog o) => o -> m ()
constructNativeDialogTransientFor :: (IsNativeDialog o, MonadIO m, IsWindow a) => a -> m (GValueConstruct o)
getNativeDialogTransientFor :: (MonadIO m, IsNativeDialog o) => o -> m (Maybe Window)
setNativeDialogTransientFor :: (MonadIO m, IsNativeDialog o, IsWindow a) => o -> a -> m ()
constructNativeDialogVisible :: (IsNativeDialog o, MonadIO m) => Bool -> m (GValueConstruct o)
getNativeDialogVisible :: (MonadIO m, IsNativeDialog o) => o -> m Bool
setNativeDialogVisible :: (MonadIO m, IsNativeDialog o) => o -> Bool -> m ()
type C_NativeDialogResponseCallback = Ptr () -> Int32 -> Ptr () -> IO ()
type NativeDialogResponseCallback = Int32 -> IO ()
afterNativeDialogResponse :: (IsNativeDialog a, MonadIO m) => a -> NativeDialogResponseCallback -> m SignalHandlerId
genClosure_NativeDialogResponse :: MonadIO m => NativeDialogResponseCallback -> m (GClosure C_NativeDialogResponseCallback)
mk_NativeDialogResponseCallback :: C_NativeDialogResponseCallback -> IO (FunPtr C_NativeDialogResponseCallback)
noNativeDialogResponseCallback :: Maybe NativeDialogResponseCallback
onNativeDialogResponse :: (IsNativeDialog a, MonadIO m) => a -> NativeDialogResponseCallback -> m SignalHandlerId
wrap_NativeDialogResponseCallback :: NativeDialogResponseCallback -> C_NativeDialogResponseCallback

Exported types

newtype NativeDialog Source #

Memory-managed wrapper type.

Constructors

NativeDialog (ManagedPtr NativeDialog)

Instances

Instances details

Eq NativeDialog Source #
Instance details Defined in GI.Gtk.Objects.NativeDialog Methods (==) :: NativeDialog -> NativeDialog -> Bool # (/=) :: NativeDialog -> NativeDialog -> Bool #
GObject NativeDialog Source #
Instance details Defined in GI.Gtk.Objects.NativeDialog
ManagedPtrNewtype NativeDialog Source #
Instance details Defined in GI.Gtk.Objects.NativeDialog Methods toManagedPtr :: NativeDialog -> ManagedPtr NativeDialog
TypedObject NativeDialog Source #
Instance details Defined in GI.Gtk.Objects.NativeDialog Methods glibType :: IO GType
HasParentTypes NativeDialog Source #
Instance details Defined in GI.Gtk.Objects.NativeDialog
IsGValue (Maybe NativeDialog) Source #	Convert `NativeDialog` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Gtk.Objects.NativeDialog Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe NativeDialog -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe NativeDialog)
type ParentTypes NativeDialog Source #
Instance details Defined in GI.Gtk.Objects.NativeDialog type ParentTypes NativeDialog = '[Object]

class (GObject o, IsDescendantOf NativeDialog o) => IsNativeDialog o Source #

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

Instances

Instances details

(GObject o, IsDescendantOf NativeDialog o) => IsNativeDialog o Source #
Instance details Defined in GI.Gtk.Objects.NativeDialog

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

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

Methods

Click to display all available methods, including inherited ones

Expand

destroy

nativeDialogDestroy Source #

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.

getModal

nativeDialogGetModal Source #

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.

getTitle

nativeDialogGetTitle Source #

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.

getTransientFor

nativeDialogGetTransientFor Source #

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.

getVisible

nativeDialogGetVisible Source #

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.

hide

nativeDialogHide Source #

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 response signal will not be emitted until after the next call to nativeDialogShow.

If the dialog is not visible this does nothing.

setModal

nativeDialogSetModal Source #

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.

setTitle

nativeDialogSetTitle Source #

Arguments

:: (HasCallStack, MonadIO m, IsNativeDialog a)
=> a	`self`: a `NativeDialog`
-> Text	`title`: title of the dialog
-> m ()

Sets the title of the NativeDialog.

setTransientFor

nativeDialogSetTransientFor Source #

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.

show

nativeDialogShow Source #

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 response signal will be emitted.

Multiple calls while the dialog is visible will be ignored.

Properties

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

constructNativeDialogModal :: (IsNativeDialog o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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 Source #

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 () Source #

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

constructNativeDialogTitle :: (IsNativeDialog o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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) Source #

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 () Source #

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.

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

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

clear #transientFor

constructNativeDialogTransientFor :: (IsNativeDialog o, MonadIO m, IsWindow a) => a -> m (GValueConstruct o) Source #

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) Source #

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 () Source #

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 currently visible.

constructNativeDialogVisible :: (IsNativeDialog o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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 Source #

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 () Source #

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 () Source #

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

type NativeDialogResponseCallback Source #

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.

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

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 :: MonadIO m => NativeDialogResponseCallback -> m (GClosure C_NativeDialogResponseCallback) Source #

Wrap the callback into a GClosure.

mk_NativeDialogResponseCallback :: C_NativeDialogResponseCallback -> IO (FunPtr C_NativeDialogResponseCallback) Source #

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

noNativeDialogResponseCallback :: Maybe NativeDialogResponseCallback Source #

A convenience synonym for Nothing :: Maybe NativeDialogResponseCallback.

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

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 Source #

Wrap a NativeDialogResponseCallback into a C_NativeDialogResponseCallback.

Exported types

Instances

Instances

Methods

Click to display all available methods, including inherited ones

Methods

Getters

Setters

destroy

getModal

getTitle

getTransientFor

getVisible

hide

setModal

setTitle

setTransientFor

show

Properties

modal

title

transientFor

visible

Signals

response