Gio.LoadableIcon

Implementations:

Gio.BytesIcon, Gio.FileIcon

Methods

	load (size, cancellable)
	load_async (size, cancellable, callback, *user_data)
	load_finish (res)

Virtual Methods

	do_load (size, cancellable)
	do_load_async (size, cancellable, callback, *user_data)
	do_load_finish (res)

Properties

None

Signals

None

Fields

None

Class Details

class Gio.LoadableIcon

Bases:

GObject.GInterface

Structure:

Gio.LoadableIconIface

GLoadableIcon extends the [iface`Gio`.Icon] interface and adds the ability to load icons from streams.

load(size, cancellable)

Parameters:

• size (int) – an integer.

• cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, None to ignore.

Raises:

GLib.Error

Returns:

a Gio.InputStream to read the icon from.

type:

a location to store the type of the loaded icon, None to ignore.

Return type:

(Gio.InputStream, type: str)

Loads a loadable icon. For the asynchronous version of this function, see Gio.LoadableIcon.load_async().

load_async(size, cancellable, callback, *user_data)

Parameters:

• size (int) – an integer.

• cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, None to ignore.

• callback (Gio.AsyncReadyCallback or None) – a Gio.AsyncReadyCallback to call when the request is satisfied

• user_data (object or None) – the data to pass to callback function

Loads an icon asynchronously. To finish this function, see Gio.LoadableIcon.load_finish(). For the synchronous, blocking version of this function, see Gio.LoadableIcon.load().

load_finish(res)

Parameters:

res (Gio.AsyncResult) – a Gio.AsyncResult.

Raises:

GLib.Error

Returns:

a Gio.InputStream to read the icon from.

type:

a location to store the type of the loaded icon, None to ignore.

Return type:

(Gio.InputStream, type: str)

Finishes an asynchronous icon load started in Gio.LoadableIcon.load_async().

do_load(size, cancellable) virtual

Parameters:

• size (int) – an integer.

• cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, None to ignore.

Returns:

a Gio.InputStream to read the icon from.

type:

a location to store the type of the loaded icon, None to ignore.

Return type:

(Gio.InputStream, type: str)

Loads a loadable icon. For the asynchronous version of this function, see Gio.LoadableIcon.load_async().

do_load_async(size, cancellable, callback, *user_data) virtual

Parameters:

• size (int) – an integer.

• cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, None to ignore.

• callback (Gio.AsyncReadyCallback or None) – a Gio.AsyncReadyCallback to call when the request is satisfied

• user_data (object or None) – the data to pass to callback function

Loads an icon asynchronously. To finish this function, see Gio.LoadableIcon.load_finish(). For the synchronous, blocking version of this function, see Gio.LoadableIcon.load().

do_load_finish(res) virtual

Parameters:

res (Gio.AsyncResult) – a Gio.AsyncResult.

Returns:

a Gio.InputStream to read the icon from.

type:

a location to store the type of the loaded icon, None to ignore.

Return type:

(Gio.InputStream, type: str)

Finishes an asynchronous icon load started in Gio.LoadableIcon.load_async().