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 <glib.h>
  34 #include <gtk/gtk.h>
  35 #include <tny-device.h>
  36
  37 G_BEGIN_DECLS
  38
  39 /**
  40  * modest_platform_platform_init:
  41  *
  42  * platform specific initialization function
  43  *
  44  * Returns: TRUE if succeeded, FALSE otherwise
  45  */
  46 gboolean modest_platform_init (void);
  47
  48
  49 /**
  50  * modest_platform_get_new_device:
  51  *
  52  * platform specific initialization function
  53  *
  54  * Returns: TRUE if succeeded, FALSE otherwise
  55  */
  56 TnyDevice*  modest_platform_get_new_device (void);
  57
  58
  59 /**
  60  * modest_platform_get_file_icon_name:
  61  * @name: the name of the file, or NULL
  62  * @mime_type: the mime-type, or NULL
  63  * @effective_mime_type: out-param which receives the 'effective mime-type', ie., the mime type
  64  * that will be used. May be NULL if you're not interested in this. Note: the returned string
  65  * is newly allocated, and should be g_free'd when done with it.
  66  *
  67  * this function gets the icon for the file, based on the file name and/or the mime type,
  68  * using the following strategy:
  69  * (1) if mime_type != NULL and mime_type != application/octet-stream, find the
  70  *     the icon name for this mime type
  71  * (2) otherwise, guess the icon type from the file name, and then goto (1)
  72  *
  73  * Returns: the icon name
  74  */
  75 gchar*  modest_platform_get_file_icon_name (const gchar* name, const gchar* mime_type,
  76                                             gchar **effective_mime_type);
  77
  78 /**
  79  * modest_platform_activate_uri:
  80  * @uri: the uri to activate
  81  *
  82  * This function activates an URI
  83  *
  84  * Returns: %TRUE if successful, %FALSE if not.
  85  **/
  86 gboolean modest_platform_activate_uri (const gchar *uri);
  87
  88 /**
  89  * modest_platform_show_uri_popup:
  90  * @uri: an URI with the string
  91  *
  92  * This function show the popup of actions for an URI
  93  *
  94  * Returns: %TRUE if successful, %FALSE if not.
  95  **/
  96 gboolean modest_platform_show_uri_popup (const gchar *uri);
  97
  98 /**
  99  * modest_platform_get_icon:
 100  * @name: the name of the icon
 101  *
 102  * this function returns an icon, or NULL in case of error
 103  */
 104 GdkPixbuf* modest_platform_get_icon (const gchar *name);
 105
 106
 107 /**
 108  * modest_platform_get_application_name:
 109  *
 110  * this function returns the name of the application. Do not modify.
 111  */
 112 const gchar* modest_platform_get_app_name (void);
 113
 114 G_END_DECLS
 115
 116 #endif /* __MODEST_PLATFORM_UTILS_H__ */