File: WebDatabase.chs

package info (click to toggle)
haskell-webkit 0.11.0-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 328 kB
  • ctags: 2
  • sloc: haskell: 386; ansic: 5; makefile: 2
file content (103 lines) | stat: -rw-r--r-- 3,562 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
{-# LANGUAGE CPP #-}
-- -*-haskell-*-
-----------------------------------------------------------------------------
--  Module      :  Graphics.UI.Gtk.WebKit.WebDatabase
--  Author      :  Andy Stewart
--  Copyright   :  (c) 2010 Andy Stewart <lazycat.manatee@gmail.com>
--
--  This library is free software; you can redistribute it and/or
--  modify it under the terms of the GNU Lesser General Public
--  License as published by the Free Software Foundation; either
--  version 2.1 of the License, or (at your option) any later version.
--
--  This library is distributed in the hope that it will be useful,
--  but WITHOUT ANY WARRANTY; without even the implied warranty of
--  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
--  Lesser General Public License for more details.
--
-- |
-- Maintainer  : gtk2hs-users@lists.sourceforge.net
-- Stability   : provisional
-- Portability : portable (depends on GHC)
--
-- Access to the WebKit Web Database
-----------------------------------------------------------------------------

module Graphics.UI.Gtk.WebKit.WebDatabase (
-- * Types
  WebDatabase,

-- * Methods  
  webDatabaseGetDisplayName,
  webDatabaseGetExpectedSize,
  webDatabaseGetFilename,
  webDatabaseGetName,
  webDatabaseGetSecurityOrigin,
  webDatabaseGetSize,
  webDatabaseRemove,
) where

import Control.Monad		(liftM)

import System.Glib.FFI
import System.Glib.UTFString
import System.Glib.GList
import System.Glib.GError 
import Graphics.UI.Gtk.Gdk.Events

{#import Graphics.UI.Gtk.Abstract.Object#}	(makeNewObject)
{#import Graphics.UI.Gtk.WebKit.Types#}
{#import System.Glib.GObject#}

{#context lib="webkit" prefix ="webkit"#}

-- | Returns the name of the 'WebDatabase' as seen by the user.
webDatabaseGetDisplayName ::
   WebDatabaseClass self => self
 -> IO String
webDatabaseGetDisplayName wd =
  {#call web_database_get_display_name#} (toWebDatabase wd) >>= peekCString
  
-- | Returns the expected size of the Database 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.
webDatabaseGetExpectedSize ::  
   WebDatabaseClass self => self
 -> IO Int  
webDatabaseGetExpectedSize wd =
    liftM fromIntegral $ {#call web_database_get_expected_size#} (toWebDatabase wd)

-- | Returns the absolute filename to the WebKitWebDatabase file on disk.
webDatabaseGetFilename ::
   WebDatabaseClass self => self
 -> IO String
webDatabaseGetFilename wd = 
  {#call web_database_get_filename#} (toWebDatabase wd) >>= peekCString

-- | Returns the canonical name of the 'WebDatabase'.
webDatabaseGetName ::
   WebDatabaseClass self => self
 -> IO String
webDatabaseGetName wd = 
  {#call web_database_get_name#} (toWebDatabase wd) >>= peekCString

-- | Returns the security origin of the WebKitWebDatabase.
webDatabaseGetSecurityOrigin :: 
   WebDatabaseClass self => self
 -> IO SecurityOrigin   
webDatabaseGetSecurityOrigin wd =
  makeNewGObject mkSecurityOrigin $ {#call web_database_get_security_origin#} (toWebDatabase wd)

-- | Returns the actual size of the 'WebDatabase' space on disk in bytes.  
webDatabaseGetSize ::
   WebDatabaseClass self => self  
 -> IO Int
webDatabaseGetSize wd = 
    liftM fromIntegral $ {#call web_database_get_size#} (toWebDatabase wd)
  
-- | Removes the 'WebDatabase' from its security origin and destroys all data stored in the database.
webDatabaseRemove ::
   WebDatabaseClass self => self
 -> IO ()
webDatabaseRemove wd =
  {#call web_database_remove#} (toWebDatabase wd)