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