Mercurial > pidgin.yaz
view doc/xfer-signals.dox @ 22119:392bfb84d372
Clarify documentation of purple_account_set_status_list(), and use @copydoc to
make purple_account_set_status() have the exact same text (prefixed with a
remark about being a vargs version of the former).
Do people like this? We have duplicated docs all over the place with vargs and
GList/va_list versions of functions, and it seems like we should either use
@copydoc for one, or make its doc just read "version of foo_list(), see it for
documentation".
(Why -do- we have two versions of everything?)
author | Will Thompson <will.thompson@collabora.co.uk> |
---|---|
date | Tue, 15 Jan 2008 19:33:20 +0000 |
parents | e0613cf8c493 |
children |
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 @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