enticeplugin

struct EnticeFunctions;

Functions provided to the plugin by Entice Designer.

int id;

This plugin ID.

int more;

int(* showMsg)(int pluginid, char* msg, int msglen, int msgtype);

Show a message: int showMsg(int pluginid, char* msg, int msglen, int msgtype);

Params:

pluginid	this plugin ID.
msg	pointer to the message.
msglen	length of bytes at msg.
msgtype	one of SHOW_MSG_* constants.

int(* registerMenuItem)(int pluginid, char* name, int namelen, int menuid, int tomenuid, void(* callback)(EnticeFunctions * efuncs, int id));

Interface with menus: int registerMenuItem(int pluginid, char* name, int namelen, int menuid, int tomenuid, EnticeIdCallback callback);

Params:

pluginid	this plugin ID.
name	pointer to the name displayed on the menu item.
namelen	length of bytes at name.
menuid	menu ID unique to this plugin. Must be positive.
tomenuid	the parent menu to add to, -1 to remove, or one of EMENU_* constants.
callback	called back on click: menuCallback(EnticeFunctions* efuncs, int menuid);

Returns:
0 on failure.

int(* registerShortcut)(int pluginid, int keys, int shortcutid, void(* callback)(EnticeFunctions * efuncs, int id));

Interface with shortcut keys: int registerShortcut(int pluginid, int keys, int shortcutid, EnticeIdCallback callback);

Params:

pluginid	this plugin ID.
keys	key code.
shortcutid	shortcut ID unique to this plugin. Must be positive.
callback	called back upon user pressing the shortcut: shortcutCallback(EnticeFunctions* efuncs, int shortcutid);

Returns:
0 on failure.

int(* getFeature)(int pluginid, int featureid, void* getinfo, uint getinfosize);

Access a feature: int getFeature(int pluginid, int featureid, void* getinfo, size_t getinfosize);

Params:

pluginid	this plugin ID.
featureid	feature ID; one of EFID_* constants.
getinfo	pointer to a buffer used by the feature, which may or may not be written to.
getinfosize	number of bytes at getinfo for use by the feature.

Returns:
defined by the feature; typically 0 on failure.

const int SHOW_MSG_BOX;
const int SHOW_MSG_BOX_INFO;
const int SHOW_MSG_BOX_ERROR;
const int SHOW_MSG_BOX_CONFIRM;
const int SHOW_MSG_OUTPUT;
const int SHOW_MSG_INPUT;

How a message will be shown.

const int EMENU_DEFAULT;
const int EMENU_EDIT;
const int EMENU_SEARCH;

Preset parent menu IDs.

const int EFID_CONFIG;
const int EFID_CURFILE;
const int EFID_CMDEXEC;
const int EFID_EDITORGETSELTEXT;
const int EFID_EDITORSETSELTEXT;
const int EFID_EXIT;
const int EFID_CURTABTYPE;

Feature IDs.

const int ETAB_NONE;
const int ETAB_UNKNOWN;
const int ETAB_EDITOR;
const int ETAB_DESIGN;

const int EF_CONFIG_PLUGIN;
const int EF_CONFIG_CURDIR;

struct EF_Config;

int(* getConfig)(int pluginid, int configtype, char* name, int namelen, char* value, int valuelen);

int(* setConfig)(int pluginid, int configtype, char* name, int namelen, char* value, int valuelen);

struct EnticePluginInfo;