00001
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00023
00024
00025
00026
00027 #ifndef _PURPLE_CONVERSATION_H_
00028 #define _PURPLE_CONVERSATION_H_
00029
00030
00032
00033
00034
00036 typedef struct _PurpleConversationUiOps PurpleConversationUiOps;
00038 typedef struct _PurpleConversation PurpleConversation;
00040 typedef struct _PurpleConvIm PurpleConvIm;
00042 typedef struct _PurpleConvChat PurpleConvChat;
00044 typedef struct _PurpleConvChatBuddy PurpleConvChatBuddy;
00046 typedef struct _PurpleConvMessage PurpleConvMessage;
00047
00051 typedef enum
00052 {
00053 PURPLE_CONV_TYPE_UNKNOWN = 0,
00054 PURPLE_CONV_TYPE_IM,
00055 PURPLE_CONV_TYPE_CHAT,
00056 PURPLE_CONV_TYPE_MISC,
00057 PURPLE_CONV_TYPE_ANY
00059 } PurpleConversationType;
00060
00064 typedef enum
00065 {
00066 PURPLE_CONV_UPDATE_ADD = 0,
00068 PURPLE_CONV_UPDATE_REMOVE,
00070 PURPLE_CONV_UPDATE_ACCOUNT,
00071 PURPLE_CONV_UPDATE_TYPING,
00072 PURPLE_CONV_UPDATE_UNSEEN,
00073 PURPLE_CONV_UPDATE_LOGGING,
00075 PURPLE_CONV_UPDATE_TOPIC,
00076
00077
00078
00079
00080 PURPLE_CONV_ACCOUNT_ONLINE,
00081 PURPLE_CONV_ACCOUNT_OFFLINE,
00082 PURPLE_CONV_UPDATE_AWAY,
00083 PURPLE_CONV_UPDATE_ICON,
00084 PURPLE_CONV_UPDATE_TITLE,
00085 PURPLE_CONV_UPDATE_CHATLEFT,
00086
00087 PURPLE_CONV_UPDATE_FEATURES
00089 } PurpleConvUpdateType;
00090
00094 typedef enum
00095 {
00096 PURPLE_NOT_TYPING = 0,
00097 PURPLE_TYPING,
00098 PURPLE_TYPED
00100 } PurpleTypingState;
00101
00105 typedef enum
00106 {
00107 PURPLE_MESSAGE_SEND = 0x0001,
00108 PURPLE_MESSAGE_RECV = 0x0002,
00109 PURPLE_MESSAGE_SYSTEM = 0x0004,
00110 PURPLE_MESSAGE_AUTO_RESP = 0x0008,
00111 PURPLE_MESSAGE_ACTIVE_ONLY = 0x0010,
00118 PURPLE_MESSAGE_NICK = 0x0020,
00119 PURPLE_MESSAGE_NO_LOG = 0x0040,
00120 PURPLE_MESSAGE_WHISPER = 0x0080,
00121 PURPLE_MESSAGE_ERROR = 0x0200,
00122 PURPLE_MESSAGE_DELAYED = 0x0400,
00123 PURPLE_MESSAGE_RAW = 0x0800,
00125 PURPLE_MESSAGE_IMAGES = 0x1000,
00126 PURPLE_MESSAGE_NOTIFY = 0x2000,
00127 PURPLE_MESSAGE_NO_LINKIFY = 0x4000,
00129 PURPLE_MESSAGE_INVISIBLE = 0x8000
00130 } PurpleMessageFlags;
00131
00135 typedef enum
00136 {
00137 PURPLE_CBFLAGS_NONE = 0x0000,
00138 PURPLE_CBFLAGS_VOICE = 0x0001,
00139 PURPLE_CBFLAGS_HALFOP = 0x0002,
00140 PURPLE_CBFLAGS_OP = 0x0004,
00141 PURPLE_CBFLAGS_FOUNDER = 0x0008,
00142 PURPLE_CBFLAGS_TYPING = 0x0010,
00143 PURPLE_CBFLAGS_AWAY = 0x0020
00145 } PurpleConvChatBuddyFlags;
00146
00147 #include "account.h"
00148 #include "buddyicon.h"
00149 #include "log.h"
00150 #include "server.h"
00151
00158 struct _PurpleConversationUiOps
00159 {
00163 void (*create_conversation)(PurpleConversation *conv);
00164
00166 void (*destroy_conversation)(PurpleConversation *conv);
00171 void (*write_chat)(PurpleConversation *conv, const char *who,
00172 const char *message, PurpleMessageFlags flags,
00173 time_t mtime);
00178 void (*write_im)(PurpleConversation *conv, const char *who,
00179 const char *message, PurpleMessageFlags flags,
00180 time_t mtime);
00189 void (*write_conv)(PurpleConversation *conv,
00190 const char *name,
00191 const char *alias,
00192 const char *message,
00193 PurpleMessageFlags flags,
00194 time_t mtime);
00195
00202 void (*chat_add_users)(PurpleConversation *conv,
00203 GList *cbuddies,
00204 gboolean new_arrivals);
00210 void (*chat_rename_user)(PurpleConversation *conv, const char *old_name,
00211 const char *new_name, const char *new_alias);
00216 void (*chat_remove_users)(PurpleConversation *conv, GList *users);
00220 void (*chat_update_user)(PurpleConversation *conv, const char *user);
00221
00225 void (*present)(PurpleConversation *conv);
00226
00231 gboolean (*has_focus)(PurpleConversation *conv);
00232
00233
00234 gboolean (*custom_smiley_add)(PurpleConversation *conv, const char *smile, gboolean remote);
00235 void (*custom_smiley_write)(PurpleConversation *conv, const char *smile,
00236 const guchar *data, gsize size);
00237 void (*custom_smiley_close)(PurpleConversation *conv, const char *smile);
00238
00244 void (*send_confirm)(PurpleConversation *conv, const char *message);
00245
00246 void (*_purple_reserved1)(void);
00247 void (*_purple_reserved2)(void);
00248 void (*_purple_reserved3)(void);
00249 void (*_purple_reserved4)(void);
00250 };
00251
00255 struct _PurpleConvIm
00256 {
00257 PurpleConversation *conv;
00259 PurpleTypingState typing_state;
00260 guint typing_timeout;
00261 time_t type_again;
00262 guint send_typed_timeout;
00264 PurpleBuddyIcon *icon;
00265 };
00266
00270 struct _PurpleConvChat
00271 {
00272 PurpleConversation *conv;
00274 GList *in_room;
00277 GList *ignored;
00278 char *who;
00279 char *topic;
00280 int id;
00281 char *nick;
00283 gboolean left;
00284 GHashTable *users;
00287 };
00288
00292 struct _PurpleConvChatBuddy
00293 {
00294 char *name;
00295 char *alias;
00298 char *alias_key;
00303 gboolean buddy;
00306 PurpleConvChatBuddyFlags flags;
00309 GHashTable *attributes;
00312 gpointer ui_data;
00313 };
00314
00320 struct _PurpleConvMessage
00321 {
00322 char *who;
00323 char *what;
00324 PurpleMessageFlags flags;
00325 time_t when;
00326 PurpleConversation *conv;
00327 char *alias;
00328 };
00329
00335 struct _PurpleConversation
00336 {
00337 PurpleConversationType type;
00339 PurpleAccount *account;
00342 char *name;
00343 char *title;
00345 gboolean logging;
00347 GList *logs;
00349 union
00350 {
00351 PurpleConvIm *im;
00352 PurpleConvChat *chat;
00353 void *misc;
00355 } u;
00356
00357 PurpleConversationUiOps *ui_ops;
00358 void *ui_data;
00360 GHashTable *data;
00362 PurpleConnectionFlags features;
00363 GList *message_history;
00364 };
00365
00366 #ifdef __cplusplus
00367 extern "C" {
00368 #endif
00369
00370
00372
00386 PurpleConversation *purple_conversation_new(PurpleConversationType type,
00387 PurpleAccount *account,
00388 const char *name);
00389
00399 void purple_conversation_destroy(PurpleConversation *conv);
00400
00401
00407 void purple_conversation_present(PurpleConversation *conv);
00408
00409
00417 PurpleConversationType purple_conversation_get_type(const PurpleConversation *conv);
00418
00425 void purple_conversation_set_ui_ops(PurpleConversation *conv,
00426 PurpleConversationUiOps *ops);
00427
00433 void purple_conversations_set_ui_ops(PurpleConversationUiOps *ops);
00434
00442 PurpleConversationUiOps *purple_conversation_get_ui_ops(
00443 const PurpleConversation *conv);
00444
00454 void purple_conversation_set_account(PurpleConversation *conv,
00455 PurpleAccount *account);
00456
00467 PurpleAccount *purple_conversation_get_account(const PurpleConversation *conv);
00468
00478 PurpleConnection *purple_conversation_get_gc(const PurpleConversation *conv);
00479
00486 void purple_conversation_set_title(PurpleConversation *conv, const char *title);
00487
00495 const char *purple_conversation_get_title(const PurpleConversation *conv);
00496
00505 void purple_conversation_autoset_title(PurpleConversation *conv);
00506
00513 void purple_conversation_set_name(PurpleConversation *conv, const char *name);
00514
00523 const char *purple_conversation_get_name(const PurpleConversation *conv);
00524
00533 const char *purple_conv_chat_cb_get_attribute(PurpleConvChatBuddy *cb, const char *key);
00534
00542 GList *purple_conv_chat_cb_get_attribute_keys(PurpleConvChatBuddy *cb);
00543
00552 void purple_conv_chat_cb_set_attribute(PurpleConvChat *chat, PurpleConvChatBuddy *cb, const char *key, const char *value);
00553
00562 void
00563 purple_conv_chat_cb_set_attributes(PurpleConvChat *chat, PurpleConvChatBuddy *cb, GList *keys, GList *values);
00564
00571 void purple_conversation_set_logging(PurpleConversation *conv, gboolean log);
00572
00580 gboolean purple_conversation_is_logging(const PurpleConversation *conv);
00581
00591 void purple_conversation_close_logs(PurpleConversation *conv);
00592
00602 PurpleConvIm *purple_conversation_get_im_data(const PurpleConversation *conv);
00603
00604 #define PURPLE_CONV_IM(c) (purple_conversation_get_im_data(c))
00605
00615 PurpleConvChat *purple_conversation_get_chat_data(const PurpleConversation *conv);
00616
00617 #define PURPLE_CONV_CHAT(c) (purple_conversation_get_chat_data(c))
00618
00626 void purple_conversation_set_data(PurpleConversation *conv, const char *key,
00627 gpointer data);
00628
00637 gpointer purple_conversation_get_data(PurpleConversation *conv, const char *key);
00638
00646 GList *purple_get_conversations(void);
00647
00653 GList *purple_get_ims(void);
00654
00660 GList *purple_get_chats(void);
00661
00671 PurpleConversation *purple_find_conversation_with_account(
00672 PurpleConversationType type, const char *name,
00673 const PurpleAccount *account);
00674
00695 void purple_conversation_write(PurpleConversation *conv, const char *who,
00696 const char *message, PurpleMessageFlags flags,
00697 time_t mtime);
00698
00704 void purple_conversation_set_features(PurpleConversation *conv,
00705 PurpleConnectionFlags features);
00706
00707
00712 PurpleConnectionFlags purple_conversation_get_features(PurpleConversation *conv);
00713
00722 gboolean purple_conversation_has_focus(PurpleConversation *conv);
00723
00730 void purple_conversation_update(PurpleConversation *conv, PurpleConvUpdateType type);
00731
00737 void purple_conversation_foreach(void (*func)(PurpleConversation *conv));
00738
00750 GList *purple_conversation_get_message_history(PurpleConversation *conv);
00751
00759 void purple_conversation_clear_message_history(PurpleConversation *conv);
00760
00770 const char *purple_conversation_message_get_sender(PurpleConvMessage *msg);
00771
00781 const char *purple_conversation_message_get_message(PurpleConvMessage *msg);
00782
00792 PurpleMessageFlags purple_conversation_message_get_flags(PurpleConvMessage *msg);
00793
00803 time_t purple_conversation_message_get_timestamp(PurpleConvMessage *msg);
00804
00808
00810
00820 PurpleConversation *purple_conv_im_get_conversation(const PurpleConvIm *im);
00821
00833 void purple_conv_im_set_icon(PurpleConvIm *im, PurpleBuddyIcon *icon);
00834
00842 PurpleBuddyIcon *purple_conv_im_get_icon(const PurpleConvIm *im);
00843
00850 void purple_conv_im_set_typing_state(PurpleConvIm *im, PurpleTypingState state);
00851
00859 PurpleTypingState purple_conv_im_get_typing_state(const PurpleConvIm *im);
00860
00867 void purple_conv_im_start_typing_timeout(PurpleConvIm *im, int timeout);
00868
00874 void purple_conv_im_stop_typing_timeout(PurpleConvIm *im);
00875
00883 guint purple_conv_im_get_typing_timeout(const PurpleConvIm *im);
00884
00896 void purple_conv_im_set_type_again(PurpleConvIm *im, unsigned int val);
00897
00906 time_t purple_conv_im_get_type_again(const PurpleConvIm *im);
00907
00913 void purple_conv_im_start_send_typed_timeout(PurpleConvIm *im);
00914
00920 void purple_conv_im_stop_send_typed_timeout(PurpleConvIm *im);
00921
00929 guint purple_conv_im_get_send_typed_timeout(const PurpleConvIm *im);
00930
00936 void purple_conv_im_update_typing(PurpleConvIm *im);
00937
00947 void purple_conv_im_write(PurpleConvIm *im, const char *who,
00948 const char *message, PurpleMessageFlags flags,
00949 time_t mtime);
00950
00964 gboolean purple_conv_present_error(const char *who, PurpleAccount *account, const char *what);
00965
00972 void purple_conv_im_send(PurpleConvIm *im, const char *message);
00973
00986 void purple_conv_send_confirm(PurpleConversation *conv, const char *message);
00987
00995 void purple_conv_im_send_with_flags(PurpleConvIm *im, const char *message, PurpleMessageFlags flags);
00996
01016 gboolean purple_conv_custom_smiley_add(PurpleConversation *conv, const char *smile,
01017 const char *cksum_type, const char *chksum,
01018 gboolean remote);
01019
01020
01030 void purple_conv_custom_smiley_write(PurpleConversation *conv,
01031 const char *smile,
01032 const guchar *data,
01033 gsize size);
01034
01044 void purple_conv_custom_smiley_close(PurpleConversation *conv, const char *smile);
01045
01049
01051
01061 PurpleConversation *purple_conv_chat_get_conversation(const PurpleConvChat *chat);
01062
01077 GList *purple_conv_chat_set_users(PurpleConvChat *chat, GList *users);
01078
01087 GList *purple_conv_chat_get_users(const PurpleConvChat *chat);
01088
01095 void purple_conv_chat_ignore(PurpleConvChat *chat, const char *name);
01096
01103 void purple_conv_chat_unignore(PurpleConvChat *chat, const char *name);
01104
01113 GList *purple_conv_chat_set_ignored(PurpleConvChat *chat, GList *ignored);
01114
01122 GList *purple_conv_chat_get_ignored(const PurpleConvChat *chat);
01123
01138 const char *purple_conv_chat_get_ignored_user(const PurpleConvChat *chat,
01139 const char *user);
01140
01149 gboolean purple_conv_chat_is_user_ignored(const PurpleConvChat *chat,
01150 const char *user);
01151
01159 void purple_conv_chat_set_topic(PurpleConvChat *chat, const char *who,
01160 const char *topic);
01161
01169 const char *purple_conv_chat_get_topic(const PurpleConvChat *chat);
01170
01177 void purple_conv_chat_set_id(PurpleConvChat *chat, int id);
01178
01186 int purple_conv_chat_get_id(const PurpleConvChat *chat);
01187
01197 void purple_conv_chat_write(PurpleConvChat *chat, const char *who,
01198 const char *message, PurpleMessageFlags flags,
01199 time_t mtime);
01200
01207 void purple_conv_chat_send(PurpleConvChat *chat, const char *message);
01208
01216 void purple_conv_chat_send_with_flags(PurpleConvChat *chat, const char *message, PurpleMessageFlags flags);
01217
01227 void purple_conv_chat_add_user(PurpleConvChat *chat, const char *user,
01228 const char *extra_msg, PurpleConvChatBuddyFlags flags,
01229 gboolean new_arrival);
01230
01248 void purple_conv_chat_add_users(PurpleConvChat *chat, GList *users, GList *extra_msgs,
01249 GList *flags, gboolean new_arrivals);
01250
01258 void purple_conv_chat_rename_user(PurpleConvChat *chat, const char *old_user,
01259 const char *new_user);
01260
01270 void purple_conv_chat_remove_user(PurpleConvChat *chat, const char *user,
01271 const char *reason);
01272
01280 void purple_conv_chat_remove_users(PurpleConvChat *chat, GList *users,
01281 const char *reason);
01282
01291 gboolean purple_conv_chat_find_user(PurpleConvChat *chat, const char *user);
01292
01300 void purple_conv_chat_user_set_flags(PurpleConvChat *chat, const char *user,
01301 PurpleConvChatBuddyFlags flags);
01302
01311 PurpleConvChatBuddyFlags purple_conv_chat_user_get_flags(PurpleConvChat *chat,
01312 const char *user);
01313
01319 void purple_conv_chat_clear_users(PurpleConvChat *chat);
01320
01327 void purple_conv_chat_set_nick(PurpleConvChat *chat, const char *nick);
01328
01335 const char *purple_conv_chat_get_nick(PurpleConvChat *chat);
01336
01345 PurpleConversation *purple_find_chat(const PurpleConnection *gc, int id);
01346
01353 void purple_conv_chat_left(PurpleConvChat *chat);
01354
01368 void purple_conv_chat_invite_user(PurpleConvChat *chat, const char *user,
01369 const char *message, gboolean confirm);
01370
01380 gboolean purple_conv_chat_has_left(PurpleConvChat *chat);
01381
01391 PurpleConvChatBuddy *purple_conv_chat_cb_new(const char *name, const char *alias,
01392 PurpleConvChatBuddyFlags flags);
01393
01400 PurpleConvChatBuddy *purple_conv_chat_cb_find(PurpleConvChat *chat, const char *name);
01401
01409 const char *purple_conv_chat_cb_get_name(PurpleConvChatBuddy *cb);
01410
01416 void purple_conv_chat_cb_destroy(PurpleConvChatBuddy *cb);
01417
01429 GList * purple_conversation_get_extended_menu(PurpleConversation *conv);
01430
01444 gboolean purple_conversation_do_command(PurpleConversation *conv, const gchar *cmdline, const gchar *markup, gchar **error);
01445
01448
01450
01458 void *purple_conversations_get_handle(void);
01459
01463 void purple_conversations_init(void);
01464
01468 void purple_conversations_uninit(void);
01469
01472 #ifdef __cplusplus
01473 }
01474 #endif
01475
01476 #endif