1 /* Copyright (c) 2009, Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
8 * * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * * Neither the name of the Nokia Corporation nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
18 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
20 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
21 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 /* modest-tny-stream-webkit.h */
33 #ifndef __MODEST_TNY_STREAM_WEBKIT_H__
34 #define __MODEST_TNY_STREAM_WEBKIT_H__
36 #include <glib-object.h>
37 #include <webkit/webkit.h>
38 #include <tny-stream.h>
42 /* convenience macros */
43 #define MODEST_TYPE_TNY_STREAM_WEBKIT (modest_tny_stream_webkit_get_type())
44 #define MODEST_TNY_STREAM_WEBKIT(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_TNY_STREAM_WEBKIT,ModestTnyStreamWebkit))
45 #define MODEST_TNY_STREAM_WEBKIT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_TNY_STREAM_WEBKIT,ModestTnyStreamWebkitClass))
46 #define MODEST_IS_TNY_STREAM_WEBKIT(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_TNY_STREAM_WEBKIT))
47 #define MODEST_IS_TNY_STREAM_WEBKIT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_TNY_STREAM_WEBKIT))
48 #define MODEST_TNY_STREAM_WEBKIT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_TNY_STREAM_WEBKIT,ModestTnyStreamWebkitClass))
50 typedef struct _ModestTnyStreamWebkit ModestTnyStreamWebkit;
51 typedef struct _ModestTnyStreamWebkitClass ModestTnyStreamWebkitClass;
53 struct _ModestTnyStreamWebkit {
57 struct _ModestTnyStreamWebkitClass {
58 GObjectClass parent_class;
61 GType modest_tny_stream_webkit_get_type (void) G_GNUC_CONST;
65 * modest_tny_stream_webkit_new:
66 * @stream: a #WebkitStream
68 * creates a new #ModestTnyStreamWebkit
70 * Returns: a new #ModestTnyStreamWebkit
72 GObject* modest_tny_stream_webkit_new (WebKitWebView *webview,
73 const gchar *mime_type, const gchar *encoding);
76 * modest_tny_stream_webkit_set_max_size:
77 * @stream: a #ModestTnyStreamWebkit
78 * @max_size: a #gssize
80 * set @max_size as the maximum size @stream will process
82 void modest_tny_stream_webkit_set_max_size (ModestTnyStreamWebkit *stream, gssize max_size);
85 * modest_tny_stream_webkit_get_max_size:
86 * @stream: a #ModestTnyStreamWebkit
88 * obtain the maximum size @stream will process
90 * Returns: a #gssize (or 0 if unlimited)
92 gssize modest_tny_stream_webkit_get_max_size (ModestTnyStreamWebkit *stream);
95 * modest_tny_stream_webkit_limit_reached:
96 * @self: a #ModestTnyStreamWebkit
98 * tells if on processing the stream, the max size limit has been hit.
100 * Returns: %TRUE if limit is reached, %FALSE otherwise.
102 gboolean modest_tny_stream_webkit_limit_reached (ModestTnyStreamWebkit *self);
106 #endif /* __MODEST_TNY_STREAM_WEBKIT_H__ */