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