Mercurial > pidgin3 / file diff

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/reference/libpurple/xfer-signals.dox	Sun Oct 13 15:41:22 2013 +0530
@@ -0,0 +1,114 @@
+/** @page xfer-signals File Transfer Signals
+
+ @signals
+  @signal file-recv-accept
+  @signal file-recv-start
+  @signal file-recv-cancel
+  @signal file-recv-complete
+  @signal file-recv-request
+  @signal file-send-accept
+  @signal file-send-start
+  @signal file-send-cancel
+  @signal file-send-complete
+ @endsignals
+
+ @see ft.h
+
+ <hr>
+
+ @signaldef file-recv-accept
+  @signalproto
+void (*file_recv_accept)(PurpleXfer *xfer, gpointer data);
+  @endsignalproto
+  @signaldesc
+   Emitted when an incoming file transfer has been accepted.
+  @param xfer The file transfer
+  @param data User data
+ @endsignaldef
+
+ @signaldef file-recv-start
+  @signalproto
+void (*file_recv_start)(PurpleXfer *xfer, gpointer data);
+  @endsignalproto
+  @signaldesc
+   Emitted when an incoming file transfer has been started.
+  @param xfer The file transfer
+  @param data User data
+ @endsignaldef
+
+ @signaldef file-recv-cancel
+  @signalproto
+void (*file_recv_cancel)(PurpleXfer *xfer, gpointer data);
+  @endsignalproto
+  @signaldesc
+   Emitted when an incoming file transfer has been canceled.
+  @param xfer The file transfer
+  @param data User data
+ @endsignaldef
+
+ @signaldef file-recv-complete
+  @signalproto
+void (*file_recv_complete)(PurpleXfer *xfer, gpointer data);
+  @endsignalproto
+  @signaldesc
+   Emitted when an incoming file transfer has been completed.
+  @param xfer The file transfer
+  @param data User data
+ @endsignaldef
+
+ @signaldef file-recv-request
+  @signalproto
+void (*file_recv_request)(PurpleXfer *xfer, gpointer data);
+  @endsignalproto
+  @signaldesc
+   Emitted before the user is prompted for an incoming file-transfer.
+   Plugins can intercept the signal to auto-accept/auto-reject the
+   requests. To auto-accept the file transfer, use
+   purple_xfer_request_accepted(). To auto-reject, set the status of the
+   xfer to PURPLE_XFER_STATUS_CANCEL_LOCAL.
+  @param xfer The file transfer
+  @param data User data
+ @endsignaldef
+
+ @signaldef file-send-accept
+  @signalproto
+void (*file_send_accept)(PurpleXfer *xfer, gpointer data);
+  @endsignalproto
+  @signaldesc
+   Emitted when an outgoing file transfer has been accepted.
+  @param xfer The file transfer
+  @param data User data
+ @endsignaldef
+
+ @signaldef file-send-start
+  @signalproto
+void (*file_send_start)(PurpleXfer *xfer, gpointer data);
+  @endsignalproto
+  @signaldesc
+   Emitted when an outgoing file transfer has started.
+  @param xfer The file transfer
+  @param data User data
+ @endsignaldef
+
+ @signaldef file-send-cancel
+  @signalproto
+void (*file_send_cancel)(PurpleXfer *xfer, gpointer data);
+  @endsignalproto
+  @signaldesc
+   Emitted when an outgoing file transfer has been canceled.
+  @param xfer The file transfer
+  @param data User data
+ @endsignaldef
+
+ @signaldef file-send-complete
+  @signalproto
+void (*file_send_complete)(PurpleXfer *xfer, gpointer data);
+  @endsignalproto
+  @signaldesc
+   Emitted when an outgoing file transfer has been completed.
+  @param xfer The file transfer
+  @param data User data
+ @endsignaldef
+
+ */
+// vim: syntax=c.doxygen tw=75 et