diff doc/conversation-signals.dox @ 16183:8cf53d7a0887

Update the Doxygen signals documentation to match the new struct names.
author Richard Laager <rlaager@wiktel.com>
date Mon, 16 Apr 2007 00:50:57 +0000
parents a2ccce52ab3d
children 36b09c6f7957
line wrap: on
line diff
--- a/doc/conversation-signals.dox	Mon Apr 16 00:49:52 2007 +0000
+++ b/doc/conversation-signals.dox	Mon Apr 16 00:50:57 2007 +0000
@@ -33,9 +33,9 @@
 
  @signaldef writing-im-msg
   @signalproto
-gboolean (*writing_im_msg)(GaimAccount *account, const char *who,
-                           char **message, GaimConversation *conv,
-                           GaimMessageFlags flags);
+gboolean (*writing_im_msg)(PurpleAccount *account, const char *who,
+                           char **message, PurpleConversation *conv,
+                           PurpleMessageFlags flags);
   @endsignalproto
   @signaldesc
    Emitted before a message is written in an IM conversation. If the
@@ -53,9 +53,9 @@
 
  @signaldef wrote-im-msg
   @signalproto
-void (*wrote_im_msg)(GaimAccount *account, const char *who,
-                     char *message, GaimConversation *conv,
-                     GaimMessageFlags flags);
+void (*wrote_im_msg)(PurpleAccount *account, const char *who,
+                     char *message, PurpleConversation *conv,
+                     PurpleMessageFlags flags);
   @endsignalproto
   @signaldesc
    Emitted after a message is written and possibly displayed in a conversation.
@@ -68,7 +68,7 @@
 
  @signaldef sending-im-msg
   @signalproto
-void (*sending_im_msg)(GaimAccount *account, const char *receiver,
+void (*sending_im_msg)(PurpleAccount *account, const char *receiver,
                        char **message);
   @endsignalproto
   @signaldesc
@@ -83,7 +83,7 @@
 
  @signaldef sent-im-msg
   @signalproto
-void (*sent_im_msg)(GaimAccount *account, const char *receiver,
+void (*sent_im_msg)(PurpleAccount *account, const char *receiver,
                     const char *message);
   @endsignalproto
   @signaldesc
@@ -95,9 +95,9 @@
 
  @signaldef receiving-im-msg
   @signalproto
-gboolean (*receiving_im_msg)(GaimAccount *account, char **sender,
-                             char **message, GaimConversation *conv,
-                             GaimMessageFlags *flags);
+gboolean (*receiving_im_msg)(PurpleAccount *account, char **sender,
+                             char **message, PurpleConversation *conv,
+                             PurpleMessageFlags *flags);
   @endsignalproto
   @signaldesc
    Emitted when an IM is received. The callback can replace the name of the
@@ -116,8 +116,8 @@
 
  @signaldef received-im-msg
   @signalproto
-void (*received_im_msg)(GaimAccount *account, char *sender, char *message,
-                        GaimConversation *conv, GaimMessageFlags flags);
+void (*received_im_msg)(PurpleAccount *account, char *sender, char *message,
+                        PurpleConversation *conv, PurpleMessageFlags flags);
   @endsignalproto
   @signaldesc
    Emitted after an IM is received.
@@ -130,9 +130,9 @@
 
  @signaldef writing-chat-msg
   @signalproto
-gboolean (*writing_chat_msg)(GaimAccount *account, const char *who,
-                             char **message, GaimConversation *conv,
-                             GaimMessageFlags flags);
+gboolean (*writing_chat_msg)(PurpleAccount *account, const char *who,
+                             char **message, PurpleConversation *conv,
+                             PurpleMessageFlags flags);
   @endsignalproto
   @signaldesc
    Emitted before a message is written in a chat conversation. If the
@@ -150,9 +150,9 @@
 
  @signaldef wrote-chat-msg
   @signalproto
-void (*wrote_chat_msg)(GaimAccount *account, const char *who,
-                       char *message, GaimConversation *conv,
-                       GaimMessageFlags flags);
+void (*wrote_chat_msg)(PurpleAccount *account, const char *who,
+                       char *message, PurpleConversation *conv,
+                       PurpleMessageFlags flags);
   @endsignalproto
   @signaldesc
    Emitted after a message is written and possibly displayed in a chat.
@@ -165,7 +165,7 @@
 
  @signaldef sending-chat-msg
   @signalproto
-void (*sending_chat_msg)(GaimAccount *account, char **message, int id);
+void (*sending_chat_msg)(PurpleAccount *account, char **message, int id);
   @endsignalproto
   @signaldesc
    Emitted before sending a message to a chat. @a message is a pointer to the
@@ -179,7 +179,7 @@
 
  @signaldef sent-chat-msg
   @signalproto
-void (*sent_chat_msg)(GaimAccount *account, const char *message, int id);
+void (*sent_chat_msg)(PurpleAccount *account, const char *message, int id);
   @endsignalproto
   @signaldesc
    Emitted after sending a message to a chat.
@@ -190,8 +190,8 @@
 
  @signaldef receiving-chat-msg
   @signalproto
-gboolean (*receiving_chat_msg)(GaimAccount *account, char **sender,
-                              char **message, GaimConversation *conv, int *flags);
+gboolean (*receiving_chat_msg)(PurpleAccount *account, char **sender,
+                              char **message, PurpleConversation *conv, int *flags);
   @endsignalproto
   @signaldesc
    Emitted when a chat message is received. The callback can replace the
@@ -210,8 +210,8 @@
 
  @signaldef received-chat-msg
   @signalproto
-void (*received_chat_msg)(GaimAccount *account, char *sender, char *message,
-                              GaimConversation *conv, GaimMessageFlags flags);
+void (*received_chat_msg)(PurpleAccount *account, char *sender, char *message,
+                              PurpleConversation *conv, PurpleMessageFlags flags);
   @endsignalproto
   @signaldesc
    Emitted after a chat message is received.
@@ -224,7 +224,7 @@
 
  @signaldef conversation-created
   @signalproto
-void (*conversation_created)(GaimConversation *conv);
+void (*conversation_created)(PurpleConversation *conv);
   @endsignalproto
   @signaldesc
    Emitted when a new conversation is created.
@@ -233,8 +233,8 @@
 
  @signaldef conversation-updated
   @signalproto
-void (*conversation_updated)(GaimConversation *conv, 
-                             GaimConvUpdateType type);
+void (*conversation_updated)(PurpleConversation *conv, 
+                             PurpleConvUpdateType type);
   @endsignalproto
   @signaldesc
    Emitted when a conversation is updated.
@@ -244,7 +244,7 @@
 
  @signaldef deleting-conversation
   @signalproto
-void (*deleting_conversation)(GaimConversation *conv);
+void (*deleting_conversation)(PurpleConversation *conv);
   @endsignalproto
   @signaldesc
    Emitted just before a conversation is to be destroyed.
@@ -253,7 +253,7 @@
 
  @signaldef buddy-typing
   @signalproto
-void (*buddy_typing)(GaimAccount *account, const char *name);
+void (*buddy_typing)(PurpleAccount *account, const char *name);
   @endsignalproto
   @signaldesc
    Emitted when a buddy starts typing in a conversation window.
@@ -263,7 +263,7 @@
 
  @signaldef buddy-typing-stopped
   @signalproto
-void (*buddy_typing_stopped)(GaimAccount *account, const char *name);
+void (*buddy_typing_stopped)(PurpleAccount *account, const char *name);
   @endsignalproto
   @signaldesc
    Emitted when a buddy stops typing in a conversation window.
@@ -273,8 +273,8 @@
 
  @signaldef chat-buddy-joining
   @signalproto
-gboolean (*chat_buddy_joining)(GaimConversation *conv, const char *name,
-                           GaimConvChatBuddyFlags flags);
+gboolean (*chat_buddy_joining)(PurpleConversation *conv, const char *name,
+                           PurpleConvChatBuddyFlags flags);
   @endsignalproto
   @signaldesc
    Emitted when a buddy is joining a chat, before the list of
@@ -287,8 +287,8 @@
 
  @signaldef chat-buddy-joined
   @signalproto
-void (*chat_buddy_joined)(GaimConversation *conv, const char *name,
-                          GaimConvChatBuddyFlags flags,
+void (*chat_buddy_joined)(PurpleConversation *conv, const char *name,
+                          PurpleConvChatBuddyFlags flags,
                           gboolean new_arrival);
   @endsignalproto
   @signaldesc
@@ -301,9 +301,9 @@
 
  @signaldef chat-buddy-flags
   @signalproto
-void (*chat_buddy_flags)(GaimConversation *conv, const char *name,
-                         GaimConvChatBuddyFlags oldflags,
-                         GaimConvChatBuddyFlags newflags);
+void (*chat_buddy_flags)(PurpleConversation *conv, const char *name,
+                         PurpleConvChatBuddyFlags oldflags,
+                         PurpleConvChatBuddyFlags newflags);
   @endsignalproto
   @signaldesc
    Emitted when a user in a chat changes flags.
@@ -315,7 +315,7 @@
 
  @signaldef chat-buddy-leaving
   @signalproto
-gboolean (*chat_buddy_leaving)(GaimConversation *conv, const char *name,
+gboolean (*chat_buddy_leaving)(PurpleConversation *conv, const char *name,
                            const char *reason);
   @endsignalproto
   @signaldesc
@@ -329,7 +329,7 @@
 
  @signaldef chat-buddy-left
   @signalproto
-void (*chat_buddy_left)(GaimConversation *conv, const char *name,
+void (*chat_buddy_left)(PurpleConversation *conv, const char *name,
                         const char *reason);
   @endsignalproto
   @signaldesc
@@ -342,7 +342,7 @@
 
  @signaldef chat-inviting-user
   @signalproto
-void (*chat_inviting_user)(GaimConversation *conv, const char *name,
+void (*chat_inviting_user)(PurpleConversation *conv, const char *name,
                            char **invite_message);
   @endsignalproto
   @signaldesc
@@ -359,7 +359,7 @@
 
  @signaldef chat-invited-user
   @signalproto
-void (*chat_invited_user)(GaimConversation *conv, const char *name,
+void (*chat_invited_user)(PurpleConversation *conv, const char *name,
                           const char *invite_message);
   @endsignalproto
   @signaldesc
@@ -371,7 +371,7 @@
 
  @signaldef chat-invited
   @signalproto
-gint (*chat_invited)(GaimAccount *account, const char *inviter,
+gint (*chat_invited)(PurpleAccount *account, const char *inviter,
                      const char *chat, const char *invite_message
                      const GHashTable *components);
   @endsignalproto
@@ -390,7 +390,7 @@
 
  @signaldef chat-joined
   @signalproto
-void (*chat_joined)(GaimConversation *conv);
+void (*chat_joined)(PurpleConversation *conv);
   @endsignalproto
   @signaldesc
    Emitted when an account joins a chat room.
@@ -399,7 +399,7 @@
 
  @signaldef chat-left
   @signalproto
-void (*chat_left)(GaimConversation *conv);
+void (*chat_left)(PurpleConversation *conv);
   @endsignalproto
   @signaldesc
    Emitted when an account leaves a chat room.
@@ -408,7 +408,7 @@
 
  @signaldef chat-topic-changed
   @signalproto
-void (*chat_topic_changed)(GaimConversation *conv, const char *who, const char *topic);
+void (*chat_topic_changed)(PurpleConversation *conv, const char *who, const char *topic);
   @endsignalproto
   @signaldesc
    Emitted when the topic is changed in a chat.