lib.h File Reference

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

#include "config.h"
#include <stddef.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.

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 MuttWindow *	menu_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

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

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 56 of file lib.h.

MENU_REDRAW_INDEX

#define MENU_REDRAW_INDEX   (1 << 0)

Redraw the index.

Definition at line 57 of file lib.h.

MENU_REDRAW_MOTION

#define MENU_REDRAW_MOTION   (1 << 1)

Redraw after moving the menu list.

Definition at line 58 of file lib.h.

MENU_REDRAW_CURRENT

#define MENU_REDRAW_CURRENT   (1 << 2)

Redraw the current line of the menu.

Definition at line 59 of file lib.h.

MENU_REDRAW_FULL

#define MENU_REDRAW_FULL   (1 << 3)

Redraw everything.

Definition at line 60 of file lib.h.

Typedef Documentation

MenuRedrawFlags

typedef uint8_t MenuRedrawFlags

Flags, e.g. MENU_REDRAW_INDEX.

Definition at line 55 of file lib.h.

Function Documentation

menu_bottom_page()

MenuRedrawFlags menu_bottom_page

(

struct Menu *

menu

)

Move the focus to the bottom of the page.

Parameters

menu	Current Menu

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 363 of file move.c.

{
  if (menu->max == 0)
  {
    mutt_error(_("No entries"));
    return MENU_REDRAW_NO_FLAGS;
  }
 
  int index = menu->top + menu->page_len - 1;
  if (index > (menu->max - 1))
    index = menu->max - 1;
  return menu_move_selection(menu, index);
}

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

menu	Current Menu

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 484 of file move.c.

{
  if (menu->max == 0)
  {
    mutt_error(_("No entries"));
    return MENU_REDRAW_NO_FLAGS;
  }
 
  short c_menu_context = cs_subset_number(menu->sub, "menu_context");
  if (c_menu_context > (menu->page_len / 2))
    return MENU_REDRAW_NO_FLAGS;
 
  c_menu_context = MIN(c_menu_context, (menu->page_len / 2));
  return menu_move_view_relative(menu, 0 - (menu->top + menu->page_len - 1 -
                                            menu->current - c_menu_context));
}

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

menu	Current Menu

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 464 of file move.c.

{
  if (menu->max == 0)
  {
    mutt_error(_("No entries"));
    return MENU_REDRAW_NO_FLAGS;
  }
 
  short c_menu_context = cs_subset_number(menu->sub, "menu_context");
  if (c_menu_context > (menu->page_len / 2))
    return MENU_REDRAW_NO_FLAGS;
 
  return menu_move_view_relative(menu, menu->current - (menu->top + (menu->page_len / 2)));
}

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

menu	Current Menu

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 443 of file move.c.

{
  if (menu->max == 0)
  {
    mutt_error(_("No entries"));
    return MENU_REDRAW_NO_FLAGS;
  }
 
  short c_menu_context = cs_subset_number(menu->sub, "menu_context");
  if (c_menu_context > (menu->page_len / 2))
    return MENU_REDRAW_NO_FLAGS;
 
  c_menu_context = MIN(c_menu_context, (menu->page_len / 2));
  return menu_move_view_relative(menu, menu->current - menu->top - c_menu_context);
}

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

menu	Current Menu

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 410 of file move.c.

{
  if (menu->max == 0)
  {
    mutt_error(_("No entries"));
    return MENU_REDRAW_NO_FLAGS;
  }
 
  return menu_move_selection(menu, 0);
}

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

menu	Current Menu

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 516 of file move.c.

{
  return menu_move_view_relative(menu, (menu->page_len / 2));
}

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

menu	Current Menu

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 506 of file move.c.

{
  return menu_move_view_relative(menu, 0 - (menu->page_len / 2));
}

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

menu	Current Menu

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 426 of file move.c.

{
  if (menu->max == 0)
  {
    mutt_error(_("No entries"));
    return MENU_REDRAW_NO_FLAGS;
  }
 
  return menu_move_selection(menu, menu->max - 1);
}

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

menu	Current Menu

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 343 of file move.c.

{
  if (menu->max == 0)
  {
    mutt_error(_("No entries"));
    return MENU_REDRAW_NO_FLAGS;
  }
 
  int i = menu->top + menu->page_len;
  if (i > (menu->max - 1))
    i = menu->max - 1;
 
  return menu_move_selection(menu, menu->top + (i - menu->top) / 2);
}

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

menu	Current Menu

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 396 of file move.c.

{
  if (menu->current < (menu->max - 1))
    return menu_move_selection(menu, menu->current + 1);
 
  mutt_message(_("You are on the last entry"));
  return MENU_REDRAW_NO_FLAGS;
}

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

menu	Current Menu

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 539 of file move.c.

{
  MenuRedrawFlags flags = menu_move_view_relative(menu, 1);
  if (flags == MENU_REDRAW_NO_FLAGS)
    mutt_message(_("You can't scroll down farther"));
  return flags;
}

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

menu	Current Menu

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 562 of file move.c.

{
  return menu_move_view_relative(menu, menu->page_len);
}

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

menu	Current Menu

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 382 of file move.c.

{
  if (menu->current > 0)
    return menu_move_selection(menu, menu->current - 1);
 
  mutt_message(_("You are on the first entry"));
  return MENU_REDRAW_NO_FLAGS;
}

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

menu	Current Menu

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 526 of file move.c.

{
  MenuRedrawFlags flags = menu_move_view_relative(menu, -1);
  if (flags == MENU_REDRAW_NO_FLAGS)
    mutt_message(_("You can't scroll up farther"));
  return flags;
}

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

menu	Current Menu

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 552 of file move.c.

{
  return menu_move_view_relative(menu, 0 - menu->page_len);
}

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

menu	Current Menu

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 333 of file move.c.

{
  return menu_move_selection(menu, menu->top);
}

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

menu	Current Menu

Definition at line 438 of file draw.c.

{
  char buf[1024] = { 0 };
  const struct AttrColor *ac = menu->color(menu, menu->current);
 
  mutt_window_move(menu->win, 0, menu->current - menu->top);
  menu->make_entry(menu, buf, sizeof(buf), menu->current);
  menu_pad_string(menu, buf, sizeof(buf));
 
  struct AttrColor *ac_ind = simple_color_get(MT_COLOR_INDICATOR);
  const bool c_arrow_cursor = cs_subset_bool(menu->sub, "arrow_cursor");
  if (c_arrow_cursor)
  {
    mutt_curses_set_color(ac_ind);
    const char *const c_arrow_string = cs_subset_string(menu->sub, "arrow_string");
    mutt_window_addstr(menu->win, c_arrow_string);
    mutt_curses_set_color(ac);
    mutt_window_addch(menu->win, ' ');
    menu_pad_string(menu, buf, sizeof(buf));
    print_enriched_string(menu->win, menu->current, ac, NULL,
                          (unsigned char *) buf, menu->sub);
  }
  else
  {
    print_enriched_string(menu->win, menu->current, ac, ac_ind,
                          (unsigned char *) buf, menu->sub);
  }
  mutt_curses_set_color_by_id(MT_COLOR_NORMAL);
}

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

menu	Current Menu

Definition at line 307 of file draw.c.

{
  mutt_curses_set_color_by_id(MT_COLOR_NORMAL);
  mutt_window_clear(menu->win);
 
  menu->page_len = menu->win->state.rows;
 
  menu->redraw = MENU_REDRAW_INDEX;
}

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

menu	Current Menu

Definition at line 321 of file draw.c.

{
  char buf[1024] = { 0 };
  const struct AttrColor *ac = NULL;
 
  const bool c_arrow_cursor = cs_subset_bool(menu->sub, "arrow_cursor");
  const char *const c_arrow_string = cs_subset_string(menu->sub, "arrow_string");
  const int arrow_width = mutt_strwidth(c_arrow_string);
  struct AttrColor *ac_ind = simple_color_get(MT_COLOR_INDICATOR);
  for (int i = menu->top; i < (menu->top + menu->page_len); i++)
  {
    if (i < menu->max)
    {
      ac = menu->color(menu, i);
 
      menu->make_entry(menu, buf, sizeof(buf), i);
      menu_pad_string(menu, buf, sizeof(buf));
 
      mutt_curses_set_color(ac);
      mutt_window_move(menu->win, 0, i - menu->top);
 
      if (i == menu->current)
        mutt_curses_set_color(ac_ind);
 
      if (c_arrow_cursor)
      {
        if (i == menu->current)
        {
          mutt_window_addstr(menu->win, c_arrow_string);
          mutt_curses_set_color(ac);
          mutt_window_addch(menu->win, ' ');
        }
        else
        {
          /* Print space chars to match the screen width of `$arrow_string` */
          mutt_window_printf(menu->win, "%*s", arrow_width + 1, "");
        }
      }
 
      if ((i == menu->current) && !c_arrow_cursor)
        print_enriched_string(menu->win, i, ac, ac_ind, (unsigned char *) buf, menu->sub);
      else
        print_enriched_string(menu->win, i, ac, NULL, (unsigned char *) buf, menu->sub);
    }
    else
    {
      mutt_curses_set_color_by_id(MT_COLOR_NORMAL);
      mutt_window_clearline(menu->win, i - menu->top);
    }
  }
  mutt_curses_set_color_by_id(MT_COLOR_NORMAL);
  menu->redraw = MENU_REDRAW_NO_FLAGS;
}

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

menu	Current Menu

Definition at line 379 of file draw.c.

{
  char buf[1024] = { 0 };
 
  /* Note: menu->color() for the index can end up retrieving a message
   * over imap (if matching against ~h for instance).  This can
   * generate status messages.  So we want to call it *before* we
   * position the cursor for drawing. */
  const struct AttrColor *old_color = menu->color(menu, menu->old_current);
  mutt_window_move(menu->win, 0, menu->old_current - menu->top);
  mutt_curses_set_color(old_color);
 
  const bool c_arrow_cursor = cs_subset_bool(menu->sub, "arrow_cursor");
  struct AttrColor *ac_ind = simple_color_get(MT_COLOR_INDICATOR);
  if (c_arrow_cursor)
  {
    const char *const c_arrow_string = cs_subset_string(menu->sub, "arrow_string");
    const int arrow_width = mutt_strwidth(c_arrow_string);
    /* clear the arrow */
    /* Print space chars to match the screen width of `$arrow_string` */
    mutt_window_printf(menu->win, "%*s", arrow_width + 1, "");
    mutt_curses_set_color_by_id(MT_COLOR_NORMAL);
 
    menu->make_entry(menu, buf, sizeof(buf), menu->old_current);
    menu_pad_string(menu, buf, sizeof(buf));
    mutt_window_move(menu->win, arrow_width + 1, menu->old_current - menu->top);
    print_enriched_string(menu->win, menu->old_current, old_color, NULL,
                          (unsigned char *) buf, menu->sub);
 
    /* now draw it in the new location */
    mutt_curses_set_color(ac_ind);
    mutt_window_mvaddstr(menu->win, 0, menu->current - menu->top, c_arrow_string);
  }
  else
  {
    mutt_curses_set_color_by_id(MT_COLOR_NORMAL);
    /* erase the current indicator */
    menu->make_entry(menu, buf, sizeof(buf), menu->old_current);
    menu_pad_string(menu, buf, sizeof(buf));
    print_enriched_string(menu->win, menu->old_current, old_color, NULL,
                          (unsigned char *) buf, menu->sub);
 
    /* now draw the new one to reflect the change */
    const struct AttrColor *cur_color = menu->color(menu, menu->current);
    cur_color = merged_color_overlay(cur_color, ac_ind);
    menu->make_entry(menu, buf, sizeof(buf), menu->current);
    menu_pad_string(menu, buf, sizeof(buf));
    mutt_window_move(menu->win, 0, menu->current - menu->top);
    mutt_curses_set_color(cur_color);
    print_enriched_string(menu->win, menu->current, cur_color, ac_ind,
                          (unsigned char *) buf, menu->sub);
  }
  mutt_curses_set_color_by_id(MT_COLOR_NORMAL);
}

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

menu	Menu to redraw

Return values

OP_NULL	Menu was redrawn
OP_REDRAW	Full redraw required

Definition at line 474 of file draw.c.

{
  /* See if all or part of the screen needs to be updated.  */
  if (menu->redraw & MENU_REDRAW_FULL)
    menu_redraw_full(menu);
 
  if (menu->redraw & MENU_REDRAW_INDEX)
    menu_redraw_index(menu);
  else if (menu->redraw & MENU_REDRAW_MOTION)
    menu_redraw_motion(menu);
  else if (menu->redraw == MENU_REDRAW_CURRENT)
    menu_redraw_current(menu);
 
  return OP_NULL;
}

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 66 of file menu.c.

{
  for (int i = 0; i < MENU_MAX; i++)
    FREE(&SearchBuffers[i]);
}

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

enum	Menu Type, e.g. MENU_PAGER

Definition at line 85 of file menu.c.

{
  struct MuttWindow *win = window_get_focus();
 
  // This should only happen before the first window is created
  if (!win)
    return MENU_INDEX;
 
  if ((win->type == WT_CUSTOM) && (win->parent->type == WT_PAGER))
    return MENU_PAGER;
 
  if (win->type != WT_MENU)
    return MENU_GENERIC;
 
  struct Menu *menu = win->wdata;
  if (!menu)
    return MENU_GENERIC;
 
  return menu->type;
}

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 75 of file menu.c.

{
  for (int i = 0; i < MENU_MAX; i++)
    SearchBuffers[i] = NULL;
}

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

type	Menu type, e.g. MENU_PAGER
sub	Config items

Return values

ptr	New MuttWindow wrapping a Menu

Definition at line 140 of file window.c.

{
  struct MuttWindow *win = mutt_window_new(WT_MENU, MUTT_WIN_ORIENT_VERTICAL,
                                           MUTT_WIN_SIZE_MAXIMISE, MUTT_WIN_SIZE_UNLIMITED,
                                           MUTT_WIN_SIZE_UNLIMITED);
 
  struct Menu *menu = menu_new(type, win, sub);
 
  win->recalc = menu_recalc;
  win->repaint = menu_repaint;
  win->wdata = menu;
  win->wdata_free = menu_wdata_free;
  win->actions |= WA_RECALC;
 
  return win;
}

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

menu

Menu

Return values

num	Index of selection

Definition at line 156 of file menu.c.

{
  if (!menu)
    return -1;
 
  return menu->current;
}

menu_set_index()

MenuRedrawFlags menu_set_index	(	struct Menu *	menu,
		int	index
	)

Set the current selection in the Menu.

Parameters

menu	Menu
index	Item to select

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_INDEX

Definition at line 170 of file menu.c.

{
  return menu_move_selection(menu, index);
}

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

menu	Menu
index	New selection

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 236 of file move.c.

{
  if (index < 0)
    index = 0;
  else if (index >= menu->max)
    index = menu->max - 1;
 
  int top = menu_drag_view(menu, menu->top, index);
 
  return menu_set_and_notify(menu, top, index);
}

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

menu	Menu
redraw	Item to redraw, e.g. MENU_REDRAW_CURRENT

Definition at line 180 of file menu.c.

{
  if (!menu)
    return;
 
  menu->redraw |= redraw;
  menu->win->actions |= WA_RECALC;
}

menu_move_view_relative()

MenuRedrawFlags menu_move_view_relative	(	struct Menu *	menu,
		int	relative
	)

Move the view relatively.

Parameters

menu	Menu
relative	Relative number of lines to move

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 254 of file move.c.

{
  const bool c_menu_move_off = cs_subset_bool(menu->sub, "menu_move_off");
 
  short c_menu_context = cs_subset_number(menu->sub, "menu_context");
  c_menu_context = MIN(c_menu_context, (menu->page_len / 2));
 
  // Move and range-check the view
  int top = menu->top + relative;
  if (top < 0)
  {
    top = 0;
  }
  else if (c_menu_move_off && (top >= (menu->max - c_menu_context)))
  {
    top = menu->max - c_menu_context - 1;
  }
  else if (!c_menu_move_off && ((top + menu->page_len) >= menu->max))
  {
    top = menu->max - menu->page_len;
  }
  if (top < 0)
    top = 0;
 
  // Move the selection on-screen
  int index = menu->current;
  if (index < top)
    index = top;
  else if (index >= (top + menu->page_len))
    index = top + menu->page_len - 1;
 
  // Check for top/bottom limits
  if (index < c_menu_context)
  {
    top = 0;
    index = menu->current;
  }
  else if (!c_menu_move_off && (index > (menu->max - c_menu_context)))
  {
    top = menu->max - menu->page_len;
    index = menu->current;
  }
 
  if (top == menu->top)
  {
    // Can't move the view; move the selection
    index = calc_fit_selection_to_view(menu, top, index + relative);
  }
  else if (index > (top + menu->page_len - c_menu_context - 1))
  {
    index = calc_fit_selection_to_view(menu, top, index + relative);
  }
  else
  {
    // Drag the selection into the view
    index = calc_fit_selection_to_view(menu, top, index);
  }
 
  return menu_set_and_notify(menu, top, index);
}

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

menu	Menu
top	Index of item at the top of the view
index	Selected item

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 66 of file move.c.

{
  MenuRedrawFlags flags = MENU_REDRAW_NO_FLAGS;
 
  if (top != menu->top)
  {
    menu->top = top;
    flags |= MENU_REDRAW_FULL;
  }
 
  if (index != menu->current)
  {
    menu->old_current = menu->current;
    menu->current = index;
 
    if (menu->redraw == MENU_REDRAW_NO_FLAGS)
    {
      // If this is the only change
      flags |= MENU_REDRAW_MOTION;
    }
    else
    {
      // otherwise, redraw completely
      flags |= MENU_REDRAW_FULL;
    }
  }
 
  if (flags != MENU_REDRAW_NO_FLAGS)
  {
    menu->redraw |= flags;
    menu->win->actions |= WA_REPAINT;
 
    mutt_debug(LL_NOTIFY, "NT_MENU\n");
    notify_send(menu->notify, NT_MENU, flags, NULL);
  }
  return flags;
}

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

menu

Menu

Definition at line 319 of file move.c.

{
  int top = calc_move_view(menu, 0);
  top = menu_drag_view(menu, top, menu->current);
 
  menu_set_and_notify(menu, top, menu->current);
}

Here is the call graph for this function:

Here is the caller graph for this function: