git.maemo.org Git - modest/blob - src/widgets/modest-tny-stream-gtkhtml.h

   1 /* Copyright (c) 2006, Nokia Corporation
   2  * All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   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.
  16  *
  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.
  28  */
  29
  30
  31 /* modest-tny-stream-gtkhtml.h */
  32
  33 #ifndef __MODEST_TNY_STREAM_GTKHTML_H__
  34 #define __MODEST_TNY_STREAM_GTKHTML_H__
  35
  36 #include <glib-object.h>
  37 #include <gtkhtml/gtkhtml.h>
  38 #include <tny-stream.h>
  39
  40 G_BEGIN_DECLS
  41
  42 /* convenience macros */
  43 #define MODEST_TYPE_TNY_STREAM_GTKHTML             (modest_tny_stream_gtkhtml_get_type())
  44 #define MODEST_TNY_STREAM_GTKHTML(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_TNY_STREAM_GTKHTML,ModestTnyStreamGtkhtml))
  45 #define MODEST_TNY_STREAM_GTKHTML_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_TNY_STREAM_GTKHTML,ModestTnyStreamGtkhtmlClass))
  46 #define MODEST_IS_TNY_STREAM_GTKHTML(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_TNY_STREAM_GTKHTML))
  47 #define MODEST_IS_TNY_STREAM_GTKHTML_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_TNY_STREAM_GTKHTML))
  48 #define MODEST_TNY_STREAM_GTKHTML_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_TNY_STREAM_GTKHTML,ModestTnyStreamGtkhtmlClass))
  49
  50 typedef struct _ModestTnyStreamGtkhtml      ModestTnyStreamGtkhtml;
  51 typedef struct _ModestTnyStreamGtkhtmlClass ModestTnyStreamGtkhtmlClass;
  52
  53 struct _ModestTnyStreamGtkhtml {
  54         GObject parent;
  55 };
  56
  57 struct _ModestTnyStreamGtkhtmlClass {
  58         GObjectClass parent_class;
  59 };
  60
  61 GType       modest_tny_stream_gtkhtml_get_type    (void) G_GNUC_CONST;
  62
  63
  64 /**
  65  * modest_tny_stream_gtkhtml_new:
  66  * @stream: a #GtkHTMLStream
  67  *
  68  * creates a new #ModestTnyStreamGtkhtml
  69  *
  70  * Returns: a new #ModestTnyStreamGtkhtml
  71  **/
  72 GObject*    modest_tny_stream_gtkhtml_new         (GtkHTMLStream* stream, GtkHTML *html);
  73
  74 /**
  75  * modest_tny_stream_gtkhtml_set_max_size:
  76  * @stream: a #ModestTnyStreamGtkhtml
  77  * @max_size: a #gssize
  78  *
  79  * set @max_size as the maximum size @stream will process
  80  */
  81 void modest_tny_stream_gtkhtml_set_max_size (ModestTnyStreamGtkhtml *stream, gssize max_size);
  82
  83 /**
  84  * modest_tny_stream_gtkhtml_get_max_size:
  85  * @stream: a #ModestTnyStreamGtkhtml
  86  *
  87  * obtain the maximum size @stream will process
  88  *
  89  * Returns: a #gssize (or 0 if unlimited)
  90  */
  91 gssize modest_tny_stream_gtkhtml_get_max_size (ModestTnyStreamGtkhtml *stream);
  92
  93 G_END_DECLS
  94
  95 #endif /* __MODEST_TNY_STREAM_GTKHTML_H__ */
  96