doc/cmd-signals.dox

Mon, 08 Jun 2009 02:24:49 +0000

author
Elliott Sales de Andrade <qulogic@pidgin.im>
date
Mon, 08 Jun 2009 02:24:49 +0000
changeset 27314
402d25ce01da
parent 23557
73ca7c62ad11
permissions
-rw-r--r--

Use the JID for adding a chat/buddy because the name is for descriptive
purpose only, and using it will not fill in the Add Chat dialog correctly.
Because the JID is not visible, the user will not know what to actually put
there instead.

23557
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
1 /** @page cmd-signals Command Signals
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
2 @signals
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
3 @signal cmd-added
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
4 @signal cmd-removed
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
5 @endsignals
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
6
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
7 @see cmds.h
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
8
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
9 @signaldef cmd-added
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
10 @signalproto
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
11 void (*cmd_added)(const char *command, PurpleCmdPriority priority,
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
12 PurpleCmdFlag flag);
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
13 @endsignalproto
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
14 @signaldesc
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
15 Emitted when a new command is added.
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
16 @param command The new command.
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
17 @param priority The priority of the new command.
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
18 @param flag The command flags.
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
19 @endsignaldef
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
20
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
21 @signaldef cmd-removed
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
22 @signalproto
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
23 void (*cmd_removed)(const char *command);
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
24 @endsignalproto
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
25 @signaldesc
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
26 Emitted when a command is removed.
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
27 @param command The removed command.
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
28 @endsignaldef
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
29 */

mercurial