doc/account-signals.dox@0ff56edeaaaf (annotated)
doc/account-signals.dox
Fri, 18 Nov 2005 12:22:20 +0000
- author
- Casey Harkins <charkins@pidgin.im>
- date
- Fri, 18 Nov 2005 12:22:20 +0000
- changeset 12127
- 0ff56edeaaaf
- parent 12070
- e678eea4d899
- child 13282
- 83e33fe74de3
- permissions
- -rw-r--r--
[gaim-migrate @ 14427]
SF Patch #1358278 from charkins
"There was likely a collision between the patch which
added the account-(en|dis)abled signals and a patch
which added cleaned up the signal documentation. The
lines for these signals are missing from the top of
account-signals.dox and ChangeLog.API. This patch adds
them in."
committer: Richard Laager <rlaager@pidgin.im>
| 6605 | 1 | /** @page account-signals Account Signals |
| 2 | ||
| 3 | @signals | |
|
12053
5aa634db0fc1
[gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
11685
diff
changeset
|
4 | @signal account-added |
| 6605 | 5 | @signal account-connecting |
|
12053
5aa634db0fc1
[gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
11685
diff
changeset
|
6 | @signal account-removed |
|
12127
0ff56edeaaaf
[gaim-migrate @ 14427]
Casey Harkins <charkins@pidgin.im>
parents:
12070
diff
changeset
|
7 | @signal account-disabled |
|
0ff56edeaaaf
[gaim-migrate @ 14427]
Casey Harkins <charkins@pidgin.im>
parents:
12070
diff
changeset
|
8 | @signal account-enabled |
| 6605 | 9 | @signal account-setting-info |
| 10 | @signal account-set-info | |
| 11628 | 11 | @signal account-status-changed |
| 6605 | 12 | @endsignals |
| 13 | ||
| 14 | <hr> | |
| 15 | ||
|
12053
5aa634db0fc1
[gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
11685
diff
changeset
|
16 | @signaldef account-added |
|
5aa634db0fc1
[gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
11685
diff
changeset
|
17 | @signalproto |
|
5aa634db0fc1
[gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
11685
diff
changeset
|
18 | void (*account_added)(GaimAccount *account); |
|
5aa634db0fc1
[gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
11685
diff
changeset
|
19 | @endsignalproto |
|
5aa634db0fc1
[gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
11685
diff
changeset
|
20 | @signaldesc |
|
5aa634db0fc1
[gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
11685
diff
changeset
|
21 | Emitted when an account is added. |
|
5aa634db0fc1
[gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
11685
diff
changeset
|
22 | @param account The account that was added. |
|
5aa634db0fc1
[gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
11685
diff
changeset
|
23 | @endsignaldef |
|
5aa634db0fc1
[gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
11685
diff
changeset
|
24 | |
| 6605 | 25 | @signaldef account-connecting |
| 26 | @signalproto | |
| 27 | void (*account_connecting)(GaimAccount *account); | |
| 28 | @endsignalproto | |
| 29 | @signaldesc | |
| 30 | This is called when an account is in the process of connecting. | |
|
6606
1387777368c7
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
31 | @param account The account in the process of connecting. |
| 6605 | 32 | @endsignaldef |
| 33 | ||
|
12053
5aa634db0fc1
[gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
11685
diff
changeset
|
34 | @signaldef account-removed |
|
5aa634db0fc1
[gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
11685
diff
changeset
|
35 | @signalproto |
|
5aa634db0fc1
[gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
11685
diff
changeset
|
36 | void (*account_removed)(GaimAccount *account); |
|
5aa634db0fc1
[gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
11685
diff
changeset
|
37 | @endsignalproto |
|
5aa634db0fc1
[gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
11685
diff
changeset
|
38 | @signaldesc |
|
5aa634db0fc1
[gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
11685
diff
changeset
|
39 | Emitted when an account is removed. |
|
5aa634db0fc1
[gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
11685
diff
changeset
|
40 | @param account The account that was removed. |
|
5aa634db0fc1
[gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
11685
diff
changeset
|
41 | @endsignaldef |
|
5aa634db0fc1
[gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
11685
diff
changeset
|
42 | |
| 12070 | 43 | @signaldef account-disabled |
| 44 | @signalproto | |
| 45 | void (*account_disabled)(GaimAccount *account); | |
| 46 | @endsignalproto | |
| 47 | @signaldesc | |
| 48 | Emitted when an account is disabled. | |
| 49 | @param account The account that was disabled. | |
| 50 | @endsignaldef | |
| 51 | ||
| 52 | @signaldef account-enabled | |
| 53 | @signalproto | |
| 54 | void (*account_enabled)(GaimAccount *account); | |
| 55 | @endsignalproto | |
| 56 | @signaldesc | |
| 57 | Emitted when an account is enabled. | |
| 58 | @param account The account that was enabled. | |
| 59 | @endsignaldef | |
| 60 | ||
| 6605 | 61 | @signaldef account-setting-info |
| 62 | @signalproto | |
| 63 | void (*account_setting_info)(GaimAccount *account, const char *new_info); | |
| 64 | @endsignalproto | |
| 65 | @signaldesc | |
| 66 | Emitted when a user is about to send his new user info, or | |
| 67 | profile, to the server. | |
|
6606
1387777368c7
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
68 | @param account The account that the info will be set on. |
|
1387777368c7
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
69 | @param new_info The new information to set. |
| 6605 | 70 | @endsignaldef |
| 71 | ||
| 72 | @signaldef account-set-info | |
| 73 | @signalproto | |
| 74 | void (*account_set_info)(GaimAccount *account, const char *new_info); | |
| 75 | @endsignalproto | |
|
6606
1387777368c7
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
76 | @signaldesc |
|
1387777368c7
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
77 | Emitted when a user sent his new user info, or profile, to the server. |
| 6605 | 78 | @param account The account that the info was set on. |
| 79 | @param new_info The new information set. | |
| 80 | @endsignaldef | |
| 81 | ||
| 11628 | 82 | @signaldef account-status-changed |
| 83 | @signalproto | |
| 84 | void (*account_status_changed)(GaimAccount *account, GaimStatus *old, GaimStatus *new); | |
| 85 | @endsignalproto | |
| 86 | @signaldesc | |
| 87 | Emitted when the status of an account changes (after the change). | |
| 88 | @param account The account that changed status. | |
| 89 | @param old The status before change. | |
| 90 | @param new The status after change. | |
| 91 | @endsignaldef | |
| 92 | ||
| 6605 | 93 | */ |
| 94 | // vim: syntax=c tw=75 et |
