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 typedef enum {
  41         MODEST_MAEMO_UTILS_GET_SUPPORTED_SECURE_AUTHENTICATION_ERROR_CANCELED
  42 } ModestMaemoUtilsGetSupportedSecureAuthenticationError;
  43
  44 GQuark modest_maemo_utils_get_supported_secure_authentication_error_quark (void);
  45
  46 /**
  47  * modest_maemo_utils_menubar_to_menu:
  48  * @ui_manager: a ui manager, with the menubar at "/MenuBar"
  49  *
  50  * convert a menubar description (in a GtkUIManager) in to a menu
  51  *
  52  * Returns: a new menu, or NULL in case of error
  53  */
  54 GtkWidget*    modest_maemo_utils_menubar_to_menu (GtkUIManager *ui_manager);
  55
  56
  57 /**
  58  * modest_maemo_utils_get_device_name
  59  *
  60  * get the name for this device. Note: this queries the bluetooth
  61  * name over DBUS, and may block. The result will be available in
  62  * MODEST_CONF_DEVICE_NAME in ModestConf; it will be updated when it
  63  * changes
  64  *
  65  */
  66 void modest_maemo_utils_get_device_name (void);
  67
  68 /**
  69  * modest_maemo_utils_folder_writable:
  70  * @filename: a string
  71  *
  72  * Checks if @filename is in a writable folder
  73  *
  74  * Returns: %TRUE if @filename is writable, %FALSE otherwise
  75  */
  76 gboolean modest_maemo_utils_folder_writable (const gchar *filename);
  77
  78 /**
  79  * modest_maemo_utils_file_exists:
  80  * @filename: a string
  81  *
  82  * Checks if @filename exists
  83  *
  84  * Returns: %TRUE if @filename currently exists, %FALSE otherwise
  85  */
  86 gboolean modest_maemo_utils_file_exists (const gchar *filename);
  87
  88 /**
  89  * modest_maemo_utils_create_temp_stream:
  90  * @extension: a string with the extension the file should get, or %NULL
  91  * @path: a string with the created file path
  92  *
  93  * Creates a temporary fs stream
  94  *
  95  * Returns: a #TnyFsStream, or %NULL if operation failed.
  96  */
  97 TnyFsStream *modest_maemo_utils_create_temp_stream (const gchar *extension, gchar **path);
  98
  99 /**
 100  * modest_maemo_utils_get_supported_secure_authentication_methods:
 101  * @proto: the protocol
 102  * @hostname: hostname of the mail server to check
 103  * @port: mail server port
 104  * @username: username of the account to check for
 105  * @parent_window: a GtkWindow that can be used a parent for progress indication
 106  *
 107  * Get a list of supported authentication methods of the server
 108  *
 109  * Returns: GList* of the method names. This list needs to be freed using g_list_free.
 110  *
 111  */
 112
 113 GList* modest_maemo_utils_get_supported_secure_authentication_methods (ModestTransportStoreProtocol proto,
 114         const gchar* hostname, gint port, const gchar* username, GtkWindow *parent_window, GError** error);
 115
 116 /**
 117  * modest_maemo_utils_setup_images_filechooser:
 118  * @chooser: a #GtkFileChooser
 119  *
 120  * Configures the default folder, and mime filter of a filechooser
 121  * for images.
 122  */
 123 void modest_maemo_utils_setup_images_filechooser (GtkFileChooser *chooser);
 124
 125 /** modest_maemo_show_information_note_and_forget:
 126  * @parent_window: The window for which the note should be transient.
 127  * @message: The text to show.
 128  *
 129  * Show the information note and destroy it when it is closed, without
 130  * blocking. Use this when you don't want to use gtk_dialog_run(), which might lead
 131  * to hangs.
 132  */
 133 void modest_maemo_show_information_note_and_forget (GtkWindow *parent_window, const gchar* message);
 134
 135 /** modest_maemo_show_information_note_in_main_context_and_forget:
 136  * @parent_window: The window for which the note should be transient.
 137  * @message: The text to show.
 138  *
 139  * This calls modest_maemo_show_information_note_and_forget() in an idle handler.
 140  * This should be used when you are not sure that you are in the main context,
 141  * because you should try to use GTK+ UI code only in the main context.
 142  */
 143 void modest_maemo_show_information_note_in_main_context_and_forget (GtkWindow *parent_window, const gchar* message);
 144
 145 /** modest_maemo_show_dialog_and_forget:
 146  * @parent_window: The window for which the note should be transient.
 147  * @message: The dialog to show.
 148  *
 149  * Show the dialog and destroy it when it is closed, without
 150  * blocking. Use this when you don't want to use gtk_dialog_run(), which might lead
 151  * to hangs.
 152  */
 153 void modest_maemo_show_dialog_and_forget (GtkWindow *parent_window, GtkDialog *dialog);
 154
 155
 156 void modest_maemo_set_thumbable_scrollbar (GtkScrolledWindow *win, gboolean thumbable);
 157
 158 /**
 159  * modest_maemo_toggle_action_set_active_block_notify:
 160  * @action: a #GtkToggleAction
 161  * @value: a #gboolean
 162  *
 163  * updates the toggle action active status, but blocking the notification of the changes.
 164  */
 165 void modest_maemo_toggle_action_set_active_block_notify (GtkToggleAction *action, gboolean value);
 166
 167 #endif /*__MODEST_MAEMO_UTILS_H__*/