git.maemo.org Git - modest/blob - src/modest-platform.h

   1 /* Copyright (c) 2006, Nokia Corporation
   2  * All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  * * Redistributions of source code must retain the above copyright
   9  *   notice, this list of conditions and the following disclaimer.
  10  * * Redistributions in binary form must reproduce the above copyright
  11  *   notice, this list of conditions and the following disclaimer in the
  12  *   documentation and/or other materials provided with the distribution.
  13  * * Neither the name of the Nokia Corporation nor the names of its
  14  *   contributors may be used to endorse or promote products derived from
  15  *   this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
  18  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  20  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
  21  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #ifndef __MODEST_PLATFORM_H__
  31 #define __MODEST_PLATFORM_H__
  32
  33 #include <tny-device.h>
  34 #include "widgets/modest-window.h"
  35 #include "widgets/modest-folder-view.h"
  36
  37 G_BEGIN_DECLS
  38
  39 typedef enum _ModestConfirmationDialogType {
  40         MODEST_CONFIRMATION_DELETE_FOLDER,
  41 } ModestConfirmationDialogType;
  42
  43 typedef enum _ModestSortDialogType {
  44         MODEST_SORT_HEADERS,
  45 } ModestSortDialogType;
  46
  47 /**
  48  * modest_platform_platform_init:
  49  *
  50  * platform specific initialization function
  51  *
  52  * Returns: TRUE if succeeded, FALSE otherwise
  53  */
  54 gboolean modest_platform_init (int argc, char *argv[]);
  55
  56
  57 /**
  58  * modest_platform_get_new_device:
  59  *
  60  * platform specific initialization function
  61  *
  62  * Returns: TRUE if succeeded, FALSE otherwise
  63  */
  64 TnyDevice*  modest_platform_get_new_device (void);
  65
  66
  67 /**
  68  * modest_platform_get_file_icon_name:
  69  * @name: the name of the file, or NULL
  70  * @mime_type: the mime-type, or NULL
  71  * @effective_mime_type: out-param which receives the 'effective mime-type', ie., the mime type
  72  * that will be used. May be NULL if you're not interested in this. Note: the returned string
  73  * is newly allocated, and should be g_free'd when done with it.
  74  *
  75  * this function gets the icon for the file, based on the file name and/or the mime type,
  76  * using the following strategy:
  77  * (1) if mime_type != NULL and mime_type != application/octet-stream, find the
  78  *     the icon name for this mime type
  79  * (2) otherwise, guess the icon type from the file name, and then goto (1)
  80  *
  81  * Returns: the icon name
  82  */
  83 gchar*  modest_platform_get_file_icon_name (const gchar* name, const gchar* mime_type,
  84                                             gchar **effective_mime_type);
  85
  86 /**
  87  * modest_platform_activate_uri:
  88  * @uri: the uri to activate
  89  *
  90  * This function activates an URI
  91  *
  92  * Returns: %TRUE if successful, %FALSE if not.
  93  **/
  94 gboolean modest_platform_activate_uri (const gchar *uri);
  95
  96 /**
  97  * modest_platform_activate_file:
  98  * @path: the path to activate
  99  * @mime_type: the mime type of the path, or %NULL to guess
 100  *
 101  * This function activates a file
 102  *
 103  * Returns: %TRUE if successful, %FALSE if not.
 104  **/
 105 gboolean modest_platform_activate_file (const gchar *path, const gchar *mime_type);
 106
 107 /**
 108  * modest_platform_show_uri_popup:
 109  * @uri: an URI with the string
 110  *
 111  * This function show the popup of actions for an URI
 112  *
 113  * Returns: %TRUE if successful, %FALSE if not.
 114  **/
 115 gboolean modest_platform_show_uri_popup (const gchar *uri);
 116
 117 /**
 118  * modest_platform_get_icon:
 119  * @name: the name of the icon
 120  *
 121  * this function returns an icon, or NULL in case of error
 122  */
 123 GdkPixbuf* modest_platform_get_icon (const gchar *name);
 124
 125
 126 /**
 127  * modest_platform_get_app_name:
 128  *
 129  * this function returns the name of the application. Do not modify.
 130  */
 131 const gchar* modest_platform_get_app_name (void);
 132
 133
 134 /**
 135  * modest_platform_run_new_folder_dialog:
 136  * @parent_window: a #GtkWindow
 137  * @parent: the parent of the new folder
 138  * @suggested_name: the suggested name for the new folder
 139  * @folder_name: the folder name selected by the user for the new folder
 140  *
 141  * runs a "new folder" confirmation dialog. The dialog will suggest a
 142  * folder name which depends of the platform if the #suggested_name
 143  * parametter is NULL. If the user input a valid folder name it's
 144  * returned in the #folder_name attribute.
 145  *
 146  * Returns: the #GtkResponseType returned by the dialog
 147  **/
 148 gint      modest_platform_run_new_folder_dialog        (GtkWindow *parent_window,
 149                                                         TnyFolderStore *parent,
 150                                                         gchar *suggested_name,
 151                                                         gchar **folder_name);
 152
 153 /**
 154  * modest_platform_run_rename_folder_dialog:
 155  * @parent_window: a #GtkWindow
 156  * @parent: the parent of the folder
 157  * @suggested_name: current name of the folder
 158  * @folder_name: the new folder name selected by the user for the folder
 159  *
 160  * runs a "rename folder" confirmation dialog. If the user input a valid folder name it's
 161  * returned in the #folder_name attribute.
 162  *
 163  * Returns: the #GtkResponseType returned by the dialog
 164  **/
 165 gint      modest_platform_run_rename_folder_dialog        (GtkWindow *parent_window,
 166                                                            TnyFolderStore *parent,
 167                                                            const gchar *current_name,
 168                                                            gchar **folder_name);
 169
 170 /**
 171  * modest_platform_run_confirmation_dialog:
 172  * @parent_window: the parent #GtkWindow of the dialog
 173  * @message: the message to show to the user
 174  *
 175  * runs a confirmation dialog
 176  *
 177  * Returns: GTK_RESPONSE_OK or GTK_RESPONSE_CANCEL
 178  **/
 179 gint      modest_platform_run_confirmation_dialog      (GtkWindow *parent_window,
 180                                                         const gchar *message);
 181
 182 /**
 183  * modest_platform_run_yes_no_dialog:
 184  * @parent_window: the parent #GtkWindow of the dialog
 185  * @message: the message to show to the user
 186  *
 187  * runs a dialog that offers yes and no buttons.
 188  *
 189  * Returns: GTK_RESPONSE_YES or GTK_RESPONSE_NO
 190  **/
 191 gint      modest_platform_run_yes_no_dialog      (GtkWindow *parent_window,
 192                                                   const gchar *message);
 193
 194
 195 /**
 196  * modest_platform_run_information_dialog:
 197  * @parent_window: the parent #GtkWindow of the dialog
 198  * @message: the message to show
 199  *
 200  * shows an information dialog
 201  **/
 202 void      modest_platform_run_information_dialog       (GtkWindow *parent_window,
 203                                                         const gchar *message);
 204
 205 /**
 206  * modest_platform_run_sort_dialog:
 207  * @parent_window: the parent #GtkWindow of the dialog
 208  * @type: the sort dialog type.
 209  *
 210  * shows a sort dialog
 211  **/
 212 void      modest_platform_run_sort_dialog       (GtkWindow *parent_window,
 213                                                  ModestSortDialogType type);
 214
 215 /*
 216  * modest_platform_connect_and_wait:
 217  * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
 218  * @account: The account to be used.
 219  * @return value: Whether a connection was made.
 220  *
 221  * Attempts to make a connection, possibly showing interactive UI to achieve this.
 222  * This will return TRUE immediately if a connection is already open.
 223  * Otherwise, this function blocks until the connection attempt has either succeded or failed.
 224  * This also sets the account to online, if it is a store account, in case it has been set to offline mode.
 225  */
 226 gboolean modest_platform_connect_and_wait (GtkWindow *parent_window, TnyAccount *account);
 227
 228
 229 /*
 230  * modest_platform_connect_and_wait_if_network_account:
 231  * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
 232  * @account: The account that might need a connection in subsequent operations.
 233  * @return value: Whether a connection was made. Also returns TRUE if no connection is necessary.
 234  *
 235  * Like modest_platform_connect_and_wait(), but only attempts to make a connection if the
 236  * account uses the network. For instance, this just returns TRUE for local maildir accounts.
 237  */
 238 gboolean modest_platform_connect_and_wait_if_network_account (GtkWindow *parent_window, TnyAccount *account);
 239
 240 /*
 241  * modest_platform_connect_and_wait_if_network_account:
 242  * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
 243  * @folder_store: The folder store (folder or account) that might need a connection in subsequent operations.
 244  * @return value: Whether a connection was made. Also returns TRUE if no connection is necessary.
 245  *
 246  * Like modest_platform_connect_and_wait(), but only attempts to make a connection if the
 247  * folder store uses the network. For instance, this just returns TRUE for local maildir folders.
 248  */
 249 gboolean modest_platform_connect_and_wait_if_network_folderstore (GtkWindow *parent_window, TnyFolderStore *folder_store);
 250
 251 /**
 252  * modest_platform_is_network_folderstore:
 253  * @folder_store: The folder store (folder or account) that needs to
 254  * decide if need a connection in subsequent operations.
 255  * @return value: Whether a connection is necessary for this folder_store.
 256  */
 257 gboolean modest_platform_is_network_folderstore (TnyFolderStore *folder_store);
 258
 259 /**
 260  * modest_platform_set_update_interval:
 261  * @minutes: The number of minutes between updates, or 0 for no updates.
 262  *
 263  * Set the number of minutes between automatic updates of email accounts.
 264  * The platform will cause the send/receive action to happen repeatedly.
 265  **/
 266 gboolean modest_platform_set_update_interval (guint minutes);
 267
 268 /**
 269  * modest_platform_get_global_settings_dialog:
 270  * @void:
 271  *
 272  * returns the global settings dialog
 273  *
 274  * Return value: a new #ModestGlobalSettingsDialog dialog
 275  **/
 276 GtkWidget* modest_platform_get_global_settings_dialog (void);
 277
 278 void modest_platform_on_new_msg (void);
 279
 280
 281 /**
 282  * modest_platform_show_help:
 283  * @parent_window:
 284  * @help_id: the help topic id to be shown in the help dialog
 285  *
 286  * shows the application help dialog
 287  **/
 288 void modest_platform_show_help (GtkWindow *parent_window,
 289                                 const gchar *help_id);
 290
 291 /**
 292  * modest_platform_show_search_messages:
 293  * @parent_window: window the dialog will be child of
 294  *
 295  * shows the search messages dialog
 296  **/
 297 void modest_platform_show_search_messages (GtkWindow *parent_window);
 298
 299 /**
 300  * modest_platform_show_addressbook:
 301  * @parent_window: window the dialog will be child of
 302  *
 303  * shows the addressbook
 304  **/
 305 void modest_platform_show_addressbook (GtkWindow *parent_window);
 306
 307
 308 GtkWidget* modest_platform_create_folder_view (TnyFolderStoreQuery *query);
 309
 310 void modest_platform_information_banner (GtkWidget *widget,
 311                                          const gchar *icon_name,
 312                                          const gchar *text);
 313
 314 GtkWidget *
 315 modest_platform_animation_banner (GtkWidget *parent,
 316                                   const gchar *annimation_name,
 317                                   const gchar *text);
 318
 319 /* TODO: This isn't platform-dependent, so this isn't the best place for this. */
 320 /* Return TRUE immediately if the account is already online,
 321  * otherwise check every second for NUMBER_OF_TRIES seconds and return TRUE as
 322  * soon as the account is online, or FALSE if the account does
 323  * not become online in the NUMBER_OF_TRIES seconds.
 324  * This is useful when the D-Bus method was run immediately after
 325  * the application was started (when using D-Bus activation),
 326  * because the account usually takes a short time to go online.
 327  * The return value is maybe not very useful.
 328  */
 329 gboolean modest_platform_check_and_wait_for_account_is_online(TnyAccount *account);
 330
 331 G_END_DECLS
 332
 333 #endif /* __MODEST_PLATFORM_UTILS_H__ */