NeoMutt  2025-12-11-435-g4ac674
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
menu.h
Go to the documentation of this file.
1
22
23#ifndef MUTT_KEY_MENU_H
24#define MUTT_KEY_MENU_H
25
26#include <stdbool.h>
27#include "mutt/lib.h"
28#include "get.h"
29#include "keymap.h"
30
32#define MAX_SEQ 8
33
38{
39 const char *name;
40 int op;
42};
43
48{
49 int op;
50 const char *seq;
51};
52
57{
58 int menu;
59 const char *function;
60 int op;
61};
62ARRAY_HEAD(MenuFunctionOpArray, struct MenuFunctionOp);
63
67struct SubMenu
68{
70 const struct MenuFuncOp *functions;
71 struct KeymapList keymaps;
72};
73ARRAY_HEAD(SubMenuArray, struct SubMenu);
74ARRAY_HEAD(SubMenuPArray, struct SubMenu *);
75
80{
81 int id;
82 const char *name;
83 struct SubMenuPArray submenus;
84};
85ARRAY_HEAD(MenuDefinitionArray, struct MenuDefinition *);
86
95typedef void (*init_keys_t)(struct SubMenu *sm_generic);
96
97bool is_bound (const struct MenuDefinition *md, int op);
98struct Keymap * km_find_func (const struct MenuDefinition *md, int func);
99int km_get_op (const char *func);
100int km_get_op_menu (int mtype, const char *func);
101struct MenuDefinition *menu_find (int menu);
102struct MenuDefinition *menu_find_by_name (const char *name);
103
104#endif /* MUTT_KEY_MENU_H */
#define ARRAY_HEAD(name, T)
Define a named struct for arrays of elements of a certain type.
Definition array.h:47
Get a key from the user.
uint8_t MenuFuncFlags
Flags, e.g. MFF_DEPRECATED.
Definition get.h:42
Keymap handling.
void(* init_keys_t)(struct SubMenu *sm_generic)
Definition menu.h:95
int km_get_op_menu(int mtype, const char *func)
Get the OpCode for a Function from a Menu.
Definition menu.c:213
struct MenuDefinition * menu_find(int menu)
Find a Menu Definition by Menu type.
Definition menu.c:245
struct MenuDefinition * menu_find_by_name(const char *name)
Find a Menu Definition by its name.
Definition menu.c:264
struct Keymap * km_find_func(const struct MenuDefinition *md, int func)
Find a function's mapping in a Menu.
Definition menu.c:157
bool is_bound(const struct MenuDefinition *md, int op)
Does a function have a keybinding?
Definition menu.c:287
int km_get_op(const char *func)
Get the OpCode for a Function.
Definition menu.c:184
Convenience wrapper for the library headers.
A keyboard mapping.
Definition keymap.h:43
Functions for a Dialog or Window.
Definition menu.h:80
const char * name
Menu name, e.g. "alias".
Definition menu.h:82
int id
Menu ID, e.g. MENU_ALIAS.
Definition menu.h:81
struct SubMenuPArray submenus
Parts making up the Menu.
Definition menu.h:83
Mapping between a function and an operation.
Definition menu.h:38
const char * name
Name of the function.
Definition menu.h:39
MenuFuncFlags flags
Flags, e.g. MFF_DEPRECATED.
Definition menu.h:41
int op
Operation, e.g. OP_DELETE.
Definition menu.h:40
Mapping between a function and an operation.
Definition menu.h:57
const char * function
Name of the function.
Definition menu.h:59
int menu
Menu, e.g. MENU_ALIAS.
Definition menu.h:58
int op
Operation, e.g. OP_DELETE.
Definition menu.h:60
Mapping between an operation and a key sequence.
Definition menu.h:48
int op
Operation, e.g. OP_DELETE.
Definition menu.h:49
const char * seq
Default key binding.
Definition menu.h:50
Collection of related functions.
Definition menu.h:68
const struct MenuFuncOp * functions
All available functions.
Definition menu.h:70
struct KeymapList keymaps
All keybindings.
Definition menu.h:71
struct MenuDefinition * parent
Primary parent.
Definition menu.h:69