git.maemo.org Git - modest/blob - src/modest-formatter.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 #ifndef __MODEST_FORMATTER_H__
  31 #define __MODEST_FORMATTER_H__
  32
  33 #include <tny-msg.h>
  34 #include <tny-header.h>
  35 #include <tny-mime-part.h>
  36
  37 G_BEGIN_DECLS
  38
  39 #define MODEST_TYPE_FORMATTER             (modest_formatter_get_type ())
  40 #define MODEST_FORMATTER(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), MODEST_TYPE_FORMATTER, ModestFormatter))
  41 #define MODEST_FORMATTER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), MODEST_TYPE_FORMATTER, ModestFormatterClass))
  42 #define MODEST_IS_FORMATTER(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), MODEST_TYPE_FORMATTER))
  43 #define MODEST_IS_FORMATTER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), MODEST_TYPE_FORMATTER))
  44 #define MODEST_FORMATTER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), MODEST_TYPE_FORMATTER, ModestFormatterClass))
  45
  46 typedef struct _ModestFormatter ModestFormatter;
  47 typedef struct _ModestFormatterClass ModestFormatterClass;
  48
  49 struct _ModestFormatter
  50 {
  51         GObject parent;
  52 };
  53
  54 struct _ModestFormatterClass
  55 {
  56         GObjectClass parent;
  57 };
  58
  59 GType modest_formatter_get_type (void);
  60
  61 ModestFormatter* modest_formatter_new (const gchar *content_type, const gchar *signature);
  62
  63 /**
  64  * modest_formatter_cite:
  65  * @self: a #ModestFormatter
  66  * @part: a non-NULL #TnyMimePart with the body of the original message
  67  * @header: a non-NULL #TnyHeader of the original message
  68  *
  69  * Creates a new message with a text body made from the body of the
  70  * original message cited. This function is locale-sensitive.
  71  *
  72  * Example of cited message:
  73  * <programlisting><para>
  74  * Original message
  75  * ----------------
  76  * Date: 1970/01/01
  77  * From: somemailATmodest.org
  78  * Body: "This is the body of the text"
  79  * </para><para>
  80  * Cited message
  81  * -------------
  82  * Body:
  83  * On 1970/01/01 somemailATmodest.org wrote:
  84  * This is the body of the text
  85  * </para></programlisting>
  86  *
  87  * Returns: a newly formatted #TnyMsg or NULL in case of error
  88  **/
  89 TnyMsg * modest_formatter_cite   (ModestFormatter *self, TnyMimePart *part, TnyHeader *header);
  90
  91
  92 /**
  93  * modest_formatter_quote:
  94  * @self: a #ModestFormatter
  95  * @part: a non-NULL #TnyMimePart with the body of the original message
  96  * @header: a non-NULL #TnyHeader of the original message
  97  *
  98  * Creates a new message with a text body made from the body of the
  99  * original message quoted. This function is locale-sensitive.
 100  *
 101  * Example of cited message:
 102  * <programlisting><para>
 103  * Original message
 104  * ----------------
 105  * Date: 1970/01/01
 106  * From: somemailATmodest.org
 107  * Body: "This is the body of the text"
 108  * </para><para>
 109  * Quoted message
 110  * -------------
 111  * Body:
 112  * On 1970/01/01 somemailATmodest.org wrote:
 113  * > This is the body of the text
 114  * </para></programlisting>
 115  *
 116  * Returns: a newly formatted #TnyMsg or NULL in case of error
 117  **/
 118 TnyMsg * modest_formatter_quote  (ModestFormatter *self, TnyMimePart *part, TnyHeader *header);
 119
 120
 121 /**
 122  * modest_formatter_inline:
 123  * @self: a #ModestFormatter
 124  * @part: a non-NULL #TnyMimePart with the body of the original message
 125  * @header: a non-NULL #TnyHeader of the original message
 126  *
 127  * Creates a new message with a text body made from the body of the
 128  * original message inlined ready to be forwarded. This function is
 129  * locale-sensitive.
 130  *
 131  * Example of cited message:
 132  * <programlisting><para>
 133  * Original message
 134  * ----------------
 135  * Date: 1970/01/01
 136  * From: somemailATmodest.org
 137  * To: mymailATmodest.org
 138  * Subject: Mail subject
 139  * Body: "This is the body of the text"
 140  * </para><para>
 141  * Inlined message
 142  * -------------
 143  * Body:
 144  * -----Forwarded Message-----
 145  * From: somemailATmodest.org
 146  * Sent: 1970/01/01
 147  * To: mymailATmodest.org
 148  * Subject: Fw: Mail subject
 149  * On 1970/01/01 somemailATmodest.org wrote:
 150  * This is the body of the text
 151  * </para></programlisting>
 152  *
 153  * Returns: a newly formatted #TnyMsg or NULL in case of error
 154  **/
 155 TnyMsg * modest_formatter_inline (ModestFormatter *self, TnyMimePart *part, TnyHeader *header);
 156
 157 /**
 158  * modest_formatter_attach:
 159  * @self: a #ModestFormatter
 160  * @part: a non-NULL #TnyMimePart with the body of the original message
 161  * @header: a non-NULL #TnyHeader of the original message
 162  *
 163  * Creates a new message with the original message as attachment
 164  *
 165  * Returns: a newly formatted #TnyMsg or NULL in case of error
 166  **/
 167 TnyMsg * modest_formatter_attach (ModestFormatter *self, TnyMimePart *part, TnyHeader *header);
 168
 169
 170 G_END_DECLS
 171
 172 #endif