init_8h_source.html

#ifndef MUTT_KEY_INIT_H

#define MUTT_KEY_INIT_H


#include "keymap.h"

#include "menu.h"


struct NotifyCallback;


extern keycode_t AbortKey;


extern struct SubMenuArray        SubMenus;

extern struct MenuDefinitionArray MenuDefs;


void                   km_cleanup          (void);

int                    km_config_observer  (struct NotifyCallback *nc);

void                   km_init             (void);

void                   km_menu_add_bindings(struct MenuDefinition *md, const struct MenuOpSeq bindings[]);

void                   km_menu_add_submenu (struct MenuDefinition *md, struct SubMenu *sm);

struct MenuDefinition *km_register_menu    (int menu, const char *name);

struct SubMenu *       km_register_submenu (const struct MenuFuncOp functions[]);

void                   km_set_abort_key    (void);

void                   km_sort             (void);


#endif /* MUTT_KEY_INIT_H */

km_config_observer
int km_config_observer(struct NotifyCallback *nc)
Notification that a Config Variable has changed - Implements observer_t -.
Definition init.c:150

MenuDefs
struct MenuDefinitionArray MenuDefs
All the registered Menus.
Definition init.c:42

AbortKey
keycode_t AbortKey
code of key to abort prompts, normally Ctrl-G
Definition init.c:47

SubMenus
struct SubMenuArray SubMenus
All the registered SubMenus.
Definition init.c:45

km_menu_add_submenu
void km_menu_add_submenu(struct MenuDefinition *md, struct SubMenu *sm)
Add a SubMenu to a Menu Definition.
Definition init.c:123

km_cleanup
void km_cleanup(void)
Free the key maps.
Definition init.c:200

km_init
void km_init(void)
Initialise all the menu keybindings.
Definition init.c:170

km_register_submenu
struct SubMenu * km_register_submenu(const struct MenuFuncOp functions[])
Register a submenu.
Definition init.c:91

km_register_menu
struct MenuDefinition * km_register_menu(int menu, const char *name)
Register a menu.
Definition init.c:107

km_sort
void km_sort(void)
Sort all the menu keybindings.
Definition init.c:192

km_set_abort_key
void km_set_abort_key(void)
Parse the abort_key config string.
Definition init.c:232

km_menu_add_bindings
void km_menu_add_bindings(struct MenuDefinition *md, const struct MenuOpSeq bindings[])
Add Keybindings to a Menu.
Definition init.c:136

keymap.h
Keymap handling.

keycode_t
short keycode_t
Type for key storage, the rest of neomutt works fine with int type.
Definition keymap.h:31

menu.h
Maniplate Menus and SubMenus.

MenuDefinition
Functions for a Dialog or Window.
Definition menu.h:80

MenuDefinition::name
const char * name
Menu name, e.g. "alias".
Definition menu.h:82

MenuFuncOp
Mapping between a function and an operation.
Definition menu.h:38

MenuOpSeq
Mapping between an operation and a key sequence.
Definition menu.h:48

NotifyCallback
Data passed to a notification function.
Definition observer.h:34

SubMenu
Collection of related functions.
Definition menu.h:68

SubMenu::functions
const struct MenuFuncOp * functions
All available functions.
Definition menu.h:70