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 PURPLE_MESSAGE_REMOTE_SEND = 0x10000
00133 } PurpleMessageFlags;
00134
00138 typedef enum
00139 {
00140 PURPLE_CBFLAGS_NONE = 0x0000,
00141 PURPLE_CBFLAGS_VOICE = 0x0001,
00142 PURPLE_CBFLAGS_HALFOP = 0x0002,
00143 PURPLE_CBFLAGS_OP = 0x0004,
00144 PURPLE_CBFLAGS_FOUNDER = 0x0008,
00145 PURPLE_CBFLAGS_TYPING = 0x0010,
00146 PURPLE_CBFLAGS_AWAY = 0x0020
00148 } PurpleConvChatBuddyFlags;
00149
00150 #include "account.h"
00151 #include "buddyicon.h"
00152 #include "log.h"
00153 #include "server.h"
00154
00161 struct _PurpleConversationUiOps
00162 {
00166 void (*create_conversation)(PurpleConversation *conv);
00167
00169 void (*destroy_conversation)(PurpleConversation *conv);
00174 void (*write_chat)(PurpleConversation *conv, const char *who,
00175 const char *message, PurpleMessageFlags flags,
00176 time_t mtime);
00181 void (*write_im)(PurpleConversation *conv, const char *who,
00182 const char *message, PurpleMessageFlags flags,
00183 time_t mtime);
00192 void (*write_conv)(PurpleConversation *conv,
00193 const char *name,
00194 const char *alias,
00195 const char *message,
00196 PurpleMessageFlags flags,
00197 time_t mtime);
00198
00205 void (*chat_add_users)(PurpleConversation *conv,
00206 GList *cbuddies,
00207 gboolean new_arrivals);
00213 void (*chat_rename_user)(PurpleConversation *conv, const char *old_name,
00214 const char *new_name, const char *new_alias);
00219 void (*chat_remove_users)(PurpleConversation *conv, GList *users);
00223 void (*chat_update_user)(PurpleConversation *conv, const char *user);
00224
00228 void (*present)(PurpleConversation *conv);
00229
00234 gboolean (*has_focus)(PurpleConversation *conv);
00235
00236
00237 gboolean (*custom_smiley_add)(PurpleConversation *conv, const char *smile, gboolean remote);
00238 void (*custom_smiley_write)(PurpleConversation *conv, const char *smile,
00239 const guchar *data, gsize size);
00240 void (*custom_smiley_close)(PurpleConversation *conv, const char *smile);
00241
00247 void (*send_confirm)(PurpleConversation *conv, const char *message);
00248
00249 void (*_purple_reserved1)(void);
00250 void (*_purple_reserved2)(void);
00251 void (*_purple_reserved3)(void);
00252 void (*_purple_reserved4)(void);
00253 };
00254
00258 struct _PurpleConvIm
00259 {
00260 PurpleConversation *conv;
00262 PurpleTypingState typing_state;
00263 guint typing_timeout;
00264 time_t type_again;
00265 guint send_typed_timeout;
00267 PurpleBuddyIcon *icon;
00268 };
00269
00273 struct _PurpleConvChat
00274 {
00275 PurpleConversation *conv;
00277 GList *in_room;
00280 GList *ignored;
00281 char *who;
00282 char *topic;
00283 int id;
00284 char *nick;
00286 gboolean left;
00287 GHashTable *users;
00290 };
00291
00295 struct _PurpleConvChatBuddy
00296 {
00297 char *name;
00298 char *alias;
00301 char *alias_key;
00306 gboolean buddy;
00309 PurpleConvChatBuddyFlags flags;
00312 GHashTable *attributes;
00315 gpointer ui_data;
00316 };
00317
00323 struct _PurpleConvMessage
00324 {
00325 char *who;
00326 char *what;
00327 PurpleMessageFlags flags;
00328 time_t when;
00329 PurpleConversation *conv;
00330 char *alias;
00331 };
00332
00338 struct _PurpleConversation
00339 {
00340 PurpleConversationType type;
00342 PurpleAccount *account;
00345 char *name;
00346 char *title;
00348 gboolean logging;
00350 GList *logs;
00352 union
00353 {
00354 PurpleConvIm *im;
00355 PurpleConvChat *chat;
00356 void *misc;
00358 } u;
00359
00360 PurpleConversationUiOps *ui_ops;
00361 void *ui_data;
00363 GHashTable *data;
00365 PurpleConnectionFlags features;
00366 GList *message_history;
00367 };
00368
00369 #ifdef __cplusplus
00370 extern "C" {
00371 #endif
00372
00373
00375
00389 PurpleConversation *purple_conversation_new(PurpleConversationType type,
00390 PurpleAccount *account,
00391 const char *name);
00392
00402 void purple_conversation_destroy(PurpleConversation *conv);
00403
00404
00410 void purple_conversation_present(PurpleConversation *conv);
00411
00412
00420 PurpleConversationType purple_conversation_get_type(const PurpleConversation *conv);
00421
00428 void purple_conversation_set_ui_ops(PurpleConversation *conv,
00429 PurpleConversationUiOps *ops);
00430
00436 void purple_conversations_set_ui_ops(PurpleConversationUiOps *ops);
00437
00445 PurpleConversationUiOps *purple_conversation_get_ui_ops(
00446 const PurpleConversation *conv);
00447
00457 void purple_conversation_set_account(PurpleConversation *conv,
00458 PurpleAccount *account);
00459
00470 PurpleAccount *purple_conversation_get_account(const PurpleConversation *conv);
00471
00481 PurpleConnection *purple_conversation_get_gc(const PurpleConversation *conv);
00482
00489 void purple_conversation_set_title(PurpleConversation *conv, const char *title);
00490
00498 const char *purple_conversation_get_title(const PurpleConversation *conv);
00499
00508 void purple_conversation_autoset_title(PurpleConversation *conv);
00509
00516 void purple_conversation_set_name(PurpleConversation *conv, const char *name);
00517
00526 const char *purple_conversation_get_name(const PurpleConversation *conv);
00527
00536 const char *purple_conv_chat_cb_get_attribute(PurpleConvChatBuddy *cb, const char *key);
00537
00545 GList *purple_conv_chat_cb_get_attribute_keys(PurpleConvChatBuddy *cb);
00546
00555 void purple_conv_chat_cb_set_attribute(PurpleConvChat *chat, PurpleConvChatBuddy *cb, const char *key, const char *value);
00556
00565 void
00566 purple_conv_chat_cb_set_attributes(PurpleConvChat *chat, PurpleConvChatBuddy *cb, GList *keys, GList *values);
00567
00574 void purple_conversation_set_logging(PurpleConversation *conv, gboolean log);
00575
00583 gboolean purple_conversation_is_logging(const PurpleConversation *conv);
00584
00594 void purple_conversation_close_logs(PurpleConversation *conv);
00595
00605 PurpleConvIm *purple_conversation_get_im_data(const PurpleConversation *conv);
00606
00607 #define PURPLE_CONV_IM(c) (purple_conversation_get_im_data(c))
00608
00618 PurpleConvChat *purple_conversation_get_chat_data(const PurpleConversation *conv);
00619
00620 #define PURPLE_CONV_CHAT(c) (purple_conversation_get_chat_data(c))
00621
00629 void purple_conversation_set_data(PurpleConversation *conv, const char *key,
00630 gpointer data);
00631
00640 gpointer purple_conversation_get_data(PurpleConversation *conv, const char *key);
00641
00649 GList *purple_get_conversations(void);
00650
00656 GList *purple_get_ims(void);
00657
00663 GList *purple_get_chats(void);
00664
00674 PurpleConversation *purple_find_conversation_with_account(
00675 PurpleConversationType type, const char *name,
00676 const PurpleAccount *account);
00677
00698 void purple_conversation_write(PurpleConversation *conv, const char *who,
00699 const char *message, PurpleMessageFlags flags,
00700 time_t mtime);
00701
00707 void purple_conversation_set_features(PurpleConversation *conv,
00708 PurpleConnectionFlags features);
00709
00710
00715 PurpleConnectionFlags purple_conversation_get_features(PurpleConversation *conv);
00716
00725 gboolean purple_conversation_has_focus(PurpleConversation *conv);
00726
00733 void purple_conversation_update(PurpleConversation *conv, PurpleConvUpdateType type);
00734
00740 void purple_conversation_foreach(void (*func)(PurpleConversation *conv));
00741
00753 GList *purple_conversation_get_message_history(PurpleConversation *conv);
00754
00762 void purple_conversation_clear_message_history(PurpleConversation *conv);
00763
00773 const char *purple_conversation_message_get_sender(PurpleConvMessage *msg);
00774
00784 const char *purple_conversation_message_get_message(PurpleConvMessage *msg);
00785
00795 PurpleMessageFlags purple_conversation_message_get_flags(PurpleConvMessage *msg);
00796
00806 time_t purple_conversation_message_get_timestamp(PurpleConvMessage *msg);
00807
00811
00813
00823 PurpleConversation *purple_conv_im_get_conversation(const PurpleConvIm *im);
00824
00836 void purple_conv_im_set_icon(PurpleConvIm *im, PurpleBuddyIcon *icon);
00837
00845 PurpleBuddyIcon *purple_conv_im_get_icon(const PurpleConvIm *im);
00846
00853 void purple_conv_im_set_typing_state(PurpleConvIm *im, PurpleTypingState state);
00854
00862 PurpleTypingState purple_conv_im_get_typing_state(const PurpleConvIm *im);
00863
00870 void purple_conv_im_start_typing_timeout(PurpleConvIm *im, int timeout);
00871
00877 void purple_conv_im_stop_typing_timeout(PurpleConvIm *im);
00878
00886 guint purple_conv_im_get_typing_timeout(const PurpleConvIm *im);
00887
00898 void purple_conv_im_set_type_again(PurpleConvIm *im, unsigned int val);
00899
00908 time_t purple_conv_im_get_type_again(const PurpleConvIm *im);
00909
00915 void purple_conv_im_start_send_typed_timeout(PurpleConvIm *im);
00916
00922 void purple_conv_im_stop_send_typed_timeout(PurpleConvIm *im);
00923
00931 guint purple_conv_im_get_send_typed_timeout(const PurpleConvIm *im);
00932
00938 void purple_conv_im_update_typing(PurpleConvIm *im);
00939
00949 void purple_conv_im_write(PurpleConvIm *im, const char *who,
00950 const char *message, PurpleMessageFlags flags,
00951 time_t mtime);
00952
00966 gboolean purple_conv_present_error(const char *who, PurpleAccount *account, const char *what);
00967
00974 void purple_conv_im_send(PurpleConvIm *im, const char *message);
00975
00988 void purple_conv_send_confirm(PurpleConversation *conv, const char *message);
00989
00997 void purple_conv_im_send_with_flags(PurpleConvIm *im, const char *message, PurpleMessageFlags flags);
00998
01018 gboolean purple_conv_custom_smiley_add(PurpleConversation *conv, const char *smile,
01019 const char *cksum_type, const char *chksum,
01020 gboolean remote);
01021
01022
01032 void purple_conv_custom_smiley_write(PurpleConversation *conv,
01033 const char *smile,
01034 const guchar *data,
01035 gsize size);
01036
01046 void purple_conv_custom_smiley_close(PurpleConversation *conv, const char *smile);
01047
01051
01053
01063 PurpleConversation *purple_conv_chat_get_conversation(const PurpleConvChat *chat);
01064
01079 GList *purple_conv_chat_set_users(PurpleConvChat *chat, GList *users);
01080
01089 GList *purple_conv_chat_get_users(const PurpleConvChat *chat);
01090
01097 void purple_conv_chat_ignore(PurpleConvChat *chat, const char *name);
01098
01105 void purple_conv_chat_unignore(PurpleConvChat *chat, const char *name);
01106
01115 GList *purple_conv_chat_set_ignored(PurpleConvChat *chat, GList *ignored);
01116
01124 GList *purple_conv_chat_get_ignored(const PurpleConvChat *chat);
01125
01140 const char *purple_conv_chat_get_ignored_user(const PurpleConvChat *chat,
01141 const char *user);
01142
01151 gboolean purple_conv_chat_is_user_ignored(const PurpleConvChat *chat,
01152 const char *user);
01153
01161 void purple_conv_chat_set_topic(PurpleConvChat *chat, const char *who,
01162 const char *topic);
01163
01171 const char *purple_conv_chat_get_topic(const PurpleConvChat *chat);
01172
01179 void purple_conv_chat_set_id(PurpleConvChat *chat, int id);
01180
01188 int purple_conv_chat_get_id(const PurpleConvChat *chat);
01189
01199 void purple_conv_chat_write(PurpleConvChat *chat, const char *who,
01200 const char *message, PurpleMessageFlags flags,
01201 time_t mtime);
01202
01209 void purple_conv_chat_send(PurpleConvChat *chat, const char *message);
01210
01218 void purple_conv_chat_send_with_flags(PurpleConvChat *chat, const char *message, PurpleMessageFlags flags);
01219
01229 void purple_conv_chat_add_user(PurpleConvChat *chat, const char *user,
01230 const char *extra_msg, PurpleConvChatBuddyFlags flags,
01231 gboolean new_arrival);
01232
01250 void purple_conv_chat_add_users(PurpleConvChat *chat, GList *users, GList *extra_msgs,
01251 GList *flags, gboolean new_arrivals);
01252
01260 void purple_conv_chat_rename_user(PurpleConvChat *chat, const char *old_user,
01261 const char *new_user);
01262
01272 void purple_conv_chat_remove_user(PurpleConvChat *chat, const char *user,
01273 const char *reason);
01274
01282 void purple_conv_chat_remove_users(PurpleConvChat *chat, GList *users,
01283 const char *reason);
01284
01293 gboolean purple_conv_chat_find_user(PurpleConvChat *chat, const char *user);
01294
01302 void purple_conv_chat_user_set_flags(PurpleConvChat *chat, const char *user,
01303 PurpleConvChatBuddyFlags flags);
01304
01313 PurpleConvChatBuddyFlags purple_conv_chat_user_get_flags(PurpleConvChat *chat,
01314 const char *user);
01315
01321 void purple_conv_chat_clear_users(PurpleConvChat *chat);
01322
01329 void purple_conv_chat_set_nick(PurpleConvChat *chat, const char *nick);
01330
01337 const char *purple_conv_chat_get_nick(PurpleConvChat *chat);
01338
01347 PurpleConversation *purple_find_chat(const PurpleConnection *gc, int id);
01348
01355 void purple_conv_chat_left(PurpleConvChat *chat);
01356
01370 void purple_conv_chat_invite_user(PurpleConvChat *chat, const char *user,
01371 const char *message, gboolean confirm);
01372
01382 gboolean purple_conv_chat_has_left(PurpleConvChat *chat);
01383
01393 PurpleConvChatBuddy *purple_conv_chat_cb_new(const char *name, const char *alias,
01394 PurpleConvChatBuddyFlags flags);
01395
01402 PurpleConvChatBuddy *purple_conv_chat_cb_find(PurpleConvChat *chat, const char *name);
01403
01411 const char *purple_conv_chat_cb_get_name(PurpleConvChatBuddy *cb);
01412
01418 void purple_conv_chat_cb_destroy(PurpleConvChatBuddy *cb);
01419
01431 GList * purple_conversation_get_extended_menu(PurpleConversation *conv);
01432
01446 gboolean purple_conversation_do_command(PurpleConversation *conv, const gchar *cmdline, const gchar *markup, gchar **error);
01447
01450
01452
01460 void *purple_conversations_get_handle(void);
01461
01465 void purple_conversations_init(void);
01466
01470 void purple_conversations_uninit(void);
01471
01474 #ifdef __cplusplus
01475 }
01476 #endif
01477
01478 #endif