Signals:
gboolean (*writing_im_msg)(GaimAccount *account, GaimConversation *conv, char **message);
- Description:
Emitted before a message is displayed in an IM conversation or sent to a remote user. message is a pointer to a string, so the plugin can replace the message that will be displayed along with the message that will be sent. This can also be used to cancel an outgoing message by returning TRUE
. - Note:
- Make sure to free *message before you replace it!
- Parameters:
-
account | The account the message is being displayed and sent on. |
conv | The conversation the message is being displayed and sent on. |
message | A pointer to the message that will be displayed and sent. |
- Returns:
TRUE
if the message should be canceled, or FALSE
otherwise.
void (*wrote_im_msg)(GaimAccount *account, GaimConversation *conv, const char *message);
- Description:
Emitted after a message is entered by the user, but before it is sent and displyed. When sending an IM, the order that the im-msg callbacks will be called is: writing-im-msg, wrote-im-msg, displaying-im-msg, displayed-im-msg, sending-im-msg, and finally sent-im-msg. - Parameters:
-
account | The account the message was displayed on. |
conv | The conversation the message was displayed on. |
message | The message that was displayed. |
gboolean (*displaying_im_msg)(GaimAccount *account, GaimConversation *conv, char **message);
- Description:
Emitted just before a message is displayed in an IM conversation. message is a pointer to a string, so the plugin can replace the message that will be displayed. This can also be used to cancel displaying a message by returning TRUE
. - Note:
- Make sure to free *message before you replace it!
- Parameters:
-
account | The account the message is being displayed on. |
conv | The conversation the message is being displayed on. |
message | A pointer to the message that will be displayed. |
- Returns:
TRUE
if the message should be canceled, or FALSE
otherwise.
void (*displayed_im_msg)(GaimAccount *account, GaimConversation *conv, const char *message);
- Description:
Emitted after a message is displayed in an IM conversation. - Parameters:
-
account | The account the message was displayed on. |
conv | The conversation the message was displayed on. |
message | The message that was displayed. |
void (*sending_im_msg)(GaimAccount *account, const char *receiver,
char **message);
- Description:
Emitted before sending an IM to a user. message is a pointer to the message string, so the plugin can replace the message before being sent. - Note:
- Make sure to free *message before you replace it!
- Parameters:
-
account | The account the message is being sent on. |
receiver | The username of the receiver. |
message | A pointer to the outgoing message. This can be modified. |
void (*sent_im_msg)(GaimAccount *account, const char *receiver,
const char *message);
- Description:
Emitted after sending an IM to a user. - Parameters:
-
account | The account the message was sent on. |
receiver | The username of the receiver. |
message | The message that was sent. |
gboolean (*received_im_msg)(GaimAccount *account, char **sender,
char **message, int *flags);
- Description:
Emitted when an IM is received. The callback can replace the name of the sender, the message, or the flags by modifying the pointer to the strings and integer. This can also be used to cancel a message by returning TRUE
. - Note:
- Make sure to free *sender and *message before you replace them!
- Returns:
TRUE
if the message should be canceled, or FALSE
otherwise.
- Parameters:
-
account | The account the message was received on. |
sender | A pointer to the username of the sender. |
message | A pointer to the message that was sent. |
flags | The message flags. |
gboolean (*writing_chat_msg)(GaimAccount *account, GaimConversation *conv, char **message);
- Description:
Emitted before a message is displayed in a chat conversation or sent to a remote chat. message is a pointer to a string, so the plugin can replace the message that will be displayed along with the message that will be sent. This can also be used to cancel an outgoing message by returning TRUE
. - Note:
- Make sure to free *message before you replace it!
- Parameters:
-
account | The account the message is being displayed and sent on. |
conv | The conversation the message is being displayed and sent on. |
message | A pointer to the message that will be displayed and sent. |
- Returns:
TRUE
if the message should be canceled, or FALSE
otherwise.
void (*wrote_chat_msg)(GaimAccount *account, GaimConversation *conv, const char *message);
- Description:
Emitted after a message is entered by the user, but before it is sent and displyed. When sending an IM, the order that the im-msg callbacks will be called is: writing-im-msg, wrote-im-msg, displaying-im-msg, displayed-im-msg, sending-im-msg, and finally sent-im-msg. - Parameters:
-
account | The account the message was displayed on. |
conv | The conversation the message was displayed on. |
message | The message that was displayed. |
gboolean (*displaying_chat_msg)(GaimAccount *account, GaimConversation *conv, char **message);
- Description:
Emitted just before a message is displayed in a chat. message is a pointer to a string, so the plugin can replace the message that will be displayed. This can also be used to cancel displaying a message by returning TRUE
. - Note:
- Make sure to free *message before you replace it!
- Parameters:
-
account | The account the message is being displayed on. |
conv | The conversation the message is being displayed on. |
message | A pointer to the message that will be displayed. |
- Returns:
TRUE
if the message should be canceled, or FALSE
otherwise.
void (*displayed_chat_msg)(GaimAccount *account, GaimConversation *conv, const char *message);
- Description:
Emitted after a message is displayed in a chat conversation. - Parameters:
-
account | The account the message was displayed on. |
conv | The conversation the message was displayed on. |
message | The message that was displayed. |
void (*sending_chat_msg)(GaimAccount *account, char **message, int id);
- Description:
Emitted before sending a message to a chat. message is a pointer to the message string, so the plugin can replace the message before being sent. - Note:
- Make sure to free *message before you replace it!
- Parameters:
-
account | The account the message is being sent on. |
message | A pointer to the message that will be sent. |
id | The ID of the chat. |
void (*sent_chat_msg)(GaimAccount *account, const char *message, int id);
- Description:
Emitted after sending a message to a chat. - Parameters:
-
account | The account the message was sent on. |
message | The message that was sent. |
id | The ID of the chat. |
gboolean (*received_chat_msg)(GaimAccount *account, char **sender,
char **message, GaimConversation *conv);
- Description:
Emitted when a chat message is received. The callback can replace the name of the sender or the messageby modifying the pointer to the strings. This can also be used to cancel displaying a message by returning TRUE
. - Note:
- Make sure to free *sender and *message before you replace them!
- Returns:
TRUE
if the message should be canceled, or FALSE
otherwise.
- Parameters:
-
account | The account the message was received on. |
sender | A pointer to the username of the sender. |
message | A pointer to the message that was sent. |
conv | The chat conversation. |
- Description:
Emitted when a window is about to switch from one conversation to another. - Parameters:
-
old_conv | The old active conversation. |
new_conv | The soon-to-be active conversation |
- Description:
Emitted when a window switched from one conversation to another. - Parameters:
-
old_conv | The old active conversation. |
new_conv | The now active conversation. |
- Description:
Emitted when a new conversation is created. - Parameters:
-
conv | The new conversation. |
- Description:
Emitted just before a conversation is to be destroyed. - Parameters:
-
conv | The conversation that's about to be destroyed. |
- Description:
Emitted when a buddy starts typing in a conversation window. - Parameters:
-
conv | The IM conversation a buddy is typing in. |
- Description:
Emitted when a buddy stops typing in a conversation window. - Parameters:
-
conv | The IM conversation a buddy is typing in. |
- Description:
Emitted when a buddy is joining a chat, before the list of users in the chat updates to include the new user. - Parameters:
-
conv | The chat conversation. |
name | The name of the user that is joining the conversation. |
- Description:
Emitted when a buddy joined a chat, after the users list is updated. - Parameters:
-
conv | The chat conversation. |
void (*chat_buddy_leaving)(GaimConversation *conv, const char *name,
const char *reason);
- Description:
Emitted when a user is leaving a chat, before the user list is updated. This may include an optional reason why the user is leaving. - Parameters:
-
conv | The chat conversation. |
name | The name of the user that is leaving the chat. |
reason | The optional reason why the user is leaving. |
void (*chat_buddy_left)(GaimConversation *conv, const char *name,
const char *reason);
- Description:
Emitted when a user leaves a chat, after the user list is updated. This may include an optional reason why the user is leaving. - Parameters:
-
conv | The chat conversation. |
name | The name of the user that left the chat. |
reason | The optional reason why the user left the chat. |
void (*chat_inviting_user)(GaimConversation *conv, const char *name,
char **invite_message);
- Description:
Emitted when a user is being invited to the chat. The callback can replace the invite message to the invitee by modifying the pointer to the invite message. - Note:
- Make sure to free *invite_message before you replace it!
- Parameters:
-
conv | The chat conversation. |
name | The name of the user being invited. |
invite_message | A pointer to the reason why a user is being invited. |
void (*chat_invited_user)(GaimConversation *conv, const char *name,
const char *invite_message);
- Description:
Emitted when a user invited another user to a chat. - Parameters:
-
conv | The chat conversation. |
conv | The name of the user that was invited. |
invite_message | The message to be sent to the user when invited. |
void (*chat_invited)(GaimAccount *account, const char *inviter,
const char *invite, const char *invite_message);
- Description:
Emitted when an account was invited to a chat. - Parameters:
-
account | The account being invited. |
inviter | The username of the person inviting the account. |
invitee | The username of the account being invited. |
invite_message | The optional invite message. |
- Description:
Emitted when an account joins a chat room. - Parameters:
-
conv | The conversation that joined the chat room. |
- Description:
Emitted when an account leaves a chat room. - Parameters:
-
conv | The conversation that left the chat room. |
Generated on Sun Aug 29 03:45:17 2004 for gaim by
1.3.4