NeoMutt
2025-12-11-860-g80c9cc
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
34
struct
MenuFuncOp
35
{
36
const
char
*
name
;
37
int
op
;
38
MenuFuncFlags
flags
;
39
};
40
44
struct
MenuOpSeq
45
{
46
int
op
;
47
const
char
*
seq
;
48
};
49
53
struct
MenuFunctionOp
54
{
55
int
menu
;
56
const
char
*
function
;
57
int
op
;
58
};
59
ARRAY_HEAD
(MenuFunctionOpArray,
struct
MenuFunctionOp
);
60
64
struct
SubMenu
65
{
66
struct
MenuDefinition
*
parent
;
67
const
struct
MenuFuncOp
*
functions
;
68
struct
KeymapList
keymaps
;
69
};
70
ARRAY_HEAD
(SubMenuArray,
struct
SubMenu
);
71
ARRAY_HEAD
(SubMenuPArray,
struct
SubMenu
*);
72
76
struct
MenuDefinition
77
{
78
int
id
;
79
const
char
*
name
;
80
struct
SubMenuPArray
submenus
;
81
};
82
ARRAY_HEAD
(MenuDefinitionArray,
struct
MenuDefinition
*);
83
92
typedef
void (*
init_keys_t
)(
struct
SubMenu
*sm_generic);
93
94
bool
is_bound
(
const
struct
MenuDefinition
*md,
int
op);
95
struct
Keymap
*
km_find_func
(
const
struct
MenuDefinition
*md,
int
func);
96
int
km_get_op
(
const
char
*func);
97
int
km_get_op_menu
(
int
mtype,
const
char
*func);
98
struct
MenuDefinition
*
menu_find
(
int
menu);
99
struct
MenuDefinition
*
menu_find_by_name
(
const
char
*
name
);
100
101
#endif
/* MUTT_KEY_MENU_H */
ARRAY_HEAD
#define ARRAY_HEAD(name, T)
Define a named struct for arrays of elements of a certain type.
Definition
array.h:47
get.h
Get a key from the user.
MenuFuncFlags
uint8_t MenuFuncFlags
Flags, e.g. MFF_DEPRECATED.
Definition
get.h:49
keymap.h
Keymap handling.
init_keys_t
void(* init_keys_t)(struct SubMenu *sm_generic)
Definition
menu.h:92
km_get_op_menu
int km_get_op_menu(int mtype, const char *func)
Get the OpCode for a Function from a Menu.
Definition
menu.c:198
menu_find
struct MenuDefinition * menu_find(int menu)
Find a Menu Definition by Menu type.
Definition
menu.c:231
menu_find_by_name
struct MenuDefinition * menu_find_by_name(const char *name)
Find a Menu Definition by its name.
Definition
menu.c:251
km_find_func
struct Keymap * km_find_func(const struct MenuDefinition *md, int func)
Find a function's mapping in a Menu.
Definition
menu.c:141
is_bound
bool is_bound(const struct MenuDefinition *md, int op)
Does a function have a keybinding?
Definition
menu.c:275
km_get_op
int km_get_op(const char *func)
Get the OpCode for a Function.
Definition
menu.c:168
lib.h
Convenience wrapper for the library headers.
Keymap
A keyboard mapping.
Definition
keymap.h:43
MenuDefinition
Functions for a Dialog or Window.
Definition
menu.h:77
MenuDefinition::name
const char * name
Menu name, e.g. "alias".
Definition
menu.h:79
MenuDefinition::id
int id
Menu ID, e.g. MENU_ALIAS.
Definition
menu.h:78
MenuDefinition::submenus
struct SubMenuPArray submenus
Parts making up the Menu.
Definition
menu.h:80
MenuFuncOp
Mapping between a function and an operation.
Definition
menu.h:35
MenuFuncOp::name
const char * name
Name of the function.
Definition
menu.h:36
MenuFuncOp::flags
MenuFuncFlags flags
Flags, e.g. MFF_DEPRECATED.
Definition
menu.h:38
MenuFuncOp::op
int op
Operation, e.g. OP_DELETE.
Definition
menu.h:37
MenuFunctionOp
Mapping between a function and an operation.
Definition
menu.h:54
MenuFunctionOp::function
const char * function
Name of the function.
Definition
menu.h:56
MenuFunctionOp::menu
int menu
Menu, e.g. MENU_ALIAS.
Definition
menu.h:55
MenuFunctionOp::op
int op
Operation, e.g. OP_DELETE.
Definition
menu.h:57
MenuOpSeq
Mapping between an operation and a key sequence.
Definition
menu.h:45
MenuOpSeq::op
int op
Operation, e.g. OP_DELETE.
Definition
menu.h:46
MenuOpSeq::seq
const char * seq
Default key binding.
Definition
menu.h:47
SubMenu
Collection of related functions.
Definition
menu.h:65
SubMenu::functions
const struct MenuFuncOp * functions
All available functions.
Definition
menu.h:67
SubMenu::keymaps
struct KeymapList keymaps
All keybindings.
Definition
menu.h:68
SubMenu::parent
struct MenuDefinition * parent
Primary parent.
Definition
menu.h:66