git.maemo.org Git - modest/blob - src/modest-utils.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 #ifndef __MODEST_UTILS_H__
  32 #define __MODEST_UTILS_H__
  33
  34 #include <gtk/gtk.h>
  35 #include <stdio.h> /* for FILE* */
  36 #include <tny-fs-stream.h>
  37 #include <modest-protocol.h>
  38 #include "widgets/modest-validating-entry.h"
  39
  40 typedef enum {
  41         MODEST_UTILS_GET_SUPPORTED_SECURE_AUTHENTICATION_ERROR_CANCELED
  42 } ModestUtilsGetSupportedSecureAuthenticationError;
  43
  44 typedef enum _ModestSortDialogType {
  45         MODEST_SORT_HEADERS,
  46 } ModestSortDialogType;
  47
  48 typedef struct _ModestMsgNotificationData {
  49         gchar *subject;
  50         gchar *from;
  51         gchar *uri;
  52 } ModestMsgNotificationData;
  53
  54 GQuark modest_utils_get_supported_secure_authentication_error_quark (void);
  55
  56
  57 /**
  58  * modest_utils_folder_writable:
  59  * @filename: a string
  60  *
  61  * Checks if @filename is in a writable folder
  62  *
  63  * Returns: %TRUE if @filename is writable, %FALSE otherwise
  64  */
  65 gboolean modest_utils_folder_writable (const gchar *filename);
  66
  67 /**
  68  * modest_utils_file_exists:
  69  * @filename: a string
  70  *
  71  * Checks if @filename exists
  72  *
  73  * Returns: %TRUE if @filename currently exists, %FALSE otherwise
  74  */
  75 gboolean modest_utils_file_exists (const gchar *filename);
  76
  77 /**
  78  * modest_utils_create_temp_stream:
  79  * @orig_name: a string with the original name of the extension, or %NULL
  80  * @hash_base: if %NULL, subdir will be random. If not, it will be a hash
  81  * of this.
  82  * @path: a string with the created file path.
  83  *
  84  * Creates a temporary fs stream, in a random subdir of /tmp or /var/tmp.
  85  *
  86  * Returns: a #TnyFsStream, or %NULL if operation failed.  Note that it is
  87  * possible that the file already exists but it is not writable. In that case,
  88  * the function would return NULL and @path would contain its path.
  89  */
  90 TnyFsStream *modest_utils_create_temp_stream (const gchar *orig_name, const gchar *hash_base, gchar **path);
  91
  92 /**
  93  * modest_utils_get_supported_secure_authentication_methods:
  94  * @proto: the protocol
  95  * @hostname: hostname of the mail server to check
  96  * @port: mail server port
  97  * @username: username of the account to check for
  98  * @parent_window: a GtkWindow that can be used a parent for progress indication
  99  *
 100  * Get a list of supported authentication methods of the server
 101  *
 102  * Returns: GList* of the method names. This list needs to be freed using g_list_free.
 103  *
 104  */
 105
 106 GList* modest_utils_get_supported_secure_authentication_methods (ModestProtocolType proto,
 107         const gchar* hostname, gint port, const gchar* username, GtkWindow *parent_window, GError** error);
 108
 109 /** modest_show_information_note_in_main_context_and_forget:
 110  * @parent_window: The window for which the note should be transient.
 111  * @message: The text to show.
 112  *
 113  * This calls modest_maemo_show_information_note_and_forget() in an idle handler.
 114  * This should be used when you are not sure that you are in the main context,
 115  * because you should try to use GTK+ UI code only in the main context.
 116  */
 117 void modest_utils_show_information_note_in_main_context_and_forget (GtkWindow *parent_window, const gchar* message);
 118
 119 /** modest_show_dialog_and_forget:
 120  * @parent_window: The window for which the note should be transient.
 121  * @message: The dialog to show.
 122  *
 123  * Show the dialog and destroy it when it is closed, without
 124  * blocking. Use this when you don't want to use gtk_dialog_run(), which might lead
 125  * to hangs.
 126  */
 127 void modest_utils_show_dialog_and_forget (GtkWindow *parent_window, GtkDialog *dialog);
 128
 129 /**
 130  * modest_toggle_action_set_active_block_notify:
 131  * @action: a #GtkToggleAction
 132  * @value: a #gboolean
 133  *
 134  * updates the toggle action active status, but blocking the notification of the changes.
 135  */
 136 void modest_utils_toggle_action_set_active_block_notify (GtkToggleAction *action, gboolean value);
 137
 138 /**
 139  * modest_utils_run_sort_dialog:
 140  * @parent_window: the modest window the dialog has been requested from
 141  * @type: a #ModestSortDialogType
 142  *
 143  * raises a sort dialog for this window
 144  */
 145 void modest_utils_run_sort_dialog (GtkWindow *parent_window, ModestSortDialogType type);
 146
 147
 148 /**
 149  * modest_list_index:
 150  * @list: a #TnyList
 151  * @object: a #GObject
 152  *
 153  * finds the index of @object in @list
 154  *
 155  * Returns: the index of @object, or -1 if @object is not in @list
 156  */
 157 gint modest_list_index (TnyList *list, GObject *object);
 158
 159 /**
 160  * modest_utils_get_available_space:
 161  * @maildir_path: the path of the maildir folder, or %NULL to
 162  * get the space available in local folders
 163  *
 164  * Obtains the space available in the local folder.
 165  *
 166  * Returns: a #guint64
 167  */
 168 guint64 modest_utils_get_available_space (const gchar *maildir_path);
 169
 170 /**
 171  * modest_images_cache_get_id:
 172  * @account: a #TnyAccount
 173  * @uri: an uri string
 174  *
 175  * obtains the hash corresponding to an image external resource to be
 176  * stored in image cache.
 177  *
 178  * Returns: a newly allocated string containing the hash key
 179  */
 180 gchar *modest_images_cache_get_id (const gchar *account, const gchar *uri);
 181
 182
 183 /**
 184  * modest_utils_get_account_name_from_recipient:
 185  * @from: the result of a call to tny_header_dup_from
 186  *
 187  * returns the account name that corresponds to the given from address
 188  *
 189  * Returns: a newly allocated string containing the account name or
 190  * %NULL in case of error
 191  */
 192 gchar *modest_utils_get_account_name_from_recipient (const gchar *from, gchar **mailbox);
 193
 194 void modest_utils_on_entry_invalid_character (ModestValidatingEntry *self,
 195                                               const gchar* character,
 196                                               gpointer user_data);
 197
 198 /**
 199  * modest_utils_open_mcc_mapping_file:
 200  * @translated: a #gboolean pointer
 201  *
 202  * open the mcc mapping file, or %NULL if it fails. It also
 203  * sets @translated to %TRUE if the file is translated
 204  *
 205  * Returns: file ptr or %NULL in case of error
 206  */
 207 FILE* modest_utils_open_mcc_mapping_file (gboolean from_lc_messages, gboolean *translated);
 208
 209 typedef enum {
 210         MODEST_UTILS_COUNTRY_MODEL_COLUMN_NAME = 0,
 211         MODEST_UTILS_COUNTRY_MODEL_COLUMN_MCC = 1,
 212         MODEST_UTILS_COUNTRY_MODEL_N_COLUMNS
 213 } ModestUtilsCountryModelColumns;
 214
 215 /**
 216  * modest_utils_create_country_model:
 217  * @locale_mcc: a #gboolean
 218  *
 219  * creates the countries tree model used in wizard from the mcc
 220  * files.
 221  *
 222  * Returns: an empty #GtkTreeModel with the columns enumerated in
 223  *  #ModestUtilsCountryModelColumns
 224  */
 225 GtkTreeModel *modest_utils_create_country_model (void);
 226
 227 /**
 228  * modest_utils_fill_country_model:
 229  * @model: a #GtkTreeModel (obtained with modest_utils_create_country_model
 230  * @locale_mcc: a #gboolean
 231  *
 232  * fills the countries tree model used in wizard from the mcc
 233  * files.
 234  *
 235  */
 236 void modest_utils_fill_country_model (GtkTreeModel *model, gint *locale_mcc);
 237
 238 /**
 239  * modest_utils_create_notification_list_from_header_list:
 240  * @header_list: a #TnyList of #TnyHeader instances
 241  *
 242  * This function transforms a list of #TnyHeader objects into a list
 243  * that will be used to issue new email notifications
 244  *
 245  * Returns: a #GList of #ModestMsgNotificationData
 246  **/
 247 GList *modest_utils_create_notification_list_from_header_list (TnyList *header_list);
 248
 249 /**
 250  * modest_utils_free_notification_list:
 251  * @notification_list: a #GList of #ModestMsgNotificationData
 252  *
 253  * Frees a list of #ModestMsgNotificationData structures
 254  **/
 255 void  modest_utils_free_notification_list (GList *notification_list);
 256 #endif /*__MODEST_MAEMO_UTILS_H__*/