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 #include "widgets/modest-sort-criterium-view.h"
  37 #include <dbus/dbus.h>
  38 #ifndef MODEST_TOOLKIT_GTK
  39 #include <libosso.h>
  40 #endif
  41
  42 G_BEGIN_DECLS
  43
  44 typedef enum _ModestConfirmationDialogType {
  45         MODEST_CONFIRMATION_DELETE_FOLDER,
  46 } ModestConfirmationDialogType;
  47
  48 typedef enum _ModestConnectedVia {
  49         MODEST_CONNECTED_VIA_WLAN_OR_WIMAX = 1,
  50         MODEST_CONNECTED_VIA_ANY = 2,
  51 } ModestConnectedVia;
  52
  53 #define MODEST_GTK_RESPONSE_NEW_FOLDER 1
  54
  55 /**
  56  * modest_platform_platform_init:
  57  *
  58  * platform specific initialization function
  59  *
  60  * Returns: TRUE if succeeded, FALSE otherwise
  61  */
  62 gboolean modest_platform_init (int argc, char *argv[]);
  63
  64
  65 /**
  66  * modest_platform_platform_init:
  67  *
  68  * platform specific un-initialization function
  69  *
  70  * Returns: TRUE if succeeded, FALSE otherwise
  71  */
  72 gboolean modest_platform_uninit (void);
  73
  74
  75 /**
  76  * modest_platform_get_new_device:
  77  *
  78  * platform specific initialization function
  79  *
  80  * Returns: TRUE if succeeded, FALSE otherwise
  81  */
  82 TnyDevice*  modest_platform_get_new_device (void);
  83
  84
  85 /**
  86  * modest_platform_get_file_icon_name:
  87  * @name: the name of the file, or NULL
  88  * @mime_type: the mime-type, or NULL
  89  * @effective_mime_type: out-param which receives the 'effective mime-type', ie., the mime type
  90  * that will be used. May be NULL if you're not interested in this. Note: the returned string
  91  * is newly allocated, and should be g_free'd when done with it.
  92  *
  93  * this function gets the icon for the file, based on the file name and/or the mime type,
  94  * using the following strategy:
  95  * (1) if mime_type != NULL and mime_type != application/octet-stream, find the
  96  *     the icon name for this mime type
  97  * (2) otherwise, guess the icon type from the file name, and then goto (1)
  98  *
  99  * Returns: the icon name
 100  */
 101 gchar*  modest_platform_get_file_icon_name (const gchar* name, const gchar* mime_type,
 102                                             gchar **effective_mime_type);
 103
 104 /**
 105  * modest_platform_activate_uri:
 106  * @uri: the uri to activate
 107  *
 108  * This function activates an URI
 109  *
 110  * Returns: %TRUE if successful, %FALSE if not.
 111  **/
 112 gboolean modest_platform_activate_uri (const gchar *uri);
 113
 114 /**
 115  * modest_platform_activate_file:
 116  * @path: the path to activate
 117  * @mime_type: the mime type of the path, or %NULL to guess
 118  *
 119  * This function activates a file
 120  *
 121  * Returns: %TRUE if successful, %FALSE if not.
 122  **/
 123 gboolean modest_platform_activate_file (const gchar *path, const gchar *mime_type);
 124
 125 /**
 126  * modest_platform_show_uri_popup:
 127  * @uri: an URI with the string
 128  *
 129  * This function show the popup of actions for an URI
 130  *
 131  * Returns: %TRUE if successful, %FALSE if not.
 132  **/
 133 gboolean modest_platform_show_uri_popup (const gchar *uri);
 134
 135 /**
 136  * modest_platform_get_icon:
 137  * @name: the name of the icon
 138  * @size: the icon size, use MODEST_ICON_SMALL or MODEST_ICON_BIG
 139  *
 140  * this function returns an icon, or NULL in case of error
 141  */
 142 GdkPixbuf* modest_platform_get_icon (const gchar *name, guint icon_size);
 143
 144
 145 /**
 146  * modest_platform_get_app_name:
 147  *
 148  * this function returns the name of the application. Do not modify.
 149  */
 150 const gchar* modest_platform_get_app_name (void);
 151
 152
 153 /**
 154  * modest_platform_run_new_folder_dialog:
 155  * @parent_window: a #GtkWindow
 156  * @suggested_parent: the parent of the new folder
 157  * @suggested_name: the suggested name for the new folder
 158  * @folder_name: the folder name selected by the user for the new folder
 159  * @parent: the chosen #TnyFolderStore (should be unreffed)
 160  *
 161  * runs a "new folder" confirmation dialog. The dialog will suggest a
 162  * folder name which depends of the platform if the #suggested_name
 163  * parametter is NULL. If the user input a valid folder name it's
 164  * returned in the #folder_name attribute.
 165  *
 166  * Returns: the #GtkResponseType returned by the dialog
 167  **/
 168 gint      modest_platform_run_new_folder_dialog        (GtkWindow *parent_window,
 169                                                         TnyFolderStore *suggested_parent,
 170                                                         gchar *suggested_name,
 171                                                         gchar **folder_name,
 172                                                         TnyFolderStore **parent);
 173
 174 /**
 175  * modest_platform_run_rename_folder_dialog:
 176  * @parent_window: a #GtkWindow
 177  * @parent: the parent of the folder
 178  * @suggested_name: current name of the folder
 179  * @folder_name: the new folder name selected by the user for the folder
 180  *
 181  * runs a "rename folder" confirmation dialog. If the user input a valid folder name it's
 182  * returned in the #folder_name attribute.
 183  *
 184  * Returns: the #GtkResponseType returned by the dialog
 185  **/
 186 gint      modest_platform_run_rename_folder_dialog        (GtkWindow *parent_window,
 187                                                            TnyFolderStore *parent,
 188                                                            const gchar *current_name,
 189                                                            gchar **folder_name);
 190
 191 /**
 192  * modest_platform_run_confirmation_dialog:
 193  * @parent_window: the parent #GtkWindow of the dialog
 194  * @message: the message to show to the user
 195  *
 196  * runs a confirmation dialog
 197  *
 198  * Returns: GTK_RESPONSE_OK or GTK_RESPONSE_CANCEL
 199  **/
 200 gint      modest_platform_run_confirmation_dialog      (GtkWindow *parent_window,
 201                                                         const gchar *message);
 202
 203
 204 /**
 205  * modest_platform_run_confirmation_dialog_with_buttons:
 206  * @parent_window: the parent #GtkWindow of the dialog
 207  * @message: the message to show to the user
 208  * @button_accept: the text to show in the label of the accept button
 209  * @button_cancel: the text to show in the label of the cancel button
 210  *
 211  * runs a confirmation dialog with the given values for the buttons
 212  *
 213  * Returns: GTK_RESPONSE_OK or GTK_RESPONSE_CANCEL
 214  **/
 215 gint
 216 modest_platform_run_confirmation_dialog_with_buttons (GtkWindow *parent_window,
 217                                                       const gchar *message,
 218                                                       const gchar *button_accept,
 219                                                       const gchar *button_cancel);
 220
 221 /**
 222  * modest_platform_run_information_dialog:
 223  * @parent_window: the parent #GtkWindow of the dialog
 224  * @message: the message to show
 225  * @block: whether or not the dialog should block the main loop or not while running
 226  *
 227  * shows an information dialog
 228  **/
 229 void      modest_platform_run_information_dialog       (GtkWindow *parent_window,
 230                                                         const gchar *message,
 231                                                         gboolean block);
 232
 233 /**
 234  * modest_platform_create_sort_dialog:
 235  * @parent_window: the parent #GtkWindow of the dialog
 236  *
 237  * creates a proper sort dialog for the platform
 238  *
 239  * Returns: a #GtkDialog implementing #ModestSortCriteriumView interface
 240  **/
 241 GtkWidget *modest_platform_create_sort_dialog       (GtkWindow *parent_window);
 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_push_email_notification:
 300  *
 301  * Notify the user when new e-mail arrives by playing a sound, making
 302  * a light blink, etc.
 303  */
 304 void modest_platform_push_email_notification(void);
 305
 306 /**
 307  * modest_platform_on_new_headers_received:
 308  * @header_list: a list of #ModestMsgNotificationData
 309  * @show_visual: adds a visual notification
 310  *
 311  * Performs the required actions when new headers are
 312  * received. Tipically it's useful for showing new email notifications
 313  **/
 314 void modest_platform_on_new_headers_received (GList *URI_list,
 315                                               gboolean show_visual);
 316
 317 /**
 318  * modest_platform_show_help:
 319  * @parent_window:
 320  * @help_id: the help topic id to be shown in the help dialog
 321  *
 322  * shows the application help dialog
 323  **/
 324 void modest_platform_show_help (GtkWindow *parent_window,
 325                                 const gchar *help_id);
 326
 327 /**
 328  * modest_platform_show_search_messages:
 329  * @parent_window: window the dialog will be child of
 330  *
 331  * shows the search messages dialog
 332  **/
 333 void modest_platform_show_search_messages (GtkWindow *parent_window);
 334
 335 /**
 336  * modest_platform_show_addressbook:
 337  * @parent_window: window the dialog will be child of
 338  *
 339  * shows the addressbook
 340  **/
 341 void modest_platform_show_addressbook (GtkWindow *parent_window);
 342
 343
 344 GtkWidget* modest_platform_create_folder_view (TnyFolderStoreQuery *query);
 345
 346 void modest_platform_information_banner (GtkWidget *widget,
 347                                          const gchar *icon_name,
 348                                          const gchar *text);
 349
 350 void modest_platform_system_banner (GtkWidget *widget,
 351                                     const gchar *icon_name,
 352                                     const gchar *text);
 353
 354 /* Timeout is in miliseconds */
 355 void modest_platform_information_banner_with_timeout (GtkWidget *parent,
 356                                                       const gchar *icon_name,
 357                                                       const gchar *text,
 358                                                       gint timeout);
 359
 360 GtkWidget *
 361 modest_platform_animation_banner (GtkWidget *parent,
 362                                   const gchar *annimation_name,
 363                                   const gchar *text);
 364
 365 /* TODO: This isn't platform-dependent, so this isn't the best place for this. */
 366 /* Return TRUE immediately if the account is already online,
 367  * otherwise check every second for NUMBER_OF_TRIES seconds and return TRUE as
 368  * soon as the account is online, or FALSE if the account does
 369  * not become online in the NUMBER_OF_TRIES seconds.
 370  * This is useful when the D-Bus method was run immediately after
 371  * the application was started (when using D-Bus activation),
 372  * because the account usually takes a short time to go online.
 373  * The return value is maybe not very useful.
 374  */
 375 gboolean modest_platform_check_and_wait_for_account_is_online(TnyAccount *account);
 376
 377
 378
 379 /**
 380  * modest_platform_run_certificate_confirmation_dialog:
 381  * @server_name: name of the server we get this dialog for
 382  * @certificate: the text representation of the certificate
 383  *
 384  * show the unknown-certificate confirmation dialog
 385  *
 386  *  Returns: TRUE (Ok-pressed) or FALSE (cancel pressed)
 387  **/
 388 gboolean modest_platform_run_certificate_confirmation_dialog (const gchar* server_name,
 389                                                               const gchar *certificate);
 390
 391
 392 /**
 393  * modest_platform_run_alert_dialog:
 394  * @prompt: prompt for the dialog
 395  * @is_question: is it a question dialog?
 396  *
 397  * show the alert dialog for TnyAlerts
 398  * if it's a aquest
 399  *
 400  *  Returns: TRUE (Ok-pressed) or FALSE (cancel pressed)
 401  **/
 402 gboolean modest_platform_run_alert_dialog (const gchar* prompt, gboolean is_question);
 403
 404
 405 /**
 406  * modest_platform_remove_new_mail_notifications:
 407  * @only_visuals: remove only the visual notifications (like LEDs)
 408  * @acc_name: account to remove notifications
 409  *
 410  * Removes all the active new mail notifications
 411  **/
 412 void modest_platform_remove_new_mail_notifications (gboolean only_visuals, const gchar *acc_name);
 413
 414 /* ModestConnectedPerformer:
 415  * @canceled: whether or not the user canceled
 416  * @err: whether an error occured during connecting, or NULL of not
 417  * @parent_window: the parent window or NULL
 418  * @account: the account or NULL
 419  * @user_data: your own user data
 420  *
 421  * This is the callback for the modest_platform_connect_and_perform* functions
 422  */
 423 typedef void (*ModestConnectedPerformer) (gboolean canceled,
 424                                           GError *err,
 425                                           GtkWindow *parent_window,
 426                                           TnyAccount *account,
 427                                           gpointer user_data);
 428
 429 typedef struct {
 430         TnyAccount *dst_account;
 431         ModestConnectedPerformer callback;
 432         gpointer data;
 433 } DoubleConnectionInfo;
 434
 435 /*
 436  * modest_platform_connect_and_perform:
 437  * @force: force the device to connect if we're offline, if FALSE then it does not connect if required
 438  * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
 439  * @account: The account to be used.
 440  * @callback: will be called when finished, can be NULL
 441  * @user_data: user data for @callback
 442  *
 443  * Attempts to make a connection, possibly showing interactive UI to achieve this.
 444  * This will return immediately if a connection is already open, which results in an instant
 445  * call of @callback. While making a connection, @account, if not NULL, will go online too. If
 446  * @account is NULL, only a network connection is made using the platform's device.
 447  */
 448 void modest_platform_connect_and_perform (GtkWindow *parent_window,
 449                                           gboolean force,
 450                                           TnyAccount *account,
 451                                           ModestConnectedPerformer callback,
 452                                           gpointer user_data);
 453
 454 /*
 455  * modest_platform_connect_if_remote_and_perform:
 456  * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
 457  * @folder_store: The folder store (folder or account) that might need a connection in subsequent operations.
 458  * @callback: will be called when finished, can be NULL
 459  * @user_data: user data for @callback
 460  *
 461  * Like modest_platform_connect_and_perform(), but only attempts to make a connection if the
 462  * folder store uses the network. For instance, this just returns for local maildir folders. It
 463  * will in that case synchronously and instantly perform the @callback
 464  */
 465 void modest_platform_connect_if_remote_and_perform (GtkWindow *parent_window,
 466                                                     gboolean force,
 467                                                     TnyFolderStore *folder_store,
 468                                                     ModestConnectedPerformer callback,
 469                                                     gpointer user_data);
 470
 471 /*
 472  * modest_platform_double_connect_and_perform:
 473  * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
 474  * @folder_store: The folder store (folder or account) that might need a connection in subsequent operations.
 475  * @callback: will be called when finished, can be NULL
 476  * @info:
 477  *
 478  */
 479 void modest_platform_double_connect_and_perform (GtkWindow *parent_window,
 480                                                  gboolean force,
 481                                                  TnyFolderStore *folder_store,
 482                                                  DoubleConnectionInfo *info);
 483
 484 /**
 485  * modest_platform_get_account_settings_wizard:
 486  * @settings: a #ModestAccountSettings
 487  *
 488  * creates a dialog for editing @settings
 489  *
 490  * Returns: the newly created dialog.
 491  */
 492 GtkWidget *modest_platform_get_account_settings_wizard (void);
 493
 494 ModestConnectedVia modest_platform_get_current_connection (void);
 495
 496
 497
 498
 499 /**
 500  * modest_platform_check_memory_low:
 501  *
 502  * @win: a ModestWindow, or NULL
 503  * @visuals: whether or not show visual information
 504  *
 505  * see if memory is too low for big memory consuming operations
 506  * optionally show a warning dialog if @win was provided
 507  *
 508  * Returns: TRUE if we're in lowmem state, FALSE otherwise
 509  */
 510 gboolean modest_platform_check_memory_low (ModestWindow *win,
 511                                            gboolean visuals);
 512
 513
 514 /**
 515  * modest_platform_run_folder_details_dialog:
 516  * @parent_window: the parent #GtkWindow for the new dialog
 517  * @folder: the #TnyFolder whose details will be shown
 518  *
 519  * Shows the folder details dialog
 520  **/
 521 void     modest_platform_run_folder_details_dialog (GtkWindow *parent_window,
 522                                                     TnyFolder *folder);
 523
 524 /**
 525  * modest_platform_run_header_details_dialog:
 526  * @parent_window: the parent #GtkWindow for the new dialog
 527  * @header: the #TnyHeader whose details will be shown
 528  * @async_get_size: %TRUE if size is obtained asynchronously from @msg
 529  * @msg: a #TnyMsg
 530  *
 531  * Shows the header details dialog
 532  **/
 533 void     modest_platform_run_header_details_dialog (GtkWindow *parent_window,
 534                                                     TnyHeader *header,
 535                                                     gboolean async_get_size,
 536                                                     TnyMsg *msg);
 537
 538 /**
 539  * modest_platform_on_runtime_initialized:
 540  *
 541  * This function will be used by platforms to connect objects between
 542  * themselves once all the singletons have been created. So this
 543  * function MUST be called *before* modest_init
 544  **/
 545 void     modest_platform_on_runtime_initialized ();
 546
 547 #ifndef MODEST_TOOLKIT_GTK
 548 /**
 549  * modest_platform_get_osso_context:
 550  *
 551  * Obtains the osso context pointer for the application
 552  *
 553  * Returns: the osso context pointer
 554  */
 555 osso_context_t *modest_platform_get_osso_context (void);
 556 #endif
 557
 558
 559
 560 GtkWidget* modest_platform_create_move_to_dialog (GtkWindow *parent_window,
 561                                                   GtkWidget **folder_view);
 562
 563 TnyList* modest_platform_get_list_to_move (ModestWindow *window);
 564
 565 DBusConnection* modest_platform_get_dbus_connection (void);
 566
 567 void modest_platform_emit_folder_updated_signal (const gchar *account_id, const gchar *folder_id);
 568
 569 G_END_DECLS
 570
 571 #endif /* __MODEST_PLATFORM_UTILS_H__ */