Icon

Icon

Object Hierarchy:

Description:

public interface Icon : Object

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.

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

To obtain a hash of a Icon, see hash.

To check if two Icons are equal, see equal.

For serializing a Icon, use serialize and deserialize.

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

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

All known implementing classes:

ThemedIcon

All known sub-interfaces:

LoadableIcon

Namespace: GLib

Package: gio-2.0

Content:

Static methods:

public static Icon deserialize (Variant value)
Deserializes a Icon previously serialized using serialize.
public static Icon? new_for_string (string str) throws Error
Generate a Icon instance from str.

Methods:

public abstract bool equal (Icon? icon2)
Checks if two icons are equal.
public virtual Icon? from_tokens (string[] tokens, int version) throws Error
public abstract uint hash ()
Gets a hash for an icon.
public virtual Variant serialize ()
Serializes a Icon into a Variant.
public string? to_string ()
Generates a textual representation of this that can be used for serialization such as when passing this to a different process or saving it to persistent storage.
public virtual bool to_tokens (GenericArray<string> tokens, out int out_version)
Generates a textual representation of this that can be used for serialization such as when passing this to a different process or saving it to persistent storage.

Inherited Members:

All known members inherited from class GLib.Object