NeoMutt  2022-04-29-249-gaae397
Teaching an old dog new tricks
DOXYGEN
Menu Function API

Prototype for a Menu Function. More...

+ Collaboration diagram for Menu Function API:

Functions

static int menu_movement (struct Menu *menu, int op)
 Handle all the common Menu movements - Implements menu_function_t -. More...
 
static int menu_search (struct Menu *menu, int op)
 Handle Menu searching - Implements menu_function_t -. More...
 
static int op_help (struct Menu *menu, int op)
 Show the help screen - Implements menu_function_t -. More...
 
static int op_jump (struct Menu *menu, int op)
 Jump to an index number - Implements menu_function_t -. More...
 

Detailed Description

Prototype for a Menu Function.

Parameters
menuMenu
opOperation to perform, e.g. OP_NEXT_PAGE
Return values
enumFunctionRetval

Function Documentation

◆ menu_movement()

static int menu_movement ( struct Menu menu,
int  op 
)
static

Handle all the common Menu movements - Implements menu_function_t -.

Definition at line 141 of file functions.c.

142{
143 switch (op)
144 {
145 case OP_BOTTOM_PAGE:
146 menu_bottom_page(menu);
147 return FR_SUCCESS;
148
149 case OP_CURRENT_BOTTOM:
151 return FR_SUCCESS;
152
153 case OP_CURRENT_MIDDLE:
155 return FR_SUCCESS;
156
157 case OP_CURRENT_TOP:
158 menu_current_top(menu);
159 return FR_SUCCESS;
160
161 case OP_FIRST_ENTRY:
162 menu_first_entry(menu);
163 return FR_SUCCESS;
164
165 case OP_HALF_DOWN:
166 menu_half_down(menu);
167 return FR_SUCCESS;
168
169 case OP_HALF_UP:
170 menu_half_up(menu);
171 return FR_SUCCESS;
172
173 case OP_LAST_ENTRY:
174 menu_last_entry(menu);
175 return FR_SUCCESS;
176
177 case OP_MIDDLE_PAGE:
178 menu_middle_page(menu);
179 return FR_SUCCESS;
180
181 case OP_NEXT_ENTRY:
182 menu_next_entry(menu);
183 return FR_SUCCESS;
184
185 case OP_NEXT_LINE:
186 menu_next_line(menu);
187 return FR_SUCCESS;
188
189 case OP_NEXT_PAGE:
190 menu_next_page(menu);
191 return FR_SUCCESS;
192
193 case OP_PREV_ENTRY:
194 menu_prev_entry(menu);
195 return FR_SUCCESS;
196
197 case OP_PREV_LINE:
198 menu_prev_line(menu);
199 return FR_SUCCESS;
200
201 case OP_PREV_PAGE:
202 menu_prev_page(menu);
203 return FR_SUCCESS;
204
205 case OP_TOP_PAGE:
206 menu_top_page(menu);
207 return FR_SUCCESS;
208
209 default:
210 return FR_UNKNOWN;
211 }
212}
@ FR_SUCCESS
Valid function - successfully performed.
Definition: dispatcher.h:39
@ FR_UNKNOWN
Unknown function.
Definition: dispatcher.h:33
MenuRedrawFlags menu_next_page(struct Menu *menu)
Move the focus to the next page in the menu.
Definition: move.c:562
MenuRedrawFlags menu_bottom_page(struct Menu *menu)
Move the focus to the bottom of the page.
Definition: move.c:363
MenuRedrawFlags menu_half_up(struct Menu *menu)
Move the focus up half a page in the menu.
Definition: move.c:506
MenuRedrawFlags menu_prev_line(struct Menu *menu)
Move the view up one line, keeping the selection the same.
Definition: move.c:526
MenuRedrawFlags menu_current_bottom(struct Menu *menu)
Move the current selection to the bottom of the window.
Definition: move.c:484
MenuRedrawFlags menu_current_middle(struct Menu *menu)
Move the current selection to the centre of the window.
Definition: move.c:464
MenuRedrawFlags menu_middle_page(struct Menu *menu)
Move the focus to the centre of the page.
Definition: move.c:343
MenuRedrawFlags menu_first_entry(struct Menu *menu)
Move the focus to the first entry in the menu.
Definition: move.c:410
MenuRedrawFlags menu_half_down(struct Menu *menu)
Move the focus down half a page in the menu.
Definition: move.c:516
MenuRedrawFlags menu_top_page(struct Menu *menu)
Move the focus to the top of the page.
Definition: move.c:333
MenuRedrawFlags menu_last_entry(struct Menu *menu)
Move the focus to the last entry in the menu.
Definition: move.c:426
MenuRedrawFlags menu_prev_page(struct Menu *menu)
Move the focus to the previous page in the menu.
Definition: move.c:552
MenuRedrawFlags menu_next_line(struct Menu *menu)
Move the view down one line, keeping the selection the same.
Definition: move.c:539
MenuRedrawFlags menu_prev_entry(struct Menu *menu)
Move the focus to the previous item in the menu.
Definition: move.c:382
MenuRedrawFlags menu_current_top(struct Menu *menu)
Move the current selection to the top of the window.
Definition: move.c:443
MenuRedrawFlags menu_next_entry(struct Menu *menu)
Move the focus to the next item in the menu.
Definition: move.c:396
+ Here is the call graph for this function:

◆ menu_search()

static int menu_search ( struct Menu menu,
int  op 
)
static

Handle Menu searching - Implements menu_function_t -.

Definition at line 217 of file functions.c.

218{
219 if (menu->search)
220 {
221 int index = search(menu, op);
222 if (index != -1)
223 menu_set_index(menu, index);
224 }
225 return FR_SUCCESS;
226}
static int search(struct Menu *menu, int op)
Search a menu.
Definition: functions.c:57
MenuRedrawFlags menu_set_index(struct Menu *menu, int index)
Set the current selection in the Menu.
Definition: menu.c:168
int(* search)(struct Menu *menu, regex_t *rx, int line)
Definition: lib.h:109
+ Here is the call graph for this function:

◆ op_help()

static int op_help ( struct Menu menu,
int  op 
)
static

Show the help screen - Implements menu_function_t -.

Definition at line 231 of file functions.c.

232{
233 mutt_help(menu->type);
234 menu->redraw = MENU_REDRAW_FULL;
235 return FR_SUCCESS;
236}
void mutt_help(enum MenuType menu)
Display the help menu.
Definition: help.c:386
#define MENU_REDRAW_FULL
Redraw everything.
Definition: lib.h:59
MenuRedrawFlags redraw
When to redraw the screen.
Definition: lib.h:72
enum MenuType type
Menu definition for keymap entries.
Definition: lib.h:73
+ Here is the call graph for this function:

◆ op_jump()

static int op_jump ( struct Menu menu,
int  op 
)
static

Jump to an index number - Implements menu_function_t -.

Definition at line 241 of file functions.c.

242{
243 if (menu->max == 0)
244 {
245 mutt_error(_("No entries"));
246 return FR_SUCCESS;
247 }
248
249 const int digit = op - OP_JUMP;
250 if (digit > 0 && digit < 10)
251 {
252 mutt_unget_ch('0' + digit);
253 }
254
255 struct Buffer *buf = mutt_buffer_pool_get();
256 if ((mutt_buffer_get_field(_("Jump to: "), buf, MUTT_COMP_NO_FLAGS, false,
257 NULL, NULL, NULL) == 0) &&
259 {
260 int n = 0;
261 if (mutt_str_atoi_full(mutt_buffer_string(buf), &n) && (n > 0) && (n < (menu->max + 1)))
262 {
263 menu_set_index(menu, n - 1); // msg numbers are 0-based
264 }
265 else
266 {
267 mutt_error(_("Invalid index number"));
268 }
269 }
270
272 return FR_SUCCESS;
273}
bool mutt_buffer_is_empty(const struct Buffer *buf)
Is the Buffer empty?
Definition: buffer.c:260
static const char * mutt_buffer_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition: buffer.h:77
int digit(const char *s)
void mutt_unget_ch(int ch)
Return a keystroke to the input buffer.
Definition: curs_lib.c:521
int mutt_buffer_get_field(const char *field, struct Buffer *buf, CompletionFlags complete, bool multiple, struct Mailbox *m, char ***files, int *numfiles)
Ask the user for a string.
Definition: window.c:180
#define mutt_error(...)
Definition: logging.h:87
#define _(a)
Definition: message.h:28
#define MUTT_COMP_NO_FLAGS
No flags are set.
Definition: mutt.h:52
void mutt_buffer_pool_release(struct Buffer **pbuf)
Free a Buffer from the pool.
Definition: pool.c:112
struct Buffer * mutt_buffer_pool_get(void)
Get a Buffer from the pool.
Definition: pool.c:101
String manipulation buffer.
Definition: buffer.h:34
int max
Number of entries in the menu.
Definition: lib.h:71
+ Here is the call graph for this function: