functions.h File Reference

Index functions. More...

#include <stdbool.h>

Include dependency graph for functions.h:

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

Go to the source code of this file.

Data Structures
struct	IndexFunctionData
	Data passed to Index worker functions. More...
struct	IndexFunction
	A NeoMutt function. More...

Typedefs
typedef int(*	index_function_t) (struct IndexFunctionData *fdata, const struct KeyEvent *event)

Functions
int	index_function_dispatcher (struct MuttWindow *win, const struct KeyEvent *event)
	Perform an Index function - Implements function_dispatcher_t -.
bool	index_next_undeleted (struct MuttWindow *win_index)
	Select the next undeleted Email (if possible).
struct MenuDefinition *	index_get_menu_definition (void)
	Get the Index Menu Definition.
struct SubMenu *	index_get_submenu (void)
	Get the Index SubMenu.

Detailed Description

Index functions.

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 functions.h.

Typedef Documentation

index_function_t

typedef int(* index_function_t) (struct IndexFunctionData *fdata, const struct KeyEvent *event)

Definition at line 55 of file functions.h.

Function Documentation

index_next_undeleted()

bool index_next_undeleted

(

struct MuttWindow *

win_index

)

Select the next undeleted Email (if possible).

Parameters

win_index

Index Window

Return values

true	Selection succeeded

Definition at line 444 of file functions.c.

{
  struct MuttWindow *dlg = dialog_find(win_index);
  if (!dlg)
    return false;
 
  struct Menu *menu = win_index->wdata;
  struct IndexSharedData *shared = dlg->wdata;
  if (!shared)
    return false;
 
  struct IndexPrivateData *priv = win_index->parent->wdata;
  const bool uncollapse = mutt_using_threads() && !window_is_focused(priv->win_index);
 
  int index = find_next_undeleted(shared->mailbox_view, menu_get_index(menu), uncollapse);
  if ((index < 0) || (index >= shared->mailbox->vcount))
  {
    // Selection failed
    notify_send(shared->notify, NT_INDEX, NT_INDEX_EMAIL, NULL);
    return false;
  }
 
  menu_set_index(menu, index);
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

index_get_menu_definition()

struct MenuDefinition * index_get_menu_definition

(

void

)

Get the Index Menu Definition.

Return values

ptr	Index Menu Definition

Definition at line 4118 of file functions.c.

{
  struct IndexModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_INDEX);
  ASSERT(mod_data);
 
  return mod_data->md_index;
}

Here is the call graph for this function:

Here is the caller graph for this function:

index_get_submenu()

struct SubMenu * index_get_submenu

(

void

)

Get the Index SubMenu.

Return values

ptr	Index SubMenu

Definition at line 355 of file functions.c.

{
  struct IndexModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_INDEX);
  ASSERT(mod_data);
 
  return mod_data->sm_index;
}

Here is the call graph for this function:

Here is the caller graph for this function: