Mercurial > pidgin.yaz
diff doc/account-signals.dox @ 6605:943b03bcecf5
[gaim-migrate @ 7129]
Added some signal documentation. The conversation signal docs are taking
forever. Who wants to help? :)
committer: Tailor Script <tailor@pidgin.im>
author | Christian Hammond <chipx86@chipx86.com> |
---|---|
date | Sun, 24 Aug 2003 06:32:28 +0000 |
parents | |
children | 34eaa941ecd6 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/account-signals.dox Sun Aug 24 06:32:28 2003 +0000 @@ -0,0 +1,65 @@ +/** @page account-signals Account Signals + + @signals + @signal account-away + @signal account-connecting + @signal account-setting-info + @signal account-set-info + @endsignals + + <hr> + + @signaldef account-away + @signalproto +void (*account_away)(GaimAccount *account, const char *state, const char *message); + @endsignalproto + @param account The account that went away. + @param state The away state. + @param message The away message. + @signaldesc + Emitted when an account goes away. + @endsignaldef + + @signaldef account-connecting + @signalproto +void (*account_connecting)(GaimAccount *account); + @endsignalproto + @param account The account in the process of connecting. + @signaldesc + This is called when an account is in the process of connecting. + @endsignaldef + + @signaldef account-setting-info + @signalproto +void (*account_setting_info)(GaimAccount *account, const char *new_info); + @endsignalproto + @param account The account that the info will be set on. + @param new_info The new information to set. + @signaldesc + Emitted when a user is about to send his new user info, or + profile, to the server. + @endsignaldef + + @signaldef account-set-info + @signalproto +void (*account_set_info)(GaimAccount *account, const char *new_info); + @endsignalproto + @param account The account that the info was set on. + @param new_info The new information set. + @signaldesc + Emitted when a user sent his new user info, or profile, to the server. + @endsignaldef + + @signaldef account-warned + @signalproto +void (*account_warned)(GaimAccount *account, const char *warner, int level); + @endsignalproto + @param account The account that was warned. + @param warner The screenname of the user that warned the account. + @param level The new warning level. + @signaldesc + Emitted when an account got warned. + @endsignaldef + + */ +// vim: syntax=c tw=75 et