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