git.maemo.org Git - modest/blob - src/modest-platform.h

   1 /* Copyright (c) 2006, Nokia Corporation
   2  * All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   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.
  16  *
  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.
  28  */
  29
  30 #ifndef __MODEST_PLATFORM_H__
  31 #define __MODEST_PLATFORM_H__
  32
  33 #include <tny-device.h>
  34 #include "widgets/modest-window.h"
  35 #include "widgets/modest-folder-view.h"
  36
  37 G_BEGIN_DECLS
  38
  39 typedef enum _ModestConfirmationDialogType {
  40         MODEST_CONFIRMATION_DELETE_FOLDER,
  41 } ModestConfirmationDialogType;
  42
  43 typedef enum _ModestSortDialogType {
  44         MODEST_SORT_HEADERS,
  45 } ModestSortDialogType;
  46
  47 /**
  48  * modest_platform_platform_init:
  49  *
  50  * platform specific initialization function
  51  *
  52  * Returns: TRUE if succeeded, FALSE otherwise
  53  */
  54 gboolean modest_platform_init (int argc, char *argv[]);
  55
  56
  57 /**
  58  * modest_platform_platform_init:
  59  *
  60  * platform specific un-initialization function
  61  *
  62  * Returns: TRUE if succeeded, FALSE otherwise
  63  */
  64 gboolean modest_platform_uninit (void);
  65
  66
  67 /**
  68  * modest_platform_get_new_device:
  69  *
  70  * platform specific initialization function
  71  *
  72  * Returns: TRUE if succeeded, FALSE otherwise
  73  */
  74 TnyDevice*  modest_platform_get_new_device (void);
  75
  76
  77 /**
  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.
  84  *
  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)
  90  *
  91  * Returns: the icon name
  92  */
  93 gchar*  modest_platform_get_file_icon_name (const gchar* name, const gchar* mime_type,
  94                                             gchar **effective_mime_type);
  95
  96 /**
  97  * modest_platform_activate_uri:
  98  * @uri: the uri to activate
  99  *
 100  * This function activates an URI
 101  *
 102  * Returns: %TRUE if successful, %FALSE if not.
 103  **/
 104 gboolean modest_platform_activate_uri (const gchar *uri);
 105
 106 /**
 107  * modest_platform_activate_file:
 108  * @path: the path to activate
 109  * @mime_type: the mime type of the path, or %NULL to guess
 110  *
 111  * This function activates a file
 112  *
 113  * Returns: %TRUE if successful, %FALSE if not.
 114  **/
 115 gboolean modest_platform_activate_file (const gchar *path, const gchar *mime_type);
 116
 117 /**
 118  * modest_platform_show_uri_popup:
 119  * @uri: an URI with the string
 120  *
 121  * This function show the popup of actions for an URI
 122  *
 123  * Returns: %TRUE if successful, %FALSE if not.
 124  **/
 125 gboolean modest_platform_show_uri_popup (const gchar *uri);
 126
 127 /**
 128  * modest_platform_get_icon:
 129  * @name: the name of the icon
 130  * @size: the icon size, use MODEST_ICON_SMALL or MODEST_ICON_BIG
 131  *
 132  * this function returns an icon, or NULL in case of error
 133  */
 134 GdkPixbuf* modest_platform_get_icon (const gchar *name, guint icon_size);
 135
 136
 137 /**
 138  * modest_platform_get_app_name:
 139  *
 140  * this function returns the name of the application. Do not modify.
 141  */
 142 const gchar* modest_platform_get_app_name (void);
 143
 144
 145 /**
 146  * modest_platform_run_new_folder_dialog:
 147  * @parent_window: a #GtkWindow
 148  * @parent: the parent of the new folder
 149  * @suggested_name: the suggested name for the new folder
 150  * @folder_name: the folder name selected by the user for the new folder
 151  *
 152  * runs a "new folder" confirmation dialog. The dialog will suggest a
 153  * folder name which depends of the platform if the #suggested_name
 154  * parametter is NULL. If the user input a valid folder name it's
 155  * returned in the #folder_name attribute.
 156  *
 157  * Returns: the #GtkResponseType returned by the dialog
 158  **/
 159 gint      modest_platform_run_new_folder_dialog        (GtkWindow *parent_window,
 160                                                         TnyFolderStore *parent,
 161                                                         gchar *suggested_name,
 162                                                         gchar **folder_name);
 163
 164 /**
 165  * modest_platform_run_rename_folder_dialog:
 166  * @parent_window: a #GtkWindow
 167  * @parent: the parent of the folder
 168  * @suggested_name: current name of the folder
 169  * @folder_name: the new folder name selected by the user for the folder
 170  *
 171  * runs a "rename folder" confirmation dialog. If the user input a valid folder name it's
 172  * returned in the #folder_name attribute.
 173  *
 174  * Returns: the #GtkResponseType returned by the dialog
 175  **/
 176 gint      modest_platform_run_rename_folder_dialog        (GtkWindow *parent_window,
 177                                                            TnyFolderStore *parent,
 178                                                            const gchar *current_name,
 179                                                            gchar **folder_name);
 180
 181 /**
 182  * modest_platform_run_confirmation_dialog:
 183  * @parent_window: the parent #GtkWindow of the dialog
 184  * @message: the message to show to the user
 185  *
 186  * runs a confirmation dialog
 187  *
 188  * Returns: GTK_RESPONSE_OK or GTK_RESPONSE_CANCEL
 189  **/
 190 gint      modest_platform_run_confirmation_dialog      (GtkWindow *parent_window,
 191                                                         const gchar *message);
 192
 193
 194 /**
 195  * modest_platform_run_confirmation_dialog_with_buttons:
 196  * @parent_window: the parent #GtkWindow of the dialog
 197  * @message: the message to show to the user
 198  * @button_accept: the text to show in the label of the accept button
 199  * @button_cancel: the text to show in the label of the cancel button
 200  *
 201  * runs a confirmation dialog with the given values for the buttons
 202  *
 203  * Returns: GTK_RESPONSE_OK or GTK_RESPONSE_CANCEL
 204  **/
 205 gint
 206 modest_platform_run_confirmation_dialog_with_buttons (GtkWindow *parent_window,
 207                                                       const gchar *message,
 208                                                       const gchar *button_accept,
 209                                                       const gchar *button_cancel);
 210
 211 /**
 212  * modest_platform_run_yes_no_dialog:
 213  * @parent_window: the parent #GtkWindow of the dialog
 214  * @message: the message to show to the user
 215  *
 216  * runs a dialog that offers yes and no buttons.
 217  *
 218  * Returns: GTK_RESPONSE_YES or GTK_RESPONSE_NO
 219  **/
 220 gint      modest_platform_run_yes_no_dialog      (GtkWindow *parent_window,
 221                                                   const gchar *message);
 222
 223
 224 /**
 225  * modest_platform_run_information_dialog:
 226  * @parent_window: the parent #GtkWindow of the dialog
 227  * @message: the message to show
 228  *
 229  * shows an information dialog
 230  **/
 231 void      modest_platform_run_information_dialog       (GtkWindow *parent_window,
 232                                                         const gchar *message);
 233
 234 /**
 235  * modest_platform_run_sort_dialog:
 236  * @parent_window: the parent #GtkWindow of the dialog
 237  * @type: the sort dialog type.
 238  *
 239  * shows a sort dialog
 240  **/
 241 void      modest_platform_run_sort_dialog       (GtkWindow *parent_window,
 242                                                  ModestSortDialogType type);
 243
 244 /*
 245  * modest_platform_connect_and_wait:
 246  * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
 247  * @account: The account to be used.
 248  * @return value: Whether a connection was made.
 249  *
 250  * Attempts to make a connection, possibly showing interactive UI to achieve this.
 251  * This will return TRUE immediately if a connection is already open.
 252  * Otherwise, this function blocks until the connection attempt has either succeded or failed.
 253  * This also sets the account to online, if it is a store account, in case it has been set to offline mode.
 254  */
 255 gboolean modest_platform_connect_and_wait (GtkWindow *parent_window, TnyAccount *account);
 256
 257
 258 /*
 259  * modest_platform_connect_and_wait_if_network_account:
 260  * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
 261  * @account: The account that might need a connection in subsequent operations.
 262  * @return value: Whether a connection was made. Also returns TRUE if no connection is necessary.
 263  *
 264  * Like modest_platform_connect_and_wait(), but only attempts to make a connection if the
 265  * account uses the network. For instance, this just returns TRUE for local maildir accounts.
 266  */
 267 gboolean modest_platform_connect_and_wait_if_network_account (GtkWindow *parent_window, TnyAccount *account);
 268
 269 /*
 270  * modest_platform_connect_and_wait_if_network_account:
 271  * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
 272  * @folder_store: The folder store (folder or account) that might need a connection in subsequent operations.
 273  * @return value: Whether a connection was made. Also returns TRUE if no connection is necessary.
 274  *
 275  * Like modest_platform_connect_and_wait(), but only attempts to make a connection if the
 276  * folder store uses the network. For instance, this just returns TRUE for local maildir folders.
 277  */
 278 gboolean modest_platform_connect_and_wait_if_network_folderstore (GtkWindow *parent_window, TnyFolderStore *folder_store);
 279
 280 /**
 281  * modest_platform_set_update_interval:
 282  * @minutes: The number of minutes between updates, or 0 for no updates.
 283  *
 284  * Set the number of minutes between automatic updates of email accounts.
 285  * The platform will cause the send/receive action to happen repeatedly.
 286  **/
 287 gboolean modest_platform_set_update_interval (guint minutes);
 288
 289 /**
 290  * modest_platform_get_global_settings_dialog:
 291  * @void:
 292  *
 293  * returns the global settings dialog
 294  *
 295  * Return value: a new #ModestGlobalSettingsDialog dialog
 296  **/
 297 GtkWidget* modest_platform_get_global_settings_dialog (void);
 298
 299 /**
 300  * modest_platform_push_email_notification:
 301  *
 302  * Notify the user when new e-mail arrives by playing a sound, making
 303  * a light blink, etc.
 304  */
 305 void modest_platform_push_email_notification(void);
 306
 307 /**
 308  * modest_platform_on_new_headers_received:
 309  * @header_list: the list of new received headers
 310  * @show_visual: adds a visual notification
 311  *
 312  * Performs the required actions when new headers are
 313  * received. Tipically it's useful for showing new email notifications
 314  **/
 315 void modest_platform_on_new_headers_received (TnyList *header_list,
 316                                               gboolean show_visual);
 317
 318 /**
 319  * modest_platform_show_help:
 320  * @parent_window:
 321  * @help_id: the help topic id to be shown in the help dialog
 322  *
 323  * shows the application help dialog
 324  **/
 325 void modest_platform_show_help (GtkWindow *parent_window,
 326                                 const gchar *help_id);
 327
 328 /**
 329  * modest_platform_show_search_messages:
 330  * @parent_window: window the dialog will be child of
 331  *
 332  * shows the search messages dialog
 333  **/
 334 void modest_platform_show_search_messages (GtkWindow *parent_window);
 335
 336 /**
 337  * modest_platform_show_addressbook:
 338  * @parent_window: window the dialog will be child of
 339  *
 340  * shows the addressbook
 341  **/
 342 void modest_platform_show_addressbook (GtkWindow *parent_window);
 343
 344
 345 GtkWidget* modest_platform_create_folder_view (TnyFolderStoreQuery *query);
 346
 347 void modest_platform_information_banner (GtkWidget *widget,
 348                                          const gchar *icon_name,
 349                                          const gchar *text);
 350
 351 /* Timeout is in miliseconds */
 352 void modest_platform_information_banner_with_timeout (GtkWidget *parent,
 353                                                       const gchar *icon_name,
 354                                                       const gchar *text,
 355                                                       gint timeout);
 356
 357 GtkWidget *
 358 modest_platform_animation_banner (GtkWidget *parent,
 359                                   const gchar *annimation_name,
 360                                   const gchar *text);
 361
 362 /* TODO: This isn't platform-dependent, so this isn't the best place for this. */
 363 /* Return TRUE immediately if the account is already online,
 364  * otherwise check every second for NUMBER_OF_TRIES seconds and return TRUE as
 365  * soon as the account is online, or FALSE if the account does
 366  * not become online in the NUMBER_OF_TRIES seconds.
 367  * This is useful when the D-Bus method was run immediately after
 368  * the application was started (when using D-Bus activation),
 369  * because the account usually takes a short time to go online.
 370  * The return value is maybe not very useful.
 371  */
 372 gboolean modest_platform_check_and_wait_for_account_is_online(TnyAccount *account);
 373
 374
 375
 376 /**
 377  * modest_platform_run_certificate_confirmation_dialog:
 378  * @server_name: name of the server we get this dialog for
 379  * @certificate: the text representation of the certificate
 380  *
 381  * show the unknown-certificate confirmation dialog
 382  *
 383  *  Returns: TRUE (Ok-pressed) or FALSE (cancel pressed)
 384  **/
 385 gboolean modest_platform_run_certificate_confirmation_dialog (const gchar* server_name,
 386                                                               const gchar *certificate);
 387
 388
 389 /**
 390  * modest_platform_run_alert_dialog:
 391  * @prompt: prompt for the dialog
 392  * @is_question: is it a question dialog?
 393  *
 394  * show the alert dialog for TnyAlerts
 395  * if it's a aquest
 396  *
 397  *  Returns: TRUE (Ok-pressed) or FALSE (cancel pressed)
 398  **/
 399 gboolean modest_platform_run_alert_dialog (const gchar* prompt, gboolean is_question);
 400
 401
 402 /**
 403  * modest_platform_remove_new_mail_notifications:
 404  * @only_visuals: remove only the visual notifications (like LEDs)
 405  *
 406  * Removes all the active new mail notifications
 407  **/
 408 void modest_platform_remove_new_mail_notifications (gboolean only_visuals);
 409
 410 /* ModestConnectedPerformer:
 411  * @canceled: whether or not the user canceled
 412  * @err: whether an error occured during connecting, or NULL of not
 413  * @parent_window: the parent window or NULL
 414  * @account: the account or NULL
 415  * @user_data: your own user data
 416  *
 417  * This is the callback for the modest_platform_connect_and_perform* functions
 418  */
 419 typedef void (*ModestConnectedPerformer) (gboolean canceled,
 420                                           GError *err,
 421                                           GtkWindow *parent_window,
 422                                           TnyAccount *account,
 423                                           gpointer user_data);
 424
 425 /*
 426  * modest_platform_connect_and_perform:
 427  * @force: force the device to connect if we're offline, if FALSE then it does not connect if required
 428  * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
 429  * @account: The account to be used.
 430  * @callback: will be called when finished, can be NULL
 431  * @user_data: user data for @callback
 432  *
 433  * Attempts to make a connection, possibly showing interactive UI to achieve this.
 434  * This will return immediately if a connection is already open, which results in an instant
 435  * call of @callback. While making a connection, @account, if not NULL, will go online too. If
 436  * @account is NULL, only a network connection is made using the platform's device.
 437  */
 438 void modest_platform_connect_and_perform (GtkWindow *parent_window,
 439                                           gboolean force,
 440                                           TnyAccount *account,
 441                                           ModestConnectedPerformer callback,
 442                                           gpointer user_data);
 443
 444 /*
 445  * modest_platform_connect_if_remote_and_perform:
 446  * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
 447  * @folder_store: The folder store (folder or account) that might need a connection in subsequent operations.
 448  * @callback: will be called when finished, can be NULL
 449  * @user_data: user data for @callback
 450  *
 451  * Like modest_platform_connect_and_perform(), but only attempts to make a connection if the
 452  * folder store uses the network. For instance, this just returns for local maildir folders. It
 453  * will in that case synchronously and instantly perform the @callback
 454  */
 455 void modest_platform_connect_if_remote_and_perform (GtkWindow *parent_window,
 456                                                     gboolean force,
 457                                                     TnyFolderStore *folder_store,
 458                                                     ModestConnectedPerformer callback,
 459                                                     gpointer user_data);
 460
 461 /**
 462  * modest_platform_get_account_settings_dialog:
 463  * @settings: a #ModestAccountSettings
 464  *
 465  * creates a dialog for editing @settings
 466  *
 467  * Returns: the newly created dialog.
 468  */
 469 GtkWidget *modest_platform_get_account_settings_dialog (ModestAccountSettings *settings);
 470
 471 /**
 472  * modest_platform_get_account_settings_wizard:
 473  * @settings: a #ModestAccountSettings
 474  *
 475  * creates a dialog for editing @settings
 476  *
 477  * Returns: the newly created dialog.
 478  */
 479 GtkWidget *modest_platform_get_account_settings_wizard ();
 480
 481 G_END_DECLS
 482
 483 #endif /* __MODEST_PLATFORM_UTILS_H__ */