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_MAEMO_UTILS_H__
32 #define __MODEST_MAEMO_UTILS_H__
35 #include <stdio.h> /* for FILE* */
36 #include <modest-protocol-info.h>
37 #include <tny-fs-stream.h>
41 #define MODEST_MAEMO_UTILS_MYDOCS_FOLDER "MyDocs"
42 #define MODEST_MAEMO_UTILS_DEFAULT_IMAGE_FOLDER ".images"
45 MODEST_MAEMO_UTILS_GET_SUPPORTED_SECURE_AUTHENTICATION_ERROR_CANCELED
46 } ModestMaemoUtilsGetSupportedSecureAuthenticationError;
48 GQuark modest_maemo_utils_get_supported_secure_authentication_error_quark (void);
51 * modest_maemo_utils_menubar_to_menu:
52 * @ui_manager: a ui manager, with the menubar at "/MenuBar"
54 * convert a menubar description (in a GtkUIManager) in to a menu
56 * Returns: a new menu, or NULL in case of error
58 GtkWidget* modest_maemo_utils_menubar_to_menu (GtkUIManager *ui_manager);
62 * modest_maemo_utils_get_device_name
64 * get the name for this device. Note: this queries the bluetooth
65 * name over DBUS, and may block. The result will be available in
66 * MODEST_CONF_DEVICE_NAME in ModestConf; it will be updated when it
70 void modest_maemo_utils_get_device_name (void);
73 * modest_maemo_utils_folder_writable:
76 * Checks if @filename is in a writable folder
78 * Returns: %TRUE if @filename is writable, %FALSE otherwise
80 gboolean modest_maemo_utils_folder_writable (const gchar *filename);
83 * modest_maemo_utils_file_exists:
86 * Checks if @filename exists
88 * Returns: %TRUE if @filename currently exists, %FALSE otherwise
90 gboolean modest_maemo_utils_file_exists (const gchar *filename);
93 * modest_maemo_utils_create_temp_stream:
94 * @orig_name: a string with the original name of the extension, or %NULL
95 * @hash_base: if %NULL, subdir will be random. If not, it will be a hash
97 * @path: a string with the created file path
99 * Creates a temporary fs stream, in a random subdir of /tmp or /var/tmp.
101 * Returns: a #TnyFsStream, or %NULL if operation failed.
103 TnyFsStream *modest_maemo_utils_create_temp_stream (const gchar *orig_name, const gchar *hash_base, gchar **path);
106 * modest_maemo_utils_get_supported_secure_authentication_methods:
107 * @proto: the protocol
108 * @hostname: hostname of the mail server to check
109 * @port: mail server port
110 * @username: username of the account to check for
111 * @parent_window: a GtkWindow that can be used a parent for progress indication
113 * Get a list of supported authentication methods of the server
115 * Returns: GList* of the method names. This list needs to be freed using g_list_free.
119 GList* modest_maemo_utils_get_supported_secure_authentication_methods (ModestTransportStoreProtocol proto,
120 const gchar* hostname, gint port, const gchar* username, GtkWindow *parent_window, GError** error);
123 * modest_maemo_utils_setup_images_filechooser:
124 * @chooser: a #GtkFileChooser
126 * Configures the default folder, and mime filter of a filechooser
129 void modest_maemo_utils_setup_images_filechooser (GtkFileChooser *chooser);
133 * modest_maemo_utils_get_osso_context:
135 * get the osso_context pointer for this application
137 * Return: the osso context pointer
139 osso_context_t *modest_maemo_utils_get_osso_context (void);
143 /** modest_maemo_show_information_note_in_main_context_and_forget:
144 * @parent_window: The window for which the note should be transient.
145 * @message: The text to show.
147 * This calls modest_maemo_show_information_note_and_forget() in an idle handler.
148 * This should be used when you are not sure that you are in the main context,
149 * because you should try to use GTK+ UI code only in the main context.
151 void modest_maemo_show_information_note_in_main_context_and_forget (GtkWindow *parent_window, const gchar* message);
153 /** modest_maemo_show_dialog_and_forget:
154 * @parent_window: The window for which the note should be transient.
155 * @message: The dialog to show.
157 * Show the dialog and destroy it when it is closed, without
158 * blocking. Use this when you don't want to use gtk_dialog_run(), which might lead
161 void modest_maemo_show_dialog_and_forget (GtkWindow *parent_window, GtkDialog *dialog);
165 * modest_maemo_open_mcc_mapping_file:
167 * open the mcc mapping file, or NULL if it fails
169 * Returns: file ptr or NULL in case of error
171 FILE* modest_maemo_open_mcc_mapping_file (void);
174 * modest_maemo_set_thumbable_scrollbar:
175 * @win: a scrollable window
176 * @thumbable: set it to thumbable (TRUE) or small (FALSE)
178 * changes the thumbability of scrollbars in a scrollable window
180 void modest_maemo_set_thumbable_scrollbar (GtkScrolledWindow *win, gboolean thumbable);
184 * modest_maemo_toggle_action_set_active_block_notify:
185 * @action: a #GtkToggleAction
186 * @value: a #gboolean
188 * updates the toggle action active status, but blocking the notification of the changes.
190 void modest_maemo_toggle_action_set_active_block_notify (GtkToggleAction *action, gboolean value);
194 * modest_maemo_get_osso_context:
196 * retrieve the osso context for this application
198 * Returns: the current osso_context_t ptr
200 osso_context_t* modest_maemo_utils_get_osso_context (void);
203 * modest_maemo_set_osso_context:
205 * remember the osso-context for this application
207 * @osso_context: a valid osso_context_t pointer
210 void modest_maemo_utils_set_osso_context (osso_context_t *osso_context);
212 #endif /*__MODEST_MAEMO_UTILS_H__*/