Conversation operations and events. More...

#include <conversation.h>

Collaboration diagram for _PurpleConversationUiOps:

Data Fields
void(*	create_conversation )(PurpleConversation *conv)
	Called when conv is created (but before the conversation-created signal is emitted).

void(*	destroy_conversation )(PurpleConversation *conv)
	Called just before conv is freed.

void(*	write_chat )(PurpleConversation conv, const char who, const char *message, PurpleMessageFlags flags, time_t mtime)
	Write a message to a chat.

void(*	write_im )(PurpleConversation conv, const char who, const char *message, PurpleMessageFlags flags, time_t mtime)
	Write a message to an IM conversation.

void(*	write_conv )(PurpleConversation conv, const char name, const char alias, const char message, PurpleMessageFlags flags, time_t mtime)
	Write a message to a conversation.

void(*	chat_add_users )(PurpleConversation conv, GList cbuddies, gboolean new_arrivals)
	Add cbuddies to a chat.

void(*	chat_rename_user )(PurpleConversation conv, const char old_name, const char new_name, const char new_alias)
	Rename the user in this chat named old_name to new_name.

void(*	chat_remove_users )(PurpleConversation conv, GList users)
	Remove users from a chat.

void(*	chat_update_user )(PurpleConversation conv, const char user)
	Called when a user's flags are changed.

void(*	present )(PurpleConversation *conv)
	Present this conversation to the user; for example, by displaying the IM dialog.

gboolean(*	has_focus )(PurpleConversation *conv)
	If this UI has a concept of focus (as in a windowing system) and this conversation has the focus, return `TRUE`; otherwise, return `FALSE`.

gboolean(*	custom_smiley_add )(PurpleConversation conv, const char smile, gboolean remote)

void(*	custom_smiley_write )(PurpleConversation conv, const char smile, const guchar *data, gsize size)

void(*	custom_smiley_close )(PurpleConversation conv, const char smile)

void(*	send_confirm )(PurpleConversation conv, const char message)
	Prompt the user for confirmation to send message.

void(*	_purple_reserved1 )(void)

void(*	_purple_reserved2 )(void)

void(*	_purple_reserved3 )(void)

void(*	_purple_reserved4 )(void)

Detailed Description

Conversation operations and events.

Any UI representing a conversation must assign a filled-out PurpleConversationUiOps structure to the PurpleConversation.

Definition at line 161 of file conversation.h.

Field Documentation

◆ _purple_reserved1

void(* _PurpleConversationUiOps::_purple_reserved1) (void)

Definition at line 249 of file conversation.h.

◆ _purple_reserved2

void(* _PurpleConversationUiOps::_purple_reserved2) (void)

Definition at line 250 of file conversation.h.

◆ _purple_reserved3

void(* _PurpleConversationUiOps::_purple_reserved3) (void)

Definition at line 251 of file conversation.h.

◆ _purple_reserved4

void(* _PurpleConversationUiOps::_purple_reserved4) (void)

Definition at line 252 of file conversation.h.

◆ chat_add_users

void(* _PurpleConversationUiOps::chat_add_users) (PurpleConversation *conv, GList *cbuddies, gboolean new_arrivals)

Add cbuddies to a chat.

Parameters

cbuddies	A `GList` of PurpleConvChatBuddy structs.
new_arrivals	Whether join notices should be shown. (Join notices are actually written to the conversation by purple_conv_chat_add_users().)

Definition at line 205 of file conversation.h.

◆ chat_remove_users

void(* _PurpleConversationUiOps::chat_remove_users) (PurpleConversation *conv, GList *users)

Remove users from a chat.

Parameters

users A GList of const char *s.

See also: purple_conv_chat_rename_user()

Definition at line 219 of file conversation.h.

◆ chat_rename_user

void(* _PurpleConversationUiOps::chat_rename_user) (PurpleConversation *conv, const char *old_name, const char *new_name, const char *new_alias)

Rename the user in this chat named old_name to new_name.

(The rename message is written to the conversation by libpurple.)

Parameters

new_alias new_name's new alias, if they have one.

See also: purple_conv_chat_add_users()

Definition at line 213 of file conversation.h.

◆ chat_update_user

void(* _PurpleConversationUiOps::chat_update_user) (PurpleConversation *conv, const char *user)

Called when a user's flags are changed.

See also: purple_conv_chat_user_set_flags()

Definition at line 223 of file conversation.h.

◆ create_conversation

void(* _PurpleConversationUiOps::create_conversation) (PurpleConversation *conv)

Called when conv is created (but before the conversation-created signal is emitted).

Definition at line 166 of file conversation.h.

◆ custom_smiley_add

gboolean(* _PurpleConversationUiOps::custom_smiley_add) (PurpleConversation *conv, const char *smile, gboolean remote)

Definition at line 237 of file conversation.h.

◆ custom_smiley_close

void(* _PurpleConversationUiOps::custom_smiley_close) (PurpleConversation *conv, const char *smile)

Definition at line 240 of file conversation.h.

◆ custom_smiley_write

void(* _PurpleConversationUiOps::custom_smiley_write) (PurpleConversation *conv, const char *smile, const guchar *data, gsize size)

Definition at line 238 of file conversation.h.

◆ destroy_conversation

void(* _PurpleConversationUiOps::destroy_conversation) (PurpleConversation *conv)

Called just before conv is freed.

Definition at line 169 of file conversation.h.

◆ has_focus

gboolean(* _PurpleConversationUiOps::has_focus) (PurpleConversation *conv)

If this UI has a concept of focus (as in a windowing system) and this conversation has the focus, return TRUE; otherwise, return FALSE.

Definition at line 234 of file conversation.h.

◆ present

void(* _PurpleConversationUiOps::present) (PurpleConversation *conv)

Present this conversation to the user; for example, by displaying the IM dialog.

Definition at line 228 of file conversation.h.

◆ send_confirm

void(* _PurpleConversationUiOps::send_confirm) (PurpleConversation *conv, const char *message)

Prompt the user for confirmation to send message.

This function should arrange for the message to be sent if the user accepts. If this field is NULL, libpurple will fall back to using purple_request_action().

Definition at line 247 of file conversation.h.

◆ write_chat

void(* _PurpleConversationUiOps::write_chat) (PurpleConversation *conv, const char *who, const char *message, PurpleMessageFlags flags, time_t mtime)

Write a message to a chat.

If this field is NULL, libpurple will fall back to using write_conv.

See also: purple_conv_chat_write()

Definition at line 174 of file conversation.h.

◆ write_conv

void(* _PurpleConversationUiOps::write_conv) (PurpleConversation *conv, const char *name, const char *alias, const char *message, PurpleMessageFlags flags, time_t mtime)

Write a message to a conversation.

This is used rather than the chat- or im-specific ops for errors, system messages (such as "x is now know as y"), and as the fallback if write_im and write_chat are not implemented. It should be implemented, or the UI will miss conversation error messages and your users will hate you.

See also: purple_conversation_write()

Definition at line 192 of file conversation.h.

◆ write_im

void(* _PurpleConversationUiOps::write_im) (PurpleConversation *conv, const char *who, const char *message, PurpleMessageFlags flags, time_t mtime)

Write a message to an IM conversation.

If this field is NULL, libpurple will fall back to using write_conv.

See also: purple_conv_im_write()

Definition at line 181 of file conversation.h.

The documentation for this struct was generated from the following file:

conversation.h

Data Fields

Detailed Description

Field Documentation

◆ _purple_reserved1

◆ _purple_reserved2

◆ _purple_reserved3

◆ _purple_reserved4

◆ chat_add_users

◆ chat_remove_users

◆ chat_rename_user

◆ chat_update_user

◆ create_conversation

◆ custom_smiley_add

◆ custom_smiley_close

◆ custom_smiley_write

◆ destroy_conversation

◆ has_focus

◆ present

◆ send_confirm

◆ write_chat

◆ write_conv

◆ write_im