Copyright (C) 2003 Timothy Ringenbach <omarvo@hotmail.com>. More...
#include "conversation.h"
Include dependency graph for cmds.h:
Go to the source code of this file.
Structures | |
#define | PURPLE_CMD_FUNC(func) ((PurpleCmdFunc)func) |
typedef enum _PurpleCmdPriority | PurpleCmdPriority |
typedef enum _PurpleCmdFlag | PurpleCmdFlag |
typedef enum _PurpleCmdStatus | PurpleCmdStatus |
typedef enum _PurpleCmdRet | PurpleCmdRet |
typedef PurpleCmdRet(* | PurpleCmdFunc )(PurpleConversation *, const gchar *cmd, gchar **args, gchar **error, void *data) |
typedef guint | PurpleCmdId |
enum | _PurpleCmdStatus { PURPLE_CMD_STATUS_OK, PURPLE_CMD_STATUS_FAILED, PURPLE_CMD_STATUS_NOT_FOUND, PURPLE_CMD_STATUS_WRONG_ARGS, PURPLE_CMD_STATUS_WRONG_PRPL, PURPLE_CMD_STATUS_WRONG_TYPE } |
enum | _PurpleCmdRet { PURPLE_CMD_RET_OK, PURPLE_CMD_RET_FAILED, PURPLE_CMD_RET_CONTINUE } |
enum | _PurpleCmdPriority { PURPLE_CMD_P_VERY_LOW = -1000, PURPLE_CMD_P_LOW = 0, PURPLE_CMD_P_DEFAULT = 1000, PURPLE_CMD_P_PRPL = 2000, PURPLE_CMD_P_PLUGIN = 3000, PURPLE_CMD_P_ALIAS = 4000, PURPLE_CMD_P_HIGH = 5000, PURPLE_CMD_P_VERY_HIGH = 6000 } |
enum | _PurpleCmdFlag { PURPLE_CMD_FLAG_IM = 0x01, PURPLE_CMD_FLAG_CHAT = 0x02, PURPLE_CMD_FLAG_PRPL_ONLY = 0x04, PURPLE_CMD_FLAG_ALLOW_WRONG_ARGS = 0x08 } |
Commands API | |
PurpleCmdId | purple_cmd_register (const gchar *cmd, const gchar *args, PurpleCmdPriority p, PurpleCmdFlag f, const gchar *prpl_id, PurpleCmdFunc func, const gchar *helpstr, void *data) |
Register a new command with the core. | |
void | purple_cmd_unregister (PurpleCmdId id) |
Unregister a command with the core. | |
PurpleCmdStatus | purple_cmd_do_command (PurpleConversation *conv, const gchar *cmdline, const gchar *markup, gchar **errormsg) |
Do a command. | |
GList * | purple_cmd_list (PurpleConversation *conv) |
List registered commands. | |
GList * | purple_cmd_help (PurpleConversation *conv, const gchar *cmd) |
Get the help string for a command. |
Copyright (C) 2003 Timothy Ringenbach <omarvo@hotmail.com>.
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
|
Do a command. Normally the UI calls this to perform a command. This might also be useful if aliases are ever implemented.
|
|
Get the help string for a command. Returns the help strings for a given command in the form of a GList, one node for each matching command.
|
|
List registered commands.
Returns a GList (which must be freed by the caller) of all commands that are valid in the context of conv, or all commands, if conv is
|
|
Register a new command with the core. The command will only happen if commands are enabled, which is a UI pref. UIs don't have to support commands at all.
|
|
Unregister a command with the core. All registered commands must be unregistered, if they're registered by a plugin or something else that might go away. Normally this is called when the plugin unloads itself.
|