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 <modest-protocol-info.h>
  37 #include <tny-fs-stream.h>
  38
  39 typedef enum {
  40         MODEST_UTILS_GET_SUPPORTED_SECURE_AUTHENTICATION_ERROR_CANCELED
  41 } ModestUtilsGetSupportedSecureAuthenticationError;
  42
  43 typedef enum _ModestSortDialogType {
  44         MODEST_SORT_HEADERS,
  45 } ModestSortDialogType;
  46
  47 GQuark modest_utils_get_supported_secure_authentication_error_quark (void);
  48
  49
  50 /**
  51  * modest_utils_folder_writable:
  52  * @filename: a string
  53  *
  54  * Checks if @filename is in a writable folder
  55  *
  56  * Returns: %TRUE if @filename is writable, %FALSE otherwise
  57  */
  58 gboolean modest_utils_folder_writable (const gchar *filename);
  59
  60 /**
  61  * modest_utils_file_exists:
  62  * @filename: a string
  63  *
  64  * Checks if @filename exists
  65  *
  66  * Returns: %TRUE if @filename currently exists, %FALSE otherwise
  67  */
  68 gboolean modest_utils_file_exists (const gchar *filename);
  69
  70 /**
  71  * modest_utils_create_temp_stream:
  72  * @orig_name: a string with the original name of the extension, or %NULL
  73  * @hash_base: if %NULL, subdir will be random. If not, it will be a hash
  74  * of this.
  75  * @path: a string with the created file path.
  76  *
  77  * Creates a temporary fs stream, in a random subdir of /tmp or /var/tmp.
  78  *
  79  * Returns: a #TnyFsStream, or %NULL if operation failed.  Note that it is
  80  * possible that the file already exists but it is not writable. In that case,
  81  * the function would return NULL and @path would contain its path.
  82  */
  83 TnyFsStream *modest_utils_create_temp_stream (const gchar *orig_name, const gchar *hash_base, gchar **path);
  84
  85 /**
  86  * modest_utils_get_supported_secure_authentication_methods:
  87  * @proto: the protocol
  88  * @hostname: hostname of the mail server to check
  89  * @port: mail server port
  90  * @username: username of the account to check for
  91  * @parent_window: a GtkWindow that can be used a parent for progress indication
  92  *
  93  * Get a list of supported authentication methods of the server
  94  *
  95  * Returns: GList* of the method names. This list needs to be freed using g_list_free.
  96  *
  97  */
  98
  99 GList* modest_utils_get_supported_secure_authentication_methods (ModestTransportStoreProtocol proto,
 100         const gchar* hostname, gint port, const gchar* username, GtkWindow *parent_window, GError** error);
 101
 102 /** modest_show_information_note_in_main_context_and_forget:
 103  * @parent_window: The window for which the note should be transient.
 104  * @message: The text to show.
 105  *
 106  * This calls modest_maemo_show_information_note_and_forget() in an idle handler.
 107  * This should be used when you are not sure that you are in the main context,
 108  * because you should try to use GTK+ UI code only in the main context.
 109  */
 110 void modest_utils_show_information_note_in_main_context_and_forget (GtkWindow *parent_window, const gchar* message);
 111
 112 /** modest_show_dialog_and_forget:
 113  * @parent_window: The window for which the note should be transient.
 114  * @message: The dialog to show.
 115  *
 116  * Show the dialog and destroy it when it is closed, without
 117  * blocking. Use this when you don't want to use gtk_dialog_run(), which might lead
 118  * to hangs.
 119  */
 120 void modest_utils_show_dialog_and_forget (GtkWindow *parent_window, GtkDialog *dialog);
 121
 122 /**
 123  * modest_toggle_action_set_active_block_notify:
 124  * @action: a #GtkToggleAction
 125  * @value: a #gboolean
 126  *
 127  * updates the toggle action active status, but blocking the notification of the changes.
 128  */
 129 void modest_utils_toggle_action_set_active_block_notify (GtkToggleAction *action, gboolean value);
 130
 131 /**
 132  * modest_utils_run_sort_dialog:
 133  * @parent_window: the modest window the dialog has been requested from
 134  * @type: a #ModestSortDialogType
 135  *
 136  * raises a sort dialog for this window
 137  */
 138 void modest_utils_run_sort_dialog (GtkWindow *parent_window, ModestSortDialogType type);
 139
 140
 141 /**
 142  * modest_list_index:
 143  * @list: a #TnyList
 144  * @object: a #GObject
 145  *
 146  * finds the index of @object in @list
 147  *
 148  * Returns: the index of @object, or -1 if @object is not in @list
 149  */
 150 gint modest_list_index (TnyList *list, GObject *object);
 151
 152 /**
 153  * modest_folder_available_space:
 154  * @maildir_path: the path of the maildir folder, or %NULL to
 155  * get the space available in local folders
 156  *
 157  * Obtains the space available in the local folder.
 158  *
 159  * Returns: a #guint64
 160  */
 161 guint64 modest_folder_available_space (const gchar *maildir_path);
 162
 163 /**
 164  * modest_images_cache_get_id:
 165  * @account: a #TnyAccount
 166  * @uri: an uri string
 167  *
 168  * obtains the hash corresponding to an image external resource to be
 169  * stored in image cache.
 170  *
 171  * Returns: a newly allocated string containing the hash key
 172  */
 173 gchar *modest_images_cache_get_id (const gchar *account, const gchar *uri);
 174
 175 #endif /*__MODEST_MAEMO_UTILS_H__*/