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  *
 131  * this function returns an icon, or NULL in case of error
 132  */
 133 GdkPixbuf* modest_platform_get_icon (const gchar *name);
 134
 135
 136 /**
 137  * modest_platform_get_app_name:
 138  *
 139  * this function returns the name of the application. Do not modify.
 140  */
 141 const gchar* modest_platform_get_app_name (void);
 142
 143
 144 /**
 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
 150  *
 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.
 155  *
 156  * Returns: the #GtkResponseType returned by the dialog
 157  **/
 158 gint      modest_platform_run_new_folder_dialog        (GtkWindow *parent_window,
 159                                                         TnyFolderStore *parent,
 160                                                         gchar *suggested_name,
 161                                                         gchar **folder_name);
 162
 163 /**
 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
 169  *
 170  * runs a "rename folder" confirmation dialog. If the user input a valid folder name it's
 171  * returned in the #folder_name attribute.
 172  *
 173  * Returns: the #GtkResponseType returned by the dialog
 174  **/
 175 gint      modest_platform_run_rename_folder_dialog        (GtkWindow *parent_window,
 176                                                            TnyFolderStore *parent,
 177                                                            const gchar *current_name,
 178                                                            gchar **folder_name);
 179
 180 /**
 181  * modest_platform_run_confirmation_dialog:
 182  * @parent_window: the parent #GtkWindow of the dialog
 183  * @message: the message to show to the user
 184  *
 185  * runs a confirmation dialog
 186  *
 187  * Returns: GTK_RESPONSE_OK or GTK_RESPONSE_CANCEL
 188  **/
 189 gint      modest_platform_run_confirmation_dialog      (GtkWindow *parent_window,
 190                                                         const gchar *message);
 191
 192
 193 /**
 194  * modest_platform_run_confirmation_dialog_with_buttons:
 195  * @parent_window: the parent #GtkWindow of the dialog
 196  * @message: the message to show to the user
 197  * @button_accept: the text to show in the label of the accept button
 198  * @button_cancel: the text to show in the label of the cancel button
 199  *
 200  * runs a confirmation dialog with the given values for the buttons
 201  *
 202  * Returns: GTK_RESPONSE_OK or GTK_RESPONSE_CANCEL
 203  **/
 204 gint
 205 modest_platform_run_confirmation_dialog_with_buttons (GtkWindow *parent_window,
 206                                                       const gchar *message,
 207                                                       const gchar *button_accept,
 208                                                       const gchar *button_cancel);
 209
 210 /**
 211  * modest_platform_run_yes_no_dialog:
 212  * @parent_window: the parent #GtkWindow of the dialog
 213  * @message: the message to show to the user
 214  *
 215  * runs a dialog that offers yes and no buttons.
 216  *
 217  * Returns: GTK_RESPONSE_YES or GTK_RESPONSE_NO
 218  **/
 219 gint      modest_platform_run_yes_no_dialog      (GtkWindow *parent_window,
 220                                                   const gchar *message);
 221
 222
 223 /**
 224  * modest_platform_run_information_dialog:
 225  * @parent_window: the parent #GtkWindow of the dialog
 226  * @message: the message to show
 227  *
 228  * shows an information dialog
 229  **/
 230 void      modest_platform_run_information_dialog       (GtkWindow *parent_window,
 231                                                         const gchar *message);
 232
 233 /**
 234  * modest_platform_run_sort_dialog:
 235  * @parent_window: the parent #GtkWindow of the dialog
 236  * @type: the sort dialog type.
 237  *
 238  * shows a sort dialog
 239  **/
 240 void      modest_platform_run_sort_dialog       (GtkWindow *parent_window,
 241                                                  ModestSortDialogType type);
 242
 243 /*
 244  * modest_platform_connect_and_wait:
 245  * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
 246  * @account: The account to be used.
 247  * @return value: Whether a connection was made.
 248  *
 249  * Attempts to make a connection, possibly showing interactive UI to achieve this.
 250  * This will return TRUE immediately if a connection is already open.
 251  * Otherwise, this function blocks until the connection attempt has either succeded or failed.
 252  * This also sets the account to online, if it is a store account, in case it has been set to offline mode.
 253  */
 254 gboolean modest_platform_connect_and_wait (GtkWindow *parent_window, TnyAccount *account);
 255
 256
 257 /*
 258  * modest_platform_connect_and_wait_if_network_account:
 259  * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
 260  * @account: The account that might need a connection in subsequent operations.
 261  * @return value: Whether a connection was made. Also returns TRUE if no connection is necessary.
 262  *
 263  * Like modest_platform_connect_and_wait(), but only attempts to make a connection if the
 264  * account uses the network. For instance, this just returns TRUE for local maildir accounts.
 265  */
 266 gboolean modest_platform_connect_and_wait_if_network_account (GtkWindow *parent_window, TnyAccount *account);
 267
 268 /*
 269  * modest_platform_connect_and_wait_if_network_account:
 270  * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
 271  * @folder_store: The folder store (folder or account) that might need a connection in subsequent operations.
 272  * @return value: Whether a connection was made. Also returns TRUE if no connection is necessary.
 273  *
 274  * Like modest_platform_connect_and_wait(), but only attempts to make a connection if the
 275  * folder store uses the network. For instance, this just returns TRUE for local maildir folders.
 276  */
 277 gboolean modest_platform_connect_and_wait_if_network_folderstore (GtkWindow *parent_window, TnyFolderStore *folder_store);
 278
 279 /**
 280  * modest_platform_set_update_interval:
 281  * @minutes: The number of minutes between updates, or 0 for no updates.
 282  *
 283  * Set the number of minutes between automatic updates of email accounts.
 284  * The platform will cause the send/receive action to happen repeatedly.
 285  **/
 286 gboolean modest_platform_set_update_interval (guint minutes);
 287
 288 /**
 289  * modest_platform_get_global_settings_dialog:
 290  * @void:
 291  *
 292  * returns the global settings dialog
 293  *
 294  * Return value: a new #ModestGlobalSettingsDialog dialog
 295  **/
 296 GtkWidget* modest_platform_get_global_settings_dialog (void);
 297
 298 /**
 299  * modest_platform_on_new_headers_received:
 300  * @header_list: the list of new received headers
 301  *
 302  * Performs the required actions when new headers are
 303  * received. Tipically it's useful for showing new email notifications
 304  **/
 305 void modest_platform_on_new_headers_received (TnyList *header_list);
 306
 307 /**
 308  * modest_platform_show_help:
 309  * @parent_window:
 310  * @help_id: the help topic id to be shown in the help dialog
 311  *
 312  * shows the application help dialog
 313  **/
 314 void modest_platform_show_help (GtkWindow *parent_window,
 315                                 const gchar *help_id);
 316
 317 /**
 318  * modest_platform_show_search_messages:
 319  * @parent_window: window the dialog will be child of
 320  *
 321  * shows the search messages dialog
 322  **/
 323 void modest_platform_show_search_messages (GtkWindow *parent_window);
 324
 325 /**
 326  * modest_platform_show_addressbook:
 327  * @parent_window: window the dialog will be child of
 328  *
 329  * shows the addressbook
 330  **/
 331 void modest_platform_show_addressbook (GtkWindow *parent_window);
 332
 333
 334 GtkWidget* modest_platform_create_folder_view (TnyFolderStoreQuery *query);
 335
 336 void modest_platform_information_banner (GtkWidget *widget,
 337                                          const gchar *icon_name,
 338                                          const gchar *text);
 339
 340 /* Timeout is in miliseconds */
 341 void modest_platform_information_banner_with_timeout (GtkWidget *parent,
 342                                                       const gchar *icon_name,
 343                                                       const gchar *text,
 344                                                       gint timeout);
 345
 346 GtkWidget *
 347 modest_platform_animation_banner (GtkWidget *parent,
 348                                   const gchar *annimation_name,
 349                                   const gchar *text);
 350
 351 /* TODO: This isn't platform-dependent, so this isn't the best place for this. */
 352 /* Return TRUE immediately if the account is already online,
 353  * otherwise check every second for NUMBER_OF_TRIES seconds and return TRUE as
 354  * soon as the account is online, or FALSE if the account does
 355  * not become online in the NUMBER_OF_TRIES seconds.
 356  * This is useful when the D-Bus method was run immediately after
 357  * the application was started (when using D-Bus activation),
 358  * because the account usually takes a short time to go online.
 359  * The return value is maybe not very useful.
 360  */
 361 gboolean modest_platform_check_and_wait_for_account_is_online(TnyAccount *account);
 362
 363
 364
 365 /**
 366  * modest_platform_run_certificate_confirmation_dialog:
 367  * @server_name: name of the server we get this dialog for
 368  * @certificate: the text representation of the certificate
 369  *
 370  * show the unknown-certificate confirmation dialog
 371  *
 372  *  Returns: TRUE (Ok-pressed) or FALSE (cancel pressed)
 373  **/
 374 gboolean modest_platform_run_certificate_confirmation_dialog (const gchar* server_name,
 375                                                               const gchar *certificate);
 376
 377
 378 /**
 379  * modest_platform_run_alert_dialog:
 380  * @prompt: prompt for the dialog
 381  * @is_question: is it a question dialog?
 382  *
 383  * show the alert dialog for TnyAlerts
 384  * if it's a aquest
 385  *
 386  *  Returns: TRUE (Ok-pressed) or FALSE (cancel pressed)
 387  **/
 388 gboolean modest_platform_run_alert_dialog (const gchar* prompt, gboolean is_question);
 389
 390
 391 /**
 392  * modest_platform_remove_new_mail_notifications:
 393  *
 394  * Removes all the active new mail notifications
 395  **/
 396 void modest_platform_remove_new_mail_notifications (void);
 397
 398 /* ModestConnectedPerformer:
 399  * @canceled: whether or not the user canceled
 400  * @err: whether an error occured during connecting, or NULL of not
 401  * @parent_window: the parent window or NULL
 402  * @account: the account or NULL
 403  * @user_data: your own user data
 404  *
 405  * This is the callback for the modest_platform_connect_and_perform* functions
 406  */
 407 typedef void (*ModestConnectedPerformer) (gboolean canceled,
 408                                           GError *err,
 409                                           GtkWindow *parent_window,
 410                                           TnyAccount *account,
 411                                           gpointer user_data);
 412
 413 /*
 414  * modest_platform_connect_and_perform:
 415  * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
 416  * @account: The account to be used.
 417  * @callback: will be called when finished, can be NULL
 418  * @user_data: user data for @callback
 419  *
 420  * Attempts to make a connection, possibly showing interactive UI to achieve this.
 421  * This will return immediately if a connection is already open, which results in an instant
 422  * call of @callback. While making a connection, @account, if not NULL, will go online too. If
 423  * @account is NULL, only a network connection is made using the platform's device.
 424  */
 425 void modest_platform_connect_and_perform (GtkWindow *parent_window,
 426                                           TnyAccount *account,
 427                                           ModestConnectedPerformer callback,
 428                                           gpointer user_data);
 429
 430 /*
 431  * modest_platform_connect_if_remote_and_perform:
 432  * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
 433  * @folder_store: The folder store (folder or account) that might need a connection in subsequent operations.
 434  * @callback: will be called when finished, can be NULL
 435  * @user_data: user data for @callback
 436  *
 437  * Like modest_platform_connect_and_perform(), but only attempts to make a connection if the
 438  * folder store uses the network. For instance, this just returns for local maildir folders. It
 439  * will in that case synchronously and instantly perform the @callback
 440  */
 441 void modest_platform_connect_if_remote_and_perform (GtkWindow *parent_window,
 442                                                                  TnyFolderStore *folder_store,
 443                                                                  ModestConnectedPerformer callback,
 444                                                                  gpointer user_data);
 445
 446 /**
 447  * modest_platform_get_account_settings_dialog:
 448  * @settings: a #ModestAccountSettings
 449  *
 450  * creates a dialog for editing @settings
 451  *
 452  * Returns: the newly created dialog.
 453  */
 454 GtkWidget *modest_platform_get_account_settings_dialog (ModestAccountSettings *settings);
 455
 456 /**
 457  * modest_platform_get_account_settings_wizard:
 458  * @settings: a #ModestAccountSettings
 459  *
 460  * creates a dialog for editing @settings
 461  *
 462  * Returns: the newly created dialog.
 463  */
 464 GtkWidget *modest_platform_get_account_settings_wizard ();
 465
 466 G_END_DECLS
 467
 468 #endif /* __MODEST_PLATFORM_UTILS_H__ */