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.
31 #ifndef __MODEST_MAEMO_UTILS_H__
32 #define __MODEST_MAEMO_UTILS_H__
35 #include <stdio.h> /* for FILE* */
36 #include <tny-fs-stream.h>
38 #include "widgets/modest-global-settings-dialog.h"
39 #include "widgets/modest-validating-entry.h"
40 #include <hildon/hildon-gtk.h>
41 #include <hildon/hildon-pannable-area.h>
43 #define MODEST_MAEMO_UTILS_MYDOCS_ENV "MYDOCSDIR"
44 #define MODEST_MAEMO_UTILS_DEFAULT_IMAGE_FOLDER ".images"
48 * modest_maemo_utils_get_device_name
50 * get the name for this device. Note: this queries the bluetooth
51 * name over DBUS, and may block. The result will be available in
52 * MODEST_CONF_DEVICE_NAME in ModestConf; it will be updated when it
56 void modest_maemo_utils_get_device_name (void);
60 * modest_maemo_utils_setup_images_filechooser:
61 * @chooser: a #GtkFileChooser
63 * Configures the default folder, and mime filter of a filechooser
66 void modest_maemo_utils_setup_images_filechooser (GtkFileChooser *chooser);
70 * modest_maemo_utils_get_osso_context:
72 * get the osso_context pointer for this application
74 * Return: the osso context pointer
76 osso_context_t *modest_maemo_utils_get_osso_context (void);
79 * modest_maemo_get_osso_context:
81 * retrieve the osso context for this application
83 * Returns: the current osso_context_t ptr
85 osso_context_t* modest_maemo_utils_get_osso_context (void);
88 * modest_maemo_set_osso_context:
90 * remember the osso-context for this application
92 * @osso_context: a valid osso_context_t pointer
95 void modest_maemo_utils_set_osso_context (osso_context_t *osso_context);
98 * modest_maemo_utils_get_manager_menubar_as_menu:
99 * @manager: a #GtkUIManager
100 * @item_name: a string
102 * obtains the node with name @item_name in @manager (which happens to be a menubar) as a
105 * Returns: a #GtkMenu
107 GtkWidget *modest_maemo_utils_get_manager_menubar_as_menu (GtkUIManager *manager, const gchar *item_name);
109 GtkWidget *modest_maemo_utils_create_captioned (GtkSizeGroup *title_size_group,
110 GtkSizeGroup *value_size_group,
115 GtkWidget *modest_maemo_utils_create_captioned_with_size_type (GtkSizeGroup *title_size_group,
116 GtkSizeGroup *value_size_group,
120 HildonSizeType size_type);
122 void modest_maemo_utils_captioned_set_label (GtkWidget *captioned,
123 const gchar *new_label,
124 gboolean use_markup);
126 GtkWidget *modest_maemo_utils_captioned_get_label_widget (GtkWidget *captioned);
128 void modest_maemo_utils_set_hbutton_layout (GtkSizeGroup *title_sizegroup,
129 GtkSizeGroup *value_sizegroup,
132 void modest_maemo_utils_set_vbutton_layout (GtkSizeGroup *sizegroup,
136 GtkWidget *modest_maemo_utils_create_group_box (const gchar *label, GtkWidget *contents);
138 gboolean modest_maemo_utils_select_attachments (GtkWindow *window, TnyList *att_list, gboolean include_msgs);
140 #ifdef MODEST_PLATFORM_MAEMO
142 * modest_maemo_utils_in_usb_mode:
144 * Check if the device is working in mass storage mode
146 * Returns: returns TRUE if the internal memory of the device is
147 * working in mass storage mode
149 gboolean modest_maemo_utils_in_usb_mode ();
153 * modest_maemo_utils_scroll_pannable:
154 * @pannable: a #HildonPannableArea
155 * @horizontal: the amount to scroll in horizontal direction
156 * @vertical: the amount to scroll in vertical direction
158 * Performs some scrolling over a pannable area. The amount of
159 * scrolling is expressed in step_increments of the pannable area
163 modest_maemo_utils_scroll_pannable(HildonPannableArea *pannable,
168 * modest_heartbeat_add:
169 * @function: function to call
170 * @userdata: data to pass to @function.
172 * Adds a function to be called when heartbeat is called. If the
173 * function returns FALSE it is automatically removed from the
174 * list of event sources and will not be called again.
176 * Returns: the ID (greater than 0) of the event source
179 modest_heartbeat_add (GSourceFunc function,
182 #endif /*__MODEST_MAEMO_UTILS_H__*/