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