Class (GI Class)

Flatpak-1.0 ▶ Flatpak ▶ Installation

Hierarchy (View Summary)

Index

Constructors

constructor

Properties

$signals $gtype

Methods

_init add_remote cleanup_local_refs_sync connect connect_after create_monitor drop_caches emit fetch_remote_metadata_sync fetch_remote_ref_sync fetch_remote_ref_sync_full fetch_remote_size_sync get_config get_current_installed_app get_default_languages get_default_locales get_display_name get_id get_installed_ref get_is_user get_min_free_space_bytes get_no_interaction get_path get_priority get_remote_by_name get_storage_type install install_bundle install_full install_ref_file launch launch_full list_installed_refs list_installed_refs_by_kind list_installed_refs_for_update list_installed_related_refs_sync list_pinned_refs list_remote_refs_sync list_remote_refs_sync_full list_remote_related_refs_for_installed_sync list_remote_related_refs_sync list_remotes list_remotes_by_type list_unused_refs list_unused_refs_with_options load_app_overrides modify_remote prune_local_repo remove_local_ref_sync remove_remote run_triggers set_config_sync set_no_interaction uninstall uninstall_full update update_appstream_full_sync update_appstream_sync update_full update_remote_sync new_for_path new_system new_system_with_id new_user

Methods - Inherited from GObject

bind_property bind_property_full block_signal_handler disconnect force_floating freeze_notify get_data get_property get_qdata getv is_floating notify notify_by_pspec ref ref_sink run_dispose set set_data set_property steal_data steal_qdata stop_emission_by_name thaw_notify unblock_signal_handler unref vfunc_constructed vfunc_dispatch_properties_changed vfunc_dispose vfunc_finalize vfunc_get_property vfunc_notify vfunc_set_property watch_closure _classInit compat_control find_property install_properties install_property interface_find_property interface_install_property interface_list_properties list_properties newv override_property

Constructors

Properties

$signals: Flatpak.Installation.SignalSignatures

Compile-time signal type information.

This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.

$gtype: GType<Flatpak.Installation>

Methods

_init

  • Adds a new remote object to the set of remotes. This is similar to flatpak_installation_modify_remote() for non-existing remote names. However, if the named remote already exists then instead of modifying it it fails with Flatpak.Error.ALREADY_INSTALLED, or if if_needed is true it silently succeeds without doing anything.

    As an exception to the last, if the local config has a filter defined, but the new remote unsets the filter (for example, it comes from an unfiltered .flatpakref via flatpak_remote_new_from_file()) the the local remote filter gets reset. This is to allow the setup where there is a default setup of a filtered remote, yet you can still use the standard flatpakref file to get the full contents without getting two remotes.

    Parameters

    Returns boolean

    true if the modifications have been committed successfully

  • Remove all OSTree refs from the local flatpak repository which are not in a deployed state. The next time the underlying OSTree repo is pruned, objects which were attached to that ref will be removed. This is useful if you pulled a flatpak refs using flatpak_installation_install_full() and specified Flatpak.InstallFlags.NO_DEPLOY but then decided not to deploy the refs later on and want to remove the local refs to prevent them from taking up disk space. Note that this will not remove the objects referred to by ref from the underlying OSTree repo, you should use flatpak_installation_prune_local_repo() to do that.

    Parameters

    Returns boolean

    true on success

  • Gets information about the maximum amount of data that needs to be transferred to pull the ref from a remote repository, and about the amount of local disk space that is required to check out this commit.

    Note that if there are locally available data that are in the ref, which is common for instance if you're doing an update then the real download size may be smaller than what is returned here.

    NOTE: Since 0.11.4 this information is accessible in FlatpakRemoteRef, so this function is not very useful anymore.

    Parameters

    Returns [boolean, number, number]

    true, unless an error occurred

  • Get the default languages used by the installation to decide which subpaths to install of locale extensions. This list may also be used by frontends like GNOME Software to decide which language-specific apps to display. An empty array means that all languages should be installed.

    Returns string[]

    A possibly empty array of strings, or null on error.

  • Like flatpak_installation_get_default_languages() but includes territory information (e.g. en_US rather than en) which may be included in the extra-languages configuration.

    Strings returned by this function are in the format specified by setlocale(): language[_territory][.codeset][modifier].

    Returns string[]

    A possibly empty array of locale strings, or null on error.

  • Returns the display name of the installation for self.

    Note that this function may return null if the installation does not have a display name.

    Returns string

    a string with the installation's display name

  • Returns the ID of the installation for self.

    The ID for the default system installation is "default". The ID for the user installation is "user".

    Returns string

    a string with the installation's ID

  • Returns whether the installation is for a user-specific location.

    Returns boolean

    true if self is a per-user installation

  • Returns the min-free-space config value from the OSTree repository of this installation.

    Applications can use this value, together with information about the available disk space and the size of pending updates or installs, to estimate whether a pull operation will fail due to running out of disk space.

    Returns [boolean, number]

    true on success, or false on error.

  • Returns the value set with flatpak_installation_set_no_interaction().

    Returns boolean

    true if interactive authorization dialogs are not allowed

  • Returns the numeric priority of the installation for self.

    Returns number

    an integer with the configured priority value

  • This is an old deprecated function, you should use Flatpak.Transaction and flatpak_transaction_add_install() instead. It has a lot more interesting features.

    Install a new application or runtime.

    Note that this function was originally written to always return a Flatpak.InstalledRef. Since 0.9.13, passing FLATPAK_INSTALL_FLAGS_NO_DEPLOY will only pull refs into the local flatpak repository without deploying them, however this function will be unable to provide information on the installed ref, so FLATPAK_ERROR_ONLY_PULLED will be set and the caller must respond accordingly.

    Parameters

    • remote_name: string

      name of the remote to use

    • kind: Flatpak.RefKind

      what this ref contains (an Flatpak.RefKind)

    • name: string

      name of the app/runtime to fetch

    • Optionalarch: string

      which architecture to fetch (default: current architecture)

    • Optionalbranch: string

      which branch to fetch (default: 'master')

    • Optionalprogress: ProgressCallback

      progress callback

    • Optionalcancellable: Gio.Cancellable

      a Gio.Cancellable

    Returns Flatpak.InstalledRef

    The ref for the newly installed app or null on failure

  • This is an old deprecated function, you should use Flatpak.Transaction and flatpak_transaction_add_install() instead. It has a lot more interesting features.

    Install a new application or runtime.

    Note that this function was originally written to always return a Flatpak.InstalledRef. Since 0.9.13, passing FLATPAK_INSTALL_FLAGS_NO_DEPLOY will only pull refs into the local flatpak repository without deploying them, however this function will be unable to provide information on the installed ref, so FLATPAK_ERROR_ONLY_PULLED will be set and the caller must respond accordingly.

    Parameters

    Returns Flatpak.InstalledRef

    The ref for the newly installed app or null on failure

  • Launch an installed application.

    You can use flatpak_installation_get_installed_ref() or flatpak_installation_get_current_installed_app() to find out what builds are available, in order to get a value for commit.

    Parameters

    • name: string

      name of the app to launch

    • Optionalarch: string

      which architecture to launch (default: current architecture)

    • Optionalbranch: string

      which branch of the application (default: "master")

    • Optionalcommit: string

      the commit of branch to launch

    • Optionalcancellable: Gio.Cancellable

      a Gio.Cancellable

    Returns boolean

    true, unless an error occurred

  • Launch an installed application.

    You can use flatpak_installation_get_installed_ref() or flatpak_installation_get_current_installed_app() to find out what builds are available, in order to get a value for commit.

    Compared to flatpak_installation_launch(), this function returns a Flatpak.Instance that can be used to get information about the running instance. You can also use it to wait for the instance to be done with g_child_watch_add() if you pass the #FLATPAK_LAUNCH_FLAGS_DO_NOT_REAP flag.

    Parameters

    Returns boolean

    true, unless an error occurred

  • Lists all the locally installed refs that are related to ref. These are things that are interesting to install, update, or uninstall together with ref. For instance, locale data or debug information.

    Note that while the related refs are usually installed from the same remote as ref (remote_name), it is possible they were installed from another remote.

    This function is similar to flatpak_installation_list_remote_related_refs_sync, but instead of looking at what is available on the remote, it only looks at the locally installed refs. This is useful for instance when you're looking for related refs to uninstall, or when you're planning to use FLATPAK_UPDATE_FLAGS_NO_PULL to install previously pulled refs.

    Parameters

    Returns Flatpak.RelatedRef[]

    a GPtrArray of Flatpak.RelatedRef instances

  • Lists the installed references that are pinned, meaning they will not be returned by flatpak_installation_list_unused_refs() and won't be removed unless explicitly specified for removal.

    Refs appear here either because they have been pinned automatically by Flatpak or because the user pinned them; see flatpak-pin(1).

    Parameters

    Returns Flatpak.InstalledRef[]

    a GPtrArray of Flatpak.InstalledRef instances

  • Lists all the available refs on remote_name that are related to ref, and which are appropriate for the installed version of ref. For example if the installed version of org.videolan.VLC has a related ref of org.videolan.VLC.Plugin.bdj//3-19.08 and the remote version of VLC has a related ref of org.videolan.VLC.Plugin.bdj//3-20.08, this function will only return the 3-19.08 branch.

    See also the related functions flatpak_installation_list_remote_related_refs_sync() and flatpak_installation_list_installed_related_refs_sync().

    The returned list contains all available related refs, but not every one should always be installed. For example, flatpak_related_ref_should_download() returns true if the reference should be installed/updated with the app, and flatpak_related_ref_should_delete() returns true if it should be uninstalled with the main ref.

    The commit property of each Flatpak.RelatedRef is not guaranteed to be non-null.

    Parameters

    Returns Flatpak.RelatedRef[]

    a GPtrArray of Flatpak.RelatedRef instances

  • Lists all the available refs on remote_name that are related to ref, and the subpaths to use. These are things that are interesting to install, update, or uninstall together with ref. For instance, locale data or debug information.

    The returned list contains all available related refs, but not every one should always be installed. For example, flatpak_related_ref_should_download() returns true if the reference should be installed/updated with the app, and flatpak_related_ref_should_delete() returns true if it should be uninstalled with the main ref.

    The commit property of each Flatpak.RelatedRef is not guaranteed to be non-null.

    Parameters

    Returns Flatpak.RelatedRef[]

    a GPtrArray of Flatpak.RelatedRef instances

  • Like flatpak_installation_list_unused_refs() but supports an extensible set of options as well as an metadata_injection parameter. The following are currently defined:

    • exclude-refs (as): Act as if these refs are not installed even if they are when determining the set of unused refs
    • filter-by-eol (b): Return refs as unused if they are End-Of-Life. Note that if this option is combined with other filters then non-EOL refs may also be returned.
    • filter-by-autoprune (b): Return refs as unused if they should be autopruned. Note that if this option is combined with other filters then non-autoprune refs may also be returned.

    Parameters

    • Optionalarch: string

      if non-null, the architecture of refs to collect

    • Optionalmetadata_injection: GLib.HashTable<any, any>

      if non-null, a GLib.HashTable mapping refs to GLib.KeyFile objects, which when available will be used instead of installed metadata

    • Optionaloptions: GLib.Variant<any>

      if non-null, a GVariant a{sv} with an extensible set of options

    • Optionalcancellable: Gio.Cancellable

      a Gio.Cancellable

    Returns Flatpak.InstalledRef[]

    a GPtrArray of Flatpak.InstalledRef instances

  • Remove the OSTree ref given by remote_name:ref from the local flatpak repository. The next time the underlying OSTree repo is pruned, objects which were attached to that ref will be removed. This is useful if you pulled a flatpak ref using flatpak_installation_install_full() and specified Flatpak.InstallFlags.NO_DEPLOY but then decided not to deploy the ref later on and want to remove the local ref to prevent it from taking up disk space. Note that this will not remove the objects referred to by ref from the underlying OSTree repo, you should use flatpak_installation_prune_local_repo() to do that.

    Parameters

    Returns boolean

    true on success

  • Set a global configuration option for the installation, currently the only supported keys are languages, which is a semicolon-separated list of language codes like "sv;en;pl", or "" to mean all languages, and extra-languages, which is a semicolon-separated list of locale identifiers like "en;en_DK;zh_HK.big5hkscs;uz_UZ.utf8@cyrillic".

    Parameters

    Returns boolean

    true if the option was set correctly

  • This method can be used to prevent interactive authorization dialogs to appear for operations on self. This is useful for background operations that are not directly triggered by a user action.

    By default, interaction is allowed.

    Parameters

    • no_interaction: boolean

      Whether to disallow interactive authorization for operations

    Returns void

  • This is an old deprecated function, you should use Flatpak.Transaction and flatpak_transaction_add_uninstall() instead. It has a lot more interesting features.

    Uninstall an application or runtime.

    Parameters

    • kind: Flatpak.RefKind

      what this ref contains (an Flatpak.RefKind)

    • name: string

      name of the app or runtime to uninstall

    • Optionalarch: string

      architecture of the app or runtime to uninstall; if null, flatpak_get_default_arch() is assumed

    • Optionalbranch: string

      name of the branch of the app or runtime to uninstall; if null, master is assumed

    • Optionalprogress: ProgressCallback

      the callback

    • Optionalcancellable: Gio.Cancellable

      a Gio.Cancellable

    Returns boolean

    true on success

  • Updates the local copy of appstream for remote_name for the specified arch.

    Parameters

    • remote_name: string

      the name of the remote

    • Optionalarch: string

      Architecture to update, or null for the local machine arch

    • Optionalprogress: ProgressCallback

      progress callback

    • Optionalout_changed: boolean

      Set to true if the contents of the appstream changed, false if nothing changed

    • Optionalcancellable: Gio.Cancellable

      a Gio.Cancellable

    Returns boolean

    true on success, or false on error

  • Updates the local copy of appstream for remote_name for the specified arch. If you need progress feedback, use flatpak_installation_update_appstream_full_sync().

    Parameters

    • remote_name: string

      the name of the remote

    • Optionalarch: string

      Architecture to update, or null for the local machine arch

    • Optionalout_changed: boolean

      Set to true if the contents of the appstream changed, false if nothing changed

    • Optionalcancellable: Gio.Cancellable

      a Gio.Cancellable

    Returns boolean

    true on success, or false on error

  • Updates the local configuration of a remote repository by fetching the related information from the summary file in the remote OSTree repository and committing the changes to the local installation.

    Parameters

    Returns boolean

    true if the remote has been updated successfully

Methods - Inherited from GObject

  • Creates a binding between source_property on source and target_property on target.

    Whenever the source_property is changed the target_property is updated using the same value. For instance:

      g_object_bind_property (action, "active", widget, "sensitive", 0);

    Will result in the "sensitive" property of the widget GObject.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.

    If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well.

    The binding will automatically be removed when either the source or the target instances are finalized. To remove the binding without affecting the source and the target you can just call g_object_unref() on the returned GObject.Binding instance.

    Removing the binding by calling g_object_unref() on it must only be done if the binding, source and target are only used from a single thread and it is clear that both source and target outlive the binding. Especially it is not safe to rely on this if the binding, source or target can be finalized from different threads. Keep another reference to the binding and use g_binding_unbind() instead to be on the safe side.

    A GObject.Object can have multiple bindings.

    Parameters

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Complete version of g_object_bind_property().

    Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well. The transform_from function is only used in case of bidirectional bindings, otherwise it will be ignored

    The binding will automatically be removed when either the source or the target instances are finalized. This will release the reference that is being held on the GObject.Binding instance; if you want to hold on to the GObject.Binding instance, you will need to hold a reference to it.

    To remove the binding, call g_binding_unbind().

    A GObject.Object can have multiple bindings.

    The same user_data parameter will be used for both transform_to and transform_from transformation functions; the notify function will be called once, when the binding is removed. If you need different data for each transformation function, please use g_object_bind_property_with_closures() instead.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target GObject.Object

    • target_property: string

      the property on target to bind

    • flags: GObject.BindingFlags

      flags to pass to GObject.Binding

    • Optionaltransform_to: BindingTransformFunc

      the transformation function from the source to the target, or null to use the default

    • Optionaltransform_from: BindingTransformFunc

      the transformation function from the target to the source, or null to use the default

    • Optionalnotify: DestroyNotify

      a function to call when disposing the binding, to free resources used by the transformation functions, or null if not required

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    This function is the language bindings friendly version of g_object_bind_property_full(), using GClosures instead of function pointers.

    Parameters

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.

    Parameters

    • id: number

      Handler ID of the handler to be disconnected

    Returns void

  • This function is intended for GObject.Object implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().

    Returns void

  • Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one GObject.Object::notify signal is emitted for each property modified while the object is frozen.

    This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.

    Returns void

  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • key: string

      name of the key for that association

    Returns any

    the data if found, or null if no such data exists.

  • Gets a property of an object.

    The value can be:

    • an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a GObject.Value initialized with the expected type of the property
    • a GObject.Value initialized with a type to which the expected type of the property can be transformed

    In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.

    Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.

    Parameters

    • property_name: string

      The name of the property to get

    • value: any

      Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type

    Returns any

  • This function gets back user data pointers stored via g_object_set_qdata().

    Parameters

    • quark: number

      A GLib.Quark, naming the user data pointer

    Returns any

    The user data pointer set, or null

  • Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    • property_name: string

      the name of a property installed on the class of object.

    Returns void

  • Emits a "notify" signal for the property specified by pspec on object.

    This function omits the property name lookup, hence it is faster than g_object_notify().

    One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:

      typedef enum
      {
        PROP_FOO = 1,
        PROP_LAST
      } MyObjectProperty;

      static GParamSpec *properties[PROP_LAST];

      static void
      my_object_class_init (MyObjectClass *klass)
      {
        properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
                                                 0, 100,
                                                 50,
                                                 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
        g_object_class_install_property (gobject_class,
                                         PROP_FOO,
                                         properties[PROP_FOO]);
      }

    and then notify a change on the "foo" property with:

      g_object_notify_by_pspec (self, properties[PROP_FOO]);

    Parameters

    Returns void

  • Increases the reference count of object.

    Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type of object will be propagated to the return type (using the GCC typeof() extension), so any casting the caller needs to do on the return type must be explicit.

    Returns GObject.Object

    the same object

  • Increase the reference count of object, and possibly remove the [floating][floating-ref] reference, if object has a floating reference.

    In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.

    Since GLib 2.56, the type of object will be propagated to the return type under the same conditions as for g_object_ref().

    Returns GObject.Object

    object

  • Releases all references to other objects. This can be used to break reference cycles.

    This function should only be called from object system implementations.

    Returns void

  • Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.

    Parameters

    • properties: { [key: string]: any }

      Object containing the properties to set

    Returns void

  • Each object carries around a table of associations from strings to pointers. This function lets you set an association.

    If the object already had an association with that name, the old association will be destroyed.

    Internally, the key is converted to a GLib.Quark using g_quark_from_string(). This means a copy of key is kept permanently (even after object has been finalized) — so it is recommended to only use a small, bounded set of values for key in your program, to avoid the GLib.Quark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optionaldata: any

      data to associate with that key

    Returns void

  • Sets a property on an object.

    Parameters

    • property_name: string

      The name of the property to set

    • value: any

      The value to set the property to

    Returns void

  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • key: string

      name of the key

    Returns any

    the data if found, or null if no such data exists.

  • This function gets back user data pointers stored via g_object_set_qdata() and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

    void
    object_add_to_user_list (GObject     *object,
                             const gchar *new_string)
    {
      // the quark, naming the object data
      GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
      // retrieve the old string list
      GList *list = g_object_steal_qdata (object, quark_string_list);

      // prepend new string
      list = g_list_prepend (list, g_strdup (new_string));
      // this changed 'list', so we need to set it again
      g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
    }
    static void
    free_string_list (gpointer data)
    {
      GList *node, *list = data;

      for (node = list; node; node = node->next)
        g_free (node->data);
      g_list_free (list);
    }

    Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().

    Parameters

    • quark: number

      A GLib.Quark, naming the user data pointer

    Returns any

    The user data pointer set, or null

  • Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.

    Parameters

    • detailedName: string

      Name of the signal to stop emission of

    Returns void

  • Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

    Duplicate notifications for each property are squashed so that at most one GObject.Object::notify signal is emitted for each property, in the reverse order in which they have been queued.

    It is an error to call this function when the freeze count is zero.

    Returns void

  • Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

    If the pointer to the GObject.Object may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to null rather than retain a dangling pointer to a potentially invalid GObject.Object instance. Use g_clear_object() for this.

    Returns void

  • the constructed function is called by g_object_new() as the final step of the object creation process. At the point of the call, all construction properties have been set on the object. The purpose of this call is to allow for object initialisation steps that can only be performed after construction properties have been set. constructed implementors should chain up to the constructed call of their parent class to allow it to complete its initialisation.

    Returns void

  • the dispose function is supposed to drop all references to other objects, but keep the instance otherwise intact, so that client method invocations still work. It may be run multiple times (due to reference loops). Before returning, dispose should chain up to the dispose method of the parent class.

    Returns void

  • instance finalization function, should finish the finalization of the instance begun in dispose and chain up to the finalize method of the parent class.

    Returns void

  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    Returns void

  • the generic setter for all properties of this type. Should be overridden for every type with properties. If implementations of set_property don't emit property change notification explicitly, this will be done implicitly by the type system. However, if the notify signal is emitted explicitly, the type system will not emit it a second time.

    Parameters

    Returns void

  • This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

    Parameters

    Returns void

Static_classInit

  • Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created GObject.ParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.

    This function is meant to be called from the interface's default vtable initialization function (the class_init member of GObject.TypeInfo.) It must not be called after after class_init has been called for any object types implementing this interface.

    If pspec is a floating reference, it will be consumed.

    Parameters

    Returns void

  • Parameters

    • property_id: number

      the new property ID

    • name: string

      the name of a property registered in a parent class or in an interface of this class.

    Returns void

Interfaces

ConstructorProps
SignalSignatures