conversation.h

Go to the documentation of this file.
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      * XXX These need to go when we implement a more generic core/UI event
00071      * system.
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  
00121 } PurpleMessageFlags;
00122 
00126 typedef enum
00127 {
00128     PURPLE_CBFLAGS_NONE          = 0x0000, 
00129     PURPLE_CBFLAGS_VOICE         = 0x0001, 
00130     PURPLE_CBFLAGS_HALFOP        = 0x0002, 
00131     PURPLE_CBFLAGS_OP            = 0x0004, 
00132     PURPLE_CBFLAGS_FOUNDER       = 0x0008, 
00133     PURPLE_CBFLAGS_TYPING        = 0x0010, 
00135 } PurpleConvChatBuddyFlags;
00136 
00137 #include "account.h"
00138 #include "buddyicon.h"
00139 #include "log.h"
00140 #include "server.h"
00141 
00148 struct _PurpleConversationUiOps
00149 {
00150     void (*create_conversation)(PurpleConversation *conv);
00151     void (*destroy_conversation)(PurpleConversation *conv);
00152     void (*write_chat)(PurpleConversation *conv, const char *who,
00153                        const char *message, PurpleMessageFlags flags,
00154                        time_t mtime);
00155     void (*write_im)(PurpleConversation *conv, const char *who,
00156                      const char *message, PurpleMessageFlags flags,
00157                      time_t mtime);
00158     void (*write_conv)(PurpleConversation *conv, const char *name, const char *alias,
00159                        const char *message, PurpleMessageFlags flags,
00160                        time_t mtime);
00161 
00162     void (*chat_add_users)(PurpleConversation *conv, GList *cbuddies, gboolean new_arrivals);   
00163     
00164     void (*chat_rename_user)(PurpleConversation *conv, const char *old_name,
00165                              const char *new_name, const char *new_alias);
00166     void (*chat_remove_users)(PurpleConversation *conv, GList *users);
00167     void (*chat_update_user)(PurpleConversation *conv, const char *user);
00168 
00169     void (*present)(PurpleConversation *conv);
00170 
00171     gboolean (*has_focus)(PurpleConversation *conv);
00172 
00173     /* Custom Smileys */
00174     gboolean (*custom_smiley_add)(PurpleConversation *conv, const char *smile, gboolean remote);
00175     void (*custom_smiley_write)(PurpleConversation *conv, const char *smile,
00176                                 const guchar *data, gsize size);
00177     void (*custom_smiley_close)(PurpleConversation *conv, const char *smile);
00178 
00179     void (*send_confirm)(PurpleConversation *conv, const char *message);
00180 
00181     void (*_purple_reserved1)(void);
00182     void (*_purple_reserved2)(void);
00183     void (*_purple_reserved3)(void);
00184     void (*_purple_reserved4)(void);
00185 };
00186 
00190 struct _PurpleConvIm
00191 {
00192     PurpleConversation *conv;            
00194     PurpleTypingState typing_state;      
00195     guint  typing_timeout;             
00196     time_t type_again;                 
00197     guint  send_typed_timeout;         
00199     PurpleBuddyIcon *icon;               
00200 };
00201 
00205 struct _PurpleConvChat
00206 {
00207     PurpleConversation *conv;          
00209     GList *in_room;                  
00210     GList *ignored;                  
00211     char  *who;                      
00212     char  *topic;                    
00213     int    id;                       
00214     char *nick;                      
00216     gboolean left;                   
00217 };
00218 
00222 struct _PurpleConvChatBuddy
00223 {
00224     char *name;                      
00225     char *alias;                     
00226     char *alias_key;                 
00227     gboolean buddy;                  
00228     PurpleConvChatBuddyFlags flags;    
00229 };
00230 
00236 struct _PurpleConversation
00237 {
00238     PurpleConversationType type;  
00240     PurpleAccount *account;       
00243     char *name;                 
00244     char *title;                
00246     gboolean logging;           
00248     GList *logs;                
00250     union
00251     {
00252         PurpleConvIm   *im;       
00253         PurpleConvChat *chat;     
00254         void *misc;             
00256     } u;
00257 
00258     PurpleConversationUiOps *ui_ops;           
00259     void *ui_data;                           
00261     GHashTable *data;                        
00263     PurpleConnectionFlags features; 
00265 };
00266 
00267 #ifdef __cplusplus
00268 extern "C" {
00269 #endif
00270 
00271 /**************************************************************************/
00273 /**************************************************************************/
00286 PurpleConversation *purple_conversation_new(PurpleConversationType type,
00287                                         PurpleAccount *account,
00288                                         const char *name);
00289 
00299 void purple_conversation_destroy(PurpleConversation *conv);
00300 
00301 
00307 void purple_conversation_present(PurpleConversation *conv);
00308 
00309 
00317 PurpleConversationType purple_conversation_get_type(const PurpleConversation *conv);
00318 
00325 void purple_conversation_set_ui_ops(PurpleConversation *conv,
00326                                   PurpleConversationUiOps *ops);
00327 
00333 void purple_conversations_set_ui_ops(PurpleConversationUiOps *ops);
00334 
00342 PurpleConversationUiOps *purple_conversation_get_ui_ops(
00343         const PurpleConversation *conv);
00344 
00354 void purple_conversation_set_account(PurpleConversation *conv,
00355                                    PurpleAccount *account);
00356 
00367 PurpleAccount *purple_conversation_get_account(const PurpleConversation *conv);
00368 
00378 PurpleConnection *purple_conversation_get_gc(const PurpleConversation *conv);
00379 
00386 void purple_conversation_set_title(PurpleConversation *conv, const char *title);
00387 
00395 const char *purple_conversation_get_title(const PurpleConversation *conv);
00396 
00405 void purple_conversation_autoset_title(PurpleConversation *conv);
00406 
00413 void purple_conversation_set_name(PurpleConversation *conv, const char *name);
00414 
00422 const char *purple_conversation_get_name(const PurpleConversation *conv);
00423 
00430 void purple_conversation_set_logging(PurpleConversation *conv, gboolean log);
00431 
00439 gboolean purple_conversation_is_logging(const PurpleConversation *conv);
00440 
00450 void purple_conversation_close_logs(PurpleConversation *conv);
00451 
00461 PurpleConvIm *purple_conversation_get_im_data(const PurpleConversation *conv);
00462 
00463 #define PURPLE_CONV_IM(c) (purple_conversation_get_im_data(c))
00464 
00474 PurpleConvChat *purple_conversation_get_chat_data(const PurpleConversation *conv);
00475 
00476 #define PURPLE_CONV_CHAT(c) (purple_conversation_get_chat_data(c))
00477 
00485 void purple_conversation_set_data(PurpleConversation *conv, const char *key,
00486                                 gpointer data);
00487 
00496 gpointer purple_conversation_get_data(PurpleConversation *conv, const char *key);
00497 
00505 GList *purple_get_conversations(void);
00506 
00512 GList *purple_get_ims(void);
00513 
00519 GList *purple_get_chats(void);
00520 
00530 PurpleConversation *purple_find_conversation_with_account(
00531         PurpleConversationType type, const char *name,
00532         const PurpleAccount *account);
00533 
00554 void purple_conversation_write(PurpleConversation *conv, const char *who,
00555         const char *message, PurpleMessageFlags flags,
00556         time_t mtime);
00557 
00558 
00564 void purple_conversation_set_features(PurpleConversation *conv,
00565         PurpleConnectionFlags features);
00566 
00567 
00572 PurpleConnectionFlags purple_conversation_get_features(PurpleConversation *conv);
00573 
00582 gboolean purple_conversation_has_focus(PurpleConversation *conv);
00583 
00590 void purple_conversation_update(PurpleConversation *conv, PurpleConvUpdateType type);
00591 
00597 void purple_conversation_foreach(void (*func)(PurpleConversation *conv));
00598 
00602 /**************************************************************************/
00604 /**************************************************************************/
00614 PurpleConversation *purple_conv_im_get_conversation(const PurpleConvIm *im);
00615 
00627 void purple_conv_im_set_icon(PurpleConvIm *im, PurpleBuddyIcon *icon);
00628 
00636 PurpleBuddyIcon *purple_conv_im_get_icon(const PurpleConvIm *im);
00637 
00644 void purple_conv_im_set_typing_state(PurpleConvIm *im, PurpleTypingState state);
00645 
00653 PurpleTypingState purple_conv_im_get_typing_state(const PurpleConvIm *im);
00654 
00661 void purple_conv_im_start_typing_timeout(PurpleConvIm *im, int timeout);
00662 
00668 void purple_conv_im_stop_typing_timeout(PurpleConvIm *im);
00669 
00677 guint purple_conv_im_get_typing_timeout(const PurpleConvIm *im);
00678 
00690 void purple_conv_im_set_type_again(PurpleConvIm *im, unsigned int val);
00691 
00700 time_t purple_conv_im_get_type_again(const PurpleConvIm *im);
00701 
00707 void purple_conv_im_start_send_typed_timeout(PurpleConvIm *im);
00708 
00714 void purple_conv_im_stop_send_typed_timeout(PurpleConvIm *im);
00715 
00723 guint purple_conv_im_get_send_typed_timeout(const PurpleConvIm *im);
00724 
00730 void purple_conv_im_update_typing(PurpleConvIm *im);
00731 
00741 void purple_conv_im_write(PurpleConvIm *im, const char *who,
00742                         const char *message, PurpleMessageFlags flags,
00743                         time_t mtime);
00744 
00758 gboolean purple_conv_present_error(const char *who, PurpleAccount *account, const char *what);
00759 
00766 void purple_conv_im_send(PurpleConvIm *im, const char *message);
00767 
00780 void purple_conv_send_confirm(PurpleConversation *conv, const char *message);
00781 
00789 void purple_conv_im_send_with_flags(PurpleConvIm *im, const char *message, PurpleMessageFlags flags);
00790 
00810 gboolean purple_conv_custom_smiley_add(PurpleConversation *conv, const char *smile,
00811                                       const char *cksum_type, const char *chksum,
00812                                       gboolean remote);
00813 
00814 
00824 void purple_conv_custom_smiley_write(PurpleConversation *conv,
00825                                    const char *smile,
00826                                    const guchar *data,
00827                                    gsize size);
00828 
00838 void purple_conv_custom_smiley_close(PurpleConversation *conv, const char *smile);
00839 
00843 /**************************************************************************/
00845 /**************************************************************************/
00855 PurpleConversation *purple_conv_chat_get_conversation(const PurpleConvChat *chat);
00856 
00869 GList *purple_conv_chat_set_users(PurpleConvChat *chat, GList *users);
00870 
00878 GList *purple_conv_chat_get_users(const PurpleConvChat *chat);
00879 
00886 void purple_conv_chat_ignore(PurpleConvChat *chat, const char *name);
00887 
00894 void purple_conv_chat_unignore(PurpleConvChat *chat, const char *name);
00895 
00904 GList *purple_conv_chat_set_ignored(PurpleConvChat *chat, GList *ignored);
00905 
00913 GList *purple_conv_chat_get_ignored(const PurpleConvChat *chat);
00914 
00929 const char *purple_conv_chat_get_ignored_user(const PurpleConvChat *chat,
00930                                             const char *user);
00931 
00940 gboolean purple_conv_chat_is_user_ignored(const PurpleConvChat *chat,
00941                                         const char *user);
00942 
00950 void purple_conv_chat_set_topic(PurpleConvChat *chat, const char *who,
00951                               const char *topic);
00952 
00960 const char *purple_conv_chat_get_topic(const PurpleConvChat *chat);
00961 
00968 void purple_conv_chat_set_id(PurpleConvChat *chat, int id);
00969 
00977 int purple_conv_chat_get_id(const PurpleConvChat *chat);
00978 
00988 void purple_conv_chat_write(PurpleConvChat *chat, const char *who,
00989                           const char *message, PurpleMessageFlags flags,
00990                           time_t mtime);
00991 
00998 void purple_conv_chat_send(PurpleConvChat *chat, const char *message);
00999 
01007 void purple_conv_chat_send_with_flags(PurpleConvChat *chat, const char *message, PurpleMessageFlags flags);
01008 
01018 void purple_conv_chat_add_user(PurpleConvChat *chat, const char *user,
01019                              const char *extra_msg, PurpleConvChatBuddyFlags flags,
01020                              gboolean new_arrival);
01021 
01039 void purple_conv_chat_add_users(PurpleConvChat *chat, GList *users, GList *extra_msgs,
01040                               GList *flags, gboolean new_arrivals);
01041 
01049 void purple_conv_chat_rename_user(PurpleConvChat *chat, const char *old_user,
01050                                 const char *new_user);
01051 
01061 void purple_conv_chat_remove_user(PurpleConvChat *chat, const char *user,
01062                                 const char *reason);
01063 
01071 void purple_conv_chat_remove_users(PurpleConvChat *chat, GList *users,
01072                                  const char *reason);
01073 
01082 gboolean purple_conv_chat_find_user(PurpleConvChat *chat, const char *user);
01083 
01091 void purple_conv_chat_user_set_flags(PurpleConvChat *chat, const char *user,
01092                                    PurpleConvChatBuddyFlags flags);
01093 
01102 PurpleConvChatBuddyFlags purple_conv_chat_user_get_flags(PurpleConvChat *chat,
01103                                                      const char *user);
01104 
01110 void purple_conv_chat_clear_users(PurpleConvChat *chat);
01111 
01118 void purple_conv_chat_set_nick(PurpleConvChat *chat, const char *nick);
01119 
01126 const char *purple_conv_chat_get_nick(PurpleConvChat *chat);
01127 
01136 PurpleConversation *purple_find_chat(const PurpleConnection *gc, int id);
01137 
01144 void purple_conv_chat_left(PurpleConvChat *chat);
01145 
01155 gboolean purple_conv_chat_has_left(PurpleConvChat *chat);
01156 
01166 PurpleConvChatBuddy *purple_conv_chat_cb_new(const char *name, const char *alias,
01167                                         PurpleConvChatBuddyFlags flags);
01168 
01175 PurpleConvChatBuddy *purple_conv_chat_cb_find(PurpleConvChat *chat, const char *name);
01176 
01184 const char *purple_conv_chat_cb_get_name(PurpleConvChatBuddy *cb);
01185 
01191 void purple_conv_chat_cb_destroy(PurpleConvChatBuddy *cb);
01192 
01195 /**************************************************************************/
01197 /**************************************************************************/
01205 void *purple_conversations_get_handle(void);
01206 
01210 void purple_conversations_init(void);
01211 
01215 void purple_conversations_uninit(void);
01216 
01219 #ifdef __cplusplus
01220 }
01221 #endif
01222 
01223 #endif /* _PURPLE_CONVERSATION_H_ */