view 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 <[e-mail]>

/** @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