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 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., 59 Temple Place - Suite 330,
  19  * Boston, MA 02111-1307, 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 <glib-object.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 #include "empathy-spell.h"
  39
  40 G_BEGIN_DECLS
  41
  42 #define EMPATHY_TYPE_CHAT         (empathy_chat_get_type ())
  43 #define EMPATHY_CHAT(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), EMPATHY_TYPE_CHAT, EmpathyChat))
  44 #define EMPATHY_CHAT_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST ((k), EMPATHY_TYPE_CHAT, EmpathyChatClass))
  45 #define EMPATHY_IS_CHAT(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), EMPATHY_TYPE_CHAT))
  46 #define EMPATHY_IS_CHAT_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), EMPATHY_TYPE_CHAT))
  47 #define EMPATHY_CHAT_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), EMPATHY_TYPE_CHAT, EmpathyChatClass))
  48
  49 typedef struct _EmpathyChat       EmpathyChat;
  50 typedef struct _EmpathyChatClass  EmpathyChatClass;
  51 typedef struct _EmpathyChatPriv   EmpathyChatPriv;
  52
  53 struct _EmpathyChat {
  54         GObject          parent;
  55
  56         /* Protected */
  57         EmpathyChatView *view;
  58         GtkWidget       *input_text_view;
  59         gboolean         block_events;
  60 };
  61
  62 struct _EmpathyChatClass {
  63         GObjectClass parent;
  64
  65         /* VTable */
  66         const gchar *    (*get_name)            (EmpathyChat   *chat);
  67         gchar *          (*get_tooltip)         (EmpathyChat   *chat);
  68         const gchar *    (*get_status_icon_name)(EmpathyChat   *chat);
  69         GtkWidget *      (*get_widget)          (EmpathyChat   *chat);
  70         gboolean         (*is_group_chat)       (EmpathyChat   *chat);
  71         void             (*set_tp_chat)         (EmpathyChat   *chat,
  72                                                  EmpathyTpChat *tp_chat);
  73         gboolean         (*key_press_event)     (EmpathyChat   *chat,
  74                                                  GdkEventKey   *event);
  75 };
  76
  77 GType              empathy_chat_get_type              (void);
  78
  79 EmpathyChatView *  empathy_chat_get_view              (EmpathyChat       *chat);
  80 void               empathy_chat_present               (EmpathyChat       *chat);
  81 void               empathy_chat_clear                 (EmpathyChat       *chat);
  82 void               empathy_chat_scroll_down           (EmpathyChat       *chat);
  83 void               empathy_chat_cut                   (EmpathyChat       *chat);
  84 void               empathy_chat_copy                  (EmpathyChat       *chat);
  85 void               empathy_chat_paste                 (EmpathyChat       *chat);
  86 const gchar *      empathy_chat_get_name              (EmpathyChat       *chat);
  87 gchar *            empathy_chat_get_tooltip           (EmpathyChat       *chat);
  88 const gchar *      empathy_chat_get_status_icon_name  (EmpathyChat       *chat);
  89 GtkWidget *        empathy_chat_get_widget            (EmpathyChat       *chat);
  90 gboolean           empathy_chat_is_group_chat         (EmpathyChat       *chat);
  91 gboolean           empathy_chat_is_connected          (EmpathyChat       *chat);
  92 void               empathy_chat_save_geometry         (EmpathyChat       *chat,
  93                                                        gint               x,
  94                                                        gint               y,
  95                                                        gint               w,
  96                                                        gint               h);
  97 void               empathy_chat_load_geometry         (EmpathyChat       *chat,
  98                                                        gint              *x,
  99                                                        gint              *y,
 100                                                        gint              *w,
 101                                                        gint              *h);
 102 void               empathy_chat_set_tp_chat           (EmpathyChat       *chat,
 103                                                        EmpathyTpChat     *tp_chat);
 104 const gchar *      empathy_chat_get_id                (EmpathyChat       *chat);
 105 McAccount *        empathy_chat_get_account           (EmpathyChat       *chat);
 106
 107 /* For spell checker dialog to correct the misspelled word. */
 108 gboolean           empathy_chat_get_is_command        (const gchar      *str);
 109 void               empathy_chat_correct_word          (EmpathyChat       *chat,
 110                                                        GtkTextIter       start,
 111                                                        GtkTextIter       end,
 112                                                        const gchar      *new_word);
 113 gboolean           empathy_chat_should_play_sound     (EmpathyChat       *chat);
 114 gboolean           empathy_chat_should_highlight_nick (EmpathyMessage    *message);
 115
 116 G_END_DECLS
 117
 118 #endif /* __EMPATHY_CHAT_H__ */