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
  36 /**
  37  * modest_maemo_utils_menubar_to_menu:
  38  * @ui_manager: a ui manager, with the menubar at "/MenuBar"
  39  *
  40  * convert a menubar description (in a GtkUIManager) in to a menu
  41  *
  42  * Returns: a new menu, or NULL in case of error
  43  */
  44 GtkWidget*    modest_maemo_utils_menubar_to_menu (GtkUIManager *ui_manager);
  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  * modest_maemo_utils_folder_writable:
  60  * @filename: a string
  61  *
  62  * Checks if @filename is in a writable folder
  63  *
  64  * Returns: %TRUE if @filename is writable, %FALSE otherwise
  65  */
  66 gboolean modest_maemo_utils_folder_writable (const gchar *filename);
  67
  68 /**
  69  * modest_maemo_utils_file_exists:
  70  * @filename: a string
  71  *
  72  * Checks if @filename exists
  73  *
  74  * Returns: %TRUE if @filename currently exists, %FALSE otherwise
  75  */
  76 gboolean modest_maemo_utils_file_exists (const gchar *filename);
  77
  78 /**
  79  * modest_maemo_utils_create_temp_stream:
  80  * @path: a string with the created file path
  81  *
  82  * Creates a temporary fs stream
  83  *
  84  * Returns: a #TnyFsStream, or %NULL if operation failed.
  85  */
  86 TnyFsStream *modest_maemo_utils_create_temp_stream (gchar **path);
  87
  88 #endif /*__MODEST_MAEMO_UTILS_H__*/