Gjsify LogoGjsify Logo

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

record

Hierarchy

  • InstallPluginsContext

Index

Constructors

Properties

name: string

Methods

  • free(): void
  • set_confirm_search(confirm_search: boolean): void
  • 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.

    Parameters

    • confirm_search: boolean

      whether to ask for confirmation before searching for plugins

    Returns void

  • set_desktop_id(desktop_id: string): void
  • 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.

    Parameters

    • desktop_id: string

      the desktop file ID of the calling application

    Returns void

  • set_startup_notification_id(startup_id: string): void
  • 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); ...


    @param startup_id the startup notification ID

    Parameters

    • startup_id: string

    Returns void

  • set_xid(xid: number): void
  • 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 ...


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

    Parameters

    • xid: number

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method