Sidebar Function API

Prototype for a Sidebar Function. More...

Collaboration diagram for Sidebar Function API:

Functions
static int	op_sidebar_first (struct SidebarWindowData *wdata, const struct KeyEvent *event)
	Selects the first unhidden mailbox - Implements sidebar_function_t -.
static int	op_sidebar_last (struct SidebarWindowData *wdata, const struct KeyEvent *event)
	Selects the last unhidden mailbox - Implements sidebar_function_t -.
static int	op_sidebar_next (struct SidebarWindowData *wdata, const struct KeyEvent *event)
	Selects the next unhidden mailbox - Implements sidebar_function_t -.
static int	op_sidebar_next_new (struct SidebarWindowData *wdata, const struct KeyEvent *event)
	Selects the next new mailbox - Implements sidebar_function_t -.
static int	op_sidebar_open (struct SidebarWindowData *wdata, const struct KeyEvent *event)
	Open highlighted mailbox - Implements sidebar_function_t -.
static int	op_sidebar_page_down (struct SidebarWindowData *wdata, const struct KeyEvent *event)
	Selects the first entry in the next page of mailboxes - Implements sidebar_function_t -.
static int	op_sidebar_page_up (struct SidebarWindowData *wdata, const struct KeyEvent *event)
	Selects the last entry in the previous page of mailboxes - Implements sidebar_function_t -.
static int	op_sidebar_prev (struct SidebarWindowData *wdata, const struct KeyEvent *event)
	Selects the previous unhidden mailbox - Implements sidebar_function_t -.
static int	op_sidebar_prev_new (struct SidebarWindowData *wdata, const struct KeyEvent *event)
	Selects the previous new mailbox - Implements sidebar_function_t -.
static int	op_sidebar_toggle_visible (struct SidebarWindowData *wdata, const struct KeyEvent *event)
	Make the sidebar (in)visible - Implements sidebar_function_t -.
static int	op_sidebar_toggle_virtual (struct SidebarWindowData *wdata, const struct KeyEvent *event)
	Deprecated - Implements sidebar_function_t -.

Detailed Description

Prototype for a Sidebar Function.

Parameters

wdata	Sidebar Window data
event	Event to process

Return values

enum	FunctionRetval

Precondition

wdata is not NULL

event is not NULL

Function Documentation

op_sidebar_first()

static int op_sidebar_first ( struct SidebarWindowData * wdata, const struct KeyEvent * event )

static

Selects the first unhidden mailbox - Implements sidebar_function_t -.

Definition at line 182 of file functions.c.

{
  if (!mutt_window_is_visible(wdata->win))
    return FR_NO_ACTION;
 
  if (ARRAY_EMPTY(&wdata->entries) || (wdata->hil_index < 0))
    return FR_NO_ACTION;
 
  int orig_hil_index = wdata->hil_index;
 
  wdata->hil_index = 0;
  if ((*ARRAY_GET(&wdata->entries, wdata->hil_index))->is_hidden)
    if (!sb_next(wdata))
      wdata->hil_index = orig_hil_index;
 
  if (orig_hil_index == wdata->hil_index)
    return FR_NO_ACTION;
 
  wdata->win->actions |= WA_RECALC;
  return FR_SUCCESS;
}

Here is the call graph for this function:

op_sidebar_last()

static int op_sidebar_last ( struct SidebarWindowData * wdata, const struct KeyEvent * event )

static

Selects the last unhidden mailbox - Implements sidebar_function_t -.

Definition at line 207 of file functions.c.

{
  if (!mutt_window_is_visible(wdata->win))
    return FR_NO_ACTION;
 
  if (ARRAY_EMPTY(&wdata->entries) || (wdata->hil_index < 0))
    return FR_NO_ACTION;
 
  int orig_hil_index = wdata->hil_index;
 
  wdata->hil_index = ARRAY_SIZE(&wdata->entries);
  if (!sb_prev(wdata))
    wdata->hil_index = orig_hil_index;
 
  if (orig_hil_index == wdata->hil_index)
    return FR_NO_ACTION;
 
  wdata->win->actions |= WA_RECALC;
  return FR_SUCCESS;
}

Here is the call graph for this function:

op_sidebar_next()

static int op_sidebar_next ( struct SidebarWindowData * wdata, const struct KeyEvent * event )

static

Selects the next unhidden mailbox - Implements sidebar_function_t -.

Definition at line 231 of file functions.c.

{
  if (!mutt_window_is_visible(wdata->win))
    return FR_NO_ACTION;
 
  if (ARRAY_EMPTY(&wdata->entries) || (wdata->hil_index < 0))
    return FR_NO_ACTION;
 
  if (!sb_next(wdata))
    return FR_NO_ACTION;
 
  wdata->win->actions |= WA_RECALC;
  return FR_SUCCESS;
}

Here is the call graph for this function:

op_sidebar_next_new()

static int op_sidebar_next_new ( struct SidebarWindowData * wdata, const struct KeyEvent * event )

static

Selects the next new mailbox - Implements sidebar_function_t -.

Search down the list of mail folders for one containing new mail.

Definition at line 251 of file functions.c.

{
  if (!mutt_window_is_visible(wdata->win))
    return FR_NO_ACTION;
 
  const size_t max_entries = ARRAY_SIZE(&wdata->entries);
  if ((max_entries == 0) || (wdata->hil_index < 0))
    return FR_NO_ACTION;
 
  const bool c_sidebar_next_new_wrap = cs_subset_bool(NeoMutt->sub, "sidebar_next_new_wrap");
  struct SbEntry **sbep = NULL;
  if ((sbep = sb_next_new(wdata, wdata->hil_index + 1, max_entries)) ||
      (c_sidebar_next_new_wrap && (sbep = sb_next_new(wdata, 0, wdata->hil_index))))
  {
    wdata->hil_index = ARRAY_IDX(&wdata->entries, sbep);
    wdata->win->actions |= WA_RECALC;
    return FR_SUCCESS;
  }
 
  return FR_NO_ACTION;
}

Here is the call graph for this function:

op_sidebar_open()

static int op_sidebar_open ( struct SidebarWindowData * wdata, const struct KeyEvent * event )

static

Open highlighted mailbox - Implements sidebar_function_t -.

Definition at line 276 of file functions.c.

{
  struct MuttWindow *win_sidebar = wdata->win;
  if (!mutt_window_is_visible(win_sidebar))
    return FR_NO_ACTION;
 
  struct MuttWindow *dlg = dialog_find(win_sidebar);
  index_change_folder(dlg, sb_get_highlight(win_sidebar));
  return FR_SUCCESS;
}

Here is the call graph for this function:

op_sidebar_page_down()

static int op_sidebar_page_down ( struct SidebarWindowData * wdata, const struct KeyEvent * event )

static

Selects the first entry in the next page of mailboxes - Implements sidebar_function_t -.

Definition at line 290 of file functions.c.

{
  if (!mutt_window_is_visible(wdata->win))
    return FR_NO_ACTION;
 
  if (ARRAY_EMPTY(&wdata->entries) || (wdata->bot_index < 0))
    return FR_NO_ACTION;
 
  int orig_hil_index = wdata->hil_index;
 
  wdata->hil_index = wdata->bot_index;
  sb_next(wdata);
  /* If the rest of the entries are hidden, go up to the last unhidden one */
  if ((*ARRAY_GET(&wdata->entries, wdata->hil_index))->is_hidden)
    sb_prev(wdata);
 
  if (orig_hil_index == wdata->hil_index)
    return FR_NO_ACTION;
 
  wdata->win->actions |= WA_RECALC;
  return FR_SUCCESS;
}

Here is the call graph for this function:

op_sidebar_page_up()

static int op_sidebar_page_up ( struct SidebarWindowData * wdata, const struct KeyEvent * event )

static

Selects the last entry in the previous page of mailboxes - Implements sidebar_function_t -.

Definition at line 316 of file functions.c.

{
  if (!mutt_window_is_visible(wdata->win))
    return FR_NO_ACTION;
 
  if (ARRAY_EMPTY(&wdata->entries) || (wdata->top_index < 0))
    return FR_NO_ACTION;
 
  int orig_hil_index = wdata->hil_index;
 
  wdata->hil_index = wdata->top_index;
  sb_prev(wdata);
  /* If the rest of the entries are hidden, go down to the last unhidden one */
  if ((*ARRAY_GET(&wdata->entries, wdata->hil_index))->is_hidden)
    sb_next(wdata);
 
  if (orig_hil_index == wdata->hil_index)
    return FR_NO_ACTION;
 
  wdata->win->actions |= WA_RECALC;
  return FR_SUCCESS;
}

Here is the call graph for this function:

op_sidebar_prev()

static int op_sidebar_prev ( struct SidebarWindowData * wdata, const struct KeyEvent * event )

static

Selects the previous unhidden mailbox - Implements sidebar_function_t -.

Definition at line 342 of file functions.c.

{
  if (!mutt_window_is_visible(wdata->win))
    return FR_NO_ACTION;
 
  if (ARRAY_EMPTY(&wdata->entries) || (wdata->hil_index < 0))
    return FR_NO_ACTION;
 
  if (!sb_prev(wdata))
    return FR_NO_ACTION;
 
  wdata->win->actions |= WA_RECALC;
  return FR_SUCCESS;
}

Here is the call graph for this function:

op_sidebar_prev_new()

static int op_sidebar_prev_new ( struct SidebarWindowData * wdata, const struct KeyEvent * event )

static

Selects the previous new mailbox - Implements sidebar_function_t -.

Search up the list of mail folders for one containing new mail.

Definition at line 362 of file functions.c.

{
  if (!mutt_window_is_visible(wdata->win))
    return FR_NO_ACTION;
 
  const size_t max_entries = ARRAY_SIZE(&wdata->entries);
  if ((max_entries == 0) || (wdata->hil_index < 0))
    return FR_NO_ACTION;
 
  const bool c_sidebar_next_new_wrap = cs_subset_bool(NeoMutt->sub, "sidebar_next_new_wrap");
  struct SbEntry **sbep = NULL;
  if ((sbep = sb_prev_new(wdata, 0, wdata->hil_index)) ||
      (c_sidebar_next_new_wrap &&
       (sbep = sb_prev_new(wdata, wdata->hil_index + 1, max_entries))))
  {
    wdata->hil_index = ARRAY_IDX(&wdata->entries, sbep);
    wdata->win->actions |= WA_RECALC;
    return FR_SUCCESS;
  }
 
  return FR_NO_ACTION;
}

Here is the call graph for this function:

op_sidebar_toggle_visible()

static int op_sidebar_toggle_visible ( struct SidebarWindowData * wdata, const struct KeyEvent * event )

static

Make the sidebar (in)visible - Implements sidebar_function_t -.

Definition at line 388 of file functions.c.

{
  bool_str_toggle(NeoMutt->sub, "sidebar_visible", NULL);
  mutt_window_reflow(NULL);
  return FR_SUCCESS;
}

Here is the call graph for this function:

op_sidebar_toggle_virtual()

static int op_sidebar_toggle_virtual ( struct SidebarWindowData * wdata, const struct KeyEvent * event )

static

Deprecated - Implements sidebar_function_t -.

Definition at line 399 of file functions.c.

{
  return FR_SUCCESS;
}