00001
00027 #ifndef _PURPLE_CONVERSATION_H_
00028 #define _PURPLE_CONVERSATION_H_
00029
00030
00032
00033
00034
00035 typedef struct _PurpleConversationUiOps PurpleConversationUiOps;
00036 typedef struct _PurpleConversation PurpleConversation;
00037 typedef struct _PurpleConvIm PurpleConvIm;
00038 typedef struct _PurpleConvChat PurpleConvChat;
00039 typedef struct _PurpleConvChatBuddy PurpleConvChatBuddy;
00040
00044 typedef enum
00045 {
00046 PURPLE_CONV_TYPE_UNKNOWN = 0,
00047 PURPLE_CONV_TYPE_IM,
00048 PURPLE_CONV_TYPE_CHAT,
00049 PURPLE_CONV_TYPE_MISC,
00050 PURPLE_CONV_TYPE_ANY
00052 } PurpleConversationType;
00053
00057 typedef enum
00058 {
00059 PURPLE_CONV_UPDATE_ADD = 0,
00061 PURPLE_CONV_UPDATE_REMOVE,
00063 PURPLE_CONV_UPDATE_ACCOUNT,
00064 PURPLE_CONV_UPDATE_TYPING,
00065 PURPLE_CONV_UPDATE_UNSEEN,
00066 PURPLE_CONV_UPDATE_LOGGING,
00068 PURPLE_CONV_UPDATE_TOPIC,
00069
00070
00071
00072
00073 PURPLE_CONV_ACCOUNT_ONLINE,
00074 PURPLE_CONV_ACCOUNT_OFFLINE,
00075 PURPLE_CONV_UPDATE_AWAY,
00076 PURPLE_CONV_UPDATE_ICON,
00077 PURPLE_CONV_UPDATE_TITLE,
00078 PURPLE_CONV_UPDATE_CHATLEFT,
00079
00080 PURPLE_CONV_UPDATE_FEATURES,
00082 } PurpleConvUpdateType;
00083
00087 typedef enum
00088 {
00089 PURPLE_NOT_TYPING = 0,
00090 PURPLE_TYPING,
00091 PURPLE_TYPED
00093 } PurpleTypingState;
00094
00098 typedef enum
00099 {
00100 PURPLE_MESSAGE_SEND = 0x0001,
00101 PURPLE_MESSAGE_RECV = 0x0002,
00102 PURPLE_MESSAGE_SYSTEM = 0x0004,
00103 PURPLE_MESSAGE_AUTO_RESP = 0x0008,
00104 PURPLE_MESSAGE_ACTIVE_ONLY = 0x0010,
00111 PURPLE_MESSAGE_NICK = 0x0020,
00112 PURPLE_MESSAGE_NO_LOG = 0x0040,
00113 PURPLE_MESSAGE_WHISPER = 0x0080,
00114 PURPLE_MESSAGE_ERROR = 0x0200,
00115 PURPLE_MESSAGE_DELAYED = 0x0400,
00116 PURPLE_MESSAGE_RAW = 0x0800,
00118 PURPLE_MESSAGE_IMAGES = 0x1000,
00119 PURPLE_MESSAGE_NOTIFY = 0x2000,
00120 PURPLE_MESSAGE_NO_LINKIFY = 0x4000
00123 } PurpleMessageFlags;
00124
00128 typedef enum
00129 {
00130 PURPLE_CBFLAGS_NONE = 0x0000,
00131 PURPLE_CBFLAGS_VOICE = 0x0001,
00132 PURPLE_CBFLAGS_HALFOP = 0x0002,
00133 PURPLE_CBFLAGS_OP = 0x0004,
00134 PURPLE_CBFLAGS_FOUNDER = 0x0008,
00135 PURPLE_CBFLAGS_TYPING = 0x0010,
00137 } PurpleConvChatBuddyFlags;
00138
00139 #include "account.h"
00140 #include "buddyicon.h"
00141 #include "log.h"
00142 #include "server.h"
00143
00150 struct _PurpleConversationUiOps
00151 {
00155 void (*create_conversation)(PurpleConversation *conv);
00156
00158 void (*destroy_conversation)(PurpleConversation *conv);
00163 void (*write_chat)(PurpleConversation *conv, const char *who,
00164 const char *message, PurpleMessageFlags flags,
00165 time_t mtime);
00170 void (*write_im)(PurpleConversation *conv, const char *who,
00171 const char *message, PurpleMessageFlags flags,
00172 time_t mtime);
00178 void (*write_conv)(PurpleConversation *conv,
00179 const char *name,
00180 const char *alias,
00181 const char *message,
00182 PurpleMessageFlags flags,
00183 time_t mtime);
00184
00191 void (*chat_add_users)(PurpleConversation *conv,
00192 GList *cbuddies,
00193 gboolean new_arrivals);
00199 void (*chat_rename_user)(PurpleConversation *conv, const char *old_name,
00200 const char *new_name, const char *new_alias);
00205 void (*chat_remove_users)(PurpleConversation *conv, GList *users);
00209 void (*chat_update_user)(PurpleConversation *conv, const char *user);
00210
00214 void (*present)(PurpleConversation *conv);
00215
00220 gboolean (*has_focus)(PurpleConversation *conv);
00221
00222
00223 gboolean (*custom_smiley_add)(PurpleConversation *conv, const char *smile, gboolean remote);
00224 void (*custom_smiley_write)(PurpleConversation *conv, const char *smile,
00225 const guchar *data, gsize size);
00226 void (*custom_smiley_close)(PurpleConversation *conv, const char *smile);
00227
00233 void (*send_confirm)(PurpleConversation *conv, const char *message);
00234
00235 void (*_purple_reserved1)(void);
00236 void (*_purple_reserved2)(void);
00237 void (*_purple_reserved3)(void);
00238 void (*_purple_reserved4)(void);
00239 };
00240
00244 struct _PurpleConvIm
00245 {
00246 PurpleConversation *conv;
00248 PurpleTypingState typing_state;
00249 guint typing_timeout;
00250 time_t type_again;
00251 guint send_typed_timeout;
00253 PurpleBuddyIcon *icon;
00254 };
00255
00259 struct _PurpleConvChat
00260 {
00261 PurpleConversation *conv;
00263 GList *in_room;
00264 GList *ignored;
00265 char *who;
00266 char *topic;
00267 int id;
00268 char *nick;
00270 gboolean left;
00271 };
00272
00276 struct _PurpleConvChatBuddy
00277 {
00278 char *name;
00279 char *alias;
00280 char *alias_key;
00281 gboolean buddy;
00282 PurpleConvChatBuddyFlags flags;
00283 };
00284
00290 struct _PurpleConversation
00291 {
00292 PurpleConversationType type;
00294 PurpleAccount *account;
00297 char *name;
00298 char *title;
00300 gboolean logging;
00302 GList *logs;
00304 union
00305 {
00306 PurpleConvIm *im;
00307 PurpleConvChat *chat;
00308 void *misc;
00310 } u;
00311
00312 PurpleConversationUiOps *ui_ops;
00313 void *ui_data;
00315 GHashTable *data;
00317 PurpleConnectionFlags features;
00319 };
00320
00321 #ifdef __cplusplus
00322 extern "C" {
00323 #endif
00324
00325
00327
00340 PurpleConversation *purple_conversation_new(PurpleConversationType type,
00341 PurpleAccount *account,
00342 const char *name);
00343
00353 void purple_conversation_destroy(PurpleConversation *conv);
00354
00355
00361 void purple_conversation_present(PurpleConversation *conv);
00362
00363
00371 PurpleConversationType purple_conversation_get_type(const PurpleConversation *conv);
00372
00379 void purple_conversation_set_ui_ops(PurpleConversation *conv,
00380 PurpleConversationUiOps *ops);
00381
00387 void purple_conversations_set_ui_ops(PurpleConversationUiOps *ops);
00388
00396 PurpleConversationUiOps *purple_conversation_get_ui_ops(
00397 const PurpleConversation *conv);
00398
00408 void purple_conversation_set_account(PurpleConversation *conv,
00409 PurpleAccount *account);
00410
00421 PurpleAccount *purple_conversation_get_account(const PurpleConversation *conv);
00422
00432 PurpleConnection *purple_conversation_get_gc(const PurpleConversation *conv);
00433
00440 void purple_conversation_set_title(PurpleConversation *conv, const char *title);
00441
00449 const char *purple_conversation_get_title(const PurpleConversation *conv);
00450
00459 void purple_conversation_autoset_title(PurpleConversation *conv);
00460
00467 void purple_conversation_set_name(PurpleConversation *conv, const char *name);
00468
00476 const char *purple_conversation_get_name(const PurpleConversation *conv);
00477
00484 void purple_conversation_set_logging(PurpleConversation *conv, gboolean log);
00485
00493 gboolean purple_conversation_is_logging(const PurpleConversation *conv);
00494
00504 void purple_conversation_close_logs(PurpleConversation *conv);
00505
00515 PurpleConvIm *purple_conversation_get_im_data(const PurpleConversation *conv);
00516
00517 #define PURPLE_CONV_IM(c) (purple_conversation_get_im_data(c))
00518
00528 PurpleConvChat *purple_conversation_get_chat_data(const PurpleConversation *conv);
00529
00530 #define PURPLE_CONV_CHAT(c) (purple_conversation_get_chat_data(c))
00531
00539 void purple_conversation_set_data(PurpleConversation *conv, const char *key,
00540 gpointer data);
00541
00550 gpointer purple_conversation_get_data(PurpleConversation *conv, const char *key);
00551
00559 GList *purple_get_conversations(void);
00560
00566 GList *purple_get_ims(void);
00567
00573 GList *purple_get_chats(void);
00574
00584 PurpleConversation *purple_find_conversation_with_account(
00585 PurpleConversationType type, const char *name,
00586 const PurpleAccount *account);
00587
00608 void purple_conversation_write(PurpleConversation *conv, const char *who,
00609 const char *message, PurpleMessageFlags flags,
00610 time_t mtime);
00611
00612
00618 void purple_conversation_set_features(PurpleConversation *conv,
00619 PurpleConnectionFlags features);
00620
00621
00626 PurpleConnectionFlags purple_conversation_get_features(PurpleConversation *conv);
00627
00636 gboolean purple_conversation_has_focus(PurpleConversation *conv);
00637
00644 void purple_conversation_update(PurpleConversation *conv, PurpleConvUpdateType type);
00645
00651 void purple_conversation_foreach(void (*func)(PurpleConversation *conv));
00652
00656
00658
00668 PurpleConversation *purple_conv_im_get_conversation(const PurpleConvIm *im);
00669
00681 void purple_conv_im_set_icon(PurpleConvIm *im, PurpleBuddyIcon *icon);
00682
00690 PurpleBuddyIcon *purple_conv_im_get_icon(const PurpleConvIm *im);
00691
00698 void purple_conv_im_set_typing_state(PurpleConvIm *im, PurpleTypingState state);
00699
00707 PurpleTypingState purple_conv_im_get_typing_state(const PurpleConvIm *im);
00708
00715 void purple_conv_im_start_typing_timeout(PurpleConvIm *im, int timeout);
00716
00722 void purple_conv_im_stop_typing_timeout(PurpleConvIm *im);
00723
00731 guint purple_conv_im_get_typing_timeout(const PurpleConvIm *im);
00732
00744 void purple_conv_im_set_type_again(PurpleConvIm *im, unsigned int val);
00745
00754 time_t purple_conv_im_get_type_again(const PurpleConvIm *im);
00755
00761 void purple_conv_im_start_send_typed_timeout(PurpleConvIm *im);
00762
00768 void purple_conv_im_stop_send_typed_timeout(PurpleConvIm *im);
00769
00777 guint purple_conv_im_get_send_typed_timeout(const PurpleConvIm *im);
00778
00784 void purple_conv_im_update_typing(PurpleConvIm *im);
00785
00795 void purple_conv_im_write(PurpleConvIm *im, const char *who,
00796 const char *message, PurpleMessageFlags flags,
00797 time_t mtime);
00798
00812 gboolean purple_conv_present_error(const char *who, PurpleAccount *account, const char *what);
00813
00820 void purple_conv_im_send(PurpleConvIm *im, const char *message);
00821
00834 void purple_conv_send_confirm(PurpleConversation *conv, const char *message);
00835
00843 void purple_conv_im_send_with_flags(PurpleConvIm *im, const char *message, PurpleMessageFlags flags);
00844
00864 gboolean purple_conv_custom_smiley_add(PurpleConversation *conv, const char *smile,
00865 const char *cksum_type, const char *chksum,
00866 gboolean remote);
00867
00868
00878 void purple_conv_custom_smiley_write(PurpleConversation *conv,
00879 const char *smile,
00880 const guchar *data,
00881 gsize size);
00882
00892 void purple_conv_custom_smiley_close(PurpleConversation *conv, const char *smile);
00893
00897
00899
00909 PurpleConversation *purple_conv_chat_get_conversation(const PurpleConvChat *chat);
00910
00923 GList *purple_conv_chat_set_users(PurpleConvChat *chat, GList *users);
00924
00932 GList *purple_conv_chat_get_users(const PurpleConvChat *chat);
00933
00940 void purple_conv_chat_ignore(PurpleConvChat *chat, const char *name);
00941
00948 void purple_conv_chat_unignore(PurpleConvChat *chat, const char *name);
00949
00958 GList *purple_conv_chat_set_ignored(PurpleConvChat *chat, GList *ignored);
00959
00967 GList *purple_conv_chat_get_ignored(const PurpleConvChat *chat);
00968
00983 const char *purple_conv_chat_get_ignored_user(const PurpleConvChat *chat,
00984 const char *user);
00985
00994 gboolean purple_conv_chat_is_user_ignored(const PurpleConvChat *chat,
00995 const char *user);
00996
01004 void purple_conv_chat_set_topic(PurpleConvChat *chat, const char *who,
01005 const char *topic);
01006
01014 const char *purple_conv_chat_get_topic(const PurpleConvChat *chat);
01015
01022 void purple_conv_chat_set_id(PurpleConvChat *chat, int id);
01023
01031 int purple_conv_chat_get_id(const PurpleConvChat *chat);
01032
01042 void purple_conv_chat_write(PurpleConvChat *chat, const char *who,
01043 const char *message, PurpleMessageFlags flags,
01044 time_t mtime);
01045
01052 void purple_conv_chat_send(PurpleConvChat *chat, const char *message);
01053
01061 void purple_conv_chat_send_with_flags(PurpleConvChat *chat, const char *message, PurpleMessageFlags flags);
01062
01072 void purple_conv_chat_add_user(PurpleConvChat *chat, const char *user,
01073 const char *extra_msg, PurpleConvChatBuddyFlags flags,
01074 gboolean new_arrival);
01075
01093 void purple_conv_chat_add_users(PurpleConvChat *chat, GList *users, GList *extra_msgs,
01094 GList *flags, gboolean new_arrivals);
01095
01103 void purple_conv_chat_rename_user(PurpleConvChat *chat, const char *old_user,
01104 const char *new_user);
01105
01115 void purple_conv_chat_remove_user(PurpleConvChat *chat, const char *user,
01116 const char *reason);
01117
01125 void purple_conv_chat_remove_users(PurpleConvChat *chat, GList *users,
01126 const char *reason);
01127
01136 gboolean purple_conv_chat_find_user(PurpleConvChat *chat, const char *user);
01137
01145 void purple_conv_chat_user_set_flags(PurpleConvChat *chat, const char *user,
01146 PurpleConvChatBuddyFlags flags);
01147
01156 PurpleConvChatBuddyFlags purple_conv_chat_user_get_flags(PurpleConvChat *chat,
01157 const char *user);
01158
01164 void purple_conv_chat_clear_users(PurpleConvChat *chat);
01165
01172 void purple_conv_chat_set_nick(PurpleConvChat *chat, const char *nick);
01173
01180 const char *purple_conv_chat_get_nick(PurpleConvChat *chat);
01181
01190 PurpleConversation *purple_find_chat(const PurpleConnection *gc, int id);
01191
01198 void purple_conv_chat_left(PurpleConvChat *chat);
01199
01209 gboolean purple_conv_chat_has_left(PurpleConvChat *chat);
01210
01220 PurpleConvChatBuddy *purple_conv_chat_cb_new(const char *name, const char *alias,
01221 PurpleConvChatBuddyFlags flags);
01222
01229 PurpleConvChatBuddy *purple_conv_chat_cb_find(PurpleConvChat *chat, const char *name);
01230
01238 const char *purple_conv_chat_cb_get_name(PurpleConvChatBuddy *cb);
01239
01245 void purple_conv_chat_cb_destroy(PurpleConvChatBuddy *cb);
01246
01256 GList * purple_conversation_get_extended_menu(PurpleConversation *conv);
01257
01269 gboolean purple_conversation_do_command(PurpleConversation *conv, const gchar *cmdline, const gchar *markup, gchar **error);
01270
01273
01275
01283 void *purple_conversations_get_handle(void);
01284
01288 void purple_conversations_init(void);
01289
01293 void purple_conversations_uninit(void);
01294
01297 #ifdef __cplusplus
01298 }
01299 #endif
01300
01301 #endif