GI.Gtk.Objects.UriLauncher

A GtkUriLauncher object collects the arguments that are needed to open a uri with an application.

Depending on system configuration, user preferences and available APIs, this may or may not show an app chooser dialog or launch the default application right away.

The operation is started with the uriLauncherLaunch function. This API follows the GIO async pattern, and the result can be obtained by calling uriLauncherLaunchFinish.

To launch a file, use FileLauncher.

Since: 4.10

Exported types

newtype UriLauncher

Memory-managed wrapper type.

Constructors

UriLauncher (ManagedPtr UriLauncher)

Instances

Eq UriLauncher

Defined in GI.Gtk.Objects.UriLauncher

Methods

(==) :: UriLauncher -> UriLauncher -> Bool

(/=) :: UriLauncher -> UriLauncher -> Bool

GObject UriLauncher

Defined in GI.Gtk.Objects.UriLauncher

ManagedPtrNewtype UriLauncher

Defined in GI.Gtk.Objects.UriLauncher

Methods

toManagedPtr :: UriLauncher -> ManagedPtr UriLauncher

TypedObject UriLauncher

Defined in GI.Gtk.Objects.UriLauncher

Methods

glibType :: IO GType

HasParentTypes UriLauncher

Defined in GI.Gtk.Objects.UriLauncher

IsGValue (Maybe UriLauncher)

Convert UriLauncher to and from GValue. See toGValue and fromGValue.

Defined in GI.Gtk.Objects.UriLauncher

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe UriLauncher -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe UriLauncher)

type ParentTypes UriLauncher

Defined in GI.Gtk.Objects.UriLauncher

type ParentTypes UriLauncher = '[Object]

class (GObject o, IsDescendantOf UriLauncher o) => IsUriLauncher o

Type class for types which can be safely cast to UriLauncher, for instance with toUriLauncher.

Instances

(GObject o, IsDescendantOf UriLauncher o) => IsUriLauncher o

Defined in GI.Gtk.Objects.UriLauncher

toUriLauncher :: (MonadIO m, IsUriLauncher o) => o -> m UriLauncher

Cast to UriLauncher, 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

Methods

bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, launch, launchFinish, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getData, getProperty, getQdata, getUri.

Setters

setData, setDataFull, setProperty, setUri.

getUri

uriLauncherGetUri

Arguments

:: (HasCallStack, MonadIO m, IsUriLauncher a)

=> a

self: a GtkUriLauncher

-> m (Maybe Text)

Returns: the uri

Gets the uri that will be opened.

Since: 4.10

launch

uriLauncherLaunch

Arguments

:: (HasCallStack, MonadIO m, IsUriLauncher a, IsWindow b, IsCancellable c)

=> a

self: a GtkUriLauncher

-> Maybe b

parent: the parent GtkWindow

-> Maybe c

cancellable: a GCancellable to cancel the operation

-> Maybe AsyncReadyCallback

callback: a callback to call when the operation is complete

-> m ()

Launch an application to open the uri.

This may present an app chooser dialog to the user.

The callback will be called when the operation is completed. It should call uriLauncherLaunchFinish to obtain the result.

Since: 4.10

launchFinish

uriLauncherLaunchFinish

Arguments

:: (HasCallStack, MonadIO m, IsUriLauncher a, IsAsyncResult b)

=> a

self: a GtkUriLauncher

-> b

result: a GAsyncResult

-> m ()

(Can throw GError)

Finishes the uriLauncherLaunch call and returns the result.

Since: 4.10

new

uriLauncherNew

Arguments

:: (HasCallStack, MonadIO m)

=> Maybe Text

uri: the uri to open

-> m UriLauncher

Returns: the new GtkUriLauncher

Creates a new GtkUriLauncher object.

Since: 4.10

setUri

uriLauncherSetUri

Arguments

:: (HasCallStack, MonadIO m, IsUriLauncher a)

=> a

self: a GtkUriLauncher

-> Maybe Text

uri: the uri

-> m ()

Sets the uri that will be opened.

Since: 4.10

Properties

uri

The uri to launch.

Since: 4.10

clearUriLauncherUri :: (MonadIO m, IsUriLauncher o) => o -> m ()

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

clear #uri

constructUriLauncherUri :: (IsUriLauncher o, MonadIO m) => Text -> m (GValueConstruct o)

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

getUriLauncherUri :: (MonadIO m, IsUriLauncher o) => o -> m (Maybe Text)

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

get uriLauncher #uri

setUriLauncherUri :: (MonadIO m, IsUriLauncher o) => o -> Text -> m ()

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

set uriLauncher [ #uri := value ]