git.maemo.org Git - modest/blob - src/hildon2/modest-maemo-utils.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
  31 #ifndef __MODEST_MAEMO_UTILS_H__
  32 #define __MODEST_MAEMO_UTILS_H__
  33
  34 #include <gtk/gtk.h>
  35 #include <stdio.h> /* for FILE* */
  36 #include <tny-fs-stream.h>
  37 #include <libosso.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>
  42
  43 #define MODEST_MAEMO_UTILS_MYDOCS_ENV "MYDOCSDIR"
  44 #define MODEST_MAEMO_UTILS_DEFAULT_IMAGE_FOLDER ".images"
  45
  46
  47 /**
  48  * modest_maemo_utils_get_device_name
  49  *
  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
  53  * changes
  54  *
  55  */
  56 void modest_maemo_utils_get_device_name (void);
  57
  58
  59 /**
  60  * modest_maemo_utils_setup_images_filechooser:
  61  * @chooser: a #GtkFileChooser
  62  *
  63  * Configures the default folder, and mime filter of a filechooser
  64  * for images.
  65  */
  66 void modest_maemo_utils_setup_images_filechooser (GtkFileChooser *chooser);
  67
  68
  69 /**
  70  * modest_maemo_utils_get_osso_context:
  71  *
  72  * get the osso_context pointer for this application
  73  *
  74  * Return: the osso context pointer
  75  */
  76 osso_context_t *modest_maemo_utils_get_osso_context (void);
  77
  78 /**
  79  * modest_maemo_set_thumbable_scrollbar:
  80  * @win: a scrollable window
  81  * @thumbable: set it to thumbable (TRUE) or small (FALSE)
  82  *
  83  * changes the thumbability of scrollbars in a scrollable window
  84  */
  85 void modest_maemo_set_thumbable_scrollbar (GtkScrolledWindow *win, gboolean thumbable);
  86
  87
  88 /**
  89  * modest_maemo_get_osso_context:
  90  *
  91  * retrieve the osso context for this application
  92  *
  93  * Returns: the current osso_context_t ptr
  94  */
  95 osso_context_t* modest_maemo_utils_get_osso_context (void);
  96
  97 /**
  98  * modest_maemo_set_osso_context:
  99  *
 100  * remember the osso-context for this application
 101  *
 102  * @osso_context: a valid osso_context_t pointer
 103  *
 104  */
 105 void modest_maemo_utils_set_osso_context (osso_context_t *osso_context);
 106
 107 /**
 108  * modest_maemo_utils_get_manager_menubar_as_menu:
 109  * @manager: a #GtkUIManager
 110  * @item_name: a string
 111  *
 112  * obtains the node with name @item_name in @manager (which happens to be a menubar) as a
 113  * #GtkMenu.
 114  *
 115  * Returns: a #GtkMenu
 116  */
 117 GtkWidget *modest_maemo_utils_get_manager_menubar_as_menu (GtkUIManager *manager, const gchar *item_name);
 118
 119 GtkWidget *modest_maemo_utils_create_captioned    (GtkSizeGroup *title_size_group,
 120                                                    GtkSizeGroup *value_size_group,
 121                                                    const gchar *title,
 122                                                    gboolean use_markup,
 123                                                    GtkWidget *control);
 124
 125 GtkWidget *modest_maemo_utils_create_captioned_with_size_type    (GtkSizeGroup *title_size_group,
 126                                                                   GtkSizeGroup *value_size_group,
 127                                                                   const gchar *title,
 128                                                                   gboolean use_markup,
 129                                                                   GtkWidget *control,
 130                                                                   HildonSizeType size_type);
 131
 132 void       modest_maemo_utils_captioned_set_label (GtkWidget *captioned,
 133                                                    const gchar *new_label,
 134                                                    gboolean use_markup);
 135
 136 GtkWidget *modest_maemo_utils_captioned_get_label_widget (GtkWidget *captioned);
 137
 138 void       modest_maemo_utils_set_hbutton_layout (GtkSizeGroup *title_sizegroup,
 139                                                   GtkSizeGroup *value_sizegroup,
 140                                                   const gchar *title,
 141                                                   GtkWidget *button);
 142 void       modest_maemo_utils_set_vbutton_layout (GtkSizeGroup *sizegroup,
 143                                                   const gchar *title,
 144                                                   GtkWidget *button);
 145
 146 GtkWidget *modest_maemo_utils_create_group_box (const gchar *label, GtkWidget *contents);
 147
 148 gboolean   modest_maemo_utils_select_attachments (GtkWindow *window, TnyList *att_list, gboolean include_msgs);
 149
 150 #ifdef MODEST_PLATFORM_MAEMO
 151 /**
 152  * modest_maemo_utils_in_usb_mode:
 153  *
 154  * Check if the device is working in mass storage mode
 155  *
 156  * Returns: returns TRUE if the internal memory of the device is
 157  * working in mass storage mode
 158  **/
 159 gboolean modest_maemo_utils_in_usb_mode ();
 160 #endif
 161
 162 /**
 163  * modest_maemo_utils_scroll_pannable:
 164  * @pannable: a #HildonPannableArea
 165  * @horizontal: the amount to scroll in horizontal direction
 166  * @vertical: the amount to scroll in vertical direction
 167  *
 168  * Performs some scrolling over a pannable area. The amount of
 169  * scrolling is expressed in step_increments of the pannable area
 170  * GtkAdjustments
 171  **/
 172 void
 173 modest_maemo_utils_scroll_pannable(HildonPannableArea *pannable,
 174                                    gint horizontal,
 175                                    gint vertical);
 176
 177 /**
 178  * modest_heartbeat_add:
 179  * @function: function to call
 180  * @userdata: data to pass to @function.
 181  *
 182  * Adds a function to be called when heartbeat is called. If the
 183  * function returns FALSE it is automatically removed from the
 184  * list of event sources and will not be called again.
 185  *
 186  * Returns: the ID (greater than 0) of the event source
 187  */
 188 guint
 189 modest_heartbeat_add (GSourceFunc function,
 190                       gpointer userdata);
 191
 192 #endif /*__MODEST_MAEMO_UTILS_H__*/