git.maemo.org Git - modest/blob - src/modest-ui.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 /* modest-ui.h */
  32
  33 #ifndef __MODEST_UI_H__
  34 #define __MODEST_UI_H__
  35
  36 #include <glib-object.h>
  37 #include <gtk/gtkcontainer.h>
  38 #include "modest-conf.h"
  39 #include "modest-tny-msg-view.h"
  40
  41 G_BEGIN_DECLS
  42
  43 /* convenience macros */
  44 #define MODEST_TYPE_UI             (modest_ui_get_type())
  45 #define MODEST_UI(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_UI,ModestUI))
  46 #define MODEST_UI_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_UI,GObject))
  47 #define MODEST_IS_UI(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_UI))
  48 #define MODEST_IS_UI_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_UI))
  49 #define MODEST_UI_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_UI,ModestUIClass))
  50
  51 typedef struct _ModestUI      ModestUI;
  52 typedef struct _ModestUIClass ModestUIClass;
  53
  54 struct _ModestUI {
  55          GObject parent;
  56         /* insert public members, if any */
  57 };
  58
  59 struct _ModestUIClass {
  60         GObjectClass parent_class;
  61         /* insert signal callback declarations, eg. */
  62         /* void (* my_event) (ModestUI* obj); */
  63 };
  64
  65
  66 /**
  67  * modest_ui_get_type:
  68  *
  69  * get the GType for ModestUI
  70  *
  71  * Returns: the GType
  72  */
  73 GType        modest_ui_get_type        (void) G_GNUC_CONST;
  74
  75
  76
  77 /**
  78  * modest_ui_new:
  79  * @modest_conf: a ModestConf instance
  80  *
  81  * Returns: a new ModestUI, or NULL in case of error
  82  */
  83 GObject*     modest_ui_new             (ModestConf *modest_conf);
  84
  85
  86 /**
  87  * modest_ui_show_main_window:
  88  * @ui: a ModestUI instance
  89  *
  90  * show the application's main window
  91  *
  92  * Returns: TRUE if succeeded, FALSE otherwise
  93  */
  94 gboolean     modest_ui_show_main_window (ModestUI *ui);
  95
  96
  97 /**
  98  * modest_ui_new_edit_window:
  99  * @ui: a ModestUI instance
 100  * @to: people to send this to, ';' separated
 101  * @cc: people to send carbon-copies (cc), ';' separated
 102  * @bcc people to send blind-carbon-copies (bcc),';' separated
 103  * @subject: the subject of the message
 104  * @body: the body text of the message
 105  * @att: a list with the filepaths for attachments
 106  *
 107  * Returns: TRUE if succeeded, FALSE otherwise
 108  */
 109 gboolean     modest_ui_new_edit_window (ModestUI *ui,
 110                                          const gchar* to,
 111                                          const gchar* cc,
 112                                          const gchar* bcc,
 113                                          const gchar* subject,
 114                                          const gchar* body,
 115                                          const GSList* att);
 116
 117
 118 GtkContainer *modest_ui_new_editor_window (ModestUI *modest_ui, gpointer *user_data);
 119
 120 gboolean modest_ui_editor_window_set_to_header(const gchar *to, gpointer window_data);
 121 gboolean modest_ui_editor_window_set_cc_header(const gchar *cc, gpointer window_data);
 122 gboolean modest_ui_editor_window_set_bcc_header(const gchar *bcc, gpointer window_data);
 123 gboolean modest_ui_editor_window_set_subject_header(const gchar *subject, gpointer window_data);
 124 gboolean modest_ui_editor_window_set_body(const gchar *body, gpointer window_data);
 125 gboolean modest_ui_editor_window_update_attachments(gpointer window_data);
 126
 127 GtkContainer *modest_ui_new_viewer_window (ModestUI *modest_ui, GtkWidget *msg_view, TnyMsgIface *msg, gpointer *user_data);
 128
 129 G_END_DECLS
 130
 131 #endif /* __MODEST_UI_H__ */