Minor changelog updates
[pidgin-git.git] / doc / xfer-signals.dox
blob39a6bd6f8ecf19ca36df00e7b62ede0422deb71c
1 /** @page xfer-signals File Transfer Signals
3  @signals
4   @signal file-recv-accept
5   @signal file-recv-start
6   @signal file-recv-cancel
7   @signal file-recv-complete
8   @signal file-recv-request
9   @signal file-send-accept
10   @signal file-send-start
11   @signal file-send-cancel
12   @signal file-send-complete
13  @endsignals
15  <hr>
17  @signaldef file-recv-accept
18   @signalproto
19 void (*file_recv_accept)(PurpleXfer *xfer, gpointer data);
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
27  @signaldef file-recv-start
28   @signalproto
29 void (*file_recv_start)(PurpleXfer *xfer, gpointer data);
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
37  @signaldef file-recv-cancel
38   @signalproto
39 void (*file_recv_cancel)(PurpleXfer *xfer, gpointer data);
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
47  @signaldef file-recv-complete
48   @signalproto
49 void (*file_recv_complete)(PurpleXfer *xfer, gpointer data);
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
57  @signaldef file-recv-request
58   @signalproto
59 void (*file_recv_request)(PurpleXfer *xfer, gpointer data);
60   @endsignalproto
61   @signaldesc
62    Emitted before the user is prompted for an incoming file-transfer.
63    Plugins can intercept the signal to auto-accept/auto-reject the
64    requests. To auto-accept the file transfer, use
65    purple_xfer_request_accepted(). To auto-reject, set the status of the
66    xfer to PURPLE_XFER_STATUS_CANCEL_LOCAL.
67   @param xfer The file transfer
68   @param data User data
69  @endsignaldef
71  @signaldef file-send-accept
72   @signalproto
73 void (*file_send_accept)(PurpleXfer *xfer, gpointer data);
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
81  @signaldef file-send-start
82   @signalproto
83 void (*file_send_start)(PurpleXfer *xfer, gpointer data);
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
91  @signaldef file-send-cancel
92   @signalproto
93 void (*file_send_cancel)(PurpleXfer *xfer, gpointer data);
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
101  @signaldef file-send-complete
102   @signalproto
103 void (*file_send_complete)(PurpleXfer *xfer, gpointer data);
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
111  */
112 // vim: syntax=c tw=75 et