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_platform_init:
60 * platform specific un-initialization function
62 * Returns: TRUE if succeeded, FALSE otherwise
64 gboolean modest_platform_uninit (void);
68 * modest_platform_get_new_device:
70 * platform specific initialization function
72 * Returns: TRUE if succeeded, FALSE otherwise
74 TnyDevice* modest_platform_get_new_device (void);
78 * modest_platform_get_file_icon_name:
79 * @name: the name of the file, or NULL
80 * @mime_type: the mime-type, or NULL
81 * @effective_mime_type: out-param which receives the 'effective mime-type', ie., the mime type
82 * that will be used. May be NULL if you're not interested in this. Note: the returned string
83 * is newly allocated, and should be g_free'd when done with it.
85 * this function gets the icon for the file, based on the file name and/or the mime type,
86 * using the following strategy:
87 * (1) if mime_type != NULL and mime_type != application/octet-stream, find the
88 * the icon name for this mime type
89 * (2) otherwise, guess the icon type from the file name, and then goto (1)
91 * Returns: the icon name
93 gchar* modest_platform_get_file_icon_name (const gchar* name, const gchar* mime_type,
94 gchar **effective_mime_type);
97 * modest_platform_activate_uri:
98 * @uri: the uri to activate
100 * This function activates an URI
102 * Returns: %TRUE if successful, %FALSE if not.
104 gboolean modest_platform_activate_uri (const gchar *uri);
107 * modest_platform_activate_file:
108 * @path: the path to activate
109 * @mime_type: the mime type of the path, or %NULL to guess
111 * This function activates a file
113 * Returns: %TRUE if successful, %FALSE if not.
115 gboolean modest_platform_activate_file (const gchar *path, const gchar *mime_type);
118 * modest_platform_show_uri_popup:
119 * @uri: an URI with the string
121 * This function show the popup of actions for an URI
123 * Returns: %TRUE if successful, %FALSE if not.
125 gboolean modest_platform_show_uri_popup (const gchar *uri);
128 * modest_platform_get_icon:
129 * @name: the name of the icon
131 * this function returns an icon, or NULL in case of error
133 GdkPixbuf* modest_platform_get_icon (const gchar *name);
137 * modest_platform_get_app_name:
139 * this function returns the name of the application. Do not modify.
141 const gchar* modest_platform_get_app_name (void);
145 * modest_platform_run_new_folder_dialog:
146 * @parent_window: a #GtkWindow
147 * @parent: the parent of the new folder
148 * @suggested_name: the suggested name for the new folder
149 * @folder_name: the folder name selected by the user for the new folder
151 * runs a "new folder" confirmation dialog. The dialog will suggest a
152 * folder name which depends of the platform if the #suggested_name
153 * parametter is NULL. If the user input a valid folder name it's
154 * returned in the #folder_name attribute.
156 * Returns: the #GtkResponseType returned by the dialog
158 gint modest_platform_run_new_folder_dialog (GtkWindow *parent_window,
159 TnyFolderStore *parent,
160 gchar *suggested_name,
161 gchar **folder_name);
164 * modest_platform_run_rename_folder_dialog:
165 * @parent_window: a #GtkWindow
166 * @parent: the parent of the folder
167 * @suggested_name: current name of the folder
168 * @folder_name: the new folder name selected by the user for the folder
170 * runs a "rename folder" confirmation dialog. If the user input a valid folder name it's
171 * returned in the #folder_name attribute.
173 * Returns: the #GtkResponseType returned by the dialog
175 gint modest_platform_run_rename_folder_dialog (GtkWindow *parent_window,
176 TnyFolderStore *parent,
177 const gchar *current_name,
178 gchar **folder_name);
181 * modest_platform_run_confirmation_dialog:
182 * @parent_window: the parent #GtkWindow of the dialog
183 * @message: the message to show to the user
185 * runs a confirmation dialog
187 * Returns: GTK_RESPONSE_OK or GTK_RESPONSE_CANCEL
189 gint modest_platform_run_confirmation_dialog (GtkWindow *parent_window,
190 const gchar *message);
193 * modest_platform_run_yes_no_dialog:
194 * @parent_window: the parent #GtkWindow of the dialog
195 * @message: the message to show to the user
197 * runs a dialog that offers yes and no buttons.
199 * Returns: GTK_RESPONSE_YES or GTK_RESPONSE_NO
201 gint modest_platform_run_yes_no_dialog (GtkWindow *parent_window,
202 const gchar *message);
206 * modest_platform_run_information_dialog:
207 * @parent_window: the parent #GtkWindow of the dialog
208 * @message: the message to show
210 * shows an information dialog
212 void modest_platform_run_information_dialog (GtkWindow *parent_window,
213 const gchar *message);
216 * modest_platform_run_sort_dialog:
217 * @parent_window: the parent #GtkWindow of the dialog
218 * @type: the sort dialog type.
220 * shows a sort dialog
222 void modest_platform_run_sort_dialog (GtkWindow *parent_window,
223 ModestSortDialogType type);
226 * modest_platform_connect_and_wait:
227 * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
228 * @account: The account to be used.
229 * @return value: Whether a connection was made.
231 * Attempts to make a connection, possibly showing interactive UI to achieve this.
232 * This will return TRUE immediately if a connection is already open.
233 * Otherwise, this function blocks until the connection attempt has either succeded or failed.
234 * This also sets the account to online, if it is a store account, in case it has been set to offline mode.
236 gboolean modest_platform_connect_and_wait (GtkWindow *parent_window, TnyAccount *account);
240 * modest_platform_connect_and_wait_if_network_account:
241 * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
242 * @account: The account that might need a connection in subsequent operations.
243 * @return value: Whether a connection was made. Also returns TRUE if no connection is necessary.
245 * Like modest_platform_connect_and_wait(), but only attempts to make a connection if the
246 * account uses the network. For instance, this just returns TRUE for local maildir accounts.
248 gboolean modest_platform_connect_and_wait_if_network_account (GtkWindow *parent_window, TnyAccount *account);
251 * modest_platform_connect_and_wait_if_network_account:
252 * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
253 * @folder_store: The folder store (folder or account) that might need a connection in subsequent operations.
254 * @return value: Whether a connection was made. Also returns TRUE if no connection is necessary.
256 * Like modest_platform_connect_and_wait(), but only attempts to make a connection if the
257 * folder store uses the network. For instance, this just returns TRUE for local maildir folders.
259 gboolean modest_platform_connect_and_wait_if_network_folderstore (GtkWindow *parent_window, TnyFolderStore *folder_store);
262 * modest_platform_set_update_interval:
263 * @minutes: The number of minutes between updates, or 0 for no updates.
265 * Set the number of minutes between automatic updates of email accounts.
266 * The platform will cause the send/receive action to happen repeatedly.
268 gboolean modest_platform_set_update_interval (guint minutes);
271 * modest_platform_get_global_settings_dialog:
274 * returns the global settings dialog
276 * Return value: a new #ModestGlobalSettingsDialog dialog
278 GtkWidget* modest_platform_get_global_settings_dialog (void);
281 * modest_platform_on_new_headers_received:
282 * @header_list: the list of new received headers
284 * Performs the required actions when new headers are
285 * received. Tipically it's useful for showing new email notifications
287 void modest_platform_on_new_headers_received (TnyList *header_list);
290 * modest_platform_show_help:
292 * @help_id: the help topic id to be shown in the help dialog
294 * shows the application help dialog
296 void modest_platform_show_help (GtkWindow *parent_window,
297 const gchar *help_id);
300 * modest_platform_show_search_messages:
301 * @parent_window: window the dialog will be child of
303 * shows the search messages dialog
305 void modest_platform_show_search_messages (GtkWindow *parent_window);
308 * modest_platform_show_addressbook:
309 * @parent_window: window the dialog will be child of
311 * shows the addressbook
313 void modest_platform_show_addressbook (GtkWindow *parent_window);
316 GtkWidget* modest_platform_create_folder_view (TnyFolderStoreQuery *query);
318 void modest_platform_information_banner (GtkWidget *widget,
319 const gchar *icon_name,
323 modest_platform_animation_banner (GtkWidget *parent,
324 const gchar *annimation_name,
327 /* TODO: This isn't platform-dependent, so this isn't the best place for this. */
328 /* Return TRUE immediately if the account is already online,
329 * otherwise check every second for NUMBER_OF_TRIES seconds and return TRUE as
330 * soon as the account is online, or FALSE if the account does
331 * not become online in the NUMBER_OF_TRIES seconds.
332 * This is useful when the D-Bus method was run immediately after
333 * the application was started (when using D-Bus activation),
334 * because the account usually takes a short time to go online.
335 * The return value is maybe not very useful.
337 gboolean modest_platform_check_and_wait_for_account_is_online(TnyAccount *account);
342 * modest_platform_run_certificate_confirmation_dialog:
343 * @server_name: name of the server we get this dialog for
344 * @certificate: the text representation of the certificate
346 * show the unknown-certificate confirmation dialog
348 * Returns: TRUE (Ok-pressed) or FALSE (cancel pressed)
350 gboolean modest_platform_run_certificate_confirmation_dialog (const gchar* server_name,
351 const gchar *certificate);
355 * modest_platform_run_alert_dialog:
356 * @prompt: prompt for the dialog
357 * @is_question: is it a question dialog?
359 * show the alert dialog for TnyAlerts
362 * Returns: TRUE (Ok-pressed) or FALSE (cancel pressed)
364 gboolean modest_platform_run_alert_dialog (const gchar* prompt, gboolean is_question);
368 * modest_platform_remove_new_mail_notifications:
370 * Removes all the active new mail notifications
372 void modest_platform_remove_new_mail_notifications (void);
374 /* ModestConnectedPerformer:
375 * @canceled: whether or not the user canceled
376 * @err: whether an error occured during connecting, or NULL of not
377 * @parent_window: the parent window or NULL
378 * @account: the account or NULL
379 * @user_data: your own user data
381 * This is the callback for the modest_platform_connect_and_perform* functions
383 typedef void (*ModestConnectedPerformer) (gboolean canceled,
385 GtkWindow *parent_window,
390 * modest_platform_connect_and_perform:
391 * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
392 * @account: The account to be used.
393 * @callback: will be called when finished, can be NULL
394 * @user_data: user data for @callback
396 * Attempts to make a connection, possibly showing interactive UI to achieve this.
397 * This will return immediately if a connection is already open, which results in an instant
398 * call of @callback. While making a connection, @account, if not NULL, will go online too. If
399 * @account is NULL, only a network connection is made using the platform's device.
401 void modest_platform_connect_and_perform (GtkWindow *parent_window,
403 ModestConnectedPerformer callback,
407 * modest_platform_connect_if_remote_and_perform:
408 * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
409 * @folder_store: The folder store (folder or account) that might need a connection in subsequent operations.
410 * @callback: will be called when finished, can be NULL
411 * @user_data: user data for @callback
413 * Like modest_platform_connect_and_perform(), but only attempts to make a connection if the
414 * folder store uses the network. For instance, this just returns for local maildir folders. It
415 * will in that case synchronously and instantly perform the @callback
417 void modest_platform_connect_if_remote_and_perform (GtkWindow *parent_window,
418 TnyFolderStore *folder_store,
419 ModestConnectedPerformer callback,
423 * modest_platform_get_account_settings_dialog:
424 * @settings: a #ModestAccountSettings
426 * creates a dialog for editing @settings
428 * Returns: the newly created dialog.
430 GtkWidget *modest_platform_get_account_settings_dialog (ModestAccountSettings *settings);
433 * modest_platform_get_account_settings_wizard:
434 * @settings: a #ModestAccountSettings
436 * creates a dialog for editing @settings
438 * Returns: the newly created dialog.
440 GtkWidget *modest_platform_get_account_settings_wizard ();
444 #endif /* __MODEST_PLATFORM_UTILS_H__ */