NeoMutt  2024-04-25-100-gcb3684
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
lib.h File Reference

GUI present the user with a selectable list. More...

#include "config.h"
#include <stdbool.h>
#include <stdint.h>
#include "mutt/lib.h"
#include "type.h"
+ Include dependency graph for lib.h:

Go to the source code of this file.

Data Structures

struct  Menu
 

Macros

#define MENU_REDRAW_NO_FLAGS   0
 No flags are set.
 
#define MENU_REDRAW_INDEX   (1 << 0)
 Redraw the index.
 
#define MENU_REDRAW_MOTION   (1 << 1)
 Redraw after moving the menu list.
 
#define MENU_REDRAW_CURRENT   (1 << 2)
 Redraw the current line of the menu.
 
#define MENU_REDRAW_FULL   (1 << 3)
 Redraw everything.
 

Typedefs

typedef uint8_t MenuRedrawFlags
 Flags, e.g. MENU_REDRAW_INDEX.
 

Enumerations

enum  ExpandoDataMenu { ED_MEN_PERCENTAGE }
 Expando UIDs for Menus. More...
 

Functions

MenuRedrawFlags menu_bottom_page (struct Menu *menu)
 Move the focus to the bottom of the page.
 
MenuRedrawFlags menu_current_bottom (struct Menu *menu)
 Move the current selection to the bottom of the window.
 
MenuRedrawFlags menu_current_middle (struct Menu *menu)
 Move the current selection to the centre of the window.
 
MenuRedrawFlags menu_current_top (struct Menu *menu)
 Move the current selection to the top of the window.
 
MenuRedrawFlags menu_first_entry (struct Menu *menu)
 Move the focus to the first entry in the menu.
 
MenuRedrawFlags menu_half_down (struct Menu *menu)
 Move the focus down half a page in the menu.
 
MenuRedrawFlags menu_half_up (struct Menu *menu)
 Move the focus up half a page in the menu.
 
MenuRedrawFlags menu_last_entry (struct Menu *menu)
 Move the focus to the last entry in the menu.
 
MenuRedrawFlags menu_middle_page (struct Menu *menu)
 Move the focus to the centre of the page.
 
MenuRedrawFlags menu_next_entry (struct Menu *menu)
 Move the focus to the next item in the menu.
 
MenuRedrawFlags menu_next_line (struct Menu *menu)
 Move the view down one line, keeping the selection the same.
 
MenuRedrawFlags menu_next_page (struct Menu *menu)
 Move the focus to the next page in the menu.
 
MenuRedrawFlags menu_prev_entry (struct Menu *menu)
 Move the focus to the previous item in the menu.
 
MenuRedrawFlags menu_prev_line (struct Menu *menu)
 Move the view up one line, keeping the selection the same.
 
MenuRedrawFlags menu_prev_page (struct Menu *menu)
 Move the focus to the previous page in the menu.
 
MenuRedrawFlags menu_top_page (struct Menu *menu)
 Move the focus to the top of the page.
 
void menu_redraw_current (struct Menu *menu)
 Redraw the current menu.
 
void menu_redraw_full (struct Menu *menu)
 Force the redraw of the Menu.
 
void menu_redraw_index (struct Menu *menu)
 Force the redraw of the index.
 
void menu_redraw_motion (struct Menu *menu)
 Force the redraw of the list part of the menu.
 
int menu_redraw (struct Menu *menu)
 Redraw the parts of the screen that have been flagged to be redrawn.
 
void menu_add_dialog_row (struct Menu *menu, const char *row)
 
void menu_cleanup (void)
 Free the saved Menu searches.
 
enum MenuType menu_get_current_type (void)
 Get the type of the current Window.
 
void menu_init (void)
 Initialise all the Menus.
 
struct MuttWindowmenu_window_new (enum MenuType type, struct ConfigSubset *sub)
 Create a new Menu Window.
 
int menu_get_index (struct Menu *menu)
 Get the current selection in the Menu.
 
MenuRedrawFlags menu_set_index (struct Menu *menu, int index)
 Set the current selection in the Menu.
 
MenuRedrawFlags menu_move_selection (struct Menu *menu, int index)
 Move the selection, keeping within between [0, menu->max].
 
void menu_queue_redraw (struct Menu *menu, MenuRedrawFlags redraw)
 Queue a request for a redraw.
 
MenuRedrawFlags menu_move_view_relative (struct Menu *menu, int relative)
 Move the view relatively.
 
MenuRedrawFlags menu_set_and_notify (struct Menu *menu, int top, int index)
 Set the Menu selection/view and notify others.
 
void menu_adjust (struct Menu *menu)
 Reapply the config to the Menu.
 
int menu_function_dispatcher (struct MuttWindow *win, int op)
 Perform a Menu function - Implements function_dispatcher_t -.
 
int menu_tagging_dispatcher (struct MuttWindow *win, int op)
 Perform tagging operations on the Menu - Implements function_dispatcher_t -.
 

Detailed Description

GUI present the user with a selectable list.

Authors
  • Richard Russon

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file lib.h.

Macro Definition Documentation

◆ MENU_REDRAW_NO_FLAGS

#define MENU_REDRAW_NO_FLAGS   0

No flags are set.

Definition at line 55 of file lib.h.

◆ MENU_REDRAW_INDEX

#define MENU_REDRAW_INDEX   (1 << 0)

Redraw the index.

Definition at line 56 of file lib.h.

◆ MENU_REDRAW_MOTION

#define MENU_REDRAW_MOTION   (1 << 1)

Redraw after moving the menu list.

Definition at line 57 of file lib.h.

◆ MENU_REDRAW_CURRENT

#define MENU_REDRAW_CURRENT   (1 << 2)

Redraw the current line of the menu.

Definition at line 58 of file lib.h.

◆ MENU_REDRAW_FULL

#define MENU_REDRAW_FULL   (1 << 3)

Redraw everything.

Definition at line 59 of file lib.h.

Typedef Documentation

◆ MenuRedrawFlags

typedef uint8_t MenuRedrawFlags

Flags, e.g. MENU_REDRAW_INDEX.

Definition at line 54 of file lib.h.

Enumeration Type Documentation

◆ ExpandoDataMenu

Expando UIDs for Menus.

See also
ED_MENU, ExpandoDomain
Enumerator
ED_MEN_PERCENTAGE 

Menu.top, ...

Definition at line 66 of file lib.h.

67{
69};
@ ED_MEN_PERCENTAGE
Menu.top, ...
Definition: lib.h:68

Function Documentation

◆ menu_bottom_page()

MenuRedrawFlags menu_bottom_page ( struct Menu menu)

Move the focus to the bottom of the page.

Parameters
menuCurrent Menu
Return values
enumMenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 363 of file move.c.

364{
365 if (menu->max == 0)
366 {
367 mutt_error(_("No entries"));
369 }
370
371 int index = menu->top + menu->page_len - 1;
372 if (index > (menu->max - 1))
373 index = menu->max - 1;
374 return menu_move_selection(menu, index);
375}
#define mutt_error(...)
Definition: logging2.h:92
#define MENU_REDRAW_NO_FLAGS
No flags are set.
Definition: lib.h:55
MenuRedrawFlags menu_move_selection(struct Menu *menu, int index)
Move the selection, keeping within between [0, menu->max].
Definition: move.c:236
#define _(a)
Definition: message.h:28
int top
Entry that is the top of the current page.
Definition: lib.h:90
int max
Number of entries in the menu.
Definition: lib.h:81
int page_len
Number of entries per screen.
Definition: lib.h:84
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ menu_current_bottom()

MenuRedrawFlags menu_current_bottom ( struct Menu menu)

Move the current selection to the bottom of the window.

Parameters
menuCurrent Menu
Return values
enumMenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 484 of file move.c.

485{
486 if (menu->max == 0)
487 {
488 mutt_error(_("No entries"));
490 }
491
492 short c_menu_context = cs_subset_number(menu->sub, "menu_context");
493 if (c_menu_context > (menu->page_len / 2))
495
496 c_menu_context = MIN(c_menu_context, (menu->page_len / 2));
497 return menu_move_view_relative(menu, 0 - (menu->top + menu->page_len - 1 -
498 menu->current - c_menu_context));
499}
short cs_subset_number(const struct ConfigSubset *sub, const char *name)
Get a number config item by name.
Definition: helpers.c:143
#define MIN(a, b)
Definition: memory.h:32
MenuRedrawFlags menu_move_view_relative(struct Menu *menu, int relative)
Move the view relatively.
Definition: move.c:254
int current
Current entry.
Definition: lib.h:80
struct ConfigSubset * sub
Inherited config items.
Definition: lib.h:87
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ menu_current_middle()

MenuRedrawFlags menu_current_middle ( struct Menu menu)

Move the current selection to the centre of the window.

Parameters
menuCurrent Menu
Return values
enumMenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 464 of file move.c.

465{
466 if (menu->max == 0)
467 {
468 mutt_error(_("No entries"));
470 }
471
472 short c_menu_context = cs_subset_number(menu->sub, "menu_context");
473 if (c_menu_context > (menu->page_len / 2))
475
476 return menu_move_view_relative(menu, menu->current - (menu->top + (menu->page_len / 2)));
477}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ menu_current_top()

MenuRedrawFlags menu_current_top ( struct Menu menu)

Move the current selection to the top of the window.

Parameters
menuCurrent Menu
Return values
enumMenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 443 of file move.c.

444{
445 if (menu->max == 0)
446 {
447 mutt_error(_("No entries"));
449 }
450
451 short c_menu_context = cs_subset_number(menu->sub, "menu_context");
452 if (c_menu_context > (menu->page_len / 2))
454
455 c_menu_context = MIN(c_menu_context, (menu->page_len / 2));
456 return menu_move_view_relative(menu, menu->current - menu->top - c_menu_context);
457}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ menu_first_entry()

MenuRedrawFlags menu_first_entry ( struct Menu menu)

Move the focus to the first entry in the menu.

Parameters
menuCurrent Menu
Return values
enumMenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 410 of file move.c.

411{
412 if (menu->max == 0)
413 {
414 mutt_error(_("No entries"));
416 }
417
418 return menu_move_selection(menu, 0);
419}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ menu_half_down()

MenuRedrawFlags menu_half_down ( struct Menu menu)

Move the focus down half a page in the menu.

Parameters
menuCurrent Menu
Return values
enumMenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 516 of file move.c.

517{
518 return menu_move_view_relative(menu, (menu->page_len / 2));
519}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ menu_half_up()

MenuRedrawFlags menu_half_up ( struct Menu menu)

Move the focus up half a page in the menu.

Parameters
menuCurrent Menu
Return values
enumMenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 506 of file move.c.

507{
508 return menu_move_view_relative(menu, 0 - (menu->page_len / 2));
509}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ menu_last_entry()

MenuRedrawFlags menu_last_entry ( struct Menu menu)

Move the focus to the last entry in the menu.

Parameters
menuCurrent Menu
Return values
enumMenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 426 of file move.c.

427{
428 if (menu->max == 0)
429 {
430 mutt_error(_("No entries"));
432 }
433
434 return menu_move_selection(menu, menu->max - 1);
435}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ menu_middle_page()

MenuRedrawFlags menu_middle_page ( struct Menu menu)

Move the focus to the centre of the page.

Parameters
menuCurrent Menu
Return values
enumMenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 343 of file move.c.

344{
345 if (menu->max == 0)
346 {
347 mutt_error(_("No entries"));
349 }
350
351 int i = menu->top + menu->page_len;
352 if (i > (menu->max - 1))
353 i = menu->max - 1;
354
355 return menu_move_selection(menu, menu->top + (i - menu->top) / 2);
356}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ menu_next_entry()

MenuRedrawFlags menu_next_entry ( struct Menu menu)

Move the focus to the next item in the menu.

Parameters
menuCurrent Menu
Return values
enumMenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 396 of file move.c.

397{
398 if (menu->current < (menu->max - 1))
399 return menu_move_selection(menu, menu->current + 1);
400
401 mutt_message(_("You are on the last entry"));
403}
#define mutt_message(...)
Definition: logging2.h:91
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ menu_next_line()

MenuRedrawFlags menu_next_line ( struct Menu menu)

Move the view down one line, keeping the selection the same.

Parameters
menuCurrent Menu
Return values
enumMenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 539 of file move.c.

540{
542 if (flags == MENU_REDRAW_NO_FLAGS)
543 mutt_message(_("You can't scroll down farther"));
544 return flags;
545}
uint8_t MenuRedrawFlags
Flags, e.g. MENU_REDRAW_INDEX.
Definition: lib.h:54
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ menu_next_page()

MenuRedrawFlags menu_next_page ( struct Menu menu)

Move the focus to the next page in the menu.

Parameters
menuCurrent Menu
Return values
enumMenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 562 of file move.c.

563{
564 return menu_move_view_relative(menu, menu->page_len);
565}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ menu_prev_entry()

MenuRedrawFlags menu_prev_entry ( struct Menu menu)

Move the focus to the previous item in the menu.

Parameters
menuCurrent Menu
Return values
enumMenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 382 of file move.c.

383{
384 if (menu->current > 0)
385 return menu_move_selection(menu, menu->current - 1);
386
387 mutt_message(_("You are on the first entry"));
389}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ menu_prev_line()

MenuRedrawFlags menu_prev_line ( struct Menu menu)

Move the view up one line, keeping the selection the same.

Parameters
menuCurrent Menu
Return values
enumMenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 526 of file move.c.

527{
529 if (flags == MENU_REDRAW_NO_FLAGS)
530 mutt_message(_("You can't scroll up farther"));
531 return flags;
532}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ menu_prev_page()

MenuRedrawFlags menu_prev_page ( struct Menu menu)

Move the focus to the previous page in the menu.

Parameters
menuCurrent Menu
Return values
enumMenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 552 of file move.c.

553{
554 return menu_move_view_relative(menu, 0 - menu->page_len);
555}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ menu_top_page()

MenuRedrawFlags menu_top_page ( struct Menu menu)

Move the focus to the top of the page.

Parameters
menuCurrent Menu
Return values
enumMenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 333 of file move.c.

334{
335 return menu_move_selection(menu, menu->top);
336}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ menu_redraw_current()

void menu_redraw_current ( struct Menu menu)

Redraw the current menu.

Parameters
menuCurrent Menu

Definition at line 444 of file draw.c.

445{
446 struct Buffer *buf = buf_pool_get();
447 const struct AttrColor *ac = menu->color(menu, menu->current);
448
449 mutt_window_move(menu->win, 0, menu->current - menu->top);
450 menu->make_entry(menu, menu->current, menu->win->state.cols, buf);
451 menu_pad_string(menu, buf);
452
454 const bool c_arrow_cursor = cs_subset_bool(menu->sub, "arrow_cursor");
455 if (c_arrow_cursor)
456 {
457 mutt_curses_set_color(ac_ind);
458 const char *const c_arrow_string = cs_subset_string(menu->sub, "arrow_string");
459 mutt_window_addstr(menu->win, c_arrow_string);
461 mutt_window_addch(menu->win, ' ');
462 menu_pad_string(menu, buf);
463 print_enriched_string(menu->win, menu->current, ac, NULL, buf, menu->sub);
464 }
465 else
466 {
467 print_enriched_string(menu->win, menu->current, ac, ac_ind, buf, menu->sub);
468 }
470 buf_pool_release(&buf);
471}
struct AttrColor * simple_color_get(enum ColorId cid)
Get the colour of an object by its ID.
Definition: simple.c:88
@ MT_COLOR_INDICATOR
Selected item in list.
Definition: color.h:54
@ MT_COLOR_NORMAL
Plain text.
Definition: color.h:59
const char * cs_subset_string(const struct ConfigSubset *sub, const char *name)
Get a string config item by name.
Definition: helpers.c:291
bool cs_subset_bool(const struct ConfigSubset *sub, const char *name)
Get a boolean config item by name.
Definition: helpers.c:47
static void menu_pad_string(struct Menu *menu, struct Buffer *buf)
Pad a string with spaces for display in the Menu.
Definition: draw.c:287
static void print_enriched_string(struct MuttWindow *win, int index, const struct AttrColor *ac_def, struct AttrColor *ac_ind, struct Buffer *buf, struct ConfigSubset *sub)
Display a string with embedded colours and graphics.
Definition: draw.c:109
const struct AttrColor * mutt_curses_set_color_by_id(enum ColorId cid)
Set the colour and attributes by the colour id.
Definition: mutt_curses.c:79
void mutt_curses_set_color(const struct AttrColor *ac)
Set the colour and attributes for text.
Definition: mutt_curses.c:38
int mutt_window_move(struct MuttWindow *win, int col, int row)
Move the cursor in a Window.
Definition: mutt_window.c:296
int mutt_window_addstr(struct MuttWindow *win, const char *str)
Write a string to a Window.
Definition: mutt_window.c:415
int mutt_window_addch(struct MuttWindow *win, int ch)
Write one character to a Window.
Definition: mutt_window.c:387
struct Buffer * buf_pool_get(void)
Get a Buffer from the pool.
Definition: pool.c:81
void buf_pool_release(struct Buffer **ptr)
Return a Buffer to the pool.
Definition: pool.c:94
A curses colour and its attributes.
Definition: attr.h:66
String manipulation buffer.
Definition: buffer.h:36
struct MuttWindow * win
Window holding the Menu.
Definition: lib.h:86
const struct AttrColor *(* color)(struct Menu *menu, int line)
Definition: lib.h:143
int(* make_entry)(struct Menu *menu, int line, int max_cols, struct Buffer *buf)
Definition: lib.h:106
struct WindowState state
Current state of the Window.
Definition: mutt_window.h:126
short cols
Number of columns, can be MUTT_WIN_SIZE_UNLIMITED.
Definition: mutt_window.h:60
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ menu_redraw_full()

void menu_redraw_full ( struct Menu menu)

Force the redraw of the Menu.

Parameters
menuCurrent Menu

Definition at line 308 of file draw.c.

309{
311 mutt_window_clear(menu->win);
312
313 menu->page_len = menu->win->state.rows;
314
316}
#define MENU_REDRAW_INDEX
Redraw the index.
Definition: lib.h:56
void mutt_window_clear(struct MuttWindow *win)
Clear a Window.
Definition: mutt_window.c:719
MenuRedrawFlags redraw
When to redraw the screen.
Definition: lib.h:82
short rows
Number of rows, can be MUTT_WIN_SIZE_UNLIMITED.
Definition: mutt_window.h:61
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ menu_redraw_index()

void menu_redraw_index ( struct Menu menu)

Force the redraw of the index.

Parameters
menuCurrent Menu

Definition at line 322 of file draw.c.

323{
324 struct Buffer *buf = buf_pool_get();
325 const struct AttrColor *ac = NULL;
326
327 const bool c_arrow_cursor = cs_subset_bool(menu->sub, "arrow_cursor");
328 const char *const c_arrow_string = cs_subset_string(menu->sub, "arrow_string");
329 const int arrow_width = mutt_strwidth(c_arrow_string);
331 for (int i = menu->top; i < (menu->top + menu->page_len); i++)
332 {
333 if (i < menu->max)
334 {
335 ac = menu->color(menu, i);
336
337 buf_reset(buf);
338 menu->make_entry(menu, i, menu->win->state.cols, buf);
339 menu_pad_string(menu, buf);
340
342 mutt_window_move(menu->win, 0, i - menu->top);
343
344 if (i == menu->current)
345 mutt_curses_set_color(ac_ind);
346
347 if (c_arrow_cursor)
348 {
349 if (i == menu->current)
350 {
351 mutt_window_addstr(menu->win, c_arrow_string);
353 mutt_window_addch(menu->win, ' ');
354 }
355 else
356 {
357 /* Print space chars to match the screen width of `$arrow_string` */
358 mutt_window_printf(menu->win, "%*s", arrow_width + 1, "");
359 }
360 }
361
362 if ((i == menu->current) && !c_arrow_cursor)
363 {
364 print_enriched_string(menu->win, i, ac, ac_ind, buf, menu->sub);
365 }
366 else
367 {
368 print_enriched_string(menu->win, i, ac, NULL, buf, menu->sub);
369 }
370 }
371 else
372 {
374 mutt_window_clearline(menu->win, i - menu->top);
375 }
376 }
379 buf_pool_release(&buf);
380}
void buf_reset(struct Buffer *buf)
Reset an existing Buffer.
Definition: buffer.c:76
size_t mutt_strwidth(const char *s)
Measure a string's width in screen cells.
Definition: curs_lib.c:443
int mutt_window_printf(struct MuttWindow *win, const char *fmt,...)
Write a formatted string to a Window.
Definition: mutt_window.c:430
void mutt_window_clearline(struct MuttWindow *win, int row)
Clear a row of a Window.
Definition: mutt_window.c:231
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ menu_redraw_motion()

void menu_redraw_motion ( struct Menu menu)

Force the redraw of the list part of the menu.

Parameters
menuCurrent Menu

Definition at line 386 of file draw.c.

387{
388 struct Buffer *buf = buf_pool_get();
389
390 /* Note: menu->color() for the index can end up retrieving a message
391 * over imap (if matching against ~h for instance). This can
392 * generate status messages. So we want to call it *before* we
393 * position the cursor for drawing. */
394 const struct AttrColor *old_color = menu->color(menu, menu->old_current);
395 mutt_window_move(menu->win, 0, menu->old_current - menu->top);
396 mutt_curses_set_color(old_color);
397
398 const bool c_arrow_cursor = cs_subset_bool(menu->sub, "arrow_cursor");
400 if (c_arrow_cursor)
401 {
402 const char *const c_arrow_string = cs_subset_string(menu->sub, "arrow_string");
403 const int arrow_width = mutt_strwidth(c_arrow_string);
404 /* clear the arrow */
405 /* Print space chars to match the screen width of `$arrow_string` */
406 mutt_window_printf(menu->win, "%*s", arrow_width + 1, "");
408
409 menu->make_entry(menu, menu->old_current, menu->win->state.cols, buf);
410 menu_pad_string(menu, buf);
411 mutt_window_move(menu->win, arrow_width + 1, menu->old_current - menu->top);
412 print_enriched_string(menu->win, menu->old_current, old_color, NULL, buf, menu->sub);
413
414 /* now draw it in the new location */
415 mutt_curses_set_color(ac_ind);
416 mutt_window_mvaddstr(menu->win, 0, menu->current - menu->top, c_arrow_string);
417 }
418 else
419 {
421 /* erase the current indicator */
422 menu->make_entry(menu, menu->old_current, menu->win->state.cols, buf);
423 menu_pad_string(menu, buf);
424 print_enriched_string(menu->win, menu->old_current, old_color, NULL, buf, menu->sub);
425
426 /* now draw the new one to reflect the change */
427 const struct AttrColor *cur_color = menu->color(menu, menu->current);
428 cur_color = merged_color_overlay(cur_color, ac_ind);
429 buf_reset(buf);
430 menu->make_entry(menu, menu->current, menu->win->state.cols, buf);
431 menu_pad_string(menu, buf);
432 mutt_window_move(menu->win, 0, menu->current - menu->top);
433 mutt_curses_set_color(cur_color);
434 print_enriched_string(menu->win, menu->current, cur_color, ac_ind, buf, menu->sub);
435 }
437 buf_pool_release(&buf);
438}
const struct AttrColor * merged_color_overlay(const struct AttrColor *base, const struct AttrColor *over)
Combine two colours.
Definition: merged.c:107
int mutt_window_mvaddstr(struct MuttWindow *win, int col, int row, const char *str)
Move the cursor and write a fixed string to a Window.
Definition: mutt_window.c:310
int old_current
For driver use only.
Definition: lib.h:91
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ menu_redraw()

int menu_redraw ( struct Menu menu)

Redraw the parts of the screen that have been flagged to be redrawn.

Parameters
menuMenu to redraw
Return values
OP_NULLMenu was redrawn
OP_REDRAWFull redraw required

Definition at line 479 of file draw.c.

480{
481 /* See if all or part of the screen needs to be updated. */
482 if (menu->redraw & MENU_REDRAW_FULL)
483 menu_redraw_full(menu);
484
485 if (menu->redraw & MENU_REDRAW_INDEX)
486 menu_redraw_index(menu);
487 else if (menu->redraw & MENU_REDRAW_MOTION)
488 menu_redraw_motion(menu);
489 else if (menu->redraw == MENU_REDRAW_CURRENT)
491
492 return OP_NULL;
493}
void menu_redraw_current(struct Menu *menu)
Redraw the current menu.
Definition: draw.c:444
void menu_redraw_index(struct Menu *menu)
Force the redraw of the index.
Definition: draw.c:322
void menu_redraw_full(struct Menu *menu)
Force the redraw of the Menu.
Definition: draw.c:308
void menu_redraw_motion(struct Menu *menu)
Force the redraw of the list part of the menu.
Definition: draw.c:386
#define MENU_REDRAW_FULL
Redraw everything.
Definition: lib.h:59
#define MENU_REDRAW_CURRENT
Redraw the current line of the menu.
Definition: lib.h:58
#define MENU_REDRAW_MOTION
Redraw after moving the menu list.
Definition: lib.h:57
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ menu_add_dialog_row()

void menu_add_dialog_row ( struct Menu menu,
const char *  row 
)

◆ menu_cleanup()

void menu_cleanup ( void  )

Free the saved Menu searches.

Definition at line 70 of file menu.c.

71{
72 for (int i = 0; i < MENU_MAX; i++)
74}
#define FREE(x)
Definition: memory.h:45
char * SearchBuffers[MENU_MAX]
Previous search string, one for each MenuType.
Definition: menu.c:43
@ MENU_MAX
Definition: type.h:57
+ Here is the caller graph for this function:

◆ menu_get_current_type()

enum MenuType menu_get_current_type ( void  )

Get the type of the current Window.

Return values
enumMenu Type, e.g. MENU_PAGER

Definition at line 89 of file menu.c.

90{
91 struct MuttWindow *win = window_get_focus();
92
93 // This should only happen before the first window is created
94 if (!win)
95 return MENU_INDEX;
96
97 if ((win->type == WT_CUSTOM) && (win->parent->type == WT_PAGER))
98 return MENU_PAGER;
99
100 if (win->type != WT_MENU)
101 return MENU_GENERIC;
102
103 struct Menu *menu = win->wdata;
104 if (!menu)
105 return MENU_GENERIC;
106
107 return menu->type;
108}
struct MuttWindow * window_get_focus(void)
Get the currently focused Window.
Definition: mutt_window.c:667
@ WT_CUSTOM
Window with a custom drawing function.
Definition: mutt_window.h:94
@ WT_PAGER
A panel containing the Pager Window.
Definition: mutt_window.h:99
@ WT_MENU
An Window containing a Menu.
Definition: mutt_window.h:97
Definition: lib.h:79
enum MenuType type
Menu definition for keymap entries.
Definition: lib.h:83
void * wdata
Private data.
Definition: mutt_window.h:144
struct MuttWindow * parent
Parent Window.
Definition: mutt_window.h:134
enum WindowType type
Window type, e.g. WT_SIDEBAR.
Definition: mutt_window.h:143
@ MENU_INDEX
Index panel (list of emails)
Definition: type.h:51
@ MENU_GENERIC
Generic selection list.
Definition: type.h:46
@ MENU_PAGER
Pager pager (email viewer)
Definition: type.h:52
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ menu_init()

void menu_init ( void  )

Initialise all the Menus.

Definition at line 79 of file menu.c.

80{
81 for (int i = 0; i < MENU_MAX; i++)
82 SearchBuffers[i] = NULL;
83}
+ Here is the caller graph for this function:

◆ menu_window_new()

struct MuttWindow * menu_window_new ( enum MenuType  type,
struct ConfigSubset sub 
)

Create a new Menu Window.

Parameters
typeMenu type, e.g. MENU_PAGER
subConfig items
Return values
ptrNew MuttWindow wrapping a Menu

Definition at line 140 of file window.c.

141{
145
146 struct Menu *menu = menu_new(type, win, sub);
147
150 win->wdata = menu;
153
154 return win;
155}
static int menu_recalc(struct MuttWindow *win)
Recalculate the Window data - Implements MuttWindow::recalc() -.
Definition: window.c:80
static int menu_repaint(struct MuttWindow *win)
Repaint the Window - Implements MuttWindow::repaint() -.
Definition: window.c:93
static void menu_wdata_free(struct MuttWindow *win, void **ptr)
Free the Menu - Implements MuttWindow::wdata_free() -.
Definition: window.c:129
struct Menu * menu_new(enum MenuType type, struct MuttWindow *win, struct ConfigSubset *sub)
Create a new Menu.
Definition: menu.c:136
struct MuttWindow * mutt_window_new(enum WindowType type, enum MuttWindowOrientation orient, enum MuttWindowSize size, int cols, int rows)
Create a new Window.
Definition: mutt_window.c:181
#define WA_RECALC
Recalculate the contents of the Window.
Definition: mutt_window.h:109
@ MUTT_WIN_ORIENT_VERTICAL
Window uses all available vertical space.
Definition: mutt_window.h:38
#define MUTT_WIN_SIZE_UNLIMITED
Use as much space as possible.
Definition: mutt_window.h:52
@ MUTT_WIN_SIZE_MAXIMISE
Window wants as much space as possible.
Definition: mutt_window.h:48
int(* repaint)(struct MuttWindow *win)
Definition: mutt_window.h:186
int(* recalc)(struct MuttWindow *win)
Definition: mutt_window.h:172
void(* wdata_free)(struct MuttWindow *win, void **ptr)
Definition: mutt_window.h:158
WindowActionFlags actions
Actions to be performed, e.g. WA_RECALC.
Definition: mutt_window.h:131
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ menu_get_index()

int menu_get_index ( struct Menu menu)

Get the current selection in the Menu.

Parameters
menuMenu
Return values
numIndex of selection

Definition at line 160 of file menu.c.

161{
162 if (!menu)
163 return -1;
164
165 return menu->current;
166}

◆ menu_set_index()

MenuRedrawFlags menu_set_index ( struct Menu menu,
int  index 
)

Set the current selection in the Menu.

Parameters
menuMenu
indexItem to select
Return values
enumMenuRedrawFlags, e.g. MENU_REDRAW_INDEX

Definition at line 174 of file menu.c.

175{
176 return menu_move_selection(menu, index);
177}
MenuRedrawFlags menu_move_selection(struct Menu *menu, int index)
Move the selection, keeping within between [0, menu->max].
Definition: move.c:236
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ menu_move_selection()

MenuRedrawFlags menu_move_selection ( struct Menu menu,
int  index 
)

Move the selection, keeping within between [0, menu->max].

Parameters
menuMenu
indexNew selection
Return values
enumMenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 236 of file move.c.

237{
238 if (index < 0)
239 index = 0;
240 else if (index >= menu->max)
241 index = menu->max - 1;
242
243 int top = menu_drag_view(menu, menu->top, index);
244
245 return menu_set_and_notify(menu, top, index);
246}
MenuRedrawFlags menu_set_and_notify(struct Menu *menu, int top, int index)
Set the Menu selection/view and notify others.
Definition: move.c:66
static int menu_drag_view(struct Menu *menu, int top, int index)
Move the view around the selection.
Definition: move.c:111
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ menu_queue_redraw()

void menu_queue_redraw ( struct Menu menu,
MenuRedrawFlags  redraw 
)

Queue a request for a redraw.

Parameters
menuMenu
redrawItem to redraw, e.g. MENU_REDRAW_CURRENT

Definition at line 184 of file menu.c.

185{
186 if (!menu)
187 return;
188
189 menu->redraw |= redraw;
190 menu->win->actions |= WA_RECALC;
191}

◆ menu_move_view_relative()

MenuRedrawFlags menu_move_view_relative ( struct Menu menu,
int  relative 
)

Move the view relatively.

Parameters
menuMenu
relativeRelative number of lines to move
Return values
enumMenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 254 of file move.c.

255{
256 const bool c_menu_move_off = cs_subset_bool(menu->sub, "menu_move_off");
257
258 short c_menu_context = cs_subset_number(menu->sub, "menu_context");
259 c_menu_context = MIN(c_menu_context, (menu->page_len / 2));
260
261 // Move and range-check the view
262 int top = menu->top + relative;
263 if (top < 0)
264 {
265 top = 0;
266 }
267 else if (c_menu_move_off && (top >= (menu->max - c_menu_context)))
268 {
269 top = menu->max - c_menu_context - 1;
270 }
271 else if (!c_menu_move_off && ((top + menu->page_len) >= menu->max))
272 {
273 top = menu->max - menu->page_len;
274 }
275 if (top < 0)
276 top = 0;
277
278 // Move the selection on-screen
279 int index = menu->current;
280 if (index < top)
281 index = top;
282 else if (index >= (top + menu->page_len))
283 index = top + menu->page_len - 1;
284
285 // Check for top/bottom limits
286 if (index < c_menu_context)
287 {
288 top = 0;
289 index = menu->current;
290 }
291 else if (!c_menu_move_off && (index > (menu->max - c_menu_context)))
292 {
293 top = menu->max - menu->page_len;
294 index = menu->current;
295 }
296
297 if (top == menu->top)
298 {
299 // Can't move the view; move the selection
300 index = calc_fit_selection_to_view(menu, top, index + relative);
301 }
302 else if (index > (top + menu->page_len - c_menu_context - 1))
303 {
304 index = calc_fit_selection_to_view(menu, top, index + relative);
305 }
306 else
307 {
308 // Drag the selection into the view
309 index = calc_fit_selection_to_view(menu, top, index);
310 }
311
312 return menu_set_and_notify(menu, top, index);
313}
static int calc_fit_selection_to_view(struct Menu *menu, int top, int index)
Move the selection into the view.
Definition: move.c:164
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ menu_set_and_notify()

MenuRedrawFlags menu_set_and_notify ( struct Menu menu,
int  top,
int  index 
)

Set the Menu selection/view and notify others.

Parameters
menuMenu
topIndex of item at the top of the view
indexSelected item
Return values
enumMenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 66 of file move.c.

67{
69
70 if (top != menu->top)
71 {
72 menu->top = top;
73 flags |= MENU_REDRAW_FULL;
74 }
75
76 if (index != menu->current)
77 {
78 menu->old_current = menu->current;
79 menu->current = index;
80
81 if (menu->redraw == MENU_REDRAW_NO_FLAGS)
82 {
83 // If this is the only change
84 flags |= MENU_REDRAW_MOTION;
85 }
86 else
87 {
88 // otherwise, redraw completely
89 flags |= MENU_REDRAW_FULL;
90 }
91 }
92
93 if (flags != MENU_REDRAW_NO_FLAGS)
94 {
95 menu->redraw |= flags;
96 menu->win->actions |= WA_REPAINT;
97
98 mutt_debug(LL_NOTIFY, "NT_MENU\n");
99 notify_send(menu->notify, NT_MENU, flags, NULL);
100 }
101 return flags;
102}
#define mutt_debug(LEVEL,...)
Definition: logging2.h:89
@ LL_NOTIFY
Log of notifications.
Definition: logging2.h:48
bool notify_send(struct Notify *notify, enum NotifyType event_type, int event_subtype, void *event_data)
Send out a notification message.
Definition: notify.c:173
#define WA_REPAINT
Redraw the contents of the Window.
Definition: mutt_window.h:110
@ NT_MENU
Menu has changed, MenuRedrawFlags.
Definition: notify_type.h:51
struct Notify * notify
Notifications.
Definition: lib.h:145
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ menu_adjust()

void menu_adjust ( struct Menu menu)

Reapply the config to the Menu.

Parameters
menuMenu

Definition at line 319 of file move.c.

320{
321 int top = calc_move_view(menu, 0);
322 top = menu_drag_view(menu, top, menu->current);
323
324 menu_set_and_notify(menu, top, menu->current);
325}
static int calc_move_view(struct Menu *menu, int relative)
Move the view.
Definition: move.c:194
+ Here is the call graph for this function:
+ Here is the caller graph for this function: