GstPbutils.InstallPluginsContext¶

Fields¶

None

Methods¶

class	`new` ()
	`copy` ()
	`free` ()
	`set_confirm_search` (confirm_search)
	`set_desktop_id` (desktop_id)
	`set_startup_notification_id` (startup_id)
	`set_xid` (xid)

Details¶

class GstPbutils.InstallPluginsContext¶

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

classmethod new()[source]¶

Returns:: a new GstPbutils.InstallPluginsContext. Free with GstPbutils.InstallPluginsContext.free() when no longer needed
Return type:: GstPbutils.InstallPluginsContext

Creates a new GstPbutils.InstallPluginsContext.

copy()[source]¶

Returns:: A copy of self
Return type:: GstPbutils.InstallPluginsContext

Copies a GstPbutils.InstallPluginsContext.

New in version 1.12.1.

free()[source]¶: Frees a GstPbutils.InstallPluginsContext.

set_confirm_search(confirm_search)[source]¶

Parameters:: confirm_search (bool) – whether to ask for confirmation before searching for plugins

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.

New in version 1.6.

set_desktop_id(desktop_id)[source]¶

Parameters:: desktop_id (str) – the desktop file ID of the calling application

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.

New in version 1.6.

set_startup_notification_id(startup_id)[source]¶

Parameters:: startup_id (str) – the startup notification ID

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);
...

New in version 1.6.

set_xid(xid)[source]¶

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

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