Menu Function API

Prototype for a Menu Function. More...

Collaboration diagram for Menu Function API:

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

Detailed Description

Prototype for a Menu Function.

Parameters

fdata	Menu Function context data
event	Event to process

Return values

enum	FunctionRetval

Precondition

fdata is not NULL

event is not NULL

Function Documentation

menu_movement()

static int menu_movement ( struct MenuFunctionData * fdata, const struct KeyEvent * event )

static

Handle all the common Menu movements - Implements menu_function_t -.

This function handles:

• OP_BOTTOM_PAGE
• OP_CURRENT_BOTTOM
• OP_CURRENT_MIDDLE
• OP_CURRENT_TOP
• OP_FIRST_ENTRY
• OP_HALF_DOWN
• OP_HALF_UP
• OP_LAST_ENTRY
• OP_MIDDLE_PAGE
• OP_NEXT_ENTRY
• OP_NEXT_LINE
• OP_NEXT_PAGE
• OP_PREV_ENTRY
• OP_PREV_LINE
• OP_PREV_PAGE
• OP_TOP_PAGE

Definition at line 165 of file functions.c.

{
  struct Menu *menu = fdata->menu;
  const int old_top = menu->top;
  const int old_current = menu->current;
  MenuRedrawFlags flags = MENU_REDRAW_NONE;
 
  const int count = event->count;
  switch (event->op)
  {
    case OP_BOTTOM_PAGE:
      flags = menu_bottom_page(menu);
      return (menu->max == 0) ? FR_ERROR : FR_SUCCESS;
 
    case OP_CURRENT_BOTTOM:
      flags = menu_current_bottom(menu);
      return (menu->max == 0) ? FR_ERROR : FR_SUCCESS;
 
    case OP_CURRENT_MIDDLE:
      flags = menu_current_middle(menu);
      return (menu->max == 0) ? FR_ERROR : FR_SUCCESS;
 
    case OP_CURRENT_TOP:
      flags = menu_current_top(menu);
      return (menu->max == 0) ? FR_ERROR : FR_SUCCESS;
 
    case OP_FIRST_ENTRY:
      flags = menu_first_entry(menu, count);
      return (menu->max == 0) ? FR_ERROR : FR_SUCCESS;
 
    case OP_HALF_DOWN:
      menu_half_down(menu, count);
      return FR_SUCCESS;
 
    case OP_HALF_UP:
      menu_half_up(menu, count);
      return FR_SUCCESS;
 
    case OP_LAST_ENTRY:
      flags = menu_last_entry(menu, count);
      return (menu->max == 0) ? FR_ERROR : FR_SUCCESS;
 
    case OP_MIDDLE_PAGE:
      flags = menu_middle_page(menu);
      return (menu->max == 0) ? FR_ERROR : FR_SUCCESS;
 
    case OP_NEXT_ENTRY:
      flags = menu_next_entry(menu, count);
      return ((flags == MENU_REDRAW_NONE) && (menu->top == old_top) &&
              (menu->current == old_current)) ?
                 FR_ERROR :
                 FR_SUCCESS;
 
    case OP_NEXT_LINE:
      flags = menu_next_line(menu, count);
      return ((flags == MENU_REDRAW_NONE) && (menu->top == old_top) &&
              (menu->current == old_current)) ?
                 FR_ERROR :
                 FR_SUCCESS;
 
    case OP_NEXT_PAGE:
      menu_next_page(menu, count);
      return FR_SUCCESS;
 
    case OP_PREV_ENTRY:
      flags = menu_prev_entry(menu, count);
      return ((flags == MENU_REDRAW_NONE) && (menu->top == old_top) &&
              (menu->current == old_current)) ?
                 FR_ERROR :
                 FR_SUCCESS;
 
    case OP_PREV_LINE:
      flags = menu_prev_line(menu, count);
      return ((flags == MENU_REDRAW_NONE) && (menu->top == old_top) &&
              (menu->current == old_current)) ?
                 FR_ERROR :
                 FR_SUCCESS;
 
    case OP_PREV_PAGE:
      menu_prev_page(menu, count);
      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 MenuFunctionData * fdata, const struct KeyEvent * event )

static

Handle Menu searching - Implements menu_function_t -.

This function handles:

• OP_SEARCH
• OP_SEARCH_NEXT
• OP_SEARCH_OPPOSITE
• OP_SEARCH_REVERSE

Definition at line 265 of file functions.c.

{
  struct Menu *menu = fdata->menu;
  if (menu->search)
  {
    int index = -1;
    const int rc = search(menu, event->op, &index);
    if ((rc == FR_SUCCESS) && (index != -1))
      menu_set_index(menu, index);
    return rc;
  }
  return FR_SUCCESS;
}

Here is the call graph for this function:

op_help()

static int op_help ( struct MenuFunctionData * fdata, const struct KeyEvent * event )

static

Show the help screen - Implements menu_function_t -.

Definition at line 282 of file functions.c.

{
  struct Menu *menu = fdata->menu;
  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 MenuFunctionData * fdata, const struct KeyEvent * event )

static

Jump to an index number - Implements menu_function_t -.

Definition at line 293 of file functions.c.

{
  struct Menu *menu = fdata->menu;
  if (menu->max == 0)
  {
    mutt_error(_("No entries"));
    return FR_ERROR;
  }
 
  struct Buffer *buf = buf_pool_get();
  int rc = FR_ERROR;
 
  int num = event->count;
  if (num == 0)
  {
    if ((mw_get_field(_("Jump to: "), buf, MUTT_COMP_NONE, HC_OTHER, NULL, NULL) != 0) ||
        buf_is_empty(buf))
    {
      rc = FR_NO_ACTION;
      goto done;
    }
 
    if (!mutt_str_atoi_full(buf_string(buf), &num) || (num < 1) || (num > menu->max))
    {
      mutt_error(_("Invalid index number"));
      goto done;
    }
  }
 
  menu_set_index(menu, num - 1); // msg numbers are 0-based
  rc = FR_SUCCESS;
 
done:
  buf_pool_release(&buf);
  return rc;
}

Here is the call graph for this function: