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