* Added simple/split view mode persistence for ModestMainWindow

[modest] / src / modest-text-utils.h

diff --git a/src/modest-text-utils.h b/src/modest-text-utils.h
index 3813468..18dea34 100644 (file)
--- a/src/modest-text-utils.h
+++ b/src/modest-text-utils.h
@@ -53,8 +53,9 @@ gchar* modest_text_utils_derived_subject (const gchar *subject,
 
 /**
  * modest_text_utils_quote:
- * @text: a string which contains the message to quote
- * @from: the sender of the original message
+ * @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"
  * @sent_date: sent date/time of the original message
  * @limit: specifies the maximum characters per line in the quoted text
  * 
@@ -86,11 +87,11 @@ gchar* modest_text_utils_cite (const gchar *text,
 
 /**
  * modest_text_utils_inlined_text
- * @from: the sender of the original message
+ * @from: the non-NULL sender of the original message
  * @sent_date: sent date/time of the original message
- * @to: sent date/time of the original message
- * @subject: sent date/time of the original message
- * @text: sent date/time of the original message
+ * @to: 
+ * @subject: 
+ * @text: 
  *
  * creates a new string with the "Original message" text prepended to
  * the text passed as argument and some data of the header
@@ -119,6 +120,24 @@ 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
  *
@@ -134,14 +153,14 @@ gchar*  modest_text_utils_convert_to_html (const gchar *txt);
  * @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);
 
 
 
@@ -168,7 +187,7 @@ gchar* modest_text_utils_get_display_address (gchar *address);
  * 
  * Returns: the length of the  prefix, or 0 if there is none
  */
-gint modest_text_utils_get_subject_prefix_len (const gchar *sub);
+gint modest_text_utils_get_subject_prefix_len (const gchar *subject);
 
 
 /**
@@ -192,11 +211,43 @@ 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 newly allocated string;
+ * free with g_free
+ */
+gchar* modest_text_utils_get_display_date (time_t date);
+
+
+/**
+ * modest_text_utils_get_display_size:
+ * @size: size in bytes
+ *
+ * get a string representation for a size in bytes.
  * 
- * Returns: the new display date. The string is *not* newly allocated,
- * but is a static buffer (for optimization reasons). Therefore, when
- * you call this function, you will loose the data.
+ * Returns: the newly allocated display string for the
+ * size in bytes. must be freed.
  */
-const gchar* modest_text_utils_get_display_date (time_t date);
+gchar * modest_text_utils_get_display_size (guint size);
+
+
+/**
+ * modest_text_utils_validate_email_address:
+ * @email_address: a string
+ * 
+ * validates the email address passed as argument
+ * 
+ * Returns: TRUE if the address is valid, FALSE otherwise
+ **/
+gboolean     modest_text_utils_validate_email_address (const gchar *email_address);
+
+/**
+ * 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__ */