diff doc/account-signals.dox @ 26845:76a1598ecf1c

Add account-(created|destroying) signals. These differ from account-(added|removed) in that they're called at allocation/destruction time instead of when adding the account to the account.c-scoped accounts list (nullclient doesn't call purple_accounts_add). For 3.0.0, barring complaints, it might be reasonable to remove purple_accounts_add and fold purple_accounts_remove into purple_accounts_delete and drop their signals.
author Paul Aurich <paul@darkrain42.org>
date Fri, 01 May 2009 06:59:36 +0000
parents 83e6e710cbf3
children 0417d6bc47cd
line wrap: on
line diff
--- a/doc/account-signals.dox	Thu Apr 30 14:44:01 2009 +0000
+++ b/doc/account-signals.dox	Fri May 01 06:59:36 2009 +0000
@@ -1,6 +1,8 @@
 /** @page account-signals Account Signals
 
  @signals
+  @signal account-created
+  @signal account-destroying
   @signal account-added
   @signal account-connecting
   @signal account-removed
@@ -21,6 +23,26 @@
 
  <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.
+  @since 2.6.0
+ @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.
+  @since 2.6.0
+ @endsignaldef
+
  @signaldef account-added
   @signalproto
 void (*account_added)(PurpleAccount *account);
@@ -28,6 +50,7 @@
   @signaldesc
    Emitted when an account is added.
   @param account The account that was added.
+  @see purple_accounts_add
  @endsignaldef
 
  @signaldef account-connecting
@@ -46,6 +69,7 @@
   @signaldesc
    Emitted when an account is removed.
   @param account The account that was removed.
+  @see purple_accounts_remove
  @endsignaldef
 
  @signaldef account-disabled