Mercurial > pidgin
annotate doc/xfer-signals.dox @ 18049:1cedd520cd18
Doxygen skeleton and license info for gnt files.
author | Sadrul Habib Chowdhury <imadil@gmail.com> |
---|---|
date | Wed, 06 Jun 2007 15:42:29 +0000 |
parents | 1414e0e01dc5 |
children | e0613cf8c493 |
rev | line source |
---|---|
11281 | 1 /** @page xfer-signals File Transfer Signals |
2 | |
3 @signals | |
4 @signal file-recv-accept | |
5 @signal file-recv-start | |
6 @signal file-recv-cancel | |
7 @signal file-recv-complete | |
13219
d0f7f698b6de
[gaim-migrate @ 15583]
Richard Laager <rlaager@wiktel.com>
parents:
11281
diff
changeset
|
8 @signal file-recv-request |
11281 | 9 @signal file-send-accept |
10 @signal file-send-start | |
11 @signal file-send-cancel | |
12 @signal file-send-complete | |
13 @endsignals | |
14 | |
15 <hr> | |
16 | |
17 @signaldef file-recv-accept | |
18 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13219
diff
changeset
|
19 void (*file_recv_accept)(PurpleXfer *xfer, gpointer data); |
11281 | 20 @endsignalproto |
21 @signaldesc | |
22 Emitted when an incoming file transfer has been accepted. | |
23 @param xfer The file transfer | |
24 @param data User data | |
25 @endsignaldef | |
26 | |
27 @signaldef file-recv-start | |
28 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13219
diff
changeset
|
29 void (*file_recv_start)(PurpleXfer *xfer, gpointer data); |
11281 | 30 @endsignalproto |
31 @signaldesc | |
32 Emitted when an incoming file transfer has been started. | |
33 @param xfer The file transfer | |
34 @param data User data | |
35 @endsignaldef | |
36 | |
37 @signaldef file-recv-cancel | |
38 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13219
diff
changeset
|
39 void (*file_recv_cancel)(PurpleXfer *xfer, gpointer data); |
11281 | 40 @endsignalproto |
41 @signaldesc | |
42 Emitted when an incoming file transfer has been canceled. | |
43 @param xfer The file transfer | |
44 @param data User data | |
45 @endsignaldef | |
46 | |
47 @signaldef file-recv-complete | |
48 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13219
diff
changeset
|
49 void (*file_recv_complete)(PurpleXfer *xfer, gpointer data); |
11281 | 50 @endsignalproto |
51 @signaldesc | |
52 Emitted when an incoming file transfer has been completed. | |
53 @param xfer The file transfer | |
54 @param data User data | |
55 @endsignaldef | |
56 | |
13219
d0f7f698b6de
[gaim-migrate @ 15583]
Richard Laager <rlaager@wiktel.com>
parents:
11281
diff
changeset
|
57 @signaldef file-recv-request |
d0f7f698b6de
[gaim-migrate @ 15583]
Richard Laager <rlaager@wiktel.com>
parents:
11281
diff
changeset
|
58 @signalproto |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13219
diff
changeset
|
59 void (*file_recv_request)(PurpleXfer *xfer, gpointer data); |
13219
d0f7f698b6de
[gaim-migrate @ 15583]
Richard Laager <rlaager@wiktel.com>
parents:
11281
diff
changeset
|
60 @endsignalproto |
d0f7f698b6de
[gaim-migrate @ 15583]
Richard Laager <rlaager@wiktel.com>
parents:
11281
diff
changeset
|
61 @signaldesc |
d0f7f698b6de
[gaim-migrate @ 15583]
Richard Laager <rlaager@wiktel.com>
parents:
11281
diff
changeset
|
62 Emitted before the user is prompted for an incoming file-transfer. |
d0f7f698b6de
[gaim-migrate @ 15583]
Richard Laager <rlaager@wiktel.com>
parents:
11281
diff
changeset
|
63 Plugins can intercept the signal to auto-accept/auto-reject the |
d0f7f698b6de
[gaim-migrate @ 15583]
Richard Laager <rlaager@wiktel.com>
parents:
11281
diff
changeset
|
64 requests. To auto-accept the file transfer, use |
16196 | 65 purple_xfer_request_accepted(). To auto-reject, set the status of the |
66 xfer to PURPLE_XFER_STATUS_CANCEL_LOCAL. | |
13219
d0f7f698b6de
[gaim-migrate @ 15583]
Richard Laager <rlaager@wiktel.com>
parents:
11281
diff
changeset
|
67 @param xfer The file transfer |
d0f7f698b6de
[gaim-migrate @ 15583]
Richard Laager <rlaager@wiktel.com>
parents:
11281
diff
changeset
|
68 @param data User data |
d0f7f698b6de
[gaim-migrate @ 15583]
Richard Laager <rlaager@wiktel.com>
parents:
11281
diff
changeset
|
69 @endsignaldef |
d0f7f698b6de
[gaim-migrate @ 15583]
Richard Laager <rlaager@wiktel.com>
parents:
11281
diff
changeset
|
70 |
11281 | 71 @signaldef file-send-accept |
72 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13219
diff
changeset
|
73 void (*file_send_accept)(PurpleXfer *xfer, gpointer data); |
11281 | 74 @endsignalproto |
75 @signaldesc | |
76 Emitted when an outgoing file transfer has been accepted. | |
77 @param xfer The file transfer | |
78 @param data User data | |
79 @endsignaldef | |
80 | |
81 @signaldef file-send-start | |
82 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13219
diff
changeset
|
83 void (*file_send_start)(PurpleXfer *xfer, gpointer data); |
11281 | 84 @endsignalproto |
85 @signaldesc | |
86 Emitted when an outgoing file transfer has started. | |
87 @param xfer The file transfer | |
88 @param data User data | |
89 @endsignaldef | |
90 | |
91 @signaldef file-send-cancel | |
92 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13219
diff
changeset
|
93 void (*file_send_cancel)(PurpleXfer *xfer, gpointer data); |
11281 | 94 @endsignalproto |
95 @signaldesc | |
96 Emitted when an outgoing file transfer has been canceled. | |
97 @param xfer The file transfer | |
98 @param data User data | |
99 @endsignaldef | |
100 | |
101 @signaldef file-send-complete | |
102 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13219
diff
changeset
|
103 void (*file_send_complete)(PurpleXfer *xfer, gpointer data); |
11281 | 104 @endsignalproto |
105 @signaldesc | |
106 Emitted when an outgoing file transfer has been completed. | |
107 @param xfer The file transfer | |
108 @param data User data | |
109 @endsignaldef | |
110 | |
111 */ | |
112 // vim: syntax=c tw=75 et |