pidgin/pidginmessage.h

   1 /* pidgin
   2  *
   3  * Pidgin is the legal property of its developers, whose names are too numerous
   4  * to list here.  Please refer to the COPYRIGHT file distributed with this
   5  * source distribution.
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  20  */
  21
  22 #ifndef PIDGIN_MESSAGE_H
  23 #define PIDGIN_MESSAGE_H
  24
  25 /**
  26  * SECTION:pidginmessage
  27  * @section_id: pidgin-pidginmessage
  28  * @short_description: <filename>pidginmessage.h</filename>
  29  * @title: Pidgin Message API
  30  */
  31
  32 #include <purple.h>
  33
  34 #include <talkatu.h>
  35
  36 G_BEGIN_DECLS
  37
  38 #define PIDGIN_TYPE_MESSAGE (pidgin_message_get_type())
  39 G_DECLARE_FINAL_TYPE(PidginMessage, pidgin_message, PIDGIN, MESSAGE, GObject)
  40
  41 /**
  42  * pidgin_message_new:
  43  * @msg: The #PurpleMessage to wrap.
  44  *
  45  * Wraps @msg so that it can be used as a #TalkatuMessage.
  46  *
  47  * Returns: (transfer full): The new #PidginMessage instance.
  48  */
  49 PidginMessage *pidgin_message_new(PurpleMessage *msg);
  50
  51 /**
  52  * pidgin_message_get_message:
  53  * @msg: The #PidginMessage instance.
  54  *
  55  * Gets the #PurpleMessage that @msg is wrapping.
  56  *
  57  * Returns: (transfer none): The #PurpleMessage that @msg is wrapping.
  58  */
  59 PurpleMessage *pidgin_message_get_message(PidginMessage *msg);
  60
  61 G_END_DECLS
  62
  63 #endif /* PIDGIN_MESSAGE_H */