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