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,
  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  * @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  *
 159  * runs a "new folder" confirmation dialog. The dialog will suggest a
 160  * folder name which depends of the platform if the #suggested_name
 161  * parametter is NULL. If the user input a valid folder name it's
 162  * returned in the #folder_name attribute.
 163  *
 164  * Returns: the #GtkResponseType returned by the dialog
 165  **/
 166 gint      modest_platform_run_new_folder_dialog        (GtkWindow *parent_window,
 167                                                         TnyFolderStore *parent,
 168                                                         gchar *suggested_name,
 169                                                         gchar **folder_name);
 170
 171 /**
 172  * modest_platform_run_rename_folder_dialog:
 173  * @parent_window: a #GtkWindow
 174  * @parent: the parent of the folder
 175  * @suggested_name: current name of the folder
 176  * @folder_name: the new folder name selected by the user for the folder
 177  *
 178  * runs a "rename folder" confirmation dialog. If the user input a valid folder name it's
 179  * returned in the #folder_name attribute.
 180  *
 181  * Returns: the #GtkResponseType returned by the dialog
 182  **/
 183 gint      modest_platform_run_rename_folder_dialog        (GtkWindow *parent_window,
 184                                                            TnyFolderStore *parent,
 185                                                            const gchar *current_name,
 186                                                            gchar **folder_name);
 187
 188 /**
 189  * modest_platform_run_confirmation_dialog:
 190  * @parent_window: the parent #GtkWindow of the dialog
 191  * @message: the message to show to the user
 192  *
 193  * runs a confirmation dialog
 194  *
 195  * Returns: GTK_RESPONSE_OK or GTK_RESPONSE_CANCEL
 196  **/
 197 gint      modest_platform_run_confirmation_dialog      (GtkWindow *parent_window,
 198                                                         const gchar *message);
 199
 200
 201 /**
 202  * modest_platform_run_confirmation_dialog_with_buttons:
 203  * @parent_window: the parent #GtkWindow of the dialog
 204  * @message: the message to show to the user
 205  * @button_accept: the text to show in the label of the accept button
 206  * @button_cancel: the text to show in the label of the cancel button
 207  *
 208  * runs a confirmation dialog with the given values for the buttons
 209  *
 210  * Returns: GTK_RESPONSE_OK or GTK_RESPONSE_CANCEL
 211  **/
 212 gint
 213 modest_platform_run_confirmation_dialog_with_buttons (GtkWindow *parent_window,
 214                                                       const gchar *message,
 215                                                       const gchar *button_accept,
 216                                                       const gchar *button_cancel);
 217
 218 /**
 219  * modest_platform_run_information_dialog:
 220  * @parent_window: the parent #GtkWindow of the dialog
 221  * @message: the message to show
 222  * @block: whether or not the dialog should block the main loop or not while running
 223  *
 224  * shows an information dialog
 225  **/
 226 void      modest_platform_run_information_dialog       (GtkWindow *parent_window,
 227                                                         const gchar *message,
 228                                                         gboolean block);
 229
 230 /**
 231  * modest_platform_create_sort_dialog:
 232  * @parent_window: the parent #GtkWindow of the dialog
 233  *
 234  * creates a proper sort dialog for the platform
 235  *
 236  * Returns: a #GtkDialog implementing #ModestSortCriteriumView interface
 237  **/
 238 GtkWidget *modest_platform_create_sort_dialog       (GtkWindow *parent_window);
 239
 240 /*
 241  * modest_platform_connect_and_wait:
 242  * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
 243  * @account: The account to be used.
 244  * @return value: Whether a connection was made.
 245  *
 246  * Attempts to make a connection, possibly showing interactive UI to achieve this.
 247  * This will return TRUE immediately if a connection is already open.
 248  * Otherwise, this function blocks until the connection attempt has either succeded or failed.
 249  * This also sets the account to online, if it is a store account, in case it has been set to offline mode.
 250  */
 251 gboolean modest_platform_connect_and_wait (GtkWindow *parent_window, TnyAccount *account);
 252
 253
 254 /*
 255  * modest_platform_connect_and_wait_if_network_account:
 256  * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
 257  * @account: The account that might need a connection in subsequent operations.
 258  * @return value: Whether a connection was made. Also returns TRUE if no connection is necessary.
 259  *
 260  * Like modest_platform_connect_and_wait(), but only attempts to make a connection if the
 261  * account uses the network. For instance, this just returns TRUE for local maildir accounts.
 262  */
 263 gboolean modest_platform_connect_and_wait_if_network_account (GtkWindow *parent_window, TnyAccount *account);
 264
 265 /*
 266  * modest_platform_connect_and_wait_if_network_account:
 267  * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
 268  * @folder_store: The folder store (folder or account) that might need a connection in subsequent operations.
 269  * @return value: Whether a connection was made. Also returns TRUE if no connection is necessary.
 270  *
 271  * Like modest_platform_connect_and_wait(), but only attempts to make a connection if the
 272  * folder store uses the network. For instance, this just returns TRUE for local maildir folders.
 273  */
 274 gboolean modest_platform_connect_and_wait_if_network_folderstore (GtkWindow *parent_window, TnyFolderStore *folder_store);
 275
 276 /**
 277  * modest_platform_set_update_interval:
 278  * @minutes: The number of minutes between updates, or 0 for no updates.
 279  *
 280  * Set the number of minutes between automatic updates of email accounts.
 281  * The platform will cause the send/receive action to happen repeatedly.
 282  **/
 283 gboolean modest_platform_set_update_interval (guint minutes);
 284
 285 /**
 286  * modest_platform_get_global_settings_dialog:
 287  * @void:
 288  *
 289  * returns the global settings dialog
 290  *
 291  * Return value: a new #ModestGlobalSettingsDialog dialog
 292  **/
 293 GtkWidget* modest_platform_get_global_settings_dialog (void);
 294
 295 /**
 296  * modest_platform_push_email_notification:
 297  *
 298  * Notify the user when new e-mail arrives by playing a sound, making
 299  * a light blink, etc.
 300  */
 301 void modest_platform_push_email_notification(void);
 302
 303 /**
 304  * modest_platform_on_new_headers_received:
 305  * @header_list: the list of new received headers
 306  * @show_visual: adds a visual notification
 307  *
 308  * Performs the required actions when new headers are
 309  * received. Tipically it's useful for showing new email notifications
 310  **/
 311 void modest_platform_on_new_headers_received (TnyList *header_list,
 312                                               gboolean show_visual);
 313
 314 /**
 315  * modest_platform_show_help:
 316  * @parent_window:
 317  * @help_id: the help topic id to be shown in the help dialog
 318  *
 319  * shows the application help dialog
 320  **/
 321 void modest_platform_show_help (GtkWindow *parent_window,
 322                                 const gchar *help_id);
 323
 324 /**
 325  * modest_platform_show_search_messages:
 326  * @parent_window: window the dialog will be child of
 327  *
 328  * shows the search messages dialog
 329  **/
 330 void modest_platform_show_search_messages (GtkWindow *parent_window);
 331
 332 /**
 333  * modest_platform_show_addressbook:
 334  * @parent_window: window the dialog will be child of
 335  *
 336  * shows the addressbook
 337  **/
 338 void modest_platform_show_addressbook (GtkWindow *parent_window);
 339
 340
 341 GtkWidget* modest_platform_create_folder_view (TnyFolderStoreQuery *query);
 342
 343 void modest_platform_information_banner (GtkWidget *widget,
 344                                          const gchar *icon_name,
 345                                          const gchar *text);
 346
 347 /* Timeout is in miliseconds */
 348 void modest_platform_information_banner_with_timeout (GtkWidget *parent,
 349                                                       const gchar *icon_name,
 350                                                       const gchar *text,
 351                                                       gint timeout);
 352
 353 GtkWidget *
 354 modest_platform_animation_banner (GtkWidget *parent,
 355                                   const gchar *annimation_name,
 356                                   const gchar *text);
 357
 358 /* TODO: This isn't platform-dependent, so this isn't the best place for this. */
 359 /* Return TRUE immediately if the account is already online,
 360  * otherwise check every second for NUMBER_OF_TRIES seconds and return TRUE as
 361  * soon as the account is online, or FALSE if the account does
 362  * not become online in the NUMBER_OF_TRIES seconds.
 363  * This is useful when the D-Bus method was run immediately after
 364  * the application was started (when using D-Bus activation),
 365  * because the account usually takes a short time to go online.
 366  * The return value is maybe not very useful.
 367  */
 368 gboolean modest_platform_check_and_wait_for_account_is_online(TnyAccount *account);
 369
 370
 371
 372 /**
 373  * modest_platform_run_certificate_confirmation_dialog:
 374  * @server_name: name of the server we get this dialog for
 375  * @certificate: the text representation of the certificate
 376  *
 377  * show the unknown-certificate confirmation dialog
 378  *
 379  *  Returns: TRUE (Ok-pressed) or FALSE (cancel pressed)
 380  **/
 381 gboolean modest_platform_run_certificate_confirmation_dialog (const gchar* server_name,
 382                                                               const gchar *certificate);
 383
 384
 385 /**
 386  * modest_platform_run_alert_dialog:
 387  * @prompt: prompt for the dialog
 388  * @is_question: is it a question dialog?
 389  *
 390  * show the alert dialog for TnyAlerts
 391  * if it's a aquest
 392  *
 393  *  Returns: TRUE (Ok-pressed) or FALSE (cancel pressed)
 394  **/
 395 gboolean modest_platform_run_alert_dialog (const gchar* prompt, gboolean is_question);
 396
 397
 398 /**
 399  * modest_platform_remove_new_mail_notifications:
 400  * @only_visuals: remove only the visual notifications (like LEDs)
 401  *
 402  * Removes all the active new mail notifications
 403  **/
 404 void modest_platform_remove_new_mail_notifications (gboolean only_visuals);
 405
 406 /* ModestConnectedPerformer:
 407  * @canceled: whether or not the user canceled
 408  * @err: whether an error occured during connecting, or NULL of not
 409  * @parent_window: the parent window or NULL
 410  * @account: the account or NULL
 411  * @user_data: your own user data
 412  *
 413  * This is the callback for the modest_platform_connect_and_perform* functions
 414  */
 415 typedef void (*ModestConnectedPerformer) (gboolean canceled,
 416                                           GError *err,
 417                                           GtkWindow *parent_window,
 418                                           TnyAccount *account,
 419                                           gpointer user_data);
 420
 421 typedef struct {
 422         TnyAccount *dst_account;
 423         ModestConnectedPerformer callback;
 424         gpointer data;
 425 } DoubleConnectionInfo;
 426
 427 /*
 428  * modest_platform_connect_and_perform:
 429  * @force: force the device to connect if we're offline, if FALSE then it does not connect if required
 430  * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
 431  * @account: The account to be used.
 432  * @callback: will be called when finished, can be NULL
 433  * @user_data: user data for @callback
 434  *
 435  * Attempts to make a connection, possibly showing interactive UI to achieve this.
 436  * This will return immediately if a connection is already open, which results in an instant
 437  * call of @callback. While making a connection, @account, if not NULL, will go online too. If
 438  * @account is NULL, only a network connection is made using the platform's device.
 439  */
 440 void modest_platform_connect_and_perform (GtkWindow *parent_window,
 441                                           gboolean force,
 442                                           TnyAccount *account,
 443                                           ModestConnectedPerformer callback,
 444                                           gpointer user_data);
 445
 446 /*
 447  * modest_platform_connect_if_remote_and_perform:
 448  * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
 449  * @folder_store: The folder store (folder or account) that might need a connection in subsequent operations.
 450  * @callback: will be called when finished, can be NULL
 451  * @user_data: user data for @callback
 452  *
 453  * Like modest_platform_connect_and_perform(), but only attempts to make a connection if the
 454  * folder store uses the network. For instance, this just returns for local maildir folders. It
 455  * will in that case synchronously and instantly perform the @callback
 456  */
 457 void modest_platform_connect_if_remote_and_perform (GtkWindow *parent_window,
 458                                                     gboolean force,
 459                                                     TnyFolderStore *folder_store,
 460                                                     ModestConnectedPerformer callback,
 461                                                     gpointer user_data);
 462
 463 /*
 464  * modest_platform_double_connect_and_perform:
 465  * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
 466  * @folder_store: The folder store (folder or account) that might need a connection in subsequent operations.
 467  * @callback: will be called when finished, can be NULL
 468  * @info:
 469  *
 470  */
 471 void modest_platform_double_connect_and_perform (GtkWindow *parent_window,
 472                                                  gboolean force,
 473                                                  TnyFolderStore *folder_store,
 474                                                  DoubleConnectionInfo *info);
 475
 476 /**
 477  * modest_platform_get_account_settings_wizard:
 478  * @settings: a #ModestAccountSettings
 479  *
 480  * creates a dialog for editing @settings
 481  *
 482  * Returns: the newly created dialog.
 483  */
 484 GtkWidget *modest_platform_get_account_settings_wizard (void);
 485
 486 ModestConnectedVia modest_platform_get_current_connection (void);
 487
 488
 489
 490
 491 /**
 492  * modest_platform_check_memory_low:
 493  *
 494  * @win: a ModestWindow, or NULL
 495  * @visuals: whether or not show visual information
 496  *
 497  * see if memory is too low for big memory consuming operations
 498  * optionally show a warning dialog if @win was provided
 499  *
 500  * Returns: TRUE if we're in lowmem state, FALSE otherwise
 501  */
 502 gboolean modest_platform_check_memory_low (ModestWindow *win,
 503                                            gboolean visuals);
 504
 505
 506 /**
 507  * modest_platform_run_folder_details_dialog:
 508  * @parent_window: the parent #GtkWindow for the new dialog
 509  * @folder: the #TnyFolder whose details will be shown
 510  *
 511  * Shows the folder details dialog
 512  **/
 513 void     modest_platform_run_folder_details_dialog (GtkWindow *parent_window,
 514                                                     TnyFolder *folder);
 515
 516 /**
 517  * modest_platform_run_header_details_dialog:
 518  * @parent_window: the parent #GtkWindow for the new dialog
 519  * @header: the #TnyHeader whose details will be shown
 520  *
 521  * Shows the header details dialog
 522  **/
 523 void     modest_platform_run_header_details_dialog (GtkWindow *parent_window,
 524                                                     TnyHeader *header);
 525
 526 /**
 527  * modest_platform_on_runtime_initialized:
 528  *
 529  * This function will be used by platforms to connect objects between
 530  * themselves once all the singletons have been created. So this
 531  * function MUST be called *before* modest_init
 532  **/
 533 void     modest_platform_on_runtime_initialized ();
 534
 535 #ifndef MODEST_TOOLKIT_GTK
 536 /**
 537  * modest_platform_get_osso_context:
 538  *
 539  * Obtains the osso context pointer for the application
 540  *
 541  * Returns: the osso context pointer
 542  */
 543 osso_context_t *modest_platform_get_osso_context (void);
 544 #endif
 545
 546
 547
 548 GtkWidget* modest_platform_create_move_to_dialog (GtkWindow *parent_window,
 549                                                   GtkWidget **folder_view);
 550
 551 TnyList* modest_platform_get_list_to_move (ModestWindow *window);
 552
 553 G_END_DECLS
 554
 555 #endif /* __MODEST_PLATFORM_UTILS_H__ */