git.maemo.org Git - modest/blob - src/modest-platform.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 #ifndef __MODEST_PLATFORM_H__
  31 #define __MODEST_PLATFORM_H__
  32
  33 #include <tny-device.h>
  34 #include "widgets/modest-window.h"
  35
  36 G_BEGIN_DECLS
  37
  38 /**
  39  * modest_platform_platform_init:
  40  *
  41  * platform specific initialization function
  42  *
  43  * Returns: TRUE if succeeded, FALSE otherwise
  44  */
  45 gboolean modest_platform_init (void);
  46
  47
  48 /**
  49  * modest_platform_get_new_device:
  50  *
  51  * platform specific initialization function
  52  *
  53  * Returns: TRUE if succeeded, FALSE otherwise
  54  */
  55 TnyDevice*  modest_platform_get_new_device (void);
  56
  57
  58 /**
  59  * modest_platform_get_file_icon_name:
  60  * @name: the name of the file, or NULL
  61  * @mime_type: the mime-type, or NULL
  62  * @effective_mime_type: out-param which receives the 'effective mime-type', ie., the mime type
  63  * that will be used. May be NULL if you're not interested in this. Note: the returned string
  64  * is newly allocated, and should be g_free'd when done with it.
  65  *
  66  * this function gets the icon for the file, based on the file name and/or the mime type,
  67  * using the following strategy:
  68  * (1) if mime_type != NULL and mime_type != application/octet-stream, find the
  69  *     the icon name for this mime type
  70  * (2) otherwise, guess the icon type from the file name, and then goto (1)
  71  *
  72  * Returns: the icon name
  73  */
  74 gchar*  modest_platform_get_file_icon_name (const gchar* name, const gchar* mime_type,
  75                                             gchar **effective_mime_type);
  76
  77 /**
  78  * modest_platform_activate_uri:
  79  * @uri: the uri to activate
  80  *
  81  * This function activates an URI
  82  *
  83  * Returns: %TRUE if successful, %FALSE if not.
  84  **/
  85 gboolean modest_platform_activate_uri (const gchar *uri);
  86
  87 /**
  88  * modest_platform_show_uri_popup:
  89  * @uri: an URI with the string
  90  *
  91  * This function show the popup of actions for an URI
  92  *
  93  * Returns: %TRUE if successful, %FALSE if not.
  94  **/
  95 gboolean modest_platform_show_uri_popup (const gchar *uri);
  96
  97 /**
  98  * modest_platform_get_icon:
  99  * @name: the name of the icon
 100  *
 101  * this function returns an icon, or NULL in case of error
 102  */
 103 GdkPixbuf* modest_platform_get_icon (const gchar *name);
 104
 105
 106 /**
 107  * modest_platform_get_application_name:
 108  *
 109  * this function returns the name of the application. Do not modify.
 110  */
 111 const gchar* modest_platform_get_app_name (void);
 112
 113
 114 gboolean modest_platform_run_new_folder_dialog (ModestWindow *parent_window,
 115                                                 TnyFolderStore *parent);
 116
 117 G_END_DECLS
 118
 119 #endif /* __MODEST_PLATFORM_UTILS_H__ */