action_desc_t Struct Reference

Describe an action to be registered (see register_action()) More...

#include <kernwin.hpp>

Public Attributes
int	cb
	size of this structure
const char *	name
	the internal name of the action; must be unique. More...
const char *	label
	the label of the action, possibly with an accelerator key definition (e.g., "~J~ump to operand")
action_handler_t *	handler
	the action handler, for activating/updating. More...
const void *	owner
	either the plugin_t, or plugmod_t responsible for registering the action. More...
const char *	shortcut
	an optional shortcut definition. E.g., "Ctrl+Enter"
const char *	tooltip
	an optional tooltip for the action
int	icon
	an optional icon ID to use
int	flags
	See Action flags.

Detailed Description

Describe an action to be registered (see register_action())

Member Data Documentation

name

const char* action_desc_t::name

the internal name of the action; must be unique.

a way to reduce possible conflicts is to prefix it with some specific prefix. E.g., "myplugin:doSthg".

handler

action_handler_t* action_desc_t::handler

the action handler, for activating/updating.

please read the comments at register_action().

owner

const void* action_desc_t::owner

either the plugin_t, or plugmod_t responsible for registering the action.

Can be nullptr Please see ACTION_DESC_LITERAL_PLUGMOD

---

The documentation for this struct was generated from the following file:

• kernwin.hpp