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
  36 G_BEGIN_DECLS
  37
  38 typedef enum _ModestConfirmationDialogType {
  39         MODEST_CONFIRMATION_DELETE_FOLDER,
  40 } ModestConfirmationDialogType;
  41
  42 typedef enum _ModestSortDialogType {
  43         MODEST_SORT_HEADERS,
  44 } ModestSortDialogType;
  45
  46 /**
  47  * modest_platform_platform_init:
  48  *
  49  * platform specific initialization function
  50  *
  51  * Returns: TRUE if succeeded, FALSE otherwise
  52  */
  53 gboolean modest_platform_init (void);
  54
  55
  56 /**
  57  * modest_platform_get_new_device:
  58  *
  59  * platform specific initialization function
  60  *
  61  * Returns: TRUE if succeeded, FALSE otherwise
  62  */
  63 TnyDevice*  modest_platform_get_new_device (void);
  64
  65
  66 /**
  67  * modest_platform_get_file_icon_name:
  68  * @name: the name of the file, or NULL
  69  * @mime_type: the mime-type, or NULL
  70  * @effective_mime_type: out-param which receives the 'effective mime-type', ie., the mime type
  71  * that will be used. May be NULL if you're not interested in this. Note: the returned string
  72  * is newly allocated, and should be g_free'd when done with it.
  73  *
  74  * this function gets the icon for the file, based on the file name and/or the mime type,
  75  * using the following strategy:
  76  * (1) if mime_type != NULL and mime_type != application/octet-stream, find the
  77  *     the icon name for this mime type
  78  * (2) otherwise, guess the icon type from the file name, and then goto (1)
  79  *
  80  * Returns: the icon name
  81  */
  82 gchar*  modest_platform_get_file_icon_name (const gchar* name, const gchar* mime_type,
  83                                             gchar **effective_mime_type);
  84
  85 /**
  86  * modest_platform_activate_uri:
  87  * @uri: the uri to activate
  88  *
  89  * This function activates an URI
  90  *
  91  * Returns: %TRUE if successful, %FALSE if not.
  92  **/
  93 gboolean modest_platform_activate_uri (const gchar *uri);
  94
  95 /**
  96  * modest_platform_activate_file:
  97  * @path: the path to activate
  98  * @mime_type: the mime type of the path, or %NULL to guess
  99  *
 100  * This function activates a file
 101  *
 102  * Returns: %TRUE if successful, %FALSE if not.
 103  **/
 104 gboolean modest_platform_activate_file (const gchar *path, const gchar *mime_type);
 105
 106 /**
 107  * modest_platform_show_uri_popup:
 108  * @uri: an URI with the string
 109  *
 110  * This function show the popup of actions for an URI
 111  *
 112  * Returns: %TRUE if successful, %FALSE if not.
 113  **/
 114 gboolean modest_platform_show_uri_popup (const gchar *uri);
 115
 116 /**
 117  * modest_platform_get_icon:
 118  * @name: the name of the icon
 119  *
 120  * this function returns an icon, or NULL in case of error
 121  */
 122 GdkPixbuf* modest_platform_get_icon (const gchar *name);
 123
 124
 125 /**
 126  * modest_platform_get_app_name:
 127  *
 128  * this function returns the name of the application. Do not modify.
 129  */
 130 const gchar* modest_platform_get_app_name (void);
 131
 132
 133 /**
 134  * modest_platform_run_new_folder_dialog:
 135  * @parent_window: a #GtkWindow
 136  * @parent: the parent of the new folder
 137  * @suggested_name: the suggested name for the new folder
 138  * @folder_name: the folder name selected by the user for the new folder
 139  *
 140  * runs a "new folder" confirmation dialog. The dialog will suggest a
 141  * folder name which depends of the platform if the #suggested_name
 142  * parametter is NULL. If the user input a valid folder name it's
 143  * returned in the #folder_name attribute.
 144  *
 145  * Returns: the #GtkResponseType returned by the dialog
 146  **/
 147 gint      modest_platform_run_new_folder_dialog        (GtkWindow *parent_window,
 148                                                         TnyFolderStore *parent,
 149                                                         gchar *suggested_name,
 150                                                         gchar **folder_name);
 151
 152 /**
 153  * modest_platform_run_confirmation_dialog:
 154  * @parent_window: the parent #GtkWindow of the dialog
 155  * @message: the message to show to the user
 156  *
 157  * runs a confirmation dialog
 158  *
 159  * Returns: GTK_RESPONSE_OK or GTK_RESPONSE_CANCEL
 160  **/
 161 gint      modest_platform_run_confirmation_dialog      (GtkWindow *parent_window,
 162                                                         const gchar *message);
 163
 164
 165 /**
 166  * modest_platform_run_information_dialog:
 167  * @parent_window: the parent #GtkWindow of the dialog
 168  * @message: the message to show
 169  *
 170  * shows an information dialog
 171  **/
 172 void      modest_platform_run_information_dialog       (GtkWindow *parent_window,
 173                                                         const gchar *message);
 174
 175 /**
 176  * modest_platform_run_sort_dialog:
 177  * @parent_window: the parent #GtkWindow of the dialog
 178  * @type: the sort dialog type.
 179  *
 180  * shows a sort dialog
 181  **/
 182 void      modest_platform_run_sort_dialog       (GtkWindow *parent_window,
 183                                                  ModestSortDialogType type);
 184
 185 /*
 186  * modest_platform_connect_and_wait:
 187  * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
 188  * @return value: Whether a connection was made.
 189  *
 190  * Attempts to make a connection, possibly showing interactive UI to achieve this.
 191  * This will return TRUE immediately if a connection is already open.
 192  * Otherwise, this function blocks until the connection attempt has either succeded or failed.
 193  */
 194 gboolean modest_platform_connect_and_wait (GtkWindow *parent_window);
 195
 196 /**
 197  * modest_platform_set_update_interval:
 198  * @minutes: The number of minutes between updates, or 0 for no updates.
 199  *
 200  * Set the number of minutes between automatic updates of email accounts.
 201  * The platform will cause the send/receive action to happen repeatedly.
 202  **/
 203 gboolean modest_platform_set_update_interval (guint minutes);
 204
 205 /**
 206  * modest_platform_get_global_settings_dialog:
 207  * @void:
 208  *
 209  * returns the global settings dialog
 210  *
 211  * Return value: a new #ModestGlobalSettingsDialog dialog
 212  **/
 213 GtkWidget* modest_platform_get_global_settings_dialog (void);
 214
 215 void modest_platform_on_new_msg (void);
 216
 217
 218 /**
 219  * modest_platform_show_help:
 220  * @parent_window:
 221  * @help_id: the help topic id to be shown in the help dialog
 222  *
 223  * shows the application help dialog
 224  **/
 225 void modest_platform_show_help (GtkWindow *parent_window,
 226                                 const gchar *help_id);
 227
 228 /**
 229  * modest_platform_show_search_messages:
 230  * @parent_window: window the dialog will be child of
 231  *
 232  * shows the search messages dialog
 233  **/
 234 void modest_platform_show_search_messages (GtkWindow *parent_window);
 235
 236 /**
 237  * modest_platform_show_addressbook:
 238  * @parent_window: window the dialog will be child of
 239  *
 240  * shows the addressbook
 241  **/
 242 void modest_platform_show_addressbook (GtkWindow *parent_window);
 243
 244 G_END_DECLS
 245
 246 #endif /* __MODEST_PLATFORM_UTILS_H__ */