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