libempathy-gtk/empathy-chat.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /*
   3  * Copyright (C) 2002-2007 Imendio AB
   4  * Copyright (C) 2007-2008 Collabora Ltd.
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License as
   8  * published by the Free Software Foundation; either version 2 of the
   9  * License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public
  17  * License along with this program; if not, write to the
  18  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  19  * Boston, MA  02110-1301  USA
  20  *
  21  * Authors: Mikael Hallendal <micke@imendio.com>
  22  *          Richard Hult <richard@imendio.com>
  23  *          Martyn Russell <martyn@imendio.com>
  24  *          Geert-Jan Van den Bogaerde <geertjan@gnome.org>
  25  *          Xavier Claessens <xclaesse@gmail.com>
  26  */
  27
  28 #ifndef __EMPATHY_CHAT_H__
  29 #define __EMPATHY_CHAT_H__
  30
  31 #include <gtk/gtk.h>
  32
  33 #include <libempathy/empathy-contact.h>
  34 #include <libempathy/empathy-message.h>
  35 #include <libempathy/empathy-tp-chat.h>
  36
  37 #include "empathy-chat-view.h"
  38
  39 G_BEGIN_DECLS
  40
  41 #define EMPATHY_TYPE_CHAT         (empathy_chat_get_type ())
  42 #define EMPATHY_CHAT(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), EMPATHY_TYPE_CHAT, EmpathyChat))
  43 #define EMPATHY_CHAT_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST ((k), EMPATHY_TYPE_CHAT, EmpathyChatClass))
  44 #define EMPATHY_IS_CHAT(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), EMPATHY_TYPE_CHAT))
  45 #define EMPATHY_IS_CHAT_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), EMPATHY_TYPE_CHAT))
  46 #define EMPATHY_CHAT_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), EMPATHY_TYPE_CHAT, EmpathyChatClass))
  47
  48 typedef struct _EmpathyChat       EmpathyChat;
  49 typedef struct _EmpathyChatClass  EmpathyChatClass;
  50 typedef struct _EmpathyChatPriv   EmpathyChatPriv;
  51
  52 struct _EmpathyChat {
  53         GtkBox parent;
  54         EmpathyChatPriv *priv;
  55
  56         /* Protected */
  57         EmpathyChatView *view;
  58         GtkWidget       *input_text_view;
  59 };
  60
  61 struct _EmpathyChatClass {
  62         GtkBoxClass parent;
  63 };
  64
  65 GType              empathy_chat_get_type             (void);
  66 EmpathyChat *      empathy_chat_new                  (EmpathyTpChat *tp_chat);
  67 EmpathyTpChat *    empathy_chat_get_tp_chat          (EmpathyChat   *chat);
  68 void               empathy_chat_set_tp_chat          (EmpathyChat   *chat,
  69                                                       EmpathyTpChat *tp_chat);
  70 TpAccount *        empathy_chat_get_account          (EmpathyChat   *chat);
  71 const gchar *      empathy_chat_get_id               (EmpathyChat   *chat);
  72 gchar *            empathy_chat_dup_name             (EmpathyChat   *chat);
  73 const gchar *      empathy_chat_get_subject          (EmpathyChat   *chat);
  74 EmpathyContact *   empathy_chat_get_remote_contact   (EmpathyChat   *chat);
  75 GtkWidget *        empathy_chat_get_contact_menu     (EmpathyChat   *chat);
  76 void               empathy_chat_clear                (EmpathyChat   *chat);
  77 void               empathy_chat_scroll_down          (EmpathyChat   *chat);
  78 void               empathy_chat_cut                  (EmpathyChat   *chat);
  79 void               empathy_chat_copy                 (EmpathyChat   *chat);
  80 void               empathy_chat_paste                (EmpathyChat   *chat);
  81 void               empathy_chat_find                 (EmpathyChat   *chat);
  82 void               empathy_chat_correct_word         (EmpathyChat   *chat,
  83                                                       GtkTextIter   *start,
  84                                                       GtkTextIter   *end,
  85                                                       const gchar   *new_word);
  86 void               empathy_chat_join_muc             (EmpathyChat   *chat,
  87                                                       const gchar   *room);
  88 gboolean           empathy_chat_is_room              (EmpathyChat   *chat);
  89 void               empathy_chat_set_show_contacts    (EmpathyChat *chat,
  90                                                       gboolean     show);
  91 guint              empathy_chat_get_nb_unread_messages (EmpathyChat   *chat);
  92
  93 void               empathy_chat_messages_read        (EmpathyChat *self);
  94
  95 gboolean           empathy_chat_is_composing (EmpathyChat *chat);
  96
  97 gboolean           empathy_chat_is_sms_channel       (EmpathyChat *self);
  98 guint              empathy_chat_get_n_messages_sending (EmpathyChat *self);
  99
 100 gchar *            empathy_chat_dup_text             (EmpathyChat *self);
 101 void               empathy_chat_set_text             (EmpathyChat *self,
 102                                                       const gchar *text);
 103
 104 G_END_DECLS
 105
 106 #endif /* __EMPATHY_CHAT_H__ */