Preview Function API

Prototype for a Preview Function. More...

Collaboration diagram for Preview Function API:

Functions
static int	preview_scroll_page_up (struct PreviewWindowData *wdata, const struct KeyEvent *event)
	Show the previous page of the message - Implements preview_function_t -.
static int	preview_scroll_page_down (struct PreviewWindowData *wdata, const struct KeyEvent *event)
	Show the next page of the message - Implements preview_function_t -.
static int	preview_scroll_half_up (struct PreviewWindowData *wdata, const struct KeyEvent *event)
	Scroll up half a page - Implements preview_function_t -.
static int	preview_scroll_half_down (struct PreviewWindowData *wdata, const struct KeyEvent *event)
	Scroll down half a page - Implements preview_function_t -.
static int	preview_scroll_line_up (struct PreviewWindowData *wdata, const struct KeyEvent *event)
	Scroll up one line - Implements preview_function_t -.
static int	preview_scroll_line_down (struct PreviewWindowData *wdata, const struct KeyEvent *event)
	Scroll down one line - Implements preview_function_t -.
static int	preview_select_first_entry (struct PreviewWindowData *wdata, const struct KeyEvent *event)
	Move to the first entry - Implements preview_function_t -.
static int	preview_select_last_entry (struct PreviewWindowData *wdata, const struct KeyEvent *event)
	Move to the last entry - Implements preview_function_t -.

Detailed Description

Prototype for a Preview Function.

Parameters

wdata	Preview Window data
event	Event to process

Return values

enum	FunctionRetval

Precondition

wdata is not NULL

event is not NULL

Function Documentation

preview_scroll_page_up()

static int preview_scroll_page_up ( struct PreviewWindowData * wdata, const struct KeyEvent * event )

static

Show the previous page of the message - Implements preview_function_t -.

Definition at line 386 of file preview.c.

{
  if (wdata->scroll_offset <= 0)
  {
    if (event->count == 0)
      mutt_message(_("Top of message is shown"));
    return FR_NO_ACTION;
  }
 
  const int count = MAX(event->count, 1);
  const int page = MAX(wdata->win->state.rows - 1, 1);
  wdata->scroll_offset -= count * page;
  if (wdata->scroll_offset < 0)
    wdata->scroll_offset = 0;
  draw_preview(wdata->win, wdata);
 
  return FR_SUCCESS;
}

Here is the call graph for this function:

preview_scroll_page_down()

static int preview_scroll_page_down ( struct PreviewWindowData * wdata, const struct KeyEvent * event )

static

Show the next page of the message - Implements preview_function_t -.

Definition at line 408 of file preview.c.

{
  if (!wdata->more_content)
  {
    if (event->count == 0)
      mutt_message(_("Bottom of message is shown"));
    return FR_NO_ACTION;
  }
 
  const int count = MAX(event->count, 1);
  const int page = MAX(wdata->win->state.rows - 1, 1);
  wdata->scroll_offset += count * page;
  draw_preview(wdata->win, wdata);
 
  return FR_SUCCESS;
}

Here is the call graph for this function:

preview_scroll_half_up()

static int preview_scroll_half_up ( struct PreviewWindowData * wdata, const struct KeyEvent * event )

static

Scroll up half a page - Implements preview_function_t -.

Definition at line 429 of file preview.c.

{
  if (wdata->scroll_offset <= 0)
  {
    if (event->count == 0)
      mutt_message(_("Top of message is shown"));
    return FR_NO_ACTION;
  }
 
  const int count = MAX(event->count, 1);
  const int half = MAX(wdata->win->state.rows / 2, 1);
  wdata->scroll_offset -= count * half;
  if (wdata->scroll_offset < 0)
    wdata->scroll_offset = 0;
  draw_preview(wdata->win, wdata);
 
  return FR_SUCCESS;
}

Here is the call graph for this function:

preview_scroll_half_down()

static int preview_scroll_half_down ( struct PreviewWindowData * wdata, const struct KeyEvent * event )

static

Scroll down half a page - Implements preview_function_t -.

Definition at line 451 of file preview.c.

{
  if (!wdata->more_content)
  {
    if (event->count == 0)
      mutt_message(_("Bottom of message is shown"));
    return FR_NO_ACTION;
  }
 
  const int count = MAX(event->count, 1);
  const int half = MAX(wdata->win->state.rows / 2, 1);
  wdata->scroll_offset += count * half;
  draw_preview(wdata->win, wdata);
 
  return FR_SUCCESS;
}

Here is the call graph for this function:

preview_scroll_line_up()

static int preview_scroll_line_up ( struct PreviewWindowData * wdata, const struct KeyEvent * event )

static

Scroll up one line - Implements preview_function_t -.

Definition at line 472 of file preview.c.

{
  if (wdata->scroll_offset <= 0)
  {
    if (event->count == 0)
      mutt_message(_("Top of message is shown"));
    return FR_NO_ACTION;
  }
 
  const int count = MAX(event->count, 1);
  wdata->scroll_offset -= count;
  if (wdata->scroll_offset < 0)
    wdata->scroll_offset = 0;
  draw_preview(wdata->win, wdata);
 
  return FR_SUCCESS;
}

Here is the call graph for this function:

preview_scroll_line_down()

static int preview_scroll_line_down ( struct PreviewWindowData * wdata, const struct KeyEvent * event )

static

Scroll down one line - Implements preview_function_t -.

Definition at line 493 of file preview.c.

{
  if (!wdata->more_content)
  {
    if (event->count == 0)
      mutt_message(_("Bottom of message is shown"));
    return FR_NO_ACTION;
  }
 
  const int count = MAX(event->count, 1);
  wdata->scroll_offset += count;
  draw_preview(wdata->win, wdata);
 
  return FR_SUCCESS;
}

Here is the call graph for this function:

preview_select_first_entry()

static int preview_select_first_entry ( struct PreviewWindowData * wdata, const struct KeyEvent * event )

static

Move to the first entry - Implements preview_function_t -.

Definition at line 513 of file preview.c.

{
  if (wdata->scroll_offset <= 0)
  {
    if (event->count == 0)
      mutt_message(_("Top of message is shown"));
    return FR_NO_ACTION;
  }
 
  wdata->scroll_offset = 0;
  draw_preview(wdata->win, wdata);
 
  return FR_SUCCESS;
}

Here is the call graph for this function:

preview_select_last_entry()

static int preview_select_last_entry ( struct PreviewWindowData * wdata, const struct KeyEvent * event )

static

Move to the last entry - Implements preview_function_t -.

Definition at line 532 of file preview.c.

{
  if (!wdata->more_content)
  {
    if (event->count == 0)
      mutt_message(_("Bottom of message is shown"));
    return FR_NO_ACTION;
  }
 
  // draw_preview() clamps the offset to the last visible page
  wdata->scroll_offset = wdata->content_lines;
  draw_preview(wdata->win, wdata);
 
  return FR_SUCCESS;
}

Here is the call graph for this function: