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
00144 } PurpleConvChatBuddyFlags;
00145
00146 #include "account.h"
00147 #include "buddyicon.h"
00148 #include "log.h"
00149 #include "server.h"
00150
00157 struct _PurpleConversationUiOps
00158 {
00162 void (*create_conversation)(PurpleConversation *conv);
00163
00165 void (*destroy_conversation)(PurpleConversation *conv);
00170 void (*write_chat)(PurpleConversation *conv, const char *who,
00171 const char *message, PurpleMessageFlags flags,
00172 time_t mtime);
00177 void (*write_im)(PurpleConversation *conv, const char *who,
00178 const char *message, PurpleMessageFlags flags,
00179 time_t mtime);
00188 void (*write_conv)(PurpleConversation *conv,
00189 const char *name,
00190 const char *alias,
00191 const char *message,
00192 PurpleMessageFlags flags,
00193 time_t mtime);
00194
00201 void (*chat_add_users)(PurpleConversation *conv,
00202 GList *cbuddies,
00203 gboolean new_arrivals);
00209 void (*chat_rename_user)(PurpleConversation *conv, const char *old_name,
00210 const char *new_name, const char *new_alias);
00215 void (*chat_remove_users)(PurpleConversation *conv, GList *users);
00219 void (*chat_update_user)(PurpleConversation *conv, const char *user);
00220
00224 void (*present)(PurpleConversation *conv);
00225
00230 gboolean (*has_focus)(PurpleConversation *conv);
00231
00232
00233 gboolean (*custom_smiley_add)(PurpleConversation *conv, const char *smile, gboolean remote);
00234 void (*custom_smiley_write)(PurpleConversation *conv, const char *smile,
00235 const guchar *data, gsize size);
00236 void (*custom_smiley_close)(PurpleConversation *conv, const char *smile);
00237
00243 void (*send_confirm)(PurpleConversation *conv, const char *message);
00244
00245 void (*_purple_reserved1)(void);
00246 void (*_purple_reserved2)(void);
00247 void (*_purple_reserved3)(void);
00248 void (*_purple_reserved4)(void);
00249 };
00250
00254 struct _PurpleConvIm
00255 {
00256 PurpleConversation *conv;
00258 PurpleTypingState typing_state;
00259 guint typing_timeout;
00260 time_t type_again;
00261 guint send_typed_timeout;
00263 PurpleBuddyIcon *icon;
00264 };
00265
00269 struct _PurpleConvChat
00270 {
00271 PurpleConversation *conv;
00273 GList *in_room;
00274 GList *ignored;
00275 char *who;
00276 char *topic;
00277 int id;
00278 char *nick;
00280 gboolean left;
00281 };
00282
00286 struct _PurpleConvChatBuddy
00287 {
00288 char *name;
00289 char *alias;
00292 char *alias_key;
00297 gboolean buddy;
00300 PurpleConvChatBuddyFlags flags;
00303 };
00304
00310 struct _PurpleConvMessage
00311 {
00312 char *who;
00313 char *what;
00314 PurpleMessageFlags flags;
00315 time_t when;
00316 PurpleConversation *conv;
00317 char *alias;
00318 };
00319
00325 struct _PurpleConversation
00326 {
00327 PurpleConversationType type;
00329 PurpleAccount *account;
00332 char *name;
00333 char *title;
00335 gboolean logging;
00337 GList *logs;
00339 union
00340 {
00341 PurpleConvIm *im;
00342 PurpleConvChat *chat;
00343 void *misc;
00345 } u;
00346
00347 PurpleConversationUiOps *ui_ops;
00348 void *ui_data;
00350 GHashTable *data;
00352 PurpleConnectionFlags features;
00353 GList *message_history;
00354 };
00355
00356 #ifdef __cplusplus
00357 extern "C" {
00358 #endif
00359
00360
00362
00376 PurpleConversation *purple_conversation_new(PurpleConversationType type,
00377 PurpleAccount *account,
00378 const char *name);
00379
00389 void purple_conversation_destroy(PurpleConversation *conv);
00390
00391
00397 void purple_conversation_present(PurpleConversation *conv);
00398
00399
00407 PurpleConversationType purple_conversation_get_type(const PurpleConversation *conv);
00408
00415 void purple_conversation_set_ui_ops(PurpleConversation *conv,
00416 PurpleConversationUiOps *ops);
00417
00423 void purple_conversations_set_ui_ops(PurpleConversationUiOps *ops);
00424
00432 PurpleConversationUiOps *purple_conversation_get_ui_ops(
00433 const PurpleConversation *conv);
00434
00444 void purple_conversation_set_account(PurpleConversation *conv,
00445 PurpleAccount *account);
00446
00457 PurpleAccount *purple_conversation_get_account(const PurpleConversation *conv);
00458
00468 PurpleConnection *purple_conversation_get_gc(const PurpleConversation *conv);
00469
00476 void purple_conversation_set_title(PurpleConversation *conv, const char *title);
00477
00485 const char *purple_conversation_get_title(const PurpleConversation *conv);
00486
00495 void purple_conversation_autoset_title(PurpleConversation *conv);
00496
00503 void purple_conversation_set_name(PurpleConversation *conv, const char *name);
00504
00513 const char *purple_conversation_get_name(const PurpleConversation *conv);
00514
00521 void purple_conversation_set_logging(PurpleConversation *conv, gboolean log);
00522
00530 gboolean purple_conversation_is_logging(const PurpleConversation *conv);
00531
00541 void purple_conversation_close_logs(PurpleConversation *conv);
00542
00552 PurpleConvIm *purple_conversation_get_im_data(const PurpleConversation *conv);
00553
00554 #define PURPLE_CONV_IM(c) (purple_conversation_get_im_data(c))
00555
00565 PurpleConvChat *purple_conversation_get_chat_data(const PurpleConversation *conv);
00566
00567 #define PURPLE_CONV_CHAT(c) (purple_conversation_get_chat_data(c))
00568
00576 void purple_conversation_set_data(PurpleConversation *conv, const char *key,
00577 gpointer data);
00578
00587 gpointer purple_conversation_get_data(PurpleConversation *conv, const char *key);
00588
00596 GList *purple_get_conversations(void);
00597
00603 GList *purple_get_ims(void);
00604
00610 GList *purple_get_chats(void);
00611
00621 PurpleConversation *purple_find_conversation_with_account(
00622 PurpleConversationType type, const char *name,
00623 const PurpleAccount *account);
00624
00645 void purple_conversation_write(PurpleConversation *conv, const char *who,
00646 const char *message, PurpleMessageFlags flags,
00647 time_t mtime);
00648
00654 void purple_conversation_set_features(PurpleConversation *conv,
00655 PurpleConnectionFlags features);
00656
00657
00662 PurpleConnectionFlags purple_conversation_get_features(PurpleConversation *conv);
00663
00672 gboolean purple_conversation_has_focus(PurpleConversation *conv);
00673
00680 void purple_conversation_update(PurpleConversation *conv, PurpleConvUpdateType type);
00681
00687 void purple_conversation_foreach(void (*func)(PurpleConversation *conv));
00688
00700 GList *purple_conversation_get_message_history(PurpleConversation *conv);
00701
00709 void purple_conversation_clear_message_history(PurpleConversation *conv);
00710
00720 const char *purple_conversation_message_get_sender(PurpleConvMessage *msg);
00721
00731 const char *purple_conversation_message_get_message(PurpleConvMessage *msg);
00732
00742 PurpleMessageFlags purple_conversation_message_get_flags(PurpleConvMessage *msg);
00743
00753 time_t purple_conversation_message_get_timestamp(PurpleConvMessage *msg);
00754
00758
00760
00770 PurpleConversation *purple_conv_im_get_conversation(const PurpleConvIm *im);
00771
00783 void purple_conv_im_set_icon(PurpleConvIm *im, PurpleBuddyIcon *icon);
00784
00792 PurpleBuddyIcon *purple_conv_im_get_icon(const PurpleConvIm *im);
00793
00800 void purple_conv_im_set_typing_state(PurpleConvIm *im, PurpleTypingState state);
00801
00809 PurpleTypingState purple_conv_im_get_typing_state(const PurpleConvIm *im);
00810
00817 void purple_conv_im_start_typing_timeout(PurpleConvIm *im, int timeout);
00818
00824 void purple_conv_im_stop_typing_timeout(PurpleConvIm *im);
00825
00833 guint purple_conv_im_get_typing_timeout(const PurpleConvIm *im);
00834
00846 void purple_conv_im_set_type_again(PurpleConvIm *im, unsigned int val);
00847
00856 time_t purple_conv_im_get_type_again(const PurpleConvIm *im);
00857
00863 void purple_conv_im_start_send_typed_timeout(PurpleConvIm *im);
00864
00870 void purple_conv_im_stop_send_typed_timeout(PurpleConvIm *im);
00871
00879 guint purple_conv_im_get_send_typed_timeout(const PurpleConvIm *im);
00880
00886 void purple_conv_im_update_typing(PurpleConvIm *im);
00887
00897 void purple_conv_im_write(PurpleConvIm *im, const char *who,
00898 const char *message, PurpleMessageFlags flags,
00899 time_t mtime);
00900
00914 gboolean purple_conv_present_error(const char *who, PurpleAccount *account, const char *what);
00915
00922 void purple_conv_im_send(PurpleConvIm *im, const char *message);
00923
00936 void purple_conv_send_confirm(PurpleConversation *conv, const char *message);
00937
00945 void purple_conv_im_send_with_flags(PurpleConvIm *im, const char *message, PurpleMessageFlags flags);
00946
00966 gboolean purple_conv_custom_smiley_add(PurpleConversation *conv, const char *smile,
00967 const char *cksum_type, const char *chksum,
00968 gboolean remote);
00969
00970
00980 void purple_conv_custom_smiley_write(PurpleConversation *conv,
00981 const char *smile,
00982 const guchar *data,
00983 gsize size);
00984
00994 void purple_conv_custom_smiley_close(PurpleConversation *conv, const char *smile);
00995
00999
01001
01011 PurpleConversation *purple_conv_chat_get_conversation(const PurpleConvChat *chat);
01012
01025 GList *purple_conv_chat_set_users(PurpleConvChat *chat, GList *users);
01026
01035 GList *purple_conv_chat_get_users(const PurpleConvChat *chat);
01036
01043 void purple_conv_chat_ignore(PurpleConvChat *chat, const char *name);
01044
01051 void purple_conv_chat_unignore(PurpleConvChat *chat, const char *name);
01052
01061 GList *purple_conv_chat_set_ignored(PurpleConvChat *chat, GList *ignored);
01062
01070 GList *purple_conv_chat_get_ignored(const PurpleConvChat *chat);
01071
01086 const char *purple_conv_chat_get_ignored_user(const PurpleConvChat *chat,
01087 const char *user);
01088
01097 gboolean purple_conv_chat_is_user_ignored(const PurpleConvChat *chat,
01098 const char *user);
01099
01107 void purple_conv_chat_set_topic(PurpleConvChat *chat, const char *who,
01108 const char *topic);
01109
01117 const char *purple_conv_chat_get_topic(const PurpleConvChat *chat);
01118
01125 void purple_conv_chat_set_id(PurpleConvChat *chat, int id);
01126
01134 int purple_conv_chat_get_id(const PurpleConvChat *chat);
01135
01145 void purple_conv_chat_write(PurpleConvChat *chat, const char *who,
01146 const char *message, PurpleMessageFlags flags,
01147 time_t mtime);
01148
01155 void purple_conv_chat_send(PurpleConvChat *chat, const char *message);
01156
01164 void purple_conv_chat_send_with_flags(PurpleConvChat *chat, const char *message, PurpleMessageFlags flags);
01165
01175 void purple_conv_chat_add_user(PurpleConvChat *chat, const char *user,
01176 const char *extra_msg, PurpleConvChatBuddyFlags flags,
01177 gboolean new_arrival);
01178
01196 void purple_conv_chat_add_users(PurpleConvChat *chat, GList *users, GList *extra_msgs,
01197 GList *flags, gboolean new_arrivals);
01198
01206 void purple_conv_chat_rename_user(PurpleConvChat *chat, const char *old_user,
01207 const char *new_user);
01208
01218 void purple_conv_chat_remove_user(PurpleConvChat *chat, const char *user,
01219 const char *reason);
01220
01228 void purple_conv_chat_remove_users(PurpleConvChat *chat, GList *users,
01229 const char *reason);
01230
01239 gboolean purple_conv_chat_find_user(PurpleConvChat *chat, const char *user);
01240
01248 void purple_conv_chat_user_set_flags(PurpleConvChat *chat, const char *user,
01249 PurpleConvChatBuddyFlags flags);
01250
01259 PurpleConvChatBuddyFlags purple_conv_chat_user_get_flags(PurpleConvChat *chat,
01260 const char *user);
01261
01267 void purple_conv_chat_clear_users(PurpleConvChat *chat);
01268
01275 void purple_conv_chat_set_nick(PurpleConvChat *chat, const char *nick);
01276
01283 const char *purple_conv_chat_get_nick(PurpleConvChat *chat);
01284
01293 PurpleConversation *purple_find_chat(const PurpleConnection *gc, int id);
01294
01301 void purple_conv_chat_left(PurpleConvChat *chat);
01302
01316 void purple_conv_chat_invite_user(PurpleConvChat *chat, const char *user,
01317 const char *message, gboolean confirm);
01318
01328 gboolean purple_conv_chat_has_left(PurpleConvChat *chat);
01329
01339 PurpleConvChatBuddy *purple_conv_chat_cb_new(const char *name, const char *alias,
01340 PurpleConvChatBuddyFlags flags);
01341
01348 PurpleConvChatBuddy *purple_conv_chat_cb_find(PurpleConvChat *chat, const char *name);
01349
01357 const char *purple_conv_chat_cb_get_name(PurpleConvChatBuddy *cb);
01358
01364 void purple_conv_chat_cb_destroy(PurpleConvChatBuddy *cb);
01365
01377 GList * purple_conversation_get_extended_menu(PurpleConversation *conv);
01378
01392 gboolean purple_conversation_do_command(PurpleConversation *conv, const gchar *cmdline, const gchar *markup, gchar **error);
01393
01396
01398
01406 void *purple_conversations_get_handle(void);
01407
01411 void purple_conversations_init(void);
01412
01416 void purple_conversations_uninit(void);
01417
01420 #ifdef __cplusplus
01421 }
01422 #endif
01423
01424 #endif