Copyright	Will Thompson, Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (garetxe@gmail.com)
Safe Haskell	None
Language	Haskell2010

GI.WebKit.Objects.WebDatabase

Contents

Exported types
Methods
Properties

Description

WebDatabase is a representation of a Web Database database. The proposed Web Database standard introduces support for SQL databases that web sites can create and access on a local computer through JavaScript.

To get access to all databases defined by a security origin, use webkit_security_origin_get_databases. Each database has a canonical name, as well as a user-friendly display name.

WebKit uses SQLite to create and access the local SQL databases. The location of a WebDatabase can be accessed wth webkit_web_database_get_filename. You can configure the location of all databases with webkit_set_database_directory_path.

For each database the web site can define an estimated size which can be accessed with webkit_web_database_get_expected_size. The current size of the database in bytes is returned by webkit_web_database_get_size.

For more information refer to the Web Database specification proposal at http://dev.w3.org/html5/webdatabase

Synopsis

Exported types

newtype WebDatabase Source #

Constructors

WebDatabase (ManagedPtr WebDatabase)

Instances

GObject WebDatabase Source #
Methods gobjectType :: WebDatabase -> IO GType #
IsObject WebDatabase Source #

IsWebDatabase WebDatabase Source #

((~) * info (ResolveWebDatabaseMethod t WebDatabase), MethodInfo * info WebDatabase p) => IsLabel t (WebDatabase -> p) Source #
Methods fromLabel :: Proxy# Symbol t -> WebDatabase -> p #
((~) * info (ResolveWebDatabaseMethod t WebDatabase), MethodInfo * info WebDatabase p) => IsLabelProxy t (WebDatabase -> p) Source #
Methods fromLabelProxy :: Proxy Symbol t -> WebDatabase -> p #
HasAttributeList * WebDatabase Source #

type AttributeList WebDatabase Source #
type AttributeList WebDatabase
type SignalList WebDatabase Source #
type SignalList WebDatabase

class GObject o => IsWebDatabase o Source #

Instances

(GObject a, UnknownAncestorError Constraint WebDatabase a) => IsWebDatabase a Source #

IsWebDatabase WebDatabase Source #

toWebDatabase :: IsWebDatabase o => o -> IO WebDatabase Source #

noWebDatabase :: Maybe WebDatabase Source #

Methods

getDisplayName

data WebDatabaseGetDisplayNameMethodInfo Source #

Instances

((~) * signature (m Text), MonadIO m, IsWebDatabase a) => MethodInfo * WebDatabaseGetDisplayNameMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy WebDatabaseGetDisplayNameMethodInfo a -> signature -> s #

webDatabaseGetDisplayName Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebDatabase a)
=> a	`webDatabase`: a `WebDatabase`
-> m Text	Returns: the name of the database as seen by the user.

Returns the name of the WebDatabase as seen by the user.

Since: 1.1.14

getExpectedSize

data WebDatabaseGetExpectedSizeMethodInfo Source #

Instances

((~) * signature (m Word64), MonadIO m, IsWebDatabase a) => MethodInfo * WebDatabaseGetExpectedSizeMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy WebDatabaseGetExpectedSizeMethodInfo a -> signature -> s #

webDatabaseGetExpectedSize Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebDatabase a)
=> a	`webDatabase`: a `WebDatabase`
-> m Word64	Returns: the expected size of the database in bytes

Returns the expected size of the WebDatabase in bytes as defined by the web author. The Web Database standard allows web authors to specify an expected size of the database to optimize the user experience.

Since: 1.1.14

getFilename

data WebDatabaseGetFilenameMethodInfo Source #

Instances

((~) * signature (m Text), MonadIO m, IsWebDatabase a) => MethodInfo * WebDatabaseGetFilenameMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy WebDatabaseGetFilenameMethodInfo a -> signature -> s #

webDatabaseGetFilename Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebDatabase a)
=> a	`webDatabase`: a `WebDatabase`
-> m Text	Returns: the absolute filename of the database

Returns the absolute filename to the WebDatabase file on disk.

Since: 1.1.14

getName

data WebDatabaseGetNameMethodInfo Source #

Instances

((~) * signature (m Text), MonadIO m, IsWebDatabase a) => MethodInfo * WebDatabaseGetNameMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy WebDatabaseGetNameMethodInfo a -> signature -> s #

webDatabaseGetName Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebDatabase a)
=> a	`webDatabase`: a `WebDatabase`
-> m Text	Returns: the name of the database

Returns the canonical name of the WebDatabase.

Since: 1.1.14

getSecurityOrigin

data WebDatabaseGetSecurityOriginMethodInfo Source #

Instances

((~) * signature (m SecurityOrigin), MonadIO m, IsWebDatabase a) => MethodInfo * WebDatabaseGetSecurityOriginMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy WebDatabaseGetSecurityOriginMethodInfo a -> signature -> s #

webDatabaseGetSecurityOrigin Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebDatabase a)
=> a	`webDatabase`: a `WebDatabase`
-> m SecurityOrigin	Returns: the security origin of the database

Returns the security origin of the WebDatabase.

Since: 1.1.14

getSize

data WebDatabaseGetSizeMethodInfo Source #

Instances

((~) * signature (m Word64), MonadIO m, IsWebDatabase a) => MethodInfo * WebDatabaseGetSizeMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy WebDatabaseGetSizeMethodInfo a -> signature -> s #

webDatabaseGetSize Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebDatabase a)
=> a	`webDatabase`: a `WebDatabase`
-> m Word64	Returns: the actual size of the database in bytes

Returns the actual size of the WebDatabase space on disk in bytes.

Since: 1.1.14

remove

data WebDatabaseRemoveMethodInfo Source #

Instances

((~) * signature (m ()), MonadIO m, IsWebDatabase a) => MethodInfo * WebDatabaseRemoveMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy WebDatabaseRemoveMethodInfo a -> signature -> s #

webDatabaseRemove Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebDatabase a)
=> a	`webDatabase`: a `WebDatabase`
-> m ()

Removes the WebDatabase from its security origin and destroys all data stored in the database.

Since: 1.1.14

Properties

displayName

data WebDatabaseDisplayNamePropertyInfo Source #

Instances

AttrInfo WebDatabaseDisplayNamePropertyInfo Source #
Associated Types type AttrAllowedOps WebDatabaseDisplayNamePropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint WebDatabaseDisplayNamePropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint WebDatabaseDisplayNamePropertyInfo :: * -> Constraint # type AttrGetType WebDatabaseDisplayNamePropertyInfo :: * # type AttrLabel WebDatabaseDisplayNamePropertyInfo :: Symbol # type AttrOrigin WebDatabaseDisplayNamePropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint WebDatabaseDisplayNamePropertyInfo o => Proxy * WebDatabaseDisplayNamePropertyInfo -> o -> IO (AttrGetType WebDatabaseDisplayNamePropertyInfo) # attrSet :: (AttrBaseTypeConstraint WebDatabaseDisplayNamePropertyInfo o, AttrSetTypeConstraint WebDatabaseDisplayNamePropertyInfo b) => Proxy * WebDatabaseDisplayNamePropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint WebDatabaseDisplayNamePropertyInfo o => Proxy * WebDatabaseDisplayNamePropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint WebDatabaseDisplayNamePropertyInfo o, AttrSetTypeConstraint WebDatabaseDisplayNamePropertyInfo b) => Proxy * WebDatabaseDisplayNamePropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin WebDatabaseDisplayNamePropertyInfo Source #
type AttrOrigin WebDatabaseDisplayNamePropertyInfo = WebDatabase
type AttrLabel WebDatabaseDisplayNamePropertyInfo Source #
type AttrLabel WebDatabaseDisplayNamePropertyInfo = "display-name"
type AttrGetType WebDatabaseDisplayNamePropertyInfo Source #
type AttrGetType WebDatabaseDisplayNamePropertyInfo = Text
type AttrBaseTypeConstraint WebDatabaseDisplayNamePropertyInfo Source #
type AttrBaseTypeConstraint WebDatabaseDisplayNamePropertyInfo = IsWebDatabase
type AttrSetTypeConstraint WebDatabaseDisplayNamePropertyInfo Source #
type AttrSetTypeConstraint WebDatabaseDisplayNamePropertyInfo = * ~ ()
type AttrAllowedOps WebDatabaseDisplayNamePropertyInfo Source #
type AttrAllowedOps WebDatabaseDisplayNamePropertyInfo = (:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag))

getWebDatabaseDisplayName :: (MonadIO m, IsWebDatabase o) => o -> m Text Source #

webDatabaseDisplayName :: AttrLabelProxy "displayName" Source #

expectedSize

data WebDatabaseExpectedSizePropertyInfo Source #

Instances

AttrInfo WebDatabaseExpectedSizePropertyInfo Source #
Associated Types type AttrAllowedOps WebDatabaseExpectedSizePropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint WebDatabaseExpectedSizePropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint WebDatabaseExpectedSizePropertyInfo :: * -> Constraint # type AttrGetType WebDatabaseExpectedSizePropertyInfo :: * # type AttrLabel WebDatabaseExpectedSizePropertyInfo :: Symbol # type AttrOrigin WebDatabaseExpectedSizePropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint WebDatabaseExpectedSizePropertyInfo o => Proxy * WebDatabaseExpectedSizePropertyInfo -> o -> IO (AttrGetType WebDatabaseExpectedSizePropertyInfo) # attrSet :: (AttrBaseTypeConstraint WebDatabaseExpectedSizePropertyInfo o, AttrSetTypeConstraint WebDatabaseExpectedSizePropertyInfo b) => Proxy * WebDatabaseExpectedSizePropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint WebDatabaseExpectedSizePropertyInfo o => Proxy * WebDatabaseExpectedSizePropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint WebDatabaseExpectedSizePropertyInfo o, AttrSetTypeConstraint WebDatabaseExpectedSizePropertyInfo b) => Proxy * WebDatabaseExpectedSizePropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin WebDatabaseExpectedSizePropertyInfo Source #
type AttrOrigin WebDatabaseExpectedSizePropertyInfo = WebDatabase
type AttrLabel WebDatabaseExpectedSizePropertyInfo Source #
type AttrLabel WebDatabaseExpectedSizePropertyInfo = "expected-size"
type AttrGetType WebDatabaseExpectedSizePropertyInfo Source #
type AttrGetType WebDatabaseExpectedSizePropertyInfo = Word64
type AttrBaseTypeConstraint WebDatabaseExpectedSizePropertyInfo Source #
type AttrBaseTypeConstraint WebDatabaseExpectedSizePropertyInfo = IsWebDatabase
type AttrSetTypeConstraint WebDatabaseExpectedSizePropertyInfo Source #
type AttrSetTypeConstraint WebDatabaseExpectedSizePropertyInfo = * ~ ()
type AttrAllowedOps WebDatabaseExpectedSizePropertyInfo Source #
type AttrAllowedOps WebDatabaseExpectedSizePropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

getWebDatabaseExpectedSize :: (MonadIO m, IsWebDatabase o) => o -> m Word64 Source #

webDatabaseExpectedSize :: AttrLabelProxy "expectedSize" Source #

filename

data WebDatabaseFilenamePropertyInfo Source #

Instances

AttrInfo WebDatabaseFilenamePropertyInfo Source #
Associated Types type AttrAllowedOps WebDatabaseFilenamePropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint WebDatabaseFilenamePropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint WebDatabaseFilenamePropertyInfo :: * -> Constraint # type AttrGetType WebDatabaseFilenamePropertyInfo :: * # type AttrLabel WebDatabaseFilenamePropertyInfo :: Symbol # type AttrOrigin WebDatabaseFilenamePropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint WebDatabaseFilenamePropertyInfo o => Proxy * WebDatabaseFilenamePropertyInfo -> o -> IO (AttrGetType WebDatabaseFilenamePropertyInfo) # attrSet :: (AttrBaseTypeConstraint WebDatabaseFilenamePropertyInfo o, AttrSetTypeConstraint WebDatabaseFilenamePropertyInfo b) => Proxy * WebDatabaseFilenamePropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint WebDatabaseFilenamePropertyInfo o => Proxy * WebDatabaseFilenamePropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint WebDatabaseFilenamePropertyInfo o, AttrSetTypeConstraint WebDatabaseFilenamePropertyInfo b) => Proxy * WebDatabaseFilenamePropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin WebDatabaseFilenamePropertyInfo Source #
type AttrOrigin WebDatabaseFilenamePropertyInfo = WebDatabase
type AttrLabel WebDatabaseFilenamePropertyInfo Source #
type AttrLabel WebDatabaseFilenamePropertyInfo = "filename"
type AttrGetType WebDatabaseFilenamePropertyInfo Source #
type AttrGetType WebDatabaseFilenamePropertyInfo = Text
type AttrBaseTypeConstraint WebDatabaseFilenamePropertyInfo Source #
type AttrBaseTypeConstraint WebDatabaseFilenamePropertyInfo = IsWebDatabase
type AttrSetTypeConstraint WebDatabaseFilenamePropertyInfo Source #
type AttrSetTypeConstraint WebDatabaseFilenamePropertyInfo = * ~ ()
type AttrAllowedOps WebDatabaseFilenamePropertyInfo Source #
type AttrAllowedOps WebDatabaseFilenamePropertyInfo = (:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag))

getWebDatabaseFilename :: (MonadIO m, IsWebDatabase o) => o -> m Text Source #

webDatabaseFilename :: AttrLabelProxy "filename" Source #

name

data WebDatabaseNamePropertyInfo Source #

Instances

AttrInfo WebDatabaseNamePropertyInfo Source #
Associated Types type AttrAllowedOps WebDatabaseNamePropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint WebDatabaseNamePropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint WebDatabaseNamePropertyInfo :: * -> Constraint # type AttrGetType WebDatabaseNamePropertyInfo :: * # type AttrLabel WebDatabaseNamePropertyInfo :: Symbol # type AttrOrigin WebDatabaseNamePropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint WebDatabaseNamePropertyInfo o => Proxy * WebDatabaseNamePropertyInfo -> o -> IO (AttrGetType WebDatabaseNamePropertyInfo) # attrSet :: (AttrBaseTypeConstraint WebDatabaseNamePropertyInfo o, AttrSetTypeConstraint WebDatabaseNamePropertyInfo b) => Proxy * WebDatabaseNamePropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint WebDatabaseNamePropertyInfo o => Proxy * WebDatabaseNamePropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint WebDatabaseNamePropertyInfo o, AttrSetTypeConstraint WebDatabaseNamePropertyInfo b) => Proxy * WebDatabaseNamePropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin WebDatabaseNamePropertyInfo Source #
type AttrOrigin WebDatabaseNamePropertyInfo = WebDatabase
type AttrLabel WebDatabaseNamePropertyInfo Source #
type AttrLabel WebDatabaseNamePropertyInfo = "name"
type AttrGetType WebDatabaseNamePropertyInfo Source #
type AttrGetType WebDatabaseNamePropertyInfo = Text
type AttrBaseTypeConstraint WebDatabaseNamePropertyInfo Source #
type AttrBaseTypeConstraint WebDatabaseNamePropertyInfo = IsWebDatabase
type AttrSetTypeConstraint WebDatabaseNamePropertyInfo Source #
type AttrSetTypeConstraint WebDatabaseNamePropertyInfo = * ~ Text
type AttrAllowedOps WebDatabaseNamePropertyInfo Source #
type AttrAllowedOps WebDatabaseNamePropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag)))

constructWebDatabaseName :: IsWebDatabase o => Text -> IO (GValueConstruct o) Source #

getWebDatabaseName :: (MonadIO m, IsWebDatabase o) => o -> m Text Source #

webDatabaseName :: AttrLabelProxy "name" Source #

securityOrigin

data WebDatabaseSecurityOriginPropertyInfo Source #

Instances

AttrInfo WebDatabaseSecurityOriginPropertyInfo Source #
Associated Types type AttrAllowedOps WebDatabaseSecurityOriginPropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint WebDatabaseSecurityOriginPropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint WebDatabaseSecurityOriginPropertyInfo :: * -> Constraint # type AttrGetType WebDatabaseSecurityOriginPropertyInfo :: * # type AttrLabel WebDatabaseSecurityOriginPropertyInfo :: Symbol # type AttrOrigin WebDatabaseSecurityOriginPropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint WebDatabaseSecurityOriginPropertyInfo o => Proxy * WebDatabaseSecurityOriginPropertyInfo -> o -> IO (AttrGetType WebDatabaseSecurityOriginPropertyInfo) # attrSet :: (AttrBaseTypeConstraint WebDatabaseSecurityOriginPropertyInfo o, AttrSetTypeConstraint WebDatabaseSecurityOriginPropertyInfo b) => Proxy * WebDatabaseSecurityOriginPropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint WebDatabaseSecurityOriginPropertyInfo o => Proxy * WebDatabaseSecurityOriginPropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint WebDatabaseSecurityOriginPropertyInfo o, AttrSetTypeConstraint WebDatabaseSecurityOriginPropertyInfo b) => Proxy * WebDatabaseSecurityOriginPropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin WebDatabaseSecurityOriginPropertyInfo Source #
type AttrOrigin WebDatabaseSecurityOriginPropertyInfo = WebDatabase
type AttrLabel WebDatabaseSecurityOriginPropertyInfo Source #
type AttrLabel WebDatabaseSecurityOriginPropertyInfo = "security-origin"
type AttrGetType WebDatabaseSecurityOriginPropertyInfo Source #
type AttrGetType WebDatabaseSecurityOriginPropertyInfo = SecurityOrigin
type AttrBaseTypeConstraint WebDatabaseSecurityOriginPropertyInfo Source #
type AttrBaseTypeConstraint WebDatabaseSecurityOriginPropertyInfo = IsWebDatabase
type AttrSetTypeConstraint WebDatabaseSecurityOriginPropertyInfo Source #
type AttrSetTypeConstraint WebDatabaseSecurityOriginPropertyInfo = IsSecurityOrigin
type AttrAllowedOps WebDatabaseSecurityOriginPropertyInfo Source #
type AttrAllowedOps WebDatabaseSecurityOriginPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag)))

constructWebDatabaseSecurityOrigin :: (IsWebDatabase o, IsSecurityOrigin a) => a -> IO (GValueConstruct o) Source #

getWebDatabaseSecurityOrigin :: (MonadIO m, IsWebDatabase o) => o -> m SecurityOrigin Source #

webDatabaseSecurityOrigin :: AttrLabelProxy "securityOrigin" Source #

size

data WebDatabaseSizePropertyInfo Source #

Instances

AttrInfo WebDatabaseSizePropertyInfo Source #
Associated Types type AttrAllowedOps WebDatabaseSizePropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint WebDatabaseSizePropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint WebDatabaseSizePropertyInfo :: * -> Constraint # type AttrGetType WebDatabaseSizePropertyInfo :: * # type AttrLabel WebDatabaseSizePropertyInfo :: Symbol # type AttrOrigin WebDatabaseSizePropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint WebDatabaseSizePropertyInfo o => Proxy * WebDatabaseSizePropertyInfo -> o -> IO (AttrGetType WebDatabaseSizePropertyInfo) # attrSet :: (AttrBaseTypeConstraint WebDatabaseSizePropertyInfo o, AttrSetTypeConstraint WebDatabaseSizePropertyInfo b) => Proxy * WebDatabaseSizePropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint WebDatabaseSizePropertyInfo o => Proxy * WebDatabaseSizePropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint WebDatabaseSizePropertyInfo o, AttrSetTypeConstraint WebDatabaseSizePropertyInfo b) => Proxy * WebDatabaseSizePropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin WebDatabaseSizePropertyInfo Source #
type AttrOrigin WebDatabaseSizePropertyInfo = WebDatabase
type AttrLabel WebDatabaseSizePropertyInfo Source #
type AttrLabel WebDatabaseSizePropertyInfo = "size"
type AttrGetType WebDatabaseSizePropertyInfo Source #
type AttrGetType WebDatabaseSizePropertyInfo = Word64
type AttrBaseTypeConstraint WebDatabaseSizePropertyInfo Source #
type AttrBaseTypeConstraint WebDatabaseSizePropertyInfo = IsWebDatabase
type AttrSetTypeConstraint WebDatabaseSizePropertyInfo Source #
type AttrSetTypeConstraint WebDatabaseSizePropertyInfo = * ~ ()
type AttrAllowedOps WebDatabaseSizePropertyInfo Source #
type AttrAllowedOps WebDatabaseSizePropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

getWebDatabaseSize :: (MonadIO m, IsWebDatabase o) => o -> m Word64 Source #

webDatabaseSize :: AttrLabelProxy "size" Source #