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 /**
  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 (void);
  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_show_uri_popup:
  98  * @uri: an URI with the string
  99  *
 100  * This function show the popup of actions for an URI
 101  *
 102  * Returns: %TRUE if successful, %FALSE if not.
 103  **/
 104 gboolean modest_platform_show_uri_popup (const gchar *uri);
 105
 106 /**
 107  * modest_platform_get_icon:
 108  * @name: the name of the icon
 109  *
 110  * this function returns an icon, or NULL in case of error
 111  */
 112 GdkPixbuf* modest_platform_get_icon (const gchar *name);
 113
 114
 115 /**
 116  * modest_platform_get_application_name:
 117  *
 118  * this function returns the name of the application. Do not modify.
 119  */
 120 const gchar* modest_platform_get_app_name (void);
 121
 122
 123 /**
 124  * modest_platform_run_new_folder_dialog:
 125  * @parent_window: a #GtkWindow
 126  * @parent: the parent of the new folder
 127  * @suggested_name: the suggested name for the new folder
 128  * @folder_name: the folder name selected by the user for the new folder
 129  *
 130  * runs a "new folder" confirmation dialog. The dialog will suggest a
 131  * folder name which depends of the platform if the #suggested_name
 132  * parametter is NULL. If the user input a valid folder name it's
 133  * returned in the #folder_name attribute.
 134  *
 135  * Returns: the #GtkResponseType returned by the dialog
 136  **/
 137 gint      modest_platform_run_new_folder_dialog        (GtkWindow *parent_window,
 138                                                         TnyFolderStore *parent,
 139                                                         gchar *suggested_name,
 140                                                         gchar **folder_name);
 141
 142 gint      modest_platform_run_confirmation_dialog      (GtkWindow *parent_window,
 143                                                         ModestConfirmationDialogType type,
 144                                                         gpointer user_data);
 145
 146 void      modest_platform_run_information_dialog       (GtkWindow *parent_window,
 147                                                         ModestInformationDialogType type);
 148
 149 G_END_DECLS
 150
 151 #endif /* __MODEST_PLATFORM_UTILS_H__ */