doc/reference/libpurple/account-signals.dox

branch
soc.2013.gobjectification.plugins
changeset 36900
423fbe5e5289
parent 33688
9454bda83147
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/reference/libpurple/account-signals.dox	Sun Oct 13 15:41:22 2013 +0530
@@ -0,0 +1,231 @@
+/** @page account-signals Account Signals
+
+ @signals
+  @signal account-created
+  @signal account-destroying
+  @signal account-added
+  @signal account-connecting
+  @signal account-removed
+  @signal account-disabled
+  @signal account-enabled
+  @signal account-setting-info
+  @signal account-set-info
+  @signal account-status-changed
+  @signal account-actions-changed
+  @signal account-alias-changed
+  @signal account-authorization-requested
+  @signal account-authorization-denied
+  @signal account-authorization-granted
+  @signal account-error-changed
+  @signal account-signed-on
+  @signal account-signed-off
+  @signal account-connection-error
+ @endsignals
+
+ @see account.h
+
+ <hr>
+
+ @signaldef account-created
+  @signalproto
+void (*account_created)(PurpleAccount *account);
+  @endsignalproto
+  @signaldesc
+   Emitted when an account is created by calling purple_account_new.
+  @param account The account.
+ @endsignaldef
+
+ @signaldef account-destroying
+  @signalproto
+void (*account_destroying)(PurpleAccount *account);
+  @endsignalproto
+  @signaldesc
+   Emitted when an account is about to be destroyed.
+  @param account The account.
+ @endsignaldef
+
+ @signaldef account-added
+  @signalproto
+void (*account_added)(PurpleAccount *account);
+  @endsignalproto
+  @signaldesc
+   Emitted when an account is added.
+  @param account The account that was added.
+  @see purple_accounts_add
+ @endsignaldef
+
+ @signaldef account-connecting
+  @signalproto
+void (*account_connecting)(PurpleAccount *account);
+  @endsignalproto
+  @signaldesc
+   This is called when an account is in the process of connecting.
+  @param account The account in the process of connecting.
+ @endsignaldef
+
+ @signaldef account-removed
+  @signalproto
+void (*account_removed)(PurpleAccount *account);
+  @endsignalproto
+  @signaldesc
+   Emitted when an account is removed.
+  @param account The account that was removed.
+  @see purple_accounts_remove
+ @endsignaldef
+
+ @signaldef account-disabled
+  @signalproto
+void (*account_disabled)(PurpleAccount *account);
+  @endsignalproto
+  @signaldesc
+   Emitted when an account is disabled.
+  @param account The account that was disabled.
+ @endsignaldef
+
+ @signaldef account-enabled
+  @signalproto
+void (*account_enabled)(PurpleAccount *account);
+  @endsignalproto
+  @signaldesc
+   Emitted when an account is enabled.
+  @param account The account that was enabled.
+ @endsignaldef
+
+ @signaldef account-setting-info
+  @signalproto
+void (*account_setting_info)(PurpleAccount *account, const char *new_info);
+  @endsignalproto
+  @signaldesc
+   Emitted when a user is about to send his new user info, or
+   profile, to the server.
+  @param account  The account that the info will be set on.
+  @param new_info The new information to set.
+ @endsignaldef
+
+ @signaldef account-set-info
+  @signalproto
+void (*account_set_info)(PurpleAccount *account, const char *new_info);
+  @endsignalproto
+  @signaldesc
+   Emitted when a user sent his new user info, or profile, to the server.
+  @param account  The account that the info was set on.
+  @param new_info The new information set.
+ @endsignaldef
+
+ @signaldef account-status-changed
+  @signalproto
+void (*account_status_changed)(PurpleAccount *account, PurpleStatus *old, PurpleStatus *new);
+  @endsignalproto
+  @signaldesc
+   Emitted when the status of an account changes (after the change).
+  @param account The account that changed status.
+  @param old     The status before change.
+  @param new     The status after change.
+ @endsignaldef
+
+ @signaldef account-actions-changed
+  @signalproto
+void (*account_actions_changed)(PurpleAccount *account);
+  @endsignalproto
+  @signaldesc
+   Emitted when the account actions are changed after initial connection.
+  @param account The account whose actions changed.
+ @endsignaldef
+
+ @signaldef account-alias-changed
+  @signalproto
+void (*account_alias_changed)(PurpleAccount *account, const char *old);
+  @endsignalproto
+  @signaldesc
+   Emitted when the alias of an account changes (after the change).
+  @param account The account for which the alias was changed.
+  @param old     The alias before change.
+ @endsignaldef
+
+ @signaldef account-authorization-requested
+  @signalproto
+int (*account_authorization_requested)(PurpleAccount *account, const char *user, const char *message, char **response);
+  @endsignalproto
+  @signaldesc
+   Emitted when a user requests authorization.
+  @param account  The account.
+  @param user     The name of the user requesting authorization.
+  @param message  The authorization request message.
+  @param response The message to send in the response.
+  @return PURPLE_ACCOUNT_RESPONSE_IGNORE to silently ignore the request,
+          PURPLE_ACCOUNT_RESPONSE_DENY to block the request (the sender might
+          get informed), PURPLE_ACCOUNT_RESPONSE_ACCEPT if the request should be
+          granted. If PURPLE_ACCOUNT_RESPONSE_PASS is returned, then the user
+          will be prompted with the request.
+ @endsignaldef
+
+ @signaldef account-authorization-denied
+  @signalproto
+void (*account_authorization_denied)(PurpleAccount *account, const char *user, const char *message);
+  @endsignalproto
+  @signaldesc
+   Emitted when the authorization request for a buddy is denied.
+  @param account The account.
+  @param user    The name of the user requesting authorization.
+  @param message The message to tell the buddy who was denied.
+ @endsignaldef
+
+ @signaldef account-authorization-granted
+  @signalproto
+void (*account_authorization_granted)(PurpleAccount *account, const char *user, const char *message);
+  @endsignalproto
+  @signaldesc
+   Emitted when the authorization request for a buddy is granted.
+  @param account The account.
+  @param user    The name of the user requesting authorization.
+  @param message The message to tell the buddy who was granted authorization.
+ @endsignaldef
+
+ @signaldef account-error-changed
+  @signalproto
+void (*account_error_changed)(PurpleAccount *account, const PurpleConnectionErrorInfo *old_error, const PurpleConnectionErrorInfo *current_error);
+  @endsignalproto
+  @signaldesc
+   Emitted when @a account's error changes.  You should not call
+   purple_account_clear_current_error() while this signal is being emitted.
+  @param account   The account whose error has changed.
+  @param old_error The account's previous error, or @c NULL if it had no
+                   error.  After this signal is emitted, @a old_error is
+                   not guaranteed to be a valid pointer.
+  @param new_error The account's new error, or @c NULL if it has no error.
+                   If not @c NULL, @a new_error will remain a valid until
+                   pointer just after the next time this signal is emitted
+                   for this @a account.
+  @see purple_account_get_current_error()
+ @endsignaldef
+
+ @signaldef account-signed-on
+  @signalproto
+void (*signed_on)(PurpleAccount *account);
+  @endsignalproto
+  @signaldesc
+   Emitted when an account has signed on.
+  @param account The account that has signed on.
+ @endsignaldef
+
+ @signaldef account-signed-off
+  @signalproto
+void (*signed_off)(PurpleAccount *account);
+  @endsignalproto
+  @signaldesc
+   Emitted when an account has signed off.
+  @param account The account that has signed off.
+ @endsignaldef
+
+ @signaldef account-connection-error
+  @signalproto
+void (*connection_error)(PurpleAccount *gc, PurpleConnectionError err, const gchar *desc)
+  @endsignalproto
+  @signaldesc
+   Emitted when a connection error occurs, before @ref signed-off.
+   @param account The account on which the error has occurred
+   @param err     The error that occurred
+   @param desc    A description of the error, giving more information.
+ @endsignaldef
+ */
+// vim: syntax=c.doxygen tw=75 et

mercurial