Gjsify LogoGjsify Logo

Index

Variables

GSETTINGS_SCHEMA: string

The GSettings schema under which all Totem settings are stored.

Functions

  • get_plugin_paths(): string[]
  • Return a %NULL-terminated array of paths to directories which can contain Totem plugins. This respects the GSettings disable_user_plugins setting.

    Returns string[]

  • Put the given icon_name into button, and pack button into header according to pack_type.

    Parameters

    • header: Gtk.Widget

      The header widget to put the button in

    • button: Gtk.Widget

      The button to use in the header

    • icon_name: string

      The icon name for the button image

    • pack_type: Gtk.PackType

      A #GtkPackType to tell us where to include the button

    Returns Gtk.Widget

  • interface_error(title: string, reason: string, parent: Gtk.Window): void
  • Display a modal error dialogue with title as its primary error text, and reason as its secondary text.

    Parameters

    • title: string

      the error title

    • reason: string

      the error reason (secondary text)

    • parent: Gtk.Window

      the error dialogue's parent #GtkWindow

    Returns void

  • interface_error_blocking(title: string, reason: string, parent: Gtk.Window): void
  • Display a modal error dialogue like totem_interface_error() which blocks until the user has dismissed it.

    Parameters

    • title: string

      the error title

    • reason: string

      the error reason (secondary text)

    • parent: Gtk.Window

      the error dialogue's parent #GtkWindow

    Returns void

  • interface_error_with_link(title: string, reason: string, uri: string, label: string, parent: Gtk.Window): void
  • Display a modal error dialogue like totem_interface_error(), but add a button which will open uri in a browser window.

    Parameters

    • title: string

      the error title

    • reason: string

      the error reason (secondary text)

    • uri: string

      the URI to open

    • label: string

      a label for the URI's button, or %NULL to use uri as the label

    • parent: Gtk.Window

      the error dialogue's parent #GtkWindow

    Returns void

  • interface_get_full_path(name: string): string
  • interface_load(name: string, fatal: boolean, parent: Gtk.Window, user_data: object): Gtk.Builder
  • Load a #GtkBuilder UI file with the given name and return the #GtkBuilder instance for it. If loading the file fails, an error dialogue is shown.

    Parameters

    • name: string

      the #GtkBuilder UI file to load

    • fatal: boolean

      %TRUE if errors loading the file should be fatal, %FALSE otherwise

    • parent: Gtk.Window

      the parent window to use when displaying error dialogues, or %NULL

    • user_data: object

      the user data to pass to gtk_builder_connect_signals(), or %NULL

    Returns Gtk.Builder

  • interface_load_pixbuf(name: string): Pixbuf
  • Load the image called name in the directory given by totem_interface_get_full_path() into a #GdkPixbuf.

    Parameters

    • name: string

      the image file name

    Returns Pixbuf

  • interface_load_with_full_path(filename: string, fatal: boolean, parent: Gtk.Window, user_data: object): Gtk.Builder
  • Load a #GtkBuilder UI file from the given path and return the #GtkBuilder instance for it. If loading the file fails, an error dialogue is shown.

    Parameters

    • filename: string

      the #GtkBuilder UI file path to load

    • fatal: boolean

      %TRUE if errors loading the file should be fatal, %FALSE otherwise

    • parent: Gtk.Window

      the parent window to use when displaying error dialogues, or %NULL

    • user_data: object

      the user data to pass to gtk_builder_connect_signals(), or %NULL

    Returns Gtk.Builder

  • plugin_find_file(plugin_name: string, file: string): string
  • Finds the specified file by looking in the plugin paths listed by totem_get_plugin_paths() and then in the system Totem data directory.

    This should be used by plugins to find plugin-specific resource files.

    Parameters

    • plugin_name: string

      the plugin name

    • file: string

      the file to find

    Returns string

  • plugin_load_interface(plugin_name: string, name: string, fatal: boolean, parent: Gtk.Window, user_data: object): Gtk.Builder
  • Loads an interface file (GtkBuilder UI file) for a plugin, given its filename and assuming it's installed in the plugin's data directory.

    This should be used instead of attempting to load interfaces manually in plugins.

    Parameters

    • plugin_name: string

      the plugin name

    • name: string

      interface filename

    • fatal: boolean

      %TRUE if it's a fatal error if the interface can't be loaded

    • parent: Gtk.Window

      the interface's parent #GtkWindow

    • user_data: object

      a pointer to be passed to each signal handler in the interface when they're called

    Returns Gtk.Builder

  • remote_command_quark(): Quark
  • remote_setting_quark(): Quark

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