← Back to branch summary

~ubuntu-branches/ubuntu/intrepid/meanwhile/intrepid

« back to all changes in this revision

Viewing changes to src/mw_srvc_im.h

  • Committer: Bazaar Package Importer
  • Author(s): Jonathan Riddell
  • Date: 2006-01-13 12:38:18 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20060113123818-zod7j3hd9z0iz5fy
Tags: 1.0.2-0ubuntu1
* New upstream release
* Rename libmeanwhile0 to libmeanwhile1

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/mw_srvc_im.h
22
22
#define _MW_SRVC_IM_H
23
23
 
24
24
 
25
 
#include <glib.h>
26
 
#include "mw_common.h"
27
 
 
28
 
 
29
 
/** @file srvc_im.h
 
25
/** @file mw_srvc_im.h
30
26
 
31
27
    The IM service provides one-on-one communication between
32
28
    users. Messages sent over conversations may relay different types
34
30
    provides plain-text chat with typing notification. More complex
35
31
    features may be negotiated transparently by setting the IM Client
36
32
    Type for a conversation, or for the service as a whole.
37
 
 */
38
 
 
39
 
 
40
 
/** Type identifier for the IM service */
41
 
#define SERVICE_IM  0x00001000
42
 
 
43
 
 
 
33
*/
 
34
 
 
35
 
 
36
#include <glib.h>
 
37
#include "mw_common.h"
 
38
 
 
39
 
 
40
#ifdef __cplusplus
 
41
extern "C" {
 
42
#endif
 
43
  
 
44
  
 
45
/* identifier for the IM service */
 
46
#define mwService_IM  0x00001000
 
47
  
 
48
  
44
49
/** @struct mwServiceIm
45
50
 
46
51
    An instance of the IM service. This service provides simple
70
75
   conversation. At any point, the feature set for the service may
71
76
   change, without affecting any existing conversations.
72
77
 
73
 
   @relates mwServiceIm_supports
74
 
   @relates mwServiceIm_setSupported
75
 
   @relates mwConversation_supports
76
 
   @relates mwConversation_send
77
 
   @relates mwServiceImHandler::conversation_recv
 
78
   @see mwServiceIm_supports
 
79
   @see mwServiceIm_setSupported
 
80
   @see mwConversation_supports
 
81
   @see mwConversation_send
 
82
   @see mwServiceImHandler::conversation_recv
78
83
 */
79
84
enum mwImSendType {
80
85
  mwImSend_PLAIN,   /**< char *, plain-text message */
82
87
  mwImSend_HTML,    /**< char *, HTML formatted message (NOTESBUDDY) */
83
88
  mwImSend_SUBJECT, /**< char *, conversation subject (NOTESBUDDY) */
84
89
  mwImSend_MIME,    /**< char *, MIME-encoded message (NOTESBUDDY) */
 
90
  mwImSend_TIMESTAMP, /**< char *, YYYY:MM:DD:HH:mm:SS format (NOTESBUDDY) */
85
91
};
86
92
 
87
93
 
88
94
 
89
 
/** @relates mwConversation_getState */
 
95
/** @see mwConversation_getState */
90
96
enum mwConversationState {
91
97
  mwConversation_CLOSED,   /**< conversation is not open */
92
98
  mwConversation_PENDING,  /**< conversation is opening */
195
201
 
196
202
/** get the state of a conversation
197
203
 
198
 
    @relates mwConversation_isOpen
199
 
    @relates mwConversation_isClosed
200
 
    @relates mwConversation_isPending
 
204
    @see mwConversation_isOpen
 
205
    @see mwConversation_isClosed
 
206
    @see mwConversation_isPending
201
207
*/
202
208
enum mwConversationState mwConversation_getState(struct mwConversation *conv);
203
209
 
233
239
/** Associates client data with a conversation. If there is existing data,
234
240
    it will not have its cleanup function called.
235
241
 
236
 
    @relates mwConversation_getClientData
237
 
    @relates mwConversation_removeClientData
 
242
    @see mwConversation_getClientData
 
243
    @see mwConversation_removeClientData
238
244
*/
239
245
void mwConversation_setClientData(struct mwConversation *conv,
240
246
                                  gpointer data, GDestroyNotify clean);
242
248
 
243
249
/** Reference associated client data
244
250
 
245
 
    @relates mwConversation_setClientData
246
 
    @relates mwConversation_removeClientData
 
251
    @see mwConversation_setClientData
 
252
    @see mwConversation_removeClientData
247
253
 */
248
254
gpointer mwConversation_getClientData(struct mwConversation *conv);
249
255
 
251
257
/** Remove any associated client data, calling the optional cleanup
252
258
    function if one was provided
253
259
 
254
 
    @relates mwConversation_setClientData
255
 
    @relates mwConversation_getClientData
 
260
    @see mwConversation_setClientData
 
261
    @see mwConversation_getClientData
256
262
*/
257
263
void mwConversation_removeClientData(struct mwConversation *conv);
258
264
 
262
268
void mwConversation_free(struct mwConversation *conv);
263
269
 
264
270
 
 
271
#ifdef __cplusplus
 
272
}
265
273
#endif
266
274
 
 
275
 
 
276
#endif /* _MW_SRVC_IM_H */