lib.h File Reference

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

#include "mutt/list.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 (struct MuttWindow *all_dialogs_window)
	Set up the Sidebar.
void	sb_cleanup (struct ListHead *sidebar_pinned, struct MuttWindow *all_dialogs_window)
	Clean up the Sidebar.
int	sb_function_dispatcher (struct MuttWindow *win, const struct KeyEvent *event)
	Perform a Sidebar function - Implements function_dispatcher_t -.
enum CommandResult	parse_sidebar_pin (const struct Command *cmd, struct Buffer *line, const struct ParseContext *pc, struct ParseError *pe)
	Parse the 'sidebar-pin' command - Implements Command::parse() -.
enum CommandResult	parse_sidebar_unpin (const struct Command *cmd, struct Buffer *line, const struct ParseContext *pc, struct ParseError *pe)
	Parse the 'sidebar-unpin' command - Implements Command::parse() -.
void	sidebar_init_keys (struct NeoMutt *n, struct SubMenu *sm_generic)
	Initialise the Sidebar Keybindings - Implements ::init_keys_api.
struct SubMenu *	sidebar_get_submenu (void)
	Get the Sidebar SubMenu.

Detailed Description

GUI display the mailboxes in a side panel.

Authors

• 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

(

struct MuttWindow *

all_dialogs_window

)

Set up the Sidebar.

Parameters

all_dialogs_window

All Dialogs Window

Definition at line 214 of file sidebar.c.

{
  // Set a default style, if unset
  struct AttrColor *ac = simple_color_get(MT_COLOR_SIDEBAR_HIGHLIGHT);
  if (!attr_color_is_set(ac))
    ac->attrs = A_UNDERLINE;
 
  if (all_dialogs_window)
  {
    // Listen for dialog creation events
    notify_observer_add(all_dialogs_window->notify, NT_WINDOW,
                        sb_insertion_window_observer, NULL);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

sb_cleanup()

void sb_cleanup	(	struct ListHead *	sidebar_pinned,
		struct MuttWindow *	all_dialogs_window )

Clean up the Sidebar.

Parameters

sidebar_pinned	List of pinned sidebar entries
all_dialogs_window	All Dialogs Window

Definition at line 234 of file sidebar.c.

{
  if (all_dialogs_window)
    notify_observer_remove(all_dialogs_window->notify, sb_insertion_window_observer, NULL);
  mutt_list_free(sidebar_pinned);
}

Here is the call graph for this function:

Here is the caller graph for this function:

sidebar_init_keys()

void sidebar_init_keys	(	struct NeoMutt *	n,
		struct SubMenu *	sm_generic )

Initialise the Sidebar Keybindings - Implements ::init_keys_api.

Definition at line 82 of file functions.c.

{
  struct SidebarModuleData *mod_data = neomutt_get_module_data(n, MODULE_ID_SIDEBAR);
  ASSERT(mod_data);
 
  struct MenuDefinition *md = NULL;
  struct SubMenu *sm = NULL;
  struct SubMenu *sm_editor = editor_get_submenu();
  ASSERT(sm_editor);
 
  sm = km_register_submenu(OpSidebar);
  md = km_register_menu(MENU_SIDEBAR, "sidebar");
  km_menu_add_submenu(md, sm);
  km_menu_add_submenu(md, sm_editor);
  km_menu_add_bindings(md, SidebarDefaultBindings);
 
  mod_data->md_sidebar = md;
  mod_data->sm_sidebar = sm;
}

Here is the call graph for this function:

Here is the caller graph for this function:

sidebar_get_submenu()

struct SubMenu * sidebar_get_submenu

(

void

)

Get the Sidebar SubMenu.

Return values

ptr	Sidebar SubMenu

Definition at line 106 of file functions.c.

{
  struct SidebarModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_SIDEBAR);
  ASSERT(mod_data);
 
  return mod_data->sm_sidebar;
}

Here is the call graph for this function:

Here is the caller graph for this function: