git.maemo.org Git - modest/blob - src/modest-tny-attachment.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-attachment.h */
  32
  33 #ifndef __MODEST_TNY_ATTACHMENT_H__
  34 #define __MODEST_TNY_ATTACHMENT_H__
  35
  36 #include <glib-object.h>
  37 #include <tny-stream-iface.h>
  38 #include <tny-msg-iface.h>
  39 #include <tny-msg-mime-part-iface.h>
  40 /* other include files */
  41
  42 G_BEGIN_DECLS
  43
  44 /* convenience macros */
  45 #define MODEST_TYPE_TNY_ATTACHMENT             (modest_tny_attachment_get_type())
  46 #define MODEST_TNY_ATTACHMENT(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_TNY_ATTACHMENT,ModestTnyAttachment))
  47 #define MODEST_TNY_ATTACHMENT_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_TNY_ATTACHMENT,GObject))
  48 #define MODEST_IS_TNY_ATTACHMENT(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_TNY_ATTACHMENT))
  49 #define MODEST_IS_TNY_ATTACHMENT_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_TNY_ATTACHMENT))
  50 #define MODEST_TNY_ATTACHMENT_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_TNY_ATTACHMENT,ModestTnyAttachmentClass))
  51
  52 typedef struct _ModestTnyAttachment      ModestTnyAttachment;
  53 typedef struct _ModestTnyAttachmentClass ModestTnyAttachmentClass;
  54
  55 struct _ModestTnyAttachment {
  56          GObject parent;
  57         /* insert public members, if any */
  58 };
  59
  60 struct _ModestTnyAttachmentClass {
  61         GObjectClass parent_class;
  62         /* insert signal callback declarations, eg. */
  63         /* void (* my_event) (ModestTnyAttachment* obj); */
  64 };
  65
  66 /* member functions */
  67 GType        modest_tny_attachment_get_type    (void) G_GNUC_CONST;
  68
  69 /* typical parameter-less _new function */
  70 /* if this is a kind of GtkWidget, it should probably return at GtkWidget*, */
  71 /*    otherwise probably a GObject*. */
  72 ModestTnyAttachment*    modest_tny_attachment_new         (void);
  73
  74 /* fill in other public functions, eg.: */
  75 /*      void       modest_tny_attachment_do_something (ModestTnyAttachment *self, const gchar* param); */
  76 /*      gboolean   modest_tny_attachment_has_foo      (ModestTnyAttachment *self, gint value); */
  77
  78 void modest_tny_attachment_set_name (ModestTnyAttachment *self, const gchar * thing);
  79 const gchar *modest_tny_attachment_get_name (ModestTnyAttachment *self);
  80
  81 void modest_tny_attachment_set_filename (ModestTnyAttachment *self, const gchar * thing);
  82 const gchar *modest_tny_attachment_get_filename (ModestTnyAttachment *self);
  83
  84 void modest_tny_attachment_set_mime_type (ModestTnyAttachment *self, const gchar * thing);
  85 const gchar *modest_tny_attachment_get_mime_type (ModestTnyAttachment *self);
  86
  87 void modest_tny_attachment_guess_mime_type (ModestTnyAttachment *self);
  88
  89 TnyStreamIface * modest_tny_attachment_get_stream (ModestTnyAttachment *self);
  90
  91 void modest_tny_attachment_free_list(GList *list);
  92
  93 GList *modest_tny_attachment_new_list_from_msg(const TnyMsgIface *msg, gboolean with_body);
  94
  95 G_END_DECLS
  96
  97 #endif /* __MODEST_TNY_ATTACHMENT_H__ */
  98