Pattern Function API

Prototype for a Pattern Function. More...

Collaboration diagram for Pattern Function API:

Functions
static int	op_generic_select_entry (struct PatternFunctionData *fdata, const struct KeyEvent *event)
	Select the current entry - Implements pattern_function_t -.
static int	op_quit (struct PatternFunctionData *fdata, const struct KeyEvent *event)
	Quit this menu - Implements pattern_function_t -.

Detailed Description

Prototype for a Pattern Function.

Parameters

fdata	Pattern Function context data
event	Event to process

Return values

enum	FunctionRetval

Precondition

fdata is not NULL

event is not NULL

Function Documentation

op_generic_select_entry()

static int op_generic_select_entry ( struct PatternFunctionData * fdata, const struct KeyEvent * event )

static

Select the current entry - Implements pattern_function_t -.

Definition at line 43 of file functions.c.

{
  struct PatternData *pd = fdata->pd;
  const int index = menu_get_index(pd->menu);
  struct PatternEntry *entry = ARRAY_GET(&pd->entries, index);
 
  if (entry)
    buf_strcpy(pd->buf, entry->tag);
 
  pd->done = true;
  pd->selection = true;
  return FR_SUCCESS;
}

Here is the call graph for this function:

op_quit()

static int op_quit ( struct PatternFunctionData * fdata, const struct KeyEvent * event )

static

Quit this menu - Implements pattern_function_t -.

This function handles:

• OP_EXIT
• OP_QUIT

Definition at line 65 of file functions.c.

{
  struct PatternData *pd = fdata->pd;
  pd->done = true;
  pd->selection = false;
  return FR_SUCCESS;
}