1 /* Copyright (c) 2006, Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
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.
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.
30 #ifndef __MODEST_PLATFORM_H__
31 #define __MODEST_PLATFORM_H__
35 #include <tny-device.h>
38 * modest_platform_platform_init:
40 * platform specific initialization function
42 * Returns: TRUE if succeeded, FALSE otherwise
44 gboolean modest_platform_init (void);
48 * modest_platform_get_new_device:
50 * platform specific initialization function
52 * Returns: TRUE if succeeded, FALSE otherwise
54 TnyDevice* modest_platform_get_new_device (void);
58 * modest_platform_get_file_icon_name:
59 * @name: the name of the file, or NULL
60 * @mime_type: the mime-type, or NULL
61 * @effective_mime_type: out-param which receives the 'effective mime-type', ie., the mime type
62 * that will be used. May be NULL if you're not interested in this. Note: the returned string
63 * is newly allocated, and should be g_free'd when done with it.
65 * this function gets the icon for the file, based on the file name and/or the mime type,
66 * using the following strategy:
67 * (1) if mime_type != NULL and mime_type != application/octet-stream, find the
68 * the icon name for this mime type
69 * (2) otherwise, guess the icon type from the file name, and then goto (1)
71 * Returns: the icon name
73 gchar* modest_platform_get_file_icon_name (const gchar* name, const gchar* mime_type,
74 gchar **effective_mime_type);
77 * modest_platform_activate_uri:
78 * @uri: the uri to activate
80 * This function activates an URI
82 * Returns: %TRUE if successful, %FALSE if not.
84 gboolean modest_platform_activate_uri (const gchar *uri);
87 * modest_platform_show_uri_popup:
88 * @uri: an URI with the string
90 * This function show the popup of actions for an URI
92 * Returns: %TRUE if successful, %FALSE if not.
94 gboolean modest_platform_show_uri_popup (const gchar *uri);
97 * modest_platform_get_icon:
98 * @name: the name of the icon
100 * this function returns an icon, or NULL in case of error
102 GdkPixbuf* modest_platform_get_icon (const gchar *name);
104 #endif /* __MODEST_PLATFORM_UTILS_H__ */