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.
30 #ifndef __MODEST_PLATFORM_H__
31 #define __MODEST_PLATFORM_H__
33 #include <tny-device.h>
34 #include "widgets/modest-window.h"
35 #include "widgets/modest-folder-view.h"
39 typedef enum _ModestConfirmationDialogType {
40 MODEST_CONFIRMATION_DELETE_FOLDER,
41 } ModestConfirmationDialogType;
43 typedef enum _ModestSortDialogType {
45 } ModestSortDialogType;
48 * modest_platform_platform_init:
50 * platform specific initialization function
52 * Returns: TRUE if succeeded, FALSE otherwise
54 gboolean modest_platform_init (int argc, char *argv[]);
58 * modest_platform_get_new_device:
60 * platform specific initialization function
62 * Returns: TRUE if succeeded, FALSE otherwise
64 TnyDevice* modest_platform_get_new_device (void);
68 * modest_platform_get_file_icon_name:
69 * @name: the name of the file, or NULL
70 * @mime_type: the mime-type, or NULL
71 * @effective_mime_type: out-param which receives the 'effective mime-type', ie., the mime type
72 * that will be used. May be NULL if you're not interested in this. Note: the returned string
73 * is newly allocated, and should be g_free'd when done with it.
75 * this function gets the icon for the file, based on the file name and/or the mime type,
76 * using the following strategy:
77 * (1) if mime_type != NULL and mime_type != application/octet-stream, find the
78 * the icon name for this mime type
79 * (2) otherwise, guess the icon type from the file name, and then goto (1)
81 * Returns: the icon name
83 gchar* modest_platform_get_file_icon_name (const gchar* name, const gchar* mime_type,
84 gchar **effective_mime_type);
87 * modest_platform_activate_uri:
88 * @uri: the uri to activate
90 * This function activates an URI
92 * Returns: %TRUE if successful, %FALSE if not.
94 gboolean modest_platform_activate_uri (const gchar *uri);
97 * modest_platform_activate_file:
98 * @path: the path to activate
99 * @mime_type: the mime type of the path, or %NULL to guess
101 * This function activates a file
103 * Returns: %TRUE if successful, %FALSE if not.
105 gboolean modest_platform_activate_file (const gchar *path, const gchar *mime_type);
108 * modest_platform_show_uri_popup:
109 * @uri: an URI with the string
111 * This function show the popup of actions for an URI
113 * Returns: %TRUE if successful, %FALSE if not.
115 gboolean modest_platform_show_uri_popup (const gchar *uri);
118 * modest_platform_get_icon:
119 * @name: the name of the icon
121 * this function returns an icon, or NULL in case of error
123 GdkPixbuf* modest_platform_get_icon (const gchar *name);
127 * modest_platform_get_app_name:
129 * this function returns the name of the application. Do not modify.
131 const gchar* modest_platform_get_app_name (void);
135 * modest_platform_run_new_folder_dialog:
136 * @parent_window: a #GtkWindow
137 * @parent: the parent of the new folder
138 * @suggested_name: the suggested name for the new folder
139 * @folder_name: the folder name selected by the user for the new folder
141 * runs a "new folder" confirmation dialog. The dialog will suggest a
142 * folder name which depends of the platform if the #suggested_name
143 * parametter is NULL. If the user input a valid folder name it's
144 * returned in the #folder_name attribute.
146 * Returns: the #GtkResponseType returned by the dialog
148 gint modest_platform_run_new_folder_dialog (GtkWindow *parent_window,
149 TnyFolderStore *parent,
150 gchar *suggested_name,
151 gchar **folder_name);
154 * modest_platform_run_rename_folder_dialog:
155 * @parent_window: a #GtkWindow
156 * @parent: the parent of the folder
157 * @suggested_name: current name of the folder
158 * @folder_name: the new folder name selected by the user for the folder
160 * runs a "rename folder" confirmation dialog. If the user input a valid folder name it's
161 * returned in the #folder_name attribute.
163 * Returns: the #GtkResponseType returned by the dialog
165 gint modest_platform_run_rename_folder_dialog (GtkWindow *parent_window,
166 TnyFolderStore *parent,
167 const gchar *current_name,
168 gchar **folder_name);
171 * modest_platform_run_confirmation_dialog:
172 * @parent_window: the parent #GtkWindow of the dialog
173 * @message: the message to show to the user
175 * runs a confirmation dialog
177 * Returns: GTK_RESPONSE_OK or GTK_RESPONSE_CANCEL
179 gint modest_platform_run_confirmation_dialog (GtkWindow *parent_window,
180 const gchar *message);
183 * modest_platform_run_yes_no_dialog:
184 * @parent_window: the parent #GtkWindow of the dialog
185 * @message: the message to show to the user
187 * runs a dialog that offers yes and no buttons.
189 * Returns: GTK_RESPONSE_YES or GTK_RESPONSE_NO
191 gint modest_platform_run_yes_no_dialog (GtkWindow *parent_window,
192 const gchar *message);
196 * modest_platform_run_information_dialog:
197 * @parent_window: the parent #GtkWindow of the dialog
198 * @message: the message to show
200 * shows an information dialog
202 void modest_platform_run_information_dialog (GtkWindow *parent_window,
203 const gchar *message);
206 * modest_platform_run_sort_dialog:
207 * @parent_window: the parent #GtkWindow of the dialog
208 * @type: the sort dialog type.
210 * shows a sort dialog
212 void modest_platform_run_sort_dialog (GtkWindow *parent_window,
213 ModestSortDialogType type);
216 * modest_platform_connect_and_wait:
217 * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
218 * @account: The account to be used.
219 * @return value: Whether a connection was made.
221 * Attempts to make a connection, possibly showing interactive UI to achieve this.
222 * This will return TRUE immediately if a connection is already open.
223 * Otherwise, this function blocks until the connection attempt has either succeded or failed.
224 * This also sets the account to online, if it is a store account, in case it has been set to offline mode.
226 gboolean modest_platform_connect_and_wait (GtkWindow *parent_window, TnyAccount *account);
230 * modest_platform_connect_and_wait_if_network_account:
231 * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
232 * @account: The account that might need a connection in subsequent operations.
233 * @return value: Whether a connection was made. Also returns TRUE if no connection is necessary.
235 * Like modest_platform_connect_and_wait(), but only attempts to make a connection if the
236 * account uses the network. For instance, this just returns TRUE for local maildir accounts.
238 gboolean modest_platform_connect_and_wait_if_network_account (GtkWindow *parent_window, TnyAccount *account);
241 * modest_platform_connect_and_wait_if_network_account:
242 * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
243 * @folder_store: The folder store (folder or account) that might need a connection in subsequent operations.
244 * @return value: Whether a connection was made. Also returns TRUE if no connection is necessary.
246 * Like modest_platform_connect_and_wait(), but only attempts to make a connection if the
247 * folder store uses the network. For instance, this just returns TRUE for local maildir folders.
249 gboolean modest_platform_connect_and_wait_if_network_folderstore (GtkWindow *parent_window, TnyFolderStore *folder_store);
252 * modest_platform_is_network_folderstore:
253 * @folder_store: The folder store (folder or account) that needs to
254 * decide if need a connection in subsequent operations.
255 * @return value: Whether a connection is necessary for this folder_store.
257 gboolean modest_platform_is_network_folderstore (TnyFolderStore *folder_store);
260 * modest_platform_set_update_interval:
261 * @minutes: The number of minutes between updates, or 0 for no updates.
263 * Set the number of minutes between automatic updates of email accounts.
264 * The platform will cause the send/receive action to happen repeatedly.
266 gboolean modest_platform_set_update_interval (guint minutes);
269 * modest_platform_get_global_settings_dialog:
272 * returns the global settings dialog
274 * Return value: a new #ModestGlobalSettingsDialog dialog
276 GtkWidget* modest_platform_get_global_settings_dialog (void);
279 * modest_platform_on_new_headers_received:
280 * @header_list: the list of new received headers
282 * Performs the required actions when new headers are
283 * received. Tipically it's useful for showing new email notifications
285 void modest_platform_on_new_headers_received (TnyList *header_list);
288 * modest_platform_show_help:
290 * @help_id: the help topic id to be shown in the help dialog
292 * shows the application help dialog
294 void modest_platform_show_help (GtkWindow *parent_window,
295 const gchar *help_id);
298 * modest_platform_set_dialog_help:
299 * @dialog: a #GtkDialog
300 * @help_id: the help topic id to be shown on requesting
303 * attachs a help topic to the dialog
305 void modest_platform_set_dialog_help (GtkDialog *parent_window,
306 const gchar *help_id);
309 * modest_platform_show_search_messages:
310 * @parent_window: window the dialog will be child of
312 * shows the search messages dialog
314 void modest_platform_show_search_messages (GtkWindow *parent_window);
317 * modest_platform_show_addressbook:
318 * @parent_window: window the dialog will be child of
320 * shows the addressbook
322 void modest_platform_show_addressbook (GtkWindow *parent_window);
325 GtkWidget* modest_platform_create_folder_view (TnyFolderStoreQuery *query);
327 void modest_platform_information_banner (GtkWidget *widget,
328 const gchar *icon_name,
332 modest_platform_animation_banner (GtkWidget *parent,
333 const gchar *annimation_name,
336 /* TODO: This isn't platform-dependent, so this isn't the best place for this. */
337 /* Return TRUE immediately if the account is already online,
338 * otherwise check every second for NUMBER_OF_TRIES seconds and return TRUE as
339 * soon as the account is online, or FALSE if the account does
340 * not become online in the NUMBER_OF_TRIES seconds.
341 * This is useful when the D-Bus method was run immediately after
342 * the application was started (when using D-Bus activation),
343 * because the account usually takes a short time to go online.
344 * The return value is maybe not very useful.
346 gboolean modest_platform_check_and_wait_for_account_is_online(TnyAccount *account);
351 * modest_platform_run_certificate_confirmation_dialog:
352 * @server_name: name of the server we get this dialog for
353 * @certificate: the text representation of the certificate
355 * show the unknown-certificate confirmation dialog
357 * Returns: TRUE (Ok-pressed) or FALSE (cancel pressed)
359 gboolean modest_platform_run_certificate_conformation_dialog (const gchar* server_name,
360 const gchar *certificate);
364 * modest_platform_run_alert_dialog:
365 * @prompt: prompt for the dialog
366 * @is_question: is it a question dialog?
368 * show the alert dialog for TnyAlerts
371 * Returns: TRUE (Ok-pressed) or FALSE (cancel pressed)
373 gboolean modest_platform_run_alert_dialog (const gchar* prompt, gboolean is_question);
377 * modest_platform_remove_new_mail_notifications:
379 * Removes all the active new mail notifications
381 void modest_platform_remove_new_mail_notifications (void);
385 #endif /* __MODEST_PLATFORM_UTILS_H__ */