libpurple/protocols/facebook/facebook.h

   1 /* purple
   2  *
   3  * Purple 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 PURPLE_FACEBOOK_FACEBOOK_H
  23 #define PURPLE_FACEBOOK_FACEBOOK_H
  24
  25 /**
  26  * SECTION:facebook
  27  * @section_id: facebook-plugin
  28  * @short_description: <filename>facebook.h</filename>
  29  * @title: Facebook Plugin
  30  *
  31  * The Facebook Messenger #PurpleProtocol.
  32  */
  33
  34 #include <glib.h>
  35 #include <gmodule.h>
  36
  37 #define FACEBOOK_TYPE_PROTOCOL  (facebook_protocol_get_type())
  38 #define FACEBOOK_PROTOCOL(obj)  (G_TYPE_CHECK_INSTANCE_CAST((obj), FACEBOOK_TYPE_PROTOCOL, FacebookProtocol))
  39 #define FACEBOOK_PROTOCOL_CLASS(klass)  (G_TYPE_CHECK_CLASS_CAST((klass), FACEBOOK_TYPE_PROTOCOL, FacebookProtocolClass))
  40 #define FACEBOOK_IS_PROTOCOL(obj)  (G_TYPE_CHECK_INSTANCE_TYPE((obj), FACEBOOK_TYPE_PROTOCOL))
  41 #define FACEBOOK_IS_PROTOCOL_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass), FACEBOOK_TYPE_PROTOCOL))
  42 #define FACEBOOK_PROTOCOL_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj), FACEBOOK_TYPE_PROTOCOL, FacebookProtocolClass))
  43
  44 /**
  45  * FB_PROTOCOL_ID:
  46  *
  47  * The Facebook protocol identifier.
  48  */
  49 #define FB_PROTOCOL_ID  "prpl-facebook"
  50
  51 typedef struct _FacebookProtocol FacebookProtocol;
  52 typedef struct _FacebookProtocolClass FacebookProtocolClass;
  53
  54 /**
  55  * FacebookProtocol:
  56  *
  57  * Represents the Facebook #PurpleProtocol.
  58  */
  59 struct _FacebookProtocol
  60 {
  61         /*< private >*/
  62         PurpleProtocol parent;
  63 };
  64
  65 /**
  66  * FacebookProtocolClass:
  67  *
  68  * The base class for all #FacebookProtocol's.
  69  */
  70 struct _FacebookProtocolClass
  71 {
  72         /*< private >*/
  73         PurpleProtocolClass parent_class;
  74 };
  75
  76 /**
  77  * facebook_protocol_get_type:
  78  *
  79  * Returns: The #GType for a #FacebookProtocol.
  80  */
  81 G_MODULE_EXPORT GType
  82 facebook_protocol_get_type(void);
  83
  84 #endif /* PURPLE_FACEBOOK_FACEBOOK_H */