Interface LoadableIcon

All Superinterfaces:

Icon, Proxy

All Known Implementing Classes:

BytesIcon, DmabufTexture, FileIcon, GLTexture, LoadableIcon.LoadableIcon$Impl, MemoryTexture, Pixbuf, Texture, Texture.Texture$Impl

@Generated("org.javagi.JavaGI")
public interface LoadableIcon
extends Proxy, Icon

GLoadableIcon extends the Icon interface and adds the ability to load icons from streams.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	LoadableIcon.LoadableIcon$Impl	The LoadableIcon$Impl type represents a native instance of the LoadableIcon interface.
static class	LoadableIcon.LoadableIconIface	Interface for icons that can be loaded as a stream.

Nested classes/interfaces inherited from interface Icon

Icon.Icon$Impl, Icon.IconIface

Method Summary

Modifier and Type	Method	Description
static @Nullable Type	getType()	Get the GType of the LoadableIcon class.
default InputStream	load(int size, @Nullable Out<String> type, @Nullable Cancellable cancellable)	Loads a loadable icon.
default void	loadAsync(int size, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Loads an icon asynchronously.
default InputStream	loadFinish(AsyncResult res, @Nullable Out<String> type)	Finishes an asynchronous icon load started in g_loadable_icon_load_async().

Methods inherited from interface Icon

equal, hash, serialize, serializeToString

Methods inherited from interface Proxy

handle

Method Details

getType

static @Nullable Type getType()

Get the GType of the LoadableIcon class.

Returns:

the GType

load

default InputStream load(int size,
 @Nullable Out<String> type,
 @Nullable Cancellable cancellable)
                  throws GErrorException

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

Parameters:

size - an integer.

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

cancellable - optional GCancellable object, null to ignore.

Returns:

a GInputStream to read the icon from.

Throws:

GErrorException - see GError

loadAsync

default void loadAsync(int size,
 @Nullable Cancellable cancellable,
 @Nullable AsyncReadyCallback callback)

Loads an icon asynchronously. To finish this function, see g_loadable_icon_load_finish(). For the synchronous, blocking version of this function, see g_loadable_icon_load().

Parameters:

size - an integer.

cancellable - optional GCancellable object, null to ignore.

callback - a GAsyncReadyCallback to call when the request is satisfied

loadFinish

default InputStream loadFinish(AsyncResult res,
 @Nullable Out<String> type)
                        throws GErrorException

Finishes an asynchronous icon load started in g_loadable_icon_load_async().

Parameters:

res - a GAsyncResult.

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

Returns:

a GInputStream to read the icon from.

Throws:

GErrorException - see GError