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 <modest-protocol-info.h>
  36
  37 /**
  38  * modest_maemo_utils_menubar_to_menu:
  39  * @ui_manager: a ui manager, with the menubar at "/MenuBar"
  40  *
  41  * convert a menubar description (in a GtkUIManager) in to a menu
  42  *
  43  * Returns: a new menu, or NULL in case of error
  44  */
  45 GtkWidget*    modest_maemo_utils_menubar_to_menu (GtkUIManager *ui_manager);
  46
  47
  48 /**
  49  * modest_maemo_utils_get_device_name
  50  *
  51  * get the name for this device. Note: this queries the bluetooth
  52  * name over DBUS, and may block. The result will be available in
  53  * MODEST_CONF_DEVICE_NAME in ModestConf; it will be updated when it
  54  * changes
  55  *
  56  */
  57 void modest_maemo_utils_get_device_name (void);
  58
  59 /**
  60  * modest_maemo_utils_folder_writable:
  61  * @filename: a string
  62  *
  63  * Checks if @filename is in a writable folder
  64  *
  65  * Returns: %TRUE if @filename is writable, %FALSE otherwise
  66  */
  67 gboolean modest_maemo_utils_folder_writable (const gchar *filename);
  68
  69 /**
  70  * modest_maemo_utils_file_exists:
  71  * @filename: a string
  72  *
  73  * Checks if @filename exists
  74  *
  75  * Returns: %TRUE if @filename currently exists, %FALSE otherwise
  76  */
  77 gboolean modest_maemo_utils_file_exists (const gchar *filename);
  78
  79 /**
  80  * modest_maemo_utils_create_temp_stream:
  81  * @extension: a string with the extension the file should get, or %NULL
  82  * @path: a string with the created file path
  83  *
  84  * Creates a temporary fs stream
  85  *
  86  * Returns: a #TnyFsStream, or %NULL if operation failed.
  87  */
  88 TnyFsStream *modest_maemo_utils_create_temp_stream (const gchar *extension, gchar **path);
  89
  90 /**
  91  * modest_protocol_info_protocol_is_local_store:
  92  * @proto: the protocol
  93  * @hostname: hostname of the mail server to check
  94  * @port: mail server port
  95  * @parent_window: a GtkWindow that can be used a parent for progress indication
  96  *
  97  * Get a list of supported authentication methods of the server
  98  *
  99  * Returns: GList* of the method names. This list needs to be freed using g_list_free.
 100  *
 101  */
 102
 103 GList* modest_maemo_utils_get_supported_secure_authentication_methods (ModestTransportStoreProtocol proto,
 104         const gchar* hostname, gint port, GtkWindow *parent_window);
 105
 106 #endif /*__MODEST_MAEMO_UTILS_H__*/