lib.h File Reference

GUI display the mailboxes in a side panel. More...

#include <stdbool.h>
#include <stdint.h>
#include "mutt_commands.h"

Include dependency graph for lib.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
void	sb_init (void)
	Set up the Sidebar. More...
void	sb_shutdown (void)
	Clean up the Sidebar. More...
void	sb_change_mailbox (struct MuttWindow *win, int op)
	Perform a Sidebar function. More...
struct Mailbox *	sb_get_highlight (struct MuttWindow *win)
	Get the Mailbox that's highlighted in the sidebar. More...
enum CommandResult	sb_parse_unwhitelist (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'unsidebar_whitelist' command - Implements Command::parse() More...
enum CommandResult	sb_parse_whitelist (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'sidebar_whitelist' command - Implements Command::parse() More...
bool	config_init_sidebar (struct ConfigSet *cs)
	Register sidebar config variables - Implements module_init_config_t. More...

Detailed Description

GUI display the mailboxes in a side panel.

Authors

• Justin Hibbits
• Thomer M. Gil
• Richard Russon

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file lib.h.

Function Documentation

sb_init()

void sb_init

(

void

)

Set up the Sidebar.

Definition at line 189 of file sidebar.c.

{
  COMMANDS_REGISTER(sb_commands);

  // Listen for dialog creation events
  notify_observer_add(AllDialogsWindow->notify, NT_WINDOW, sb_insertion_observer, NULL);
}

Here is the call graph for this function:

Here is the caller graph for this function:

sb_shutdown()

void sb_shutdown

(

void

)

Clean up the Sidebar.

Definition at line 200 of file sidebar.c.

{
  if (AllDialogsWindow)
    notify_observer_remove(AllDialogsWindow->notify, sb_insertion_observer, NULL);
  mutt_list_free(&SidebarWhitelist);
}

Here is the call graph for this function:

Here is the caller graph for this function:

sb_change_mailbox()

void sb_change_mailbox	(	struct MuttWindow *	win,
		int	op
	)

Perform a Sidebar function.

Parameters

win	Sidebar Window
op	Operation to perform, e.g. OP_SIDEBAR_NEXT_NEW

Definition at line 265 of file functions.c.

{
  if (!mutt_window_is_visible(win))
    return;

  struct SidebarWindowData *wdata = sb_wdata_get(win);
  if (!wdata)
    return;

  if (wdata->hil_index < 0) /* It'll get reset on the next draw */
    return;

  bool changed = false;
  switch (op)
  {
    case OP_SIDEBAR_FIRST:
      changed = select_first(wdata);
      break;
    case OP_SIDEBAR_LAST:
      changed = select_last(wdata);
      break;
    case OP_SIDEBAR_NEXT:
      changed = select_next(wdata);
      break;
    case OP_SIDEBAR_NEXT_NEW:
      changed = select_next_new(wdata, C_SidebarNextNewWrap);
      break;
    case OP_SIDEBAR_PAGE_DOWN:
      changed = select_page_down(wdata);
      break;
    case OP_SIDEBAR_PAGE_UP:
      changed = select_page_up(wdata);
      break;
    case OP_SIDEBAR_PREV:
      changed = select_prev(wdata);
      break;
    case OP_SIDEBAR_PREV_NEW:
      changed = select_prev_new(wdata, C_SidebarNextNewWrap);
      break;
    default:
      return;
  }
  if (changed)
    win->actions |= WA_RECALC;
}

Here is the call graph for this function:

Here is the caller graph for this function:

sb_get_highlight()

struct Mailbox* sb_get_highlight

(

struct MuttWindow *

win

)

Get the Mailbox that's highlighted in the sidebar.

Parameters

win	Sidebar Window

Return values

ptr

Mailbox

Definition at line 56 of file sidebar.c.

{
  if (!C_SidebarVisible)
    return NULL;

  struct SidebarWindowData *wdata = sb_wdata_get(win);
  if (wdata->hil_index < 0)
    return NULL;

  struct SbEntry **sbep = ARRAY_GET(&wdata->entries, wdata->hil_index);
  if (!sbep)
    return NULL;

  return (*sbep)->mailbox;
}

Here is the call graph for this function:

Here is the caller graph for this function:

sb_parse_unwhitelist()

enum CommandResult sb_parse_unwhitelist	(	struct Buffer *	buf,
		struct Buffer *	s,
		intptr_t	data,
		struct Buffer *	err
	)

Parse the 'unsidebar_whitelist' command - Implements Command::parse()

Definition at line 61 of file commands.c.

{
  struct Buffer *path = mutt_buffer_pool_get();

  do
  {
    mutt_extract_token(path, s, MUTT_TOKEN_BACKTICK_VARS);
    /* Check for deletion of entire list */
    if (mutt_str_equal(mutt_b2s(path), "*"))
    {
      mutt_list_free(&SidebarWhitelist);
      break;
    }
    mutt_buffer_expand_path(path);
    remove_from_stailq(&SidebarWhitelist, mutt_b2s(path));
  } while (MoreArgs(s));
  mutt_buffer_pool_release(&path);

  return MUTT_CMD_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

sb_parse_whitelist()

enum CommandResult sb_parse_whitelist	(	struct Buffer *	buf,
		struct Buffer *	s,
		intptr_t	data,
		struct Buffer *	err
	)

Parse the 'sidebar_whitelist' command - Implements Command::parse()

Definition at line 42 of file commands.c.

{
  struct Buffer *path = mutt_buffer_pool_get();

  do
  {
    mutt_extract_token(path, s, MUTT_TOKEN_BACKTICK_VARS);
    mutt_buffer_expand_path(path);
    add_to_stailq(&SidebarWhitelist, mutt_b2s(path));
  } while (MoreArgs(s));
  mutt_buffer_pool_release(&path);

  return MUTT_CMD_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

config_init_sidebar()

bool config_init_sidebar

(

struct ConfigSet *

cs

)

Register sidebar config variables - Implements module_init_config_t.

Definition at line 122 of file config.c.

{
  return cs_register_variables(cs, SidebarVars, 0);
}

Here is the call graph for this function: