gi-gstpbutils-1.0.25: GStreamer Plugins Base Utils bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.GstPbutils.Structs.InstallPluginsContext

Description

Opaque context structure for the plugin installation. Use the provided API to set details on it.

Synopsis

Exported types

newtype InstallPluginsContext Source #

Memory-managed wrapper type.

Constructors

InstallPluginsContext (ManagedPtr InstallPluginsContext) 

Methods

Click to display all available methods, including inherited ones

Expand

Methods

copy, free.

Getters

None.

Setters

setConfirmSearch, setDesktopId, setStartupNotificationId, setXid.

copy

free

new

setConfirmSearch

installPluginsContextSetConfirmSearch Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> InstallPluginsContext

ctx: a InstallPluginsContext

-> Bool

confirmSearch: whether to ask for confirmation before searching for plugins

-> m () 

This function is used to tell the external installer process whether it should ask for confirmation or not before searching for missing plugins.

If set, this option will be passed to the installer via a --interaction=[show-confirm-search|hide-confirm-search] command line option.

Since: 1.6

setDesktopId

installPluginsContextSetDesktopId Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> InstallPluginsContext

ctx: a InstallPluginsContext

-> Text

desktopId: the desktop file ID of the calling application

-> m () 

This function is used to pass the calling application's desktop file ID to the external installer process.

A desktop file ID is the basename of the desktop file, including the .desktop extension.

If set, the desktop file ID will be passed to the installer via a --desktop-id= command line option.

Since: 1.6

setStartupNotificationId

installPluginsContextSetStartupNotificationId Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> InstallPluginsContext

ctx: a InstallPluginsContext

-> Text

startupId: the startup notification ID

-> m () 

Sets the startup notification ID for the launched process.

This is typically used to to pass the current X11 event timestamp to the external installer process.

Startup notification IDs are defined in the FreeDesktop.Org Startup Notifications standard.

If set, the ID will be passed to the installer via a --startup-notification-id= command line option.

GTK+/GNOME applications should be able to create a startup notification ID like this: > > timestamp = gtk_get_current_event_time (); > startup_id = g_strdup_printf ("_TIME%u", timestamp); >...

Since: 1.6

setXid

installPluginsContextSetXid Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> InstallPluginsContext

ctx: a InstallPluginsContext

-> Word32

xid: the XWindow ID (XID) of the top-level application

-> m () 

This function is for X11-based applications (such as most Gtk/Qt applications on linux/unix) only. You can use it to tell the external installer the XID of your main application window. That way the installer can make its own window transient to your application window during the installation.

If set, the XID will be passed to the installer via a --transient-for=XID command line option.

Gtk+/Gnome application should be able to obtain the XID of the top-level window like this: > >##include gtk/gtk.h >##ifdef GDK_WINDOWING_X11 >##include gdk/gdkx.h >##endif >... >##ifdef GDK_WINDOWING_X11 > xid = GDK_WINDOW_XWINDOW (GTK_WIDGET (application_window)->window); >##endif >...