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__
33 #include <tny-device.h>
34 #include "widgets/modest-window.h"
38 typedef enum _ModestConfirmationDialogType {
39 MODEST_CONFIRMATION_DELETE_FOLDER,
40 } ModestConfirmationDialogType;
42 typedef enum _ModestInformationDialogType {
43 MODEST_INFORMATION_CREATE_FOLDER,
44 MODEST_INFORMATION_DELETE_FOLDER,
45 } ModestInformationDialogType;
47 typedef enum _ModestSortDialogType {
49 } ModestSortDialogType;
52 * modest_platform_platform_init:
54 * platform specific initialization function
56 * Returns: TRUE if succeeded, FALSE otherwise
58 gboolean modest_platform_init (void);
62 * modest_platform_get_new_device:
64 * platform specific initialization function
66 * Returns: TRUE if succeeded, FALSE otherwise
68 TnyDevice* modest_platform_get_new_device (void);
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.
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)
85 * Returns: the icon name
87 gchar* modest_platform_get_file_icon_name (const gchar* name, const gchar* mime_type,
88 gchar **effective_mime_type);
91 * modest_platform_activate_uri:
92 * @uri: the uri to activate
94 * This function activates an URI
96 * Returns: %TRUE if successful, %FALSE if not.
98 gboolean modest_platform_activate_uri (const gchar *uri);
101 * modest_platform_activate_file:
102 * @path: the path to activate
104 * This function activates a file
106 * Returns: %TRUE if successful, %FALSE if not.
108 gboolean modest_platform_activate_file (const gchar *path);
111 * modest_platform_show_uri_popup:
112 * @uri: an URI with the string
114 * This function show the popup of actions for an URI
116 * Returns: %TRUE if successful, %FALSE if not.
118 gboolean modest_platform_show_uri_popup (const gchar *uri);
121 * modest_platform_get_icon:
122 * @name: the name of the icon
124 * this function returns an icon, or NULL in case of error
126 GdkPixbuf* modest_platform_get_icon (const gchar *name);
130 * modest_platform_get_application_name:
132 * this function returns the name of the application. Do not modify.
134 const gchar* modest_platform_get_app_name (void);
138 * modest_platform_run_new_folder_dialog:
139 * @parent_window: a #GtkWindow
140 * @parent: the parent of the new folder
141 * @suggested_name: the suggested name for the new folder
142 * @folder_name: the folder name selected by the user for the new folder
144 * runs a "new folder" confirmation dialog. The dialog will suggest a
145 * folder name which depends of the platform if the #suggested_name
146 * parametter is NULL. If the user input a valid folder name it's
147 * returned in the #folder_name attribute.
149 * Returns: the #GtkResponseType returned by the dialog
151 gint modest_platform_run_new_folder_dialog (GtkWindow *parent_window,
152 TnyFolderStore *parent,
153 gchar *suggested_name,
154 gchar **folder_name);
157 * modest_platform_run_confirmation_dialog:
158 * @parent_window: the parent #GtkWindow of the dialog
159 * @message: the message to show to the user
161 * runs a confirmation dialog
163 * Returns: GTK_RESPONSE_OK or GTK_RESPONSE_CANCEL
165 gint modest_platform_run_confirmation_dialog (GtkWindow *parent_window,
166 const gchar *message);
170 * modest_platform_run_information_dialog:
171 * @parent_window: the parent #GtkWindow of the dialog
172 * @type: the type of information dialog
174 * shows an information dialog
176 void modest_platform_run_information_dialog (GtkWindow *parent_window,
177 ModestInformationDialogType type);
179 * modest_platform_run_sort_dialog:
180 * @parent_window: the parent #GtkWindow of the dialog
181 * @type: the sort dialog type.
183 * shows a sort dialog
185 void modest_platform_run_sort_dialog (GtkWindow *parent_window,
186 ModestSortDialogType type);
189 * modest_platform_connect_and_wait:
190 * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
191 * @return value: Whether a connection was made.
193 * Attempts to make a connection, possibly showing interactive UI to achieve this.
194 * This will return TRUE immediately if a connection is already open.
195 * Otherwise, this function blocks until the connection attempt has either succeded or failed.
197 gboolean modest_platform_connect_and_wait (GtkWindow *parent_window);
200 * modest_platform_set_update_interval:
201 * @minutes: The number of minutes between updates, or 0 for no updates.
203 * Set the number of minutes between automatic updates of email accounts.
204 * The platform will cause the send/receive action to happen repeatedly.
206 gboolean modest_platform_set_update_interval (guint minutes);
208 GtkWidget* modest_platform_get_global_settings_dialog ();
212 #endif /* __MODEST_PLATFORM_UTILS_H__ */