comparison libpurple/cmds.h @ 25237:401f548e3544

propagate from branch 'im.pidgin.pidgin' (head df6eba32e5b6b34d7483cbfb7e9f2e4c836ac35f) to branch 'org.darkrain42.pidgin.buddy-add' (head 6831808999a270f8c1a128c7430a73d3dc0bfae2)
author Paul Aurich <paul@darkrain42.org>
date Sun, 21 Dec 2008 18:32:37 +0000
parents d8452c0bec7b
children 5876584828e8
comparison
equal deleted inserted replaced
25172:125cac3e24ee 25237:401f548e3544
36 PURPLE_CMD_STATUS_OK, 36 PURPLE_CMD_STATUS_OK,
37 PURPLE_CMD_STATUS_FAILED, 37 PURPLE_CMD_STATUS_FAILED,
38 PURPLE_CMD_STATUS_NOT_FOUND, 38 PURPLE_CMD_STATUS_NOT_FOUND,
39 PURPLE_CMD_STATUS_WRONG_ARGS, 39 PURPLE_CMD_STATUS_WRONG_ARGS,
40 PURPLE_CMD_STATUS_WRONG_PRPL, 40 PURPLE_CMD_STATUS_WRONG_PRPL,
41 PURPLE_CMD_STATUS_WRONG_TYPE, 41 PURPLE_CMD_STATUS_WRONG_TYPE
42 } PurpleCmdStatus; 42 } PurpleCmdStatus;
43 43
44 /** Commands registered with the core return one of these values when run. 44 /** Commands registered with the core return one of these values when run.
45 * Normally, a command will want to return one of the first two; in some 45 * Normally, a command will want to return one of the first two; in some
46 * unusual cases, you might want to have several functions called for a 46 * unusual cases, you might want to have several functions called for a
49 * commands with the same name. 49 * commands with the same name.
50 */ 50 */
51 typedef enum _PurpleCmdRet { 51 typedef enum _PurpleCmdRet {
52 PURPLE_CMD_RET_OK, /**< Everything's okay; Don't look for another command to call. */ 52 PURPLE_CMD_RET_OK, /**< Everything's okay; Don't look for another command to call. */
53 PURPLE_CMD_RET_FAILED, /**< The command failed, but stop looking.*/ 53 PURPLE_CMD_RET_FAILED, /**< The command failed, but stop looking.*/
54 PURPLE_CMD_RET_CONTINUE, /**< Continue, looking for other commands with the same name to call. */ 54 PURPLE_CMD_RET_CONTINUE /**< Continue, looking for other commands with the same name to call. */
55 } PurpleCmdRet; 55 } PurpleCmdRet;
56 56
57 #define PURPLE_CMD_FUNC(func) ((PurpleCmdFunc)func) 57 #define PURPLE_CMD_FUNC(func) ((PurpleCmdFunc)func)
58 58
59 /** A function implementing a command, as passed to purple_cmd_register(). 59 /** A function implementing a command, as passed to purple_cmd_register().
74 PURPLE_CMD_P_DEFAULT = 1000, 74 PURPLE_CMD_P_DEFAULT = 1000,
75 PURPLE_CMD_P_PRPL = 2000, 75 PURPLE_CMD_P_PRPL = 2000,
76 PURPLE_CMD_P_PLUGIN = 3000, 76 PURPLE_CMD_P_PLUGIN = 3000,
77 PURPLE_CMD_P_ALIAS = 4000, 77 PURPLE_CMD_P_ALIAS = 4000,
78 PURPLE_CMD_P_HIGH = 5000, 78 PURPLE_CMD_P_HIGH = 5000,
79 PURPLE_CMD_P_VERY_HIGH = 6000, 79 PURPLE_CMD_P_VERY_HIGH = 6000
80 } PurpleCmdPriority; 80 } PurpleCmdPriority;
81 81
82 /** Flags used to set various properties of commands. Every command should 82 /** Flags used to set various properties of commands. Every command should
83 * have at least one of #PURPLE_CMD_FLAG_IM and #PURPLE_CMD_FLAG_CHAT set in 83 * have at least one of #PURPLE_CMD_FLAG_IM and #PURPLE_CMD_FLAG_CHAT set in
84 * order to be even slighly useful. 84 * order to be even slighly useful.
91 /** Command is usable in multi-user chats. */ 91 /** Command is usable in multi-user chats. */
92 PURPLE_CMD_FLAG_CHAT = 0x02, 92 PURPLE_CMD_FLAG_CHAT = 0x02,
93 /** Command is usable only for a particular prpl. */ 93 /** Command is usable only for a particular prpl. */
94 PURPLE_CMD_FLAG_PRPL_ONLY = 0x04, 94 PURPLE_CMD_FLAG_PRPL_ONLY = 0x04,
95 /** Incorrect arguments to this command should be accepted anyway. */ 95 /** Incorrect arguments to this command should be accepted anyway. */
96 PURPLE_CMD_FLAG_ALLOW_WRONG_ARGS = 0x08, 96 PURPLE_CMD_FLAG_ALLOW_WRONG_ARGS = 0x08
97 } PurpleCmdFlag; 97 } PurpleCmdFlag;
98 98
99 99
100 /*@}*/ 100 /*@}*/
101 101