git.maemo.org Git - modest/blob - src/maemo/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 <modest-protocol-info.h>
  37 #include <tny-fs-stream.h>
  38 #include <libosso.h>
  39
  40
  41 #define MODEST_MAEMO_UTILS_MYDOCS_FOLDER "MyDocs"
  42 #define MODEST_MAEMO_UTILS_DEFAULT_IMAGE_FOLDER ".images"
  43
  44
  45 /**
  46  * modest_maemo_utils_get_device_name
  47  *
  48  * get the name for this device. Note: this queries the bluetooth
  49  * name over DBUS, and may block. The result will be available in
  50  * MODEST_CONF_DEVICE_NAME in ModestConf; it will be updated when it
  51  * changes
  52  *
  53  */
  54 void modest_maemo_utils_get_device_name (void);
  55
  56
  57 /**
  58  * modest_maemo_utils_setup_images_filechooser:
  59  * @chooser: a #GtkFileChooser
  60  *
  61  * Configures the default folder, and mime filter of a filechooser
  62  * for images.
  63  */
  64 void modest_maemo_utils_setup_images_filechooser (GtkFileChooser *chooser);
  65
  66
  67 /**
  68  * modest_maemo_utils_get_osso_context:
  69  *
  70  * get the osso_context pointer for this application
  71  *
  72  * Return: the osso context pointer
  73  */
  74 osso_context_t *modest_maemo_utils_get_osso_context (void);
  75
  76 /**
  77  * modest_maemo_open_mcc_mapping_file:
  78  *
  79  * open the mcc mapping file, or NULL if it fails
  80  *
  81  * Returns: file ptr or NULL in case of error
  82  */
  83 FILE* modest_maemo_open_mcc_mapping_file (void);
  84
  85 /**
  86  * modest_maemo_set_thumbable_scrollbar:
  87  * @win: a scrollable window
  88  * @thumbable: set it to thumbable (TRUE) or small (FALSE)
  89  *
  90  * changes the thumbability of scrollbars in a scrollable window
  91  */
  92 void modest_maemo_set_thumbable_scrollbar (GtkScrolledWindow *win, gboolean thumbable);
  93
  94
  95 /**
  96  * modest_maemo_get_osso_context:
  97  *
  98  * retrieve the osso context for this application
  99  *
 100  * Returns: the current osso_context_t ptr
 101  */
 102 osso_context_t* modest_maemo_utils_get_osso_context (void);
 103
 104 /**
 105  * modest_maemo_set_osso_context:
 106  *
 107  * remember the osso-context for this application
 108  *
 109  * @osso_context: a valid osso_context_t pointer
 110  *
 111  */
 112 void modest_maemo_utils_set_osso_context (osso_context_t *osso_context);
 113
 114 #endif /*__MODEST_MAEMO_UTILS_H__*/