History Function API

Prototype for a History Function. More...

Collaboration diagram for History Function API:

Functions
static int	op_generic_select_entry (struct HistoryData *hd, const struct KeyEvent *event)
	Select the current entry - Implements history_function_t -.
static int	op_quit (struct HistoryData *hd, const struct KeyEvent *event)
	Quit this menu - Implements history_function_t -.

Detailed Description

Prototype for a History Function.

Parameters

menu	Menu
event	Event to process

Return values

enum	FunctionRetval

Precondition

menu is not NULL

event is not NULL

Function Documentation

op_generic_select_entry()

static int op_generic_select_entry ( struct HistoryData * hd, const struct KeyEvent * event )

static

Select the current entry - Implements history_function_t -.

Definition at line 41 of file functions.c.

{
  const int index = menu_get_index(hd->menu);
 
  const char **pentry = ARRAY_GET(hd->matches, index);
  if (pentry)
    buf_strcpy(hd->buf, *pentry);
 
  hd->done = true;
  hd->selection = true;
  return FR_SUCCESS;
}

Here is the call graph for this function:

op_quit()

static int op_quit ( struct HistoryData * hd, const struct KeyEvent * event )

static

Quit this menu - Implements history_function_t -.

This function handles:

• OP_EXIT
• OP_QUIT

Definition at line 61 of file functions.c.

{
  hd->done = true;
  hd->selection = false;
  return FR_SUCCESS;
}