Gio.Icon

g GObject.GInterface GObject.GInterface Gio.Icon Gio.Icon GObject.GInterface->Gio.Icon

Implementations:
 Gio.BytesIcon, Gio.Emblem, Gio.EmblemedIcon, Gio.FileIcon, Gio.ThemedIcon

Methods

class deserialize (value)
class hash (icon)
class new_for_string (str)
  equal (icon2)
  serialize ()
  to_string ()

Virtual Methods

  do_equal (icon2)
  do_hash ()
  do_serialize ()

Properties

None

Signals

None

Fields

None

Class Details

class Gio.Icon
Bases:GObject.GInterface
Structure:Gio.IconIface

Gio.Icon is a very minimal interface for icons. It provides functions for checking the equality of two icons, hashing of icons and serializing an icon to and from strings.

Gio.Icon does not provide the actual pixmap for the icon as this is out of GIO’s scope, however implementations of Gio.Icon may contain the name of an icon (see Gio.ThemedIcon), or the path to an icon (see Gio.LoadableIcon).

To obtain a hash of a Gio.Icon, see Gio.Icon.hash().

To check if two Gio.Icons are equal, see Gio.Icon.equal().

For serializing a Gio.Icon, use Gio.Icon.serialize() and Gio.Icon.deserialize().

If you want to consume Gio.Icon (for example, in a toolkit) you must be prepared to handle at least the three following cases: Gio.LoadableIcon, Gio.ThemedIcon and Gio.EmblemedIcon. It may also make sense to have fast-paths for other cases (like handling #GdkPixbuf directly, for example) but all compliant Gio.Icon implementations outside of GIO must implement Gio.LoadableIcon.

If your application or library provides one or more Gio.Icon implementations you need to ensure that your new implementation also implements Gio.LoadableIcon. Additionally, you must provide an implementation of Gio.Icon.serialize() that gives a result that is understood by Gio.Icon.deserialize(), yielding one of the built-in icon types.

classmethod deserialize(value)[source]
Parameters:value (GLib.Variant) – a GLib.Variant created with Gio.Icon.serialize()
Returns:a Gio.Icon, or None when deserialization fails.
Return type:Gio.Icon

Deserializes a Gio.Icon previously serialized using Gio.Icon.serialize().

New in version 2.38.

classmethod hash(icon)[source]
Parameters:icon (object) – #gconstpointer to an icon object.
Returns:a int containing a hash for the icon, suitable for use in a GLib.HashTable or similar data structure.
Return type:int

Gets a hash for an icon.

classmethod new_for_string(str)[source]
Parameters:str (str) – A string obtained via Gio.Icon.to_string().
Raises:GLib.Error
Returns:An object implementing the Gio.Icon interface or None if error is set.
Return type:Gio.Icon

Generate a Gio.Icon instance from str. This function can fail if str is not valid - see Gio.Icon.to_string() for discussion.

If your application or library provides one or more Gio.Icon implementations you need to ensure that each GObject.GType is registered with the type system prior to calling Gio.Icon.new_for_string().

New in version 2.20.

equal(icon2)[source]
Parameters:icon2 (Gio.Icon or None) – pointer to the second Gio.Icon.
Returns:True if self is equal to icon2. False otherwise.
Return type:bool

Checks if two icons are equal.

serialize()[source]
Returns:a GLib.Variant, or None when serialization fails.
Return type:GLib.Variant

Serializes a Gio.Icon into a GLib.Variant. An equivalent Gio.Icon can be retrieved back by calling Gio.Icon.deserialize() on the returned value. As serialization will avoid using raw icon data when possible, it only makes sense to transfer the GLib.Variant between processes on the same machine, (as opposed to over the network), and within the same file system namespace.

New in version 2.38.

to_string()[source]
Returns:An allocated NUL-terminated UTF8 string or None if self can’t be serialized. Use GLib.free() to free.
Return type:str or None

Generates a textual representation of self that can be used for serialization such as when passing self to a different process or saving it to persistent storage. Use Gio.Icon.new_for_string() to get self back from the returned string.

The encoding of the returned string is proprietary to Gio.Icon except in the following two cases

  • If self is a Gio.FileIcon, the returned string is a native path (such as /path/to/my icon.png) without escaping if the Gio.File for self is a native file. If the file is not native, the returned string is the result of Gio.File.get_uri() (such as sftp://path/to/my%20icon.png).
  • If self is a Gio.ThemedIcon with exactly one name and no fallbacks, the encoding is simply the name (such as network-server).

New in version 2.20.

do_equal(icon2) virtual
Parameters:icon2 (Gio.Icon or None) – pointer to the second Gio.Icon.
Returns:True if icon1 is equal to icon2. False otherwise.
Return type:bool

Checks if two icons are equal.

do_hash() virtual
Returns:a int containing a hash for the icon, suitable for use in a GLib.HashTable or similar data structure.
Return type:int

Gets a hash for an icon.

do_serialize() virtual
Returns:a GLib.Variant, or None when serialization fails.
Return type:GLib.Variant

Serializes a Gio.Icon into a GLib.Variant. An equivalent Gio.Icon can be retrieved back by calling Gio.Icon.deserialize() on the returned value. As serialization will avoid using raw icon data when possible, it only makes sense to transfer the GLib.Variant between processes on the same machine, (as opposed to over the network), and within the same file system namespace.

New in version 2.38.