Package org.gnome.webkit

Class FaviconDatabase

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.webkit.FaviconDatabase

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public final class FaviconDatabase
extends GObject

Provides access to the icons associated with web sites.

WebKit will automatically look for available icons in <link> elements on opened pages as well as an existing favicon.ico and load the images found into a memory cache if possible. That cache is frozen to an on-disk database for persistence.

If WebKitSettings:enable-private-browsing is true, new icons won't be added to the on-disk database and no existing icons will be deleted from it. Nevertheless, WebKit will still store them in the in-memory cache during the current execution.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FaviconDatabase.Builder<B extends FaviconDatabase.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	FaviconDatabase.FaviconChangedCallback	Functional interface declaration of the FaviconChangedCallback callback.
static class	FaviconDatabase.FaviconDatabaseClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
FaviconDatabase(MemorySegment address)	Create a FaviconDatabase proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected FaviconDatabase	asParent()	Returns this instance as if it were its parent type.
static FaviconDatabase.Builder<? extends FaviconDatabase.Builder>	builder()	A FaviconDatabase.Builder object constructs a FaviconDatabase with the specified properties.
void	clear()	Clears all icons from the database.
void	emitFaviconChanged(String pageUri, String faviconUri)	Emits the "favicon-changed" signal.
void	getFavicon(String pageUri, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Asynchronously obtains a favicon image.
Texture	getFaviconFinish(AsyncResult result)	Finishes an operation started with webkit_favicon_database_get_favicon().
String	getFaviconUri(String pageUri)	Obtains the URI of the favicon for the given pageUri.
static Type	getType()	Get the GType of the FaviconDatabase class
SignalConnection<FaviconDatabase.FaviconChangedCallback>	onFaviconChanged(FaviconDatabase.FaviconChangedCallback handler)	This signal is emitted when the favicon URI of pageUri has been changed to faviconUri in the database.

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getMemoryLayout, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FaviconDatabase

public FaviconDatabase(MemorySegment address)

Create a FaviconDatabase proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Method Details

getType

public static Type getType()

Get the GType of the FaviconDatabase class

Returns:

the GType

asParent

protected FaviconDatabase asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class GObject

clear

public void clear()

Clears all icons from the database.

getFavicon

public void getFavicon(String pageUri,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

Asynchronously obtains a favicon image.

Asynchronously obtains an image of the favicon for the given page URI. It returns the cached icon if it's in the database asynchronously waiting for the icon to be read from the database.

This is an asynchronous method. When the operation is finished, callback will be invoked. You can then call webkit_favicon_database_get_favicon_finish() to get the result of the operation.

Parameters:

pageUri - URI of the page for which we want to retrieve the favicon

cancellable - A GCancellable or null.

callback - A GAsyncReadyCallback to call when the request is satisfied or null if you don't care about the result.

getFaviconFinish

public Texture getFaviconFinish(AsyncResult result)
                         throws GErrorException

Finishes an operation started with webkit_favicon_database_get_favicon().

Parameters:

result - A GAsyncResult obtained from the GAsyncReadyCallback passed to webkit_favicon_database_get_favicon()

Returns:

a new favicon image, or null in case of error.

Throws:

GErrorException - see GError

getFaviconUri

public String getFaviconUri(String pageUri)

Obtains the URI of the favicon for the given pageUri.

Parameters:

pageUri - URI of the page containing the icon

Returns:

a newly allocated URI for the favicon, or null if the database doesn't have a favicon for pageUri.

onFaviconChanged

public SignalConnection<FaviconDatabase.FaviconChangedCallback> onFaviconChanged(FaviconDatabase.FaviconChangedCallback handler)

This signal is emitted when the favicon URI of pageUri has been changed to faviconUri in the database. You can connect to this signal and call webkit_favicon_database_get_favicon() to get the favicon. If you are interested in the favicon of a WebKitWebView it's easier to use the WebKitWebView:favicon property. See webkit_web_view_get_favicon() for more details.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• FaviconDatabase.FaviconChangedCallback.run(java.lang.String, java.lang.String)

emitFaviconChanged

public void emitFaviconChanged(String pageUri,
 String faviconUri)

Emits the "favicon-changed" signal. See onFaviconChanged(org.gnome.webkit.FaviconDatabase.FaviconChangedCallback).

builder

public static FaviconDatabase.Builder<? extends FaviconDatabase.Builder> builder()

A FaviconDatabase.Builder object constructs a FaviconDatabase with the specified properties. Use the various set...() methods to set properties, and finish construction with FaviconDatabase.Builder.build().