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 /**
  43  * modest_platform_platform_init:
  44  *
  45  * platform specific initialization function
  46  *
  47  * Returns: TRUE if succeeded, FALSE otherwise
  48  */
  49 gboolean modest_platform_init (void);
  50
  51
  52 /**
  53  * modest_platform_get_new_device:
  54  *
  55  * platform specific initialization function
  56  *
  57  * Returns: TRUE if succeeded, FALSE otherwise
  58  */
  59 TnyDevice*  modest_platform_get_new_device (void);
  60
  61
  62 /**
  63  * modest_platform_get_file_icon_name:
  64  * @name: the name of the file, or NULL
  65  * @mime_type: the mime-type, or NULL
  66  * @effective_mime_type: out-param which receives the 'effective mime-type', ie., the mime type
  67  * that will be used. May be NULL if you're not interested in this. Note: the returned string
  68  * is newly allocated, and should be g_free'd when done with it.
  69  *
  70  * this function gets the icon for the file, based on the file name and/or the mime type,
  71  * using the following strategy:
  72  * (1) if mime_type != NULL and mime_type != application/octet-stream, find the
  73  *     the icon name for this mime type
  74  * (2) otherwise, guess the icon type from the file name, and then goto (1)
  75  *
  76  * Returns: the icon name
  77  */
  78 gchar*  modest_platform_get_file_icon_name (const gchar* name, const gchar* mime_type,
  79                                             gchar **effective_mime_type);
  80
  81 /**
  82  * modest_platform_activate_uri:
  83  * @uri: the uri to activate
  84  *
  85  * This function activates an URI
  86  *
  87  * Returns: %TRUE if successful, %FALSE if not.
  88  **/
  89 gboolean modest_platform_activate_uri (const gchar *uri);
  90
  91 /**
  92  * modest_platform_show_uri_popup:
  93  * @uri: an URI with the string
  94  *
  95  * This function show the popup of actions for an URI
  96  *
  97  * Returns: %TRUE if successful, %FALSE if not.
  98  **/
  99 gboolean modest_platform_show_uri_popup (const gchar *uri);
 100
 101 /**
 102  * modest_platform_get_icon:
 103  * @name: the name of the icon
 104  *
 105  * this function returns an icon, or NULL in case of error
 106  */
 107 GdkPixbuf* modest_platform_get_icon (const gchar *name);
 108
 109
 110 /**
 111  * modest_platform_get_application_name:
 112  *
 113  * this function returns the name of the application. Do not modify.
 114  */
 115 const gchar* modest_platform_get_app_name (void);
 116
 117
 118 /**
 119  * modest_platform_run_new_folder_dialog:
 120  * @parent_window: a #GtkWindow
 121  * @parent: the parent of the new folder
 122  * @suggested_name: the suggested name for the new folder
 123  * @folder_name: the folder name selected by the user for the new folder
 124  *
 125  * runs a "new folder" confirmation dialog. The dialog will suggest a
 126  * folder name which depends of the platform if the #suggested_name
 127  * parametter is NULL. If the user input a valid folder name it's
 128  * returned in the #folder_name attribute.
 129  *
 130  * Returns: the #GtkResponseType returned by the dialog
 131  **/
 132 gint      modest_platform_run_new_folder_dialog        (GtkWindow *parent_window,
 133                                                         TnyFolderStore *parent,
 134                                                         gchar *suggested_name,
 135                                                         gchar **folder_name);
 136
 137 gint      modest_platform_run_confirmation_dialog      (GtkWindow *parent_window,
 138                                                         ModestConfirmationDialogType type,
 139                                                         gpointer user_data);
 140
 141 G_END_DECLS
 142
 143 #endif /* __MODEST_PLATFORM_UTILS_H__ */