Mercurial > pidgin.yaz
comparison doc/xfer-signals.dox @ 16183:8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
author | Richard Laager <rlaager@wiktel.com> |
---|---|
date | Mon, 16 Apr 2007 00:50:57 +0000 |
parents | d0f7f698b6de |
children | 1414e0e01dc5 |
comparison
equal
deleted
inserted
replaced
16182:36d9409dab58 | 16183:8cf53d7a0887 |
---|---|
14 | 14 |
15 <hr> | 15 <hr> |
16 | 16 |
17 @signaldef file-recv-accept | 17 @signaldef file-recv-accept |
18 @signalproto | 18 @signalproto |
19 void (*file_recv_accept)(GaimXfer *xfer, gpointer data); | 19 void (*file_recv_accept)(PurpleXfer *xfer, gpointer data); |
20 @endsignalproto | 20 @endsignalproto |
21 @signaldesc | 21 @signaldesc |
22 Emitted when an incoming file transfer has been accepted. | 22 Emitted when an incoming file transfer has been accepted. |
23 @param xfer The file transfer | 23 @param xfer The file transfer |
24 @param data User data | 24 @param data User data |
25 @endsignaldef | 25 @endsignaldef |
26 | 26 |
27 @signaldef file-recv-start | 27 @signaldef file-recv-start |
28 @signalproto | 28 @signalproto |
29 void (*file_recv_start)(GaimXfer *xfer, gpointer data); | 29 void (*file_recv_start)(PurpleXfer *xfer, gpointer data); |
30 @endsignalproto | 30 @endsignalproto |
31 @signaldesc | 31 @signaldesc |
32 Emitted when an incoming file transfer has been started. | 32 Emitted when an incoming file transfer has been started. |
33 @param xfer The file transfer | 33 @param xfer The file transfer |
34 @param data User data | 34 @param data User data |
35 @endsignaldef | 35 @endsignaldef |
36 | 36 |
37 @signaldef file-recv-cancel | 37 @signaldef file-recv-cancel |
38 @signalproto | 38 @signalproto |
39 void (*file_recv_cancel)(GaimXfer *xfer, gpointer data); | 39 void (*file_recv_cancel)(PurpleXfer *xfer, gpointer data); |
40 @endsignalproto | 40 @endsignalproto |
41 @signaldesc | 41 @signaldesc |
42 Emitted when an incoming file transfer has been canceled. | 42 Emitted when an incoming file transfer has been canceled. |
43 @param xfer The file transfer | 43 @param xfer The file transfer |
44 @param data User data | 44 @param data User data |
45 @endsignaldef | 45 @endsignaldef |
46 | 46 |
47 @signaldef file-recv-complete | 47 @signaldef file-recv-complete |
48 @signalproto | 48 @signalproto |
49 void (*file_recv_complete)(GaimXfer *xfer, gpointer data); | 49 void (*file_recv_complete)(PurpleXfer *xfer, gpointer data); |
50 @endsignalproto | 50 @endsignalproto |
51 @signaldesc | 51 @signaldesc |
52 Emitted when an incoming file transfer has been completed. | 52 Emitted when an incoming file transfer has been completed. |
53 @param xfer The file transfer | 53 @param xfer The file transfer |
54 @param data User data | 54 @param data User data |
55 @endsignaldef | 55 @endsignaldef |
56 | 56 |
57 @signaldef file-recv-request | 57 @signaldef file-recv-request |
58 @signalproto | 58 @signalproto |
59 void (*file_recv_request)(GaimXfer *xfer, gpointer data); | 59 void (*file_recv_request)(PurpleXfer *xfer, gpointer data); |
60 @endsignalproto | 60 @endsignalproto |
61 @signaldesc | 61 @signaldesc |
62 Emitted before the user is prompted for an incoming file-transfer. | 62 Emitted before the user is prompted for an incoming file-transfer. |
63 Plugins can intercept the signal to auto-accept/auto-reject the | 63 Plugins can intercept the signal to auto-accept/auto-reject the |
64 requests. To auto-accept the file transfer, use | 64 requests. To auto-accept the file transfer, use |
68 @param data User data | 68 @param data User data |
69 @endsignaldef | 69 @endsignaldef |
70 | 70 |
71 @signaldef file-send-accept | 71 @signaldef file-send-accept |
72 @signalproto | 72 @signalproto |
73 void (*file_send_accept)(GaimXfer *xfer, gpointer data); | 73 void (*file_send_accept)(PurpleXfer *xfer, gpointer data); |
74 @endsignalproto | 74 @endsignalproto |
75 @signaldesc | 75 @signaldesc |
76 Emitted when an outgoing file transfer has been accepted. | 76 Emitted when an outgoing file transfer has been accepted. |
77 @param xfer The file transfer | 77 @param xfer The file transfer |
78 @param data User data | 78 @param data User data |
79 @endsignaldef | 79 @endsignaldef |
80 | 80 |
81 @signaldef file-send-start | 81 @signaldef file-send-start |
82 @signalproto | 82 @signalproto |
83 void (*file_send_start)(GaimXfer *xfer, gpointer data); | 83 void (*file_send_start)(PurpleXfer *xfer, gpointer data); |
84 @endsignalproto | 84 @endsignalproto |
85 @signaldesc | 85 @signaldesc |
86 Emitted when an outgoing file transfer has started. | 86 Emitted when an outgoing file transfer has started. |
87 @param xfer The file transfer | 87 @param xfer The file transfer |
88 @param data User data | 88 @param data User data |
89 @endsignaldef | 89 @endsignaldef |
90 | 90 |
91 @signaldef file-send-cancel | 91 @signaldef file-send-cancel |
92 @signalproto | 92 @signalproto |
93 void (*file_send_cancel)(GaimXfer *xfer, gpointer data); | 93 void (*file_send_cancel)(PurpleXfer *xfer, gpointer data); |
94 @endsignalproto | 94 @endsignalproto |
95 @signaldesc | 95 @signaldesc |
96 Emitted when an outgoing file transfer has been canceled. | 96 Emitted when an outgoing file transfer has been canceled. |
97 @param xfer The file transfer | 97 @param xfer The file transfer |
98 @param data User data | 98 @param data User data |
99 @endsignaldef | 99 @endsignaldef |
100 | 100 |
101 @signaldef file-send-complete | 101 @signaldef file-send-complete |
102 @signalproto | 102 @signalproto |
103 void (*file_send_complete)(GaimXfer *xfer, gpointer data); | 103 void (*file_send_complete)(PurpleXfer *xfer, gpointer data); |
104 @endsignalproto | 104 @endsignalproto |
105 @signaldesc | 105 @signaldesc |
106 Emitted when an outgoing file transfer has been completed. | 106 Emitted when an outgoing file transfer has been completed. |
107 @param xfer The file transfer | 107 @param xfer The file transfer |
108 @param data User data | 108 @param data User data |