Menu Function API

Prototype for a Menu Function. More...

Collaboration diagram for Menu Function API:

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

Detailed Description

Prototype for a Menu Function.

Parameters

menu	Menu
event	Event to process

Return values

enum	FunctionRetval

Precondition

menu is not NULL

event is not NULL

Function Documentation

menu_movement()

static int menu_movement ( struct Menu * menu, const struct KeyEvent * event )

static

Handle all the common Menu movements - Implements menu_function_t -.

Definition at line 142 of file functions.c.

{
  switch (event->op)
  {
    case OP_BOTTOM_PAGE:
      menu_bottom_page(menu);
      return FR_SUCCESS;
 
    case OP_CURRENT_BOTTOM:
      menu_current_bottom(menu);
      return FR_SUCCESS;
 
    case OP_CURRENT_MIDDLE:
      menu_current_middle(menu);
      return FR_SUCCESS;
 
    case OP_CURRENT_TOP:
      menu_current_top(menu);
      return FR_SUCCESS;
 
    case OP_FIRST_ENTRY:
      menu_first_entry(menu);
      return FR_SUCCESS;
 
    case OP_HALF_DOWN:
      menu_half_down(menu);
      return FR_SUCCESS;
 
    case OP_HALF_UP:
      menu_half_up(menu);
      return FR_SUCCESS;
 
    case OP_LAST_ENTRY:
      menu_last_entry(menu);
      return FR_SUCCESS;
 
    case OP_MIDDLE_PAGE:
      menu_middle_page(menu);
      return FR_SUCCESS;
 
    case OP_NEXT_ENTRY:
      menu_next_entry(menu);
      return FR_SUCCESS;
 
    case OP_NEXT_LINE:
      menu_next_line(menu);
      return FR_SUCCESS;
 
    case OP_NEXT_PAGE:
      menu_next_page(menu);
      return FR_SUCCESS;
 
    case OP_PREV_ENTRY:
      menu_prev_entry(menu);
      return FR_SUCCESS;
 
    case OP_PREV_LINE:
      menu_prev_line(menu);
      return FR_SUCCESS;
 
    case OP_PREV_PAGE:
      menu_prev_page(menu);
      return FR_SUCCESS;
 
    case OP_TOP_PAGE:
      menu_top_page(menu);
      return FR_SUCCESS;
 
    default:
      return FR_UNKNOWN;
  }
}

Here is the call graph for this function:

menu_search()

static int menu_search ( struct Menu * menu, const struct KeyEvent * event )

static

Handle Menu searching - Implements menu_function_t -.

Definition at line 218 of file functions.c.

{
  if (menu->search)
  {
    int index = search(menu, event->op);
    if (index != -1)
      menu_set_index(menu, index);
  }
  return FR_SUCCESS;
}

Here is the call graph for this function:

op_help()

static int op_help ( struct Menu * menu, const struct KeyEvent * event )

static

Show the help screen - Implements menu_function_t -.

Definition at line 232 of file functions.c.

{
  mutt_help(menu->md);
  menu->redraw = MENU_REDRAW_FULL;
  return FR_SUCCESS;
}

Here is the call graph for this function:

op_jump()

static int op_jump ( struct Menu * menu, const struct KeyEvent * event )

static

Jump to an index number - Implements menu_function_t -.

Definition at line 242 of file functions.c.

{
  if (menu->max == 0)
  {
    mutt_error(_("No entries"));
    return FR_SUCCESS;
  }
 
  const int digit = event->op - OP_JUMP;
  if ((digit > 0) && (digit < 10))
  {
    mutt_unget_ch('0' + digit);
  }
 
  struct Buffer *buf = buf_pool_get();
  if ((mw_get_field(_("Jump to: "), buf, MUTT_COMP_NO_FLAGS, HC_OTHER, NULL, NULL) == 0) &&
      !buf_is_empty(buf))
  {
    int n = 0;
    if (mutt_str_atoi_full(buf_string(buf), &n) && (n > 0) && (n < (menu->max + 1)))
    {
      menu_set_index(menu, n - 1); // msg numbers are 0-based
    }
    else
    {
      mutt_error(_("Invalid index number"));
    }
  }
 
  buf_pool_release(&buf);
  return FR_SUCCESS;
}

Here is the call graph for this function: