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;
47 typedef enum _ModestConnectedVia {
48 MODEST_CONNECTED_VIA_WLAN_OR_WIMAX = 1,
49 MODEST_CONNECTED_VIA_ANY,
53 * modest_platform_platform_init:
55 * platform specific initialization function
57 * Returns: TRUE if succeeded, FALSE otherwise
59 gboolean modest_platform_init (int argc, char *argv[]);
63 * modest_platform_platform_init:
65 * platform specific un-initialization function
67 * Returns: TRUE if succeeded, FALSE otherwise
69 gboolean modest_platform_uninit (void);
73 * modest_platform_get_new_device:
75 * platform specific initialization function
77 * Returns: TRUE if succeeded, FALSE otherwise
79 TnyDevice* modest_platform_get_new_device (void);
83 * modest_platform_get_file_icon_name:
84 * @name: the name of the file, or NULL
85 * @mime_type: the mime-type, or NULL
86 * @effective_mime_type: out-param which receives the 'effective mime-type', ie., the mime type
87 * that will be used. May be NULL if you're not interested in this. Note: the returned string
88 * is newly allocated, and should be g_free'd when done with it.
90 * this function gets the icon for the file, based on the file name and/or the mime type,
91 * using the following strategy:
92 * (1) if mime_type != NULL and mime_type != application/octet-stream, find the
93 * the icon name for this mime type
94 * (2) otherwise, guess the icon type from the file name, and then goto (1)
96 * Returns: the icon name
98 gchar* modest_platform_get_file_icon_name (const gchar* name, const gchar* mime_type,
99 gchar **effective_mime_type);
102 * modest_platform_activate_uri:
103 * @uri: the uri to activate
105 * This function activates an URI
107 * Returns: %TRUE if successful, %FALSE if not.
109 gboolean modest_platform_activate_uri (const gchar *uri);
112 * modest_platform_activate_file:
113 * @path: the path to activate
114 * @mime_type: the mime type of the path, or %NULL to guess
116 * This function activates a file
118 * Returns: %TRUE if successful, %FALSE if not.
120 gboolean modest_platform_activate_file (const gchar *path, const gchar *mime_type);
123 * modest_platform_show_uri_popup:
124 * @uri: an URI with the string
126 * This function show the popup of actions for an URI
128 * Returns: %TRUE if successful, %FALSE if not.
130 gboolean modest_platform_show_uri_popup (const gchar *uri);
133 * modest_platform_get_icon:
134 * @name: the name of the icon
135 * @size: the icon size, use MODEST_ICON_SMALL or MODEST_ICON_BIG
137 * this function returns an icon, or NULL in case of error
139 GdkPixbuf* modest_platform_get_icon (const gchar *name, guint icon_size);
143 * modest_platform_get_app_name:
145 * this function returns the name of the application. Do not modify.
147 const gchar* modest_platform_get_app_name (void);
151 * modest_platform_run_new_folder_dialog:
152 * @parent_window: a #GtkWindow
153 * @parent: the parent of the new folder
154 * @suggested_name: the suggested name for the new folder
155 * @folder_name: the folder name selected by the user for the new folder
157 * runs a "new folder" confirmation dialog. The dialog will suggest a
158 * folder name which depends of the platform if the #suggested_name
159 * parametter is NULL. If the user input a valid folder name it's
160 * returned in the #folder_name attribute.
162 * Returns: the #GtkResponseType returned by the dialog
164 gint modest_platform_run_new_folder_dialog (GtkWindow *parent_window,
165 TnyFolderStore *parent,
166 gchar *suggested_name,
167 gchar **folder_name);
170 * modest_platform_run_rename_folder_dialog:
171 * @parent_window: a #GtkWindow
172 * @parent: the parent of the folder
173 * @suggested_name: current name of the folder
174 * @folder_name: the new folder name selected by the user for the folder
176 * runs a "rename folder" confirmation dialog. If the user input a valid folder name it's
177 * returned in the #folder_name attribute.
179 * Returns: the #GtkResponseType returned by the dialog
181 gint modest_platform_run_rename_folder_dialog (GtkWindow *parent_window,
182 TnyFolderStore *parent,
183 const gchar *current_name,
184 gchar **folder_name);
187 * modest_platform_run_confirmation_dialog:
188 * @parent_window: the parent #GtkWindow of the dialog
189 * @message: the message to show to the user
191 * runs a confirmation dialog
193 * Returns: GTK_RESPONSE_OK or GTK_RESPONSE_CANCEL
195 gint modest_platform_run_confirmation_dialog (GtkWindow *parent_window,
196 const gchar *message);
200 * modest_platform_run_confirmation_dialog_with_buttons:
201 * @parent_window: the parent #GtkWindow of the dialog
202 * @message: the message to show to the user
203 * @button_accept: the text to show in the label of the accept button
204 * @button_cancel: the text to show in the label of the cancel button
206 * runs a confirmation dialog with the given values for the buttons
208 * Returns: GTK_RESPONSE_OK or GTK_RESPONSE_CANCEL
211 modest_platform_run_confirmation_dialog_with_buttons (GtkWindow *parent_window,
212 const gchar *message,
213 const gchar *button_accept,
214 const gchar *button_cancel);
217 * modest_platform_run_yes_no_dialog:
218 * @parent_window: the parent #GtkWindow of the dialog
219 * @message: the message to show to the user
221 * runs a dialog that offers yes and no buttons.
223 * Returns: GTK_RESPONSE_YES or GTK_RESPONSE_NO
225 gint modest_platform_run_yes_no_dialog (GtkWindow *parent_window,
226 const gchar *message);
230 * modest_platform_run_information_dialog:
231 * @parent_window: the parent #GtkWindow of the dialog
232 * @message: the message to show
234 * shows an information dialog
236 void modest_platform_run_information_dialog (GtkWindow *parent_window,
237 const gchar *message);
240 * modest_platform_run_sort_dialog:
241 * @parent_window: the parent #GtkWindow of the dialog
242 * @type: the sort dialog type.
244 * shows a sort dialog
246 void modest_platform_run_sort_dialog (GtkWindow *parent_window,
247 ModestSortDialogType type);
250 * modest_platform_connect_and_wait:
251 * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
252 * @account: The account to be used.
253 * @return value: Whether a connection was made.
255 * Attempts to make a connection, possibly showing interactive UI to achieve this.
256 * This will return TRUE immediately if a connection is already open.
257 * Otherwise, this function blocks until the connection attempt has either succeded or failed.
258 * This also sets the account to online, if it is a store account, in case it has been set to offline mode.
260 gboolean modest_platform_connect_and_wait (GtkWindow *parent_window, TnyAccount *account);
264 * modest_platform_connect_and_wait_if_network_account:
265 * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
266 * @account: The account that might need a connection in subsequent operations.
267 * @return value: Whether a connection was made. Also returns TRUE if no connection is necessary.
269 * Like modest_platform_connect_and_wait(), but only attempts to make a connection if the
270 * account uses the network. For instance, this just returns TRUE for local maildir accounts.
272 gboolean modest_platform_connect_and_wait_if_network_account (GtkWindow *parent_window, TnyAccount *account);
275 * modest_platform_connect_and_wait_if_network_account:
276 * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
277 * @folder_store: The folder store (folder or account) that might need a connection in subsequent operations.
278 * @return value: Whether a connection was made. Also returns TRUE if no connection is necessary.
280 * Like modest_platform_connect_and_wait(), but only attempts to make a connection if the
281 * folder store uses the network. For instance, this just returns TRUE for local maildir folders.
283 gboolean modest_platform_connect_and_wait_if_network_folderstore (GtkWindow *parent_window, TnyFolderStore *folder_store);
286 * modest_platform_set_update_interval:
287 * @minutes: The number of minutes between updates, or 0 for no updates.
289 * Set the number of minutes between automatic updates of email accounts.
290 * The platform will cause the send/receive action to happen repeatedly.
292 gboolean modest_platform_set_update_interval (guint minutes);
295 * modest_platform_get_global_settings_dialog:
298 * returns the global settings dialog
300 * Return value: a new #ModestGlobalSettingsDialog dialog
302 GtkWidget* modest_platform_get_global_settings_dialog (void);
305 * modest_platform_push_email_notification:
307 * Notify the user when new e-mail arrives by playing a sound, making
308 * a light blink, etc.
310 void modest_platform_push_email_notification(void);
313 * modest_platform_on_new_headers_received:
314 * @header_list: the list of new received headers
315 * @show_visual: adds a visual notification
317 * Performs the required actions when new headers are
318 * received. Tipically it's useful for showing new email notifications
320 void modest_platform_on_new_headers_received (TnyList *header_list,
321 gboolean show_visual);
324 * modest_platform_show_help:
326 * @help_id: the help topic id to be shown in the help dialog
328 * shows the application help dialog
330 void modest_platform_show_help (GtkWindow *parent_window,
331 const gchar *help_id);
334 * modest_platform_show_search_messages:
335 * @parent_window: window the dialog will be child of
337 * shows the search messages dialog
339 void modest_platform_show_search_messages (GtkWindow *parent_window);
342 * modest_platform_show_addressbook:
343 * @parent_window: window the dialog will be child of
345 * shows the addressbook
347 void modest_platform_show_addressbook (GtkWindow *parent_window);
350 GtkWidget* modest_platform_create_folder_view (TnyFolderStoreQuery *query);
352 void modest_platform_information_banner (GtkWidget *widget,
353 const gchar *icon_name,
356 /* Timeout is in miliseconds */
357 void modest_platform_information_banner_with_timeout (GtkWidget *parent,
358 const gchar *icon_name,
363 modest_platform_animation_banner (GtkWidget *parent,
364 const gchar *annimation_name,
367 /* TODO: This isn't platform-dependent, so this isn't the best place for this. */
368 /* Return TRUE immediately if the account is already online,
369 * otherwise check every second for NUMBER_OF_TRIES seconds and return TRUE as
370 * soon as the account is online, or FALSE if the account does
371 * not become online in the NUMBER_OF_TRIES seconds.
372 * This is useful when the D-Bus method was run immediately after
373 * the application was started (when using D-Bus activation),
374 * because the account usually takes a short time to go online.
375 * The return value is maybe not very useful.
377 gboolean modest_platform_check_and_wait_for_account_is_online(TnyAccount *account);
382 * modest_platform_run_certificate_confirmation_dialog:
383 * @server_name: name of the server we get this dialog for
384 * @certificate: the text representation of the certificate
386 * show the unknown-certificate confirmation dialog
388 * Returns: TRUE (Ok-pressed) or FALSE (cancel pressed)
390 gboolean modest_platform_run_certificate_confirmation_dialog (const gchar* server_name,
391 const gchar *certificate);
395 * modest_platform_run_alert_dialog:
396 * @prompt: prompt for the dialog
397 * @is_question: is it a question dialog?
399 * show the alert dialog for TnyAlerts
402 * Returns: TRUE (Ok-pressed) or FALSE (cancel pressed)
404 gboolean modest_platform_run_alert_dialog (const gchar* prompt, gboolean is_question);
408 * modest_platform_remove_new_mail_notifications:
409 * @only_visuals: remove only the visual notifications (like LEDs)
411 * Removes all the active new mail notifications
413 void modest_platform_remove_new_mail_notifications (gboolean only_visuals);
415 /* ModestConnectedPerformer:
416 * @canceled: whether or not the user canceled
417 * @err: whether an error occured during connecting, or NULL of not
418 * @parent_window: the parent window or NULL
419 * @account: the account or NULL
420 * @user_data: your own user data
422 * This is the callback for the modest_platform_connect_and_perform* functions
424 typedef void (*ModestConnectedPerformer) (gboolean canceled,
426 GtkWindow *parent_window,
431 TnyAccount *dst_account;
432 ModestConnectedPerformer callback;
434 } DoubleConnectionInfo;
437 * modest_platform_connect_and_perform:
438 * @force: force the device to connect if we're offline, if FALSE then it does not connect if required
439 * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
440 * @account: The account to be used.
441 * @callback: will be called when finished, can be NULL
442 * @user_data: user data for @callback
444 * Attempts to make a connection, possibly showing interactive UI to achieve this.
445 * This will return immediately if a connection is already open, which results in an instant
446 * call of @callback. While making a connection, @account, if not NULL, will go online too. If
447 * @account is NULL, only a network connection is made using the platform's device.
449 void modest_platform_connect_and_perform (GtkWindow *parent_window,
452 ModestConnectedPerformer callback,
456 * modest_platform_connect_if_remote_and_perform:
457 * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
458 * @folder_store: The folder store (folder or account) that might need a connection in subsequent operations.
459 * @callback: will be called when finished, can be NULL
460 * @user_data: user data for @callback
462 * Like modest_platform_connect_and_perform(), but only attempts to make a connection if the
463 * folder store uses the network. For instance, this just returns for local maildir folders. It
464 * will in that case synchronously and instantly perform the @callback
466 void modest_platform_connect_if_remote_and_perform (GtkWindow *parent_window,
468 TnyFolderStore *folder_store,
469 ModestConnectedPerformer callback,
473 * modest_platform_double_connect_and_perform:
474 * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
475 * @folder_store: The folder store (folder or account) that might need a connection in subsequent operations.
476 * @callback: will be called when finished, can be NULL
480 void modest_platform_double_connect_and_perform (GtkWindow *parent_window,
482 TnyFolderStore *folder_store,
483 DoubleConnectionInfo *info);
486 * modest_platform_get_account_settings_dialog:
487 * @settings: a #ModestAccountSettings
489 * creates a dialog for editing @settings
491 * Returns: the newly created dialog.
493 GtkWidget *modest_platform_get_account_settings_dialog (ModestAccountSettings *settings);
496 * modest_platform_get_account_settings_wizard:
497 * @settings: a #ModestAccountSettings
499 * creates a dialog for editing @settings
501 * Returns: the newly created dialog.
503 GtkWidget *modest_platform_get_account_settings_wizard ();
505 ModestConnectedVia modest_platform_get_current_connection (void);
509 #endif /* __MODEST_PLATFORM_UTILS_H__ */