1 /* Copyright (c) 2006, Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
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.
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.
31 #ifndef __MODEST_UTILS_H__
32 #define __MODEST_UTILS_H__
35 #include <stdio.h> /* for FILE* */
36 #include <modest-protocol-info.h>
37 #include <tny-fs-stream.h>
40 MODEST_UTILS_GET_SUPPORTED_SECURE_AUTHENTICATION_ERROR_CANCELED
41 } ModestUtilsGetSupportedSecureAuthenticationError;
43 GQuark modest_utils_get_supported_secure_authentication_error_quark (void);
47 * modest_utils_folder_writable:
50 * Checks if @filename is in a writable folder
52 * Returns: %TRUE if @filename is writable, %FALSE otherwise
54 gboolean modest_utils_folder_writable (const gchar *filename);
57 * modest_utils_file_exists:
60 * Checks if @filename exists
62 * Returns: %TRUE if @filename currently exists, %FALSE otherwise
64 gboolean modest_utils_file_exists (const gchar *filename);
67 * modest_utils_create_temp_stream:
68 * @orig_name: a string with the original name of the extension, or %NULL
69 * @hash_base: if %NULL, subdir will be random. If not, it will be a hash
71 * @path: a string with the created file path.
73 * Creates a temporary fs stream, in a random subdir of /tmp or /var/tmp.
75 * Returns: a #TnyFsStream, or %NULL if operation failed. Note that it is
76 * possible that the file already exists but it is not writable. In that case,
77 * the function would return NULL and @path would contain its path.
79 TnyFsStream *modest_utils_create_temp_stream (const gchar *orig_name, const gchar *hash_base, gchar **path);
82 * modest_utils_get_supported_secure_authentication_methods:
83 * @proto: the protocol
84 * @hostname: hostname of the mail server to check
85 * @port: mail server port
86 * @username: username of the account to check for
87 * @parent_window: a GtkWindow that can be used a parent for progress indication
89 * Get a list of supported authentication methods of the server
91 * Returns: GList* of the method names. This list needs to be freed using g_list_free.
95 GList* modest_utils_get_supported_secure_authentication_methods (ModestTransportStoreProtocol proto,
96 const gchar* hostname, gint port, const gchar* username, GtkWindow *parent_window, GError** error);
98 /** modest_show_information_note_in_main_context_and_forget:
99 * @parent_window: The window for which the note should be transient.
100 * @message: The text to show.
102 * This calls modest_maemo_show_information_note_and_forget() in an idle handler.
103 * This should be used when you are not sure that you are in the main context,
104 * because you should try to use GTK+ UI code only in the main context.
106 void modest_utils_show_information_note_in_main_context_and_forget (GtkWindow *parent_window, const gchar* message);
108 /** modest_show_dialog_and_forget:
109 * @parent_window: The window for which the note should be transient.
110 * @message: The dialog to show.
112 * Show the dialog and destroy it when it is closed, without
113 * blocking. Use this when you don't want to use gtk_dialog_run(), which might lead
116 void modest_utils_show_dialog_and_forget (GtkWindow *parent_window, GtkDialog *dialog);
119 * modest_toggle_action_set_active_block_notify:
120 * @action: a #GtkToggleAction
121 * @value: a #gboolean
123 * updates the toggle action active status, but blocking the notification of the changes.
125 void modest_utils_toggle_action_set_active_block_notify (GtkToggleAction *action, gboolean value);
130 * @object: a #GObject
132 * finds the index of @object in @list
134 * Returns: the index of @object, or -1 if @object is not in @list
136 gint modest_list_index (TnyList *list, GObject *object);
139 * modest_folder_available_space:
140 * @maildir_path: the path of the maildir folder, or %NULL to
141 * get the space available in local folders
143 * Obtains the space available in the local folder.
145 * Returns: a #guint64
147 guint64 modest_folder_available_space (const gchar *maildir_path);
149 #endif /*__MODEST_MAEMO_UTILS_H__*/