annotate doc/xfer-signals.dox @ 25540:d892a9275d0d

make use of utf8 filename in jabber.
author Yoshiki Yazawa <yaz@honeyplanet.jp>
date Tue, 14 Aug 2007 06:58:29 +0000
parents 1414e0e01dc5
children e0613cf8c493
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11281
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
1 /** @page xfer-signals File Transfer Signals
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
2
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
3 @signals
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
4 @signal file-recv-accept
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
5 @signal file-recv-start
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
6 @signal file-recv-cancel
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
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
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
9 @signal file-send-accept
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
10 @signal file-send-start
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
11 @signal file-send-cancel
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
12 @signal file-send-complete
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
13 @endsignals
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
14
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
15 <hr>
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
16
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
17 @signaldef file-recv-accept
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
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
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
20 @endsignalproto
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
21 @signaldesc
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
22 Emitted when an incoming file transfer has been accepted.
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
23 @param xfer The file transfer
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
24 @param data User data
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
25 @endsignaldef
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
26
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
27 @signaldef file-recv-start
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
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
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
30 @endsignalproto
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
31 @signaldesc
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
32 Emitted when an incoming file transfer has been started.
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
33 @param xfer The file transfer
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
34 @param data User data
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
35 @endsignaldef
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
36
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
37 @signaldef file-recv-cancel
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
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
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
40 @endsignalproto
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
41 @signaldesc
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
42 Emitted when an incoming file transfer has been canceled.
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
43 @param xfer The file transfer
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
44 @param data User data
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
45 @endsignaldef
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
46
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
47 @signaldef file-recv-complete
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
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
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
50 @endsignalproto
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
51 @signaldesc
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
52 Emitted when an incoming file transfer has been completed.
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
53 @param xfer The file transfer
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
54 @param data User data
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
55 @endsignaldef
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
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
1414e0e01dc5 More renaming.
Richard Laager <rlaager@wiktel.com>
parents: 16183
diff changeset
65 purple_xfer_request_accepted(). To auto-reject, set the status of the
1414e0e01dc5 More renaming.
Richard Laager <rlaager@wiktel.com>
parents: 16183
diff changeset
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
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
71 @signaldef file-send-accept
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
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
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
74 @endsignalproto
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
75 @signaldesc
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
76 Emitted when an outgoing file transfer has been accepted.
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
77 @param xfer The file transfer
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
78 @param data User data
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
79 @endsignaldef
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
80
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
81 @signaldef file-send-start
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
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
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
84 @endsignalproto
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
85 @signaldesc
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
86 Emitted when an outgoing file transfer has started.
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
87 @param xfer The file transfer
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
88 @param data User data
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
89 @endsignaldef
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
90
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
91 @signaldef file-send-cancel
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
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
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
94 @endsignalproto
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
95 @signaldesc
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
96 Emitted when an outgoing file transfer has been canceled.
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
97 @param xfer The file transfer
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
98 @param data User data
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
99 @endsignaldef
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
100
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
101 @signaldef file-send-complete
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
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
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
104 @endsignalproto
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
105 @signaldesc
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
106 Emitted when an outgoing file transfer has been completed.
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
107 @param xfer The file transfer
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
108 @param data User data
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
109 @endsignaldef
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
110
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
111 */
920a37a4c1be [gaim-migrate @ 13478]
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
112 // vim: syntax=c tw=75 et