gi-webkit2-4.0.11: WebKit2 bindings

CopyrightWill Thompson, Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.WebKit2.Objects.FaviconDatabase

Contents

Description

 

Synopsis

Exported types

Methods

clear

faviconDatabaseClear Source #

Arguments

:: (HasCallStack, MonadIO m, IsFaviconDatabase a) 
=> a

database: a FaviconDatabase

-> m () 

Clears all icons from the database.

getFavicon

faviconDatabaseGetFavicon Source #

Arguments

:: (HasCallStack, MonadIO m, IsFaviconDatabase a, IsCancellable b) 
=> a

database: a FaviconDatabase

-> Text

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

-> Maybe b

cancellable: A Cancellable or Nothing.

-> Maybe AsyncReadyCallback

callback: A AsyncReadyCallback to call when the request is satisfied or Nothing if you don't care about the result.

-> m () 

Asynchronously obtains a Surface 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 faviconDatabaseGetFaviconFinish to get the result of the operation.

You must call webContextSetFaviconDatabaseDirectory for the WebContext associated with this FaviconDatabase before attempting to use this function; otherwise, faviconDatabaseGetFaviconFinish will return FaviconDatabaseErrorNotInitialized.

getFaviconFinish

faviconDatabaseGetFaviconFinish Source #

Arguments

:: (HasCallStack, MonadIO m, IsFaviconDatabase a, IsAsyncResult b) 
=> a

database: a FaviconDatabase

-> b

result: A AsyncResult obtained from the AsyncReadyCallback passed to faviconDatabaseGetFavicon

-> m Surface

Returns: a new reference to a Surface, or Nothing in case of error. (Can throw GError)

Finishes an operation started with faviconDatabaseGetFavicon.

getFaviconUri

faviconDatabaseGetFaviconUri Source #

Arguments

:: (HasCallStack, MonadIO m, IsFaviconDatabase a) 
=> a

database: a FaviconDatabase

-> Text

pageUri: URI of the page containing the icon

-> m Text

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

Obtains the URI of the favicon for the given pageUri.

Signals

faviconChanged