* Modified the _get_display_size method to fit with the file management specs
[modest] / src / modest-text-utils.h
index cd693cc..80e12a0 100644 (file)
@@ -36,6 +36,8 @@
 #include <time.h>
 #include <glib.h>
 
+#define _FM(str) dgettext("hildon-fm",str)
+
 /**
  * modest_text_utils_derived_subject:
  * @subject: a string which contains the original subject
@@ -56,6 +58,7 @@ gchar* modest_text_utils_derived_subject (const gchar *subject,
  * @text: a non-NULL string which contains the message to quote
  * @from: a non-NULL  sender of the original message
  * @content_type: the non-NULL content type for the quoting, e.g. "text/html"
+ * @signature: NULL or the signature to add
  * @sent_date: sent date/time of the original message
  * @limit: specifies the maximum characters per line in the quoted text
  * 
@@ -65,6 +68,7 @@ gchar* modest_text_utils_derived_subject (const gchar *subject,
  */
 gchar* modest_text_utils_quote (const gchar *text, 
                                const gchar *content_type,
+                               const gchar *signature,
                                const gchar *from,
                                const time_t sent_date, 
                                int limit);
@@ -82,6 +86,7 @@ gchar* modest_text_utils_quote (const gchar *text,
  */
 gchar* modest_text_utils_cite (const gchar *text,
                               const gchar *content_type,
+                              const gchar *signature,
                               const gchar *from,
                               time_t sent_date);
 
@@ -100,6 +105,7 @@ gchar* modest_text_utils_cite (const gchar *text,
  */
 gchar*   modest_text_utils_inline (const gchar *text,
                                   const gchar *content_type,
+                                  const gchar *signature,
                                   const gchar *from,
                                   time_t sent_date,
                                   const gchar *to,
@@ -120,8 +126,26 @@ gchar*   modest_text_utils_remove_address (const gchar *address_list,
                                           const gchar *address);
 
 /**
+ * modest_text_utils_address_range_at_position:
+ * @address_list: utf8 string containing a list of addresses
+ * @position: a gint
+ * @start: a gint pointer
+ * @end: a gint pointer
+ *
+ * Finds the start and end positions of the address at @position,
+ * in @recipients_list, a list of addresses in the format of a 
+ * recipient list in email. It stores the results in @start and
+ * @end
+ */
+void     modest_text_utils_address_range_at_position (const gchar *recipients_list,
+                                                     gint position,
+                                                     gint *start,
+                                                     gint *end);
+                                                     
+
+/**
  * modest_text_utils_convert_to_html:
- * @txt: a string which contains the message to quote
+ * @txt: a string
  *
  * convert plain text (utf8) into html
  * 
@@ -129,20 +153,30 @@ gchar*   modest_text_utils_remove_address (const gchar *address_list,
  */
 gchar*  modest_text_utils_convert_to_html (const gchar *txt);
 
+/**
+ * modest_text_utils_convert_to_html_body:
+ * @txt: a string
+ *
+ * convert plain text (utf8) into html without adding html headers.
+ * 
+ * Returns: a newly allocated string containing the html
+ */
+gchar*  modest_text_utils_convert_to_html_body (const gchar *data);
+
 
 /**
  * modest_text_utils_strftime:
  * @s:
  * @max:
  * @fmt:
- * @tm
+ * @timet:
  *
  * this is just an alias for strftime(3), so we can use that without
  * getting warning from gcc
  * 
  * Returns: a formatted string of max length @max in @s
  */
-size_t modest_text_utils_strftime(char *s, size_t max, const char  *fmt, const  struct tm *tm);
+size_t modest_text_utils_strftime(char *s, size_t max, const char  *fmt, time_t timet);
 
 
 
@@ -193,10 +227,10 @@ gint modest_text_utils_utf8_strcmp (const gchar* s1, const gchar *s2, gboolean i
  *
  * get a string representation for a date.
  * 
- * Returns: the new display date, as a constant string.
- * must NOT be freed
+ * Returns: the new display date, as a newly allocated string;
+ * free with g_free
  */
-const gchar* modest_text_utils_get_display_date (time_t date);
+gchar* modest_text_utils_get_display_date (time_t date);
 
 
 /**
@@ -208,7 +242,7 @@ const gchar* modest_text_utils_get_display_date (time_t date);
  * Returns: the newly allocated display string for the
  * size in bytes. must be freed.
  */
-gchar * modest_text_utils_get_display_size (gint size);
+gchar * modest_text_utils_get_display_size (guint size);
 
 
 /**
@@ -221,4 +255,28 @@ gchar * modest_text_utils_get_display_size (gint size);
  **/
 gboolean     modest_text_utils_validate_email_address (const gchar *email_address);
 
+/**
+ * modest_text_utils_validate_recipient:
+ * @recipient: a string
+ *
+ * validates @recipient as a valid recipient field for header.
+ * It's different from modest_text_utils_validate_email_address()
+ * as it validates a whole recipient, and not only the part between
+ * the &lt; and &gt; symbols.
+ *
+ * Returns: %TRUE if the recipient is valid, FALSE otherwise
+ **/
+gboolean     modest_text_utils_validate_recipient (const gchar *recipient);
+
+/**
+ * modest_text_utils_split_addresses_list:
+ * @addresses: a string
+ *
+ * obtains a GSList of addresses from a string of addresses
+ * in the format understood by email protocols
+ *
+ * Returns: a GSList of strings
+ **/
+GSList      *modest_text_utils_split_addresses_list (const gchar *addresses);
+
 #endif /* __MODEST_TEXT_UTILS_H__ */