Mercurial > pidgin
view doc/xfer-signals.dox @ 19133:c6282dc3fb9f
propagate from branch 'im.pidgin.pidgin' (head 6521407fd5a6d9175e6532a874a2735658c113e9)
to branch 'im.pidgin.soc.2007.finchfeat' (head 47dd316bb08a5320b3e606960fd08c7678429657)
author | Eric Polino <aluink@pidgin.im> |
---|---|
date | Thu, 05 Jul 2007 02:41:26 +0000 |
parents | 1414e0e01dc5 |
children | e0613cf8c493 |
line wrap: on
line source
/** @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 <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 tw=75 et