doc/account-signals.dox

   1 /** @page account-signals Account Signals
   2
   3  @signals
   4   @signal account-created
   5   @signal account-destroying
   6   @signal account-added
   7   @signal account-connecting
   8   @signal account-removed
   9   @signal account-disabled
  10   @signal account-enabled
  11   @signal account-setting-info
  12   @signal account-set-info
  13   @signal account-status-changed
  14   @signal account-actions-changed
  15   @signal account-alias-changed
  16   @signal account-authorization-requested
  17   @signal account-authorization-denied
  18   @signal account-authorization-granted
  19   @signal account-error-changed
  20  @endsignals
  21
  22  @see account.h
  23
  24  <hr>
  25
  26  @signaldef account-created
  27   @signalproto
  28 void (*account_created)(PurpleAccount *account);
  29   @endsignalproto
  30   @signaldesc
  31    Emitted when an account is created by calling purple_account_new.
  32   @param account The account.
  33   @since 2.6.0
  34  @endsignaldef
  35
  36  @signaldef account-destroying
  37   @signalproto
  38 void (*account_destroying)(PurpleAccount *account);
  39   @endsignalproto
  40   @signaldesc
  41    Emitted when an account is about to be destroyed.
  42   @param account The account.
  43   @since 2.6.0
  44  @endsignaldef
  45
  46  @signaldef account-added
  47   @signalproto
  48 void (*account_added)(PurpleAccount *account);
  49   @endsignalproto
  50   @signaldesc
  51    Emitted when an account is added.
  52   @param account The account that was added.
  53   @see purple_accounts_add
  54  @endsignaldef
  55
  56  @signaldef account-connecting
  57   @signalproto
  58 void (*account_connecting)(PurpleAccount *account);
  59   @endsignalproto
  60   @signaldesc
  61    This is called when an account is in the process of connecting.
  62   @param account The account in the process of connecting.
  63  @endsignaldef
  64
  65  @signaldef account-removed
  66   @signalproto
  67 void (*account_removed)(PurpleAccount *account);
  68   @endsignalproto
  69   @signaldesc
  70    Emitted when an account is removed.
  71   @param account The account that was removed.
  72   @see purple_accounts_remove
  73  @endsignaldef
  74
  75  @signaldef account-disabled
  76   @signalproto
  77 void (*account_disabled)(PurpleAccount *account);
  78   @endsignalproto
  79   @signaldesc
  80    Emitted when an account is disabled.
  81   @param account The account that was disabled.
  82  @endsignaldef
  83
  84  @signaldef account-enabled
  85   @signalproto
  86 void (*account_enabled)(PurpleAccount *account);
  87   @endsignalproto
  88   @signaldesc
  89    Emitted when an account is enabled.
  90   @param account The account that was enabled.
  91  @endsignaldef
  92
  93  @signaldef account-setting-info
  94   @signalproto
  95 void (*account_setting_info)(PurpleAccount *account, const char *new_info);
  96   @endsignalproto
  97   @signaldesc
  98    Emitted when a user is about to send his new user info, or
  99    profile, to the server.
 100   @param account  The account that the info will be set on.
 101   @param new_info The new information to set.
 102  @endsignaldef
 103
 104  @signaldef account-set-info
 105   @signalproto
 106 void (*account_set_info)(PurpleAccount *account, const char *new_info);
 107   @endsignalproto
 108   @signaldesc
 109    Emitted when a user sent his new user info, or profile, to the server.
 110   @param account  The account that the info was set on.
 111   @param new_info The new information set.
 112  @endsignaldef
 113
 114  @signaldef account-status-changed
 115   @signalproto
 116 void (*account_status_changed)(PurpleAccount *account, PurpleStatus *old, PurpleStatus *new);
 117   @endsignalproto
 118   @signaldesc
 119    Emitted when the status of an account changes (after the change).
 120   @param account The account that changed status.
 121   @param old     The status before change.
 122   @param new     The status after change.
 123  @endsignaldef
 124
 125  @signaldef account-actions-changed
 126   @signalproto
 127 void (*account_actions_changed)(PurpleAccount *account);
 128   @endsignalproto
 129   @signaldesc
 130    Emitted when the account actions are changed after initial connection.
 131   @param account The account whose actions changed.
 132  @endsignaldef
 133
 134  @signaldef account-alias-changed
 135   @signalproto
 136 void (*account_alias_changed)(PurpleAccount *account, const char *old);
 137   @endsignalproto
 138   @signaldesc
 139    Emitted when the alias of an account changes (after the change).
 140   @param account The account for which the alias was changed.
 141   @param old     The alias before change.
 142  @endsignaldef
 143
 144  @signaldef account-authorization-requested
 145   @signalproto
 146 int (*account_authorization_requested)(PurpleAccount *account, const char *user);
 147   @endsignalproto
 148   @signaldesc
 149    Emitted when a user requests authorization.
 150   @param account The account.
 151   @param user    The name of the user requesting authorization.
 152   @return Less than zero to deny the request without prompting, greater
 153           than zero if the request should be granted. If zero is returned,
 154           then the user will be prompted with the request.
 155   @since 2.3.0
 156  @endsignaldef
 157
 158  @signaldef account-authorization-denied
 159   @signalproto
 160 void (*account_authorization_denied)(PurpleAccount *account, const char *user);
 161   @endsignalproto
 162   @signaldesc
 163    Emitted when the authorization request for a buddy is denied.
 164   @param account The account.
 165   @param user    The name of the user requesting authorization.
 166   @since 2.3.0
 167  @endsignaldef
 168
 169  @signaldef account-authorization-granted
 170   @signalproto
 171 void (*account_authorization_granted)(PurpleAccount *account, const char *user);
 172   @endsignalproto
 173   @signaldesc
 174    Emitted when the authorization request for a buddy is granted.
 175   @param account The account.
 176   @param user    The name of the user requesting authorization.
 177   @since 2.3.0
 178  @endsignaldef
 179
 180  @signaldef account-error-changed
 181   @signalproto
 182 void (*account_error_changed)(PurpleAccount *account, const PurpleConnectionErrorInfo *old_error, const PurpleConnectionErrorInfo *current_error);
 183   @endsignalproto
 184   @signaldesc
 185    Emitted when @a account's error changes.  You should not call
 186    purple_account_clear_current_error() while this signal is being emitted.
 187   @param account   The account whose error has changed.
 188   @param old_error The account's previous error, or @c NULL if it had no
 189                    error.  After this signal is emitted, @a old_error is
 190                    not guaranteed to be a valid pointer.
 191   @param new_error The account's new error, or @c NULL if it has no error.
 192                    If not @c NULL, @a new_error will remain a valid until
 193                    pointer just after the next time this signal is emitted
 194                    for this @a account.
 195   @see purple_account_get_current_error()
 196   @since 2.3.0
 197  @endsignaldef
 198
 199  */
 200 // vim: syntax=c.doxygen tw=75 et