libempathy/empathy-message.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /*
   3  * Copyright (C) 2004-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  *          Xavier Claessens <xclaesse@gmail.com>
  23  */
  24
  25 #ifndef __EMPATHY_MESSAGE_H__
  26 #define __EMPATHY_MESSAGE_H__
  27
  28 #include <glib-object.h>
  29 #include <telepathy-logger/entry.h>
  30
  31 #include "empathy-contact.h"
  32 #include "empathy-time.h"
  33
  34 G_BEGIN_DECLS
  35
  36 #define EMPATHY_TYPE_MESSAGE         (empathy_message_get_type ())
  37 #define EMPATHY_MESSAGE(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), EMPATHY_TYPE_MESSAGE, EmpathyMessage))
  38 #define EMPATHY_MESSAGE_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST ((k), EMPATHY_TYPE_MESSAGE, EmpathyMessageClass))
  39 #define EMPATHY_IS_MESSAGE(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), EMPATHY_TYPE_MESSAGE))
  40 #define EMPATHY_IS_MESSAGE_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), EMPATHY_TYPE_MESSAGE))
  41 #define EMPATHY_MESSAGE_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), EMPATHY_TYPE_MESSAGE, EmpathyMessageClass))
  42
  43 typedef struct _EmpathyMessage      EmpathyMessage;
  44 typedef struct _EmpathyMessageClass EmpathyMessageClass;
  45
  46 struct _EmpathyMessage {
  47         GObject parent;
  48         gpointer priv;
  49 };
  50
  51 struct _EmpathyMessageClass {
  52         GObjectClass parent_class;
  53 };
  54
  55 GType                    empathy_message_get_type          (void) G_GNUC_CONST;
  56 EmpathyMessage *         empathy_message_new               (const gchar              *body);
  57 EmpathyMessage *         empathy_message_from_tpl_log_entry (TplEntry                *logentry);
  58 TpChannelTextMessageType empathy_message_get_tptype        (EmpathyMessage           *message);
  59 void                     empathy_message_set_tptype        (EmpathyMessage           *message,
  60                                                             TpChannelTextMessageType  type);
  61 EmpathyContact *         empathy_message_get_sender        (EmpathyMessage           *message);
  62 void                     empathy_message_set_sender        (EmpathyMessage           *message,
  63                                                             EmpathyContact           *contact);
  64 EmpathyContact *         empathy_message_get_receiver      (EmpathyMessage           *message);
  65 void                     empathy_message_set_receiver      (EmpathyMessage           *message,
  66                                                             EmpathyContact           *contact);
  67 const gchar *            empathy_message_get_body          (EmpathyMessage           *message);
  68 void                     empathy_message_set_body          (EmpathyMessage           *message,
  69                                                             const gchar              *body);
  70 time_t                   empathy_message_get_timestamp     (EmpathyMessage           *message);
  71 void                     empathy_message_set_timestamp     (EmpathyMessage           *message,
  72                                                             time_t                    timestamp);
  73 gboolean                 empathy_message_is_backlog        (EmpathyMessage           *message);
  74 void                     empathy_message_set_is_backlog    (EmpathyMessage           *message,
  75                                                             gboolean                 is_backlog);
  76 gboolean                 empathy_message_is_incoming       (EmpathyMessage           *message);
  77 void                     empathy_message_set_incoming      (EmpathyMessage           *message,
  78                                                             gboolean                 incoming);
  79
  80 gboolean                 empathy_message_should_highlight  (EmpathyMessage           *message);
  81 TpChannelTextMessageType empathy_message_type_from_str     (const gchar              *type_str);
  82 const gchar *            empathy_message_type_to_str       (TpChannelTextMessageType  type);
  83
  84 guint                    empathy_message_get_id (EmpathyMessage *message);
  85 void                     empathy_message_set_id (EmpathyMessage *message, guint id);
  86
  87 gboolean                 empathy_message_equal (EmpathyMessage *message1, EmpathyMessage *message2);
  88
  89 TpChannelTextMessageFlags empathy_message_get_flags        (EmpathyMessage           *message);
  90 void                      empathy_message_set_flags        (EmpathyMessage           *message,
  91                                                             TpChannelTextMessageFlags flags);
  92
  93 G_END_DECLS
  94
  95 #endif /* __EMPATHY_MESSAGE_H__ */