Class (GI Class)

Gio-2.0GioFileInfo

Stores information about a file system object referenced by a Gio.File.

Functionality for manipulating basic metadata for files. Gio.FileInfo implements methods for getting information that all files should contain, and allows for manipulation of extended attributes.

See the file attributes document for more information on how GIO handles file attributes.

To obtain a Gio.FileInfo for a Gio.File, use Gio.File.query_info (or its async variant). To obtain a Gio.FileInfo for a file input or output stream, use Gio.FileInputStream.query_info or Gio.FileOutputStream.query_info (or their async variants).

To change the actual attributes of a file, you should then set the attribute in the Gio.FileInfo and call Gio.File.set_attributes_from_info or Gio.File.set_attributes_async on a Gio.File.

However, not all attributes can be changed in the file. For instance, the actual size of a file cannot be changed via Gio.FileInfo.set_size. You may call Gio.File.query_settable_attributes and Gio.File.query_writable_namespaces to discover the settable attributes of a particular file at runtime.

The direct accessors, such as Gio.FileInfo.get_name, are slightly more optimized than the generic attribute accessors, such as Gio.FileInfo.get_attribute_byte_string.This optimization will matter only if calling the API in a tight loop.

It is an error to call these accessors without specifying their required file attributes when creating the Gio.FileInfo. Use Gio.FileInfo.has_attribute or Gio.FileInfo.list_attributes to check what attributes are specified for a Gio.FileInfo.

Gio.FileAttributeMatcher allows for searching through a Gio.FileInfo for attributes.

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Methods - Inherited from GObject

Constructors

Properties

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

Methods

  • Gets the access time of the current info and returns it as a GLib.DateTime.

    It is an error to call this if the Gio.FileInfo does not contain G_FILE_ATTRIBUTE_TIME_ACCESS. If G_FILE_ATTRIBUTE_TIME_ACCESS_USEC is provided, the resulting GLib.DateTime will additionally have microsecond precision.

    If nanosecond precision is needed, G_FILE_ATTRIBUTE_TIME_ACCESS_NSEC must be queried separately using g_file_info_get_attribute_uint32().

    Returns GLib.DateTime

    access time, or null if unknown

  • Gets the value of an attribute, formatted as a human readable string.

    This escapes things as needed to make the string valid UTF-8 and readable by humans. It’s not meant to be a machine readable or reversible escaping format.

    To format file name attributes of type Gio.FileAttributeType.BYTE_STRING for output as UTF-8, use GLib.filename_to_utf8 instead:

    const char *trash_orig_path_byte_string;
    g_autofree char *trash_orig_path_utf8 = NULL;

    trash_orig_path_byte_string = g_file_info_get_attribute_byte_string (info, G_FILE_ATTRIBUTE_TRASH_ORIG_PATH);
    trash_orig_path_utf8 = g_filename_to_utf8 (trash_orig_path_byte_string, -1, NULL, NULL, NULL);
    if (trash_orig_path_utf8 != NULL)
    g_message ("Some larger UTF-8 string with filename embedded as %s", trash_orig_path_utf8);

    Parameters

    • attribute: string

      a file attribute key.

    Returns string

    a UTF-8 string associated with the given attribute, or null if the attribute wasn’t set. When you're done with the string it must be freed with g_free().

  • Gets the value of a boolean attribute. If the attribute does not contain a boolean value, false will be returned.

    Parameters

    • attribute: string

      a file attribute key.

    Returns boolean

    the boolean value contained within the attribute.

  • Gets the value of a byte string attribute. If the attribute does not contain a byte string, null will be returned.

    Parameters

    • attribute: string

      a file attribute key.

    Returns string

    the contents of the attribute value as a byte string, or null otherwise.

  • Gets the value of a byte string attribute as a file path.

    If the attribute does not contain a byte string, NULL will be returned.

    This function is meant to be used by language bindings that have specific handling for Unix paths.

    Parameters

    • attribute: string

      a file attribute key.

    Returns string

    the contents of the attribute value as a file path, or null otherwise.

  • Gets a signed 32-bit integer contained within the attribute. If the attribute does not contain a signed 32-bit integer, or is invalid, 0 will be returned.

    Parameters

    • attribute: string

      a file attribute key.

    Returns number

    a signed 32-bit integer from the attribute.

  • Gets a signed 64-bit integer contained within the attribute. If the attribute does not contain a signed 64-bit integer, or is invalid, 0 will be returned.

    Parameters

    • attribute: string

      a file attribute key.

    Returns number

    a signed 64-bit integer from the attribute.

  • Gets the value of a string attribute. If the attribute does not contain a string, null will be returned.

    Parameters

    • attribute: string

      a file attribute key.

    Returns string

    the contents of the attribute value as a UTF-8 string, or null otherwise.

  • Gets the value of a stringv attribute. If the attribute does not contain a stringv, null will be returned.

    Parameters

    • attribute: string

      a file attribute key.

    Returns string[]

    the contents of the attribute value as a stringv, or null otherwise. Do not free. These returned strings are UTF-8.

  • Gets an unsigned 32-bit integer contained within the attribute. If the attribute does not contain an unsigned 32-bit integer, or is invalid, 0 will be returned.

    Parameters

    • attribute: string

      a file attribute key.

    Returns number

    an unsigned 32-bit integer from the attribute.

  • Gets a unsigned 64-bit integer contained within the attribute. If the attribute does not contain an unsigned 64-bit integer, or is invalid, 0 will be returned.

    Parameters

    • attribute: string

      a file attribute key.

    Returns number

    a unsigned 64-bit integer from the attribute.

  • Gets the file's content type.

    It is an error to call this if the Gio.FileInfo does not contain G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE.

    Returns string

    a string containing the file's content type, or null if unknown.

  • Gets the creation time of the current info and returns it as a GLib.DateTime.

    It is an error to call this if the Gio.FileInfo does not contain G_FILE_ATTRIBUTE_TIME_CREATED. If G_FILE_ATTRIBUTE_TIME_CREATED_USEC is provided, the resulting GLib.DateTime will additionally have microsecond precision.

    If nanosecond precision is needed, G_FILE_ATTRIBUTE_TIME_CREATED_NSEC must be queried separately using g_file_info_get_attribute_uint32().

    Returns GLib.DateTime

    creation time, or null if unknown

  • Gets a display name for a file. This is guaranteed to always be set.

    It is an error to call this if the Gio.FileInfo does not contain G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME.

    Returns string

    a string containing the display name.

  • Gets the edit name for a file.

    It is an error to call this if the Gio.FileInfo does not contain G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME.

    Returns string

    a string containing the edit name.

  • Gets the [entity tag][iface@Gio.File#entity-tags] for a given Gio.FileInfo. See G_FILE_ATTRIBUTE_ETAG_VALUE.

    It is an error to call this if the Gio.FileInfo does not contain G_FILE_ATTRIBUTE_ETAG_VALUE.

    Returns string

    a string containing the value of the "etag:value" attribute.

  • Gets a file's type (whether it is a regular file, symlink, etc). This is different from the file's content type, see g_file_info_get_content_type().

    It is an error to call this if the Gio.FileInfo does not contain G_FILE_ATTRIBUTE_STANDARD_TYPE.

    Returns Gio.FileType

    a Gio.FileType for the given file.

  • Checks if a file is a backup file.

    It is an error to call this if the Gio.FileInfo does not contain G_FILE_ATTRIBUTE_STANDARD_IS_BACKUP.

    Returns boolean

    true if file is a backup file, false otherwise.

  • Checks if a file is hidden.

    It is an error to call this if the Gio.FileInfo does not contain G_FILE_ATTRIBUTE_STANDARD_IS_HIDDEN.

    Returns boolean

    true if the file is a hidden file, false otherwise.

  • Checks if a file is a symlink.

    It is an error to call this if the Gio.FileInfo does not contain G_FILE_ATTRIBUTE_STANDARD_IS_SYMLINK.

    Returns boolean

    true if the given info is a symlink.

  • Gets the modification time of the current info and returns it as a GLib.DateTime.

    It is an error to call this if the Gio.FileInfo does not contain G_FILE_ATTRIBUTE_TIME_MODIFIED. If G_FILE_ATTRIBUTE_TIME_MODIFIED_USEC is provided, the resulting GLib.DateTime will additionally have microsecond precision.

    If nanosecond precision is needed, G_FILE_ATTRIBUTE_TIME_MODIFIED_NSEC must be queried separately using g_file_info_get_attribute_uint32().

    Returns GLib.DateTime

    modification time, or null if unknown

  • Gets the modification time of the current info and sets it in result.

    It is an error to call this if the Gio.FileInfo does not contain G_FILE_ATTRIBUTE_TIME_MODIFIED. If G_FILE_ATTRIBUTE_TIME_MODIFIED_USEC is provided it will be used too.

    Returns TimeVal

  • Gets the name for a file. This is guaranteed to always be set.

    It is an error to call this if the Gio.FileInfo does not contain G_FILE_ATTRIBUTE_STANDARD_NAME.

    Returns string

    a string containing the file name.

  • Gets the file's size (in bytes). The size is retrieved through the value of the G_FILE_ATTRIBUTE_STANDARD_SIZE attribute and is converted from guint64 to goffset before returning the result.

    It is an error to call this if the Gio.FileInfo does not contain G_FILE_ATTRIBUTE_STANDARD_SIZE.

    Returns number

    a goffset containing the file's size (in bytes).

  • Gets the value of the sort_order attribute from the Gio.FileInfo. See G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER.

    It is an error to call this if the Gio.FileInfo does not contain G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER.

    Returns number

    a gint32 containing the value of the "standard::sort_order" attribute.

  • Gets the symlink target for a given Gio.FileInfo.

    It is an error to call this if the Gio.FileInfo does not contain G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET.

    Returns string

    a string containing the symlink target.

  • Checks if a file info structure has an attribute named attribute.

    Parameters

    • attribute: string

      a file attribute key.

    Returns boolean

    true if info has an attribute named attribute, false otherwise.

  • Checks if a file info structure has an attribute in the specified name_space.

    Parameters

    • name_space: string

      a file attribute namespace.

    Returns boolean

    true if info has an attribute in name_space, false otherwise.

  • Lists the file info structure's attributes.

    Parameters

    • Optionalname_space: string

      a file attribute key's namespace, or null to list all attributes.

    Returns string[]

    a null-terminated array of strings of all of the possible attribute types for the given name_space, or null on error.

  • Removes all cases of attribute from info if it exists.

    Parameters

    • attribute: string

      a file attribute key.

    Returns void

  • Sets the G_FILE_ATTRIBUTE_TIME_ACCESS and G_FILE_ATTRIBUTE_TIME_ACCESS_USEC attributes in the file info to the given date/time value.

    G_FILE_ATTRIBUTE_TIME_ACCESS_NSEC will be cleared.

    Parameters

    Returns void

  • Sets the attribute to contain the given attr_value, if possible.

    Parameters

    • attribute: string

      a file attribute key.

    • attr_value: boolean

      a boolean value.

    Returns void

  • Sets the attribute to contain the given attr_value, if possible.

    Parameters

    • attribute: string

      a file attribute key.

    • attr_value: string

      a byte string.

    Returns void

  • Sets the attribute to contain the given attr_value, if possible.

    This function is meant to be used by language bindings that have specific handling for Unix paths.

    Parameters

    • attribute: string

      a file attribute key.

    • attr_value: string

      a file path.

    Returns void

  • Sets the attribute to contain the given attr_value, if possible.

    Parameters

    • attribute: string

      a file attribute key.

    • attr_value: number

      a signed 32-bit integer

    Returns void

  • Sets the attribute to contain the given attr_value, if possible.

    Parameters

    • attribute: string

      attribute name to set.

    • attr_value: number

      int64 value to set attribute to.

    Returns void

  • Sets the attribute status for an attribute key. This is only needed by external code that implement g_file_set_attributes_from_info() or similar functions.

    The attribute must exist in info for this to work. Otherwise false is returned and info is unchanged.

    Parameters

    Returns boolean

    true if the status was changed, false if the key was not set.

  • Sets the attribute to contain the given attr_value, if possible.

    Parameters

    • attribute: string

      a file attribute key.

    • attr_value: string

      a UTF-8 string.

    Returns void

  • Sets the attribute to contain the given attr_value, if possible.

    Sinze: 2.22

    Parameters

    • attribute: string

      a file attribute key

    • attr_value: string[]

      a null terminated array of UTF-8 strings.

    Returns void

  • Sets the attribute to contain the given attr_value, if possible.

    Parameters

    • attribute: string

      a file attribute key.

    • attr_value: number

      an unsigned 32-bit integer.

    Returns void

  • Sets the attribute to contain the given attr_value, if possible.

    Parameters

    • attribute: string

      a file attribute key.

    • attr_value: number

      an unsigned 64-bit integer.

    Returns void

  • Sets the G_FILE_ATTRIBUTE_TIME_CREATED and G_FILE_ATTRIBUTE_TIME_CREATED_USEC attributes in the file info to the given date/time value.

    G_FILE_ATTRIBUTE_TIME_CREATED_NSEC will be cleared.

    Parameters

    Returns void

  • Sets the display name for the current Gio.FileInfo. See G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME.

    Parameters

    • display_name: string

      a string containing a display name.

    Returns void

  • Sets the edit name for the current file. See G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME.

    Parameters

    • edit_name: string

      a string containing an edit name.

    Returns void

  • Sets the "is_hidden" attribute in a Gio.FileInfo according to is_hidden. See G_FILE_ATTRIBUTE_STANDARD_IS_HIDDEN.

    Parameters

    • is_hidden: boolean

      a gboolean.

    Returns void

  • Sets the "is_symlink" attribute in a Gio.FileInfo according to is_symlink. See G_FILE_ATTRIBUTE_STANDARD_IS_SYMLINK.

    Parameters

    • is_symlink: boolean

      a gboolean.

    Returns void

  • Sets the G_FILE_ATTRIBUTE_TIME_MODIFIED and G_FILE_ATTRIBUTE_TIME_MODIFIED_USEC attributes in the file info to the given date/time value.

    G_FILE_ATTRIBUTE_TIME_MODIFIED_NSEC will be cleared.

    Parameters

    Returns void

  • Sets the G_FILE_ATTRIBUTE_TIME_MODIFIED and G_FILE_ATTRIBUTE_TIME_MODIFIED_USEC attributes in the file info to the given time value.

    G_FILE_ATTRIBUTE_TIME_MODIFIED_NSEC will be cleared.

    Parameters

    Returns void

  • Sets the name attribute for the current Gio.FileInfo. See G_FILE_ATTRIBUTE_STANDARD_NAME.

    Parameters

    • name: string

      a string containing a name.

    Returns void

  • Sets the G_FILE_ATTRIBUTE_STANDARD_SIZE attribute in the file info to the given size.

    Parameters

    • size: number

      a goffset containing the file's size.

    Returns void

  • Sets the sort order attribute in the file info structure. See G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER.

    Parameters

    • sort_order: number

      a sort order integer.

    Returns void

  • Sets the G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET attribute in the file info to the given symlink target.

    Parameters

    • symlink_target: string

      a static string containing a path to a symlink target.

    Returns void

  • Unsets a mask set by g_file_info_set_attribute_mask(), if one is set.

    Returns void

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

  • 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